AgendaEvents Class Reference

Inheritance diagram for AgendaEvents:

Collaboration diagram for AgendaEvents:

Public Member Functions
	__construct ()
	Constructor.
	get ($id)
	Get agenda event.
	index ($sortfield="t.id", $sortorder='ASC', $limit=100, $page=0, $user_ids='', $sqlfilters='', $properties='', $pagination_data=false)
	List agenda events.
	post ($request_data=null)
	Create an agenda event.
	put ($id, $request_data=null)
	Update an agenda event.
	delete ($id)
	Delete an agenda event.
Public Member Functions inherited from DolibarrApi
	__construct ($db, $cachedir='', $refreshCache=false)
	Constructor.

Protected Member Functions
	_cleanObjectDatas ($object)
	Clean sensible object datas @phpstan-template T.
Protected Member Functions inherited from DolibarrApi
	_checkValForAPI ($field, $value, $object)
	Check and convert a string depending on its type/name.
	_filterObjectProperties ($object, $properties)
	Filter properties that will be returned on object.
	_checkFilters ($sqlfilters, &$error='')
	Return if a $sqlfilters parameter is valid Function no more used.

Private Member Functions
	_validate ($data)
	Validate fields before create or update object.

Additional Inherited Members
Static Protected Member Functions inherited from DolibarrApi
static	_checkAccessToResource ($resource, $resource_id=0, $dbtablename='', $feature2='', $dbt_keyfield='fk_soc', $dbt_select='rowid')
	Check access by user to a given resource.
static	_forge_criteria_callback ($matches)
	Function to forge a SQL criteria from a Generic filter string.

Detailed Description

Definition at line 35 of file api_agendaevents.class.php.

Member Function Documentation

_cleanObjectDatas()

AgendaEvents::_cleanObjectDatas ( $object )

protected

Clean sensible object datas @phpstan-template T.

Parameters

Object

$object

Object to clean

Returns

Object Object with cleaned properties @phpstan-param T $object @phpstan-return T

Reimplemented from DolibarrApi.

Definition at line 415 of file api_agendaevents.class.php.

References $object.

Referenced by get(), and index().

_validate()

AgendaEvents::_validate ( $data )

private

Validate fields before create or update object.

Parameters

?array<string,string>

$data Array with data to verify

Returns

array<string,string>

Exceptions

RestException

Definition at line 390 of file api_agendaevents.class.php.

Referenced by post().

delete()

AgendaEvents::delete

(

$id

)

Delete an agenda event.

Since

5.0.0 Initial implementation

Parameters

int

$id

ID of Agenda Event to delete

Returns

array @phan-return array{success:array{code:int,message:string}} @phpstan-return array{success:array{code:int,message:string}}

Exceptions

RestException

Definition at line 346 of file api_agendaevents.class.php.

References $id, and DolibarrApi\_checkAccessToResource().

get()

AgendaEvents::get

(

$id

)

Get agenda event.

Return an array with agenda event information

Since

5.0.0 Initial implementation

Parameters

int

$id

ID of Agenda Event to get

Returns

Object Object with cleaned properties

Exceptions

RestException

Definition at line 73 of file api_agendaevents.class.php.

References $id, DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().

index()

AgendaEvents::index	(		$sortfield = "t.id",
			$sortorder = 'ASC',
			$limit = 100,
			$page = 0,
			$user_ids = '',
			$sqlfilters = '',
			$properties = '',
			$pagination_data = false )

List agenda events.

Get a list of agenda events

Since

5.0.0 Initial implementation

21.0.0 Added data pagination

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Limit for list
int	$page	Page number
string	$user_ids	User ids filter field (owners of event). Example: '1' or '1,2,3' {@pattern /^[0-9,]*$/i}
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.label:like:'%dol%') and (t.datec:<:'20160101')"
string	$properties	Restrict the data returned to these properties. Ignored if empty. Comma separated list of properties names
bool	$pagination_data	If this parameter is set to true the response will include pagination data. Default value is false. Page starts from 0*

Returns

array Array of order objects @phan-return ActionComm[]|array{data:ActionComm[],pagination:array{total:int,page:int,page_count:int,limit:int}} @phpstan-return ActionComm[]|array{data:ActionComm[],pagination:array{total:int,page:int,page_count:int,limit:int}}

Exceptions

RestException

Definition at line 123 of file api_agendaevents.class.php.

References _cleanObjectDatas(), DolibarrApi\_filterObjectProperties(), forgeSQLFromUniversalSearchCriteria(), and isModEnabled().

post()

AgendaEvents::post

(

$request_data = null

)

Create an agenda event.

Since

5.0.0 Initial implementation

Parameters

array

$request_data

Request data @phan-param ?array<string,string> $request_data @phpstan-param ?array<string,string> $request_data

Returns

int ID of Agenda Event

Exceptions

RestException

Definition at line 235 of file api_agendaevents.class.php.

References DolibarrApi\_checkValForAPI(), _validate(), and sanitizeVal().

put()

AgendaEvents::put	(		$id,
			$request_data = null )

Update an agenda event.

Since

11.0.0 Initial implementation

Parameters

int	$id	ID of Agenda Event to update
array	$request_data	Data @phan-param ?array<string,string> $request_data @phpstan-param ?array<string,string> $request_data

Returns

Object|false Object with cleaned properties

Exceptions

RestException

Definition at line 285 of file api_agendaevents.class.php.

References $id, DolibarrApi\_checkAccessToResource(), DolibarrApi\_checkValForAPI(), and sanitizeVal().

---

The documentation for this class was generated from the following file:

• dolibarr_23.0/htdocs/comm/action/class/api_agendaevents.class.php