dolibarr  21.0.0-alpha
Public Member Functions | Private Member Functions | List of all members
Zapier Class Reference
Inheritance diagram for Zapier:
Inheritance graph
[legend]
Collaboration diagram for Zapier:
Collaboration graph
[legend]

Public Member Functions

 __construct ()
 Constructor. More...
 
 get ($id)
 Get properties of a hook object. More...
 
 getModulesChoices ()
 Get list of possibles choices for module. More...
 
 index ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $sqlfilters='', $properties='')
 List hooks. More...
 
 post ($request_data=null)
 Create hook object. More...
 
 delete ($id)
 Delete hook. More...
 
 _cleanObjectDatas ($object)
 Clean sensible object datas. More...
 
- Public Member Functions inherited from DolibarrApi
 __construct ($db, $cachedir='', $refreshCache=false)
 Constructor. More...
 

Private Member Functions

 validate ($data, $fields)
 Validate fields before create or update object. More...
 

Additional Inherited Members

- Protected Member Functions inherited from DolibarrApi
 _checkValForAPI ($field, $value, $object)
 Check and convert a string depending on its type/name. More...
 
 _filterObjectProperties ($object, $properties)
 Filter properties that will be returned on object. More...
 
 _checkFilters ($sqlfilters, &$error='')
 Return if a $sqlfilters parameter is valid Function no more used. More...
 
- 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 36 of file api_zapier.class.php.

Constructor & Destructor Documentation

◆ __construct()

Zapier::__construct ( )

Constructor.

@url GET /

Definition at line 57 of file api_zapier.class.php.

Member Function Documentation

◆ _cleanObjectDatas()

Zapier::_cleanObjectDatas (   $object)

Clean sensible object datas.

Parameters
Object$objectObject to clean
Returns
Object Object with cleaned properties

Reimplemented from DolibarrApi.

Definition at line 304 of file api_zapier.class.php.

References $object.

◆ delete()

Zapier::delete (   $id)

Delete hook.

Parameters
int$idHook ID
Returns
array

@url DELETE /hook/{id}

Definition at line 270 of file api_zapier.class.php.

◆ get()

Zapier::get (   $id)

Get properties of a hook object.

Return an array with hook information

Parameters
int$idID of hook
Returns
Object Object with cleaned properties

@url GET /hooks/{id}

Exceptions
RestException

Definition at line 76 of file api_zapier.class.php.

◆ getModulesChoices()

Zapier::getModulesChoices ( )

Get list of possibles choices for module.

Return an array with hook information

Returns
array data

@url GET /getmoduleschoices/

Exceptions
RestException

Definition at line 104 of file api_zapier.class.php.

◆ index()

Zapier::index (   $sortfield = "t.rowid",
  $sortorder = 'ASC',
  $limit = 100,
  $page = 0,
  $sqlfilters = '',
  $properties = '' 
)

List hooks.

Get a list of hooks

Parameters
string$sortfieldSort field
string$sortorderSort order
int$limitLimit for list
int$pagePage number
string$sqlfiltersOther criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.date_creation:<:'20160101')"
string$propertiesRestrict the data returned to these properties. Ignored if empty. Comma separated list of properties names
Returns
array Array of order objects
Exceptions
RestException@url GET /hooks/

Definition at line 146 of file api_zapier.class.php.

◆ post()

Zapier::post (   $request_data = null)

Create hook object.

Parameters
array$request_dataRequest datas
Returns
array ID of hook

@url POST /hook/

Definition at line 228 of file api_zapier.class.php.

References dol_syslog().

◆ validate()

Zapier::validate (   $data,
  $fields 
)
private

Validate fields before create or update object.

Parameters
array$dataArray of data to validate
array$fieldsArray of fields needed
Returns
array
Exceptions
RestException

Definition at line 321 of file api_zapier.class.php.


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