Inheritance diagram for AgendaEvents:

Collaboration diagram for AgendaEvents:

Public Member Functions
	__construct ()
	Constructor.

	get ($id)
	Get properties of a Agenda Events object.

	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 Agenda Event object.

	put ($id, $request_data=null)
	Update Agenda Event general fields.

	delete ($id)
	Delete Agenda Event.

Public Member Functions inherited from DolibarrApi
	__construct ($db, $cachedir='', $refreshCache=false)
	Constructor.

Protected Member Functions
	_cleanObjectDatas ($object)
	Clean sensible object datas.

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 31 of file api_agendaevents.class.php.

Member Function Documentation

◆ _cleanObjectDatas()

AgendaEvents::_cleanObjectDatas ( $object )

protected

Clean sensible object datas.

Parameters

Object $object Object to clean

Returns: Object Object with cleaned properties

Reimplemented from DolibarrApi.

Definition at line 376 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 $data Array with data to verify

Returns: array

Exceptions

RestException

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

Referenced by post().

◆ delete()

AgendaEvents::delete ( $id )

Delete Agenda Event.

Parameters

int $id Agenda Event ID

Returns: array

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

References $id, and DolibarrApi\_checkAccessToResource().

◆ get()

AgendaEvents::get ( $id )

Get properties of a Agenda Events object.

Return an array with Agenda Events information

Parameters

int $id ID of Agenda Events

Returns: Object Object with cleaned properties

Exceptions

RestException

Definition at line 65 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

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*