AgendaEvents Class Reference

Inheritance diagram for AgendaEvents:

Collaboration diagram for AgendaEvents:

Public Member Functions
	__construct ()
	Constructor.
	get ($id)
	Get properties of a Agenda Events object. More...
	index ($sortfield="t.id", $sortorder='ASC', $limit=100, $page=0, $user_ids=0, $sqlfilters='')
	List Agenda Events. More...
	post ($request_data=null)
	Create Agenda Event object. More...
	put ($id, $request_data=null)
	Update Agenda Event general fields. More...
	delete ($id)
	Delete Agenda Event. More...
Public Member Functions inherited from DolibarrApi
	__construct ($db, $cachedir='', $refreshCache=false)
	Constructor. More...

Protected Member Functions
	_cleanObjectDatas ($object)
	Clean sensible object datas. More...
Protected Member Functions inherited from DolibarrApi
	_checkValForAPI ($field, $value, $object)
	Check and convert a string depending on its type/name. More...
	_checkFilters ($sqlfilters, &$error='')
	Return if a $sqlfilters parameter is valid. More...

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

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. More...
static	_forge_criteria_callback ($matches)
	Function to forge a SQL criteria from a Generic filter string. More...

Detailed Description

Definition at line 30 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 354 of file api_agendaevents.class.php.

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

delete()

AgendaEvents::delete

(

$id

)

Delete Agenda Event.

Parameters

int

$id

Agenda Event ID

Returns

array

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

get()

AgendaEvents::get

(

$id

)

Get properties of a Agenda Events object.

Return an array with Agenda Events informations

Parameters

int

$id

ID of Agenda Events

Returns

array|mixed Data without useless information

Exceptions

RestException

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

index()

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

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')"

Returns

array Array of Agenda Events objects

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

post()

AgendaEvents::post

(

$request_data = null

)

Create Agenda Event object.

Parameters

array

$request_data

Request data

Returns

int ID of Agenda Event

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

put()

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

Update Agenda Event general fields.

Parameters

int	$id	Id of Agenda Event to update
array	$request_data	Datas

Returns

int

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

---

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

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