dolibarr  7.0.0-beta
Public Member Functions | List of all members
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...
 
 delete ($id)
 Update Agenda Event general fields (won't touch lines of expensereport) More...
 
 _validate ($data)
 Validate fields before create or update object. More...
 
 _cleanObjectDatas ($object)
 Clean sensible object datas. More...
 
- Public Member Functions inherited from DolibarrApi
 __construct ($db, $cachedir='', $refreshCache=false)
 Constructor. More...
 
 _cleanObjectDatas ($object)
 Executed method when API is called without parameter. More...
 
 _checkFilters ($sqlfilters)
 Return if a $sqlfilters parameter is valid. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from DolibarrApi
static _checkAccessToResource ($resource, $resource_id=0, $dbtablename='', $feature2='', $dbt_keyfield='fk_soc', $dbt_select='rowid')
 Check user access to a resource. More...
 
static _forge_criteria_callback ($matches)
 Function to forge a SQL criteria. More...
 

Detailed Description

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

Member Function Documentation

AgendaEvents::_cleanObjectDatas (   $object)

Clean sensible object datas.

Parameters
object$objectObject to clean
Returns
array Array of cleaned object properties

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

Referenced by get(), and index().

AgendaEvents::_validate (   $data)

Validate fields before create or update object.

Parameters
array$dataArray with data to verify
Returns
array
Exceptions
RestException

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

Referenced by post().

AgendaEvents::delete (   $id)

Update Agenda Event general fields (won't touch lines of expensereport)

Parameters
int$idId of Agenda Event to update
array$request_dataDatas
Returns
int Delete Agenda Event
Parameters
int$idAgenda Event ID
Returns
array

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

References DolibarrApi\_checkAccessToResource().

AgendaEvents::get (   $id)

Get properties of a Agenda Events object.

Return an array with Agenda Events informations

Parameters
int$idID of Agenda Events
Returns
array|mixed Data without useless information
Exceptions
RestException

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

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

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$sortfieldSort field
string$sortorderSort order
int$limitLimit for list
int$pagePage number
string$user_idsUser ids filter field (owners of event). Example: '1' or '1,2,3' { /^[0-9,]*$/i}
string$sqlfiltersOther 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 100 of file api_agendaevents.class.php.

References DolibarrApi\_checkFilters(), and _cleanObjectDatas().

AgendaEvents::post (   $request_data = NULL)

Create Agenda Event object.

Parameters
array$request_dataRequest data
Returns
int ID of Agenda Event

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

References _validate().


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