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='') | |
| 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... | |
| _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 | ( | ) |
Member Function Documentation
◆ _cleanObjectDatas()
| Zapier::_cleanObjectDatas | ( | $object | ) |
Clean sensible object datas.
- Parameters
-
Object $object Object to clean
- Returns
- Object Object with cleaned properties
Reimplemented from DolibarrApi.
Definition at line 352 of file api_zapier.class.php.
◆ delete()
| Zapier::delete | ( | $id | ) |
Delete hook.
- Parameters
-
int $id Hook ID
- Returns
- array
@url DELETE /hook/{id}
Definition at line 318 of file api_zapier.class.php.
◆ get()
| Zapier::get | ( | $id | ) |
Get properties of a hook object.
Return an array with hook informations
- Parameters
-
int $id ID of hook
- Returns
- Object Object with cleaned properties
@url GET /hooks/{id}
- Exceptions
-
RestException
Definition at line 75 of file api_zapier.class.php.
◆ getModulesChoices()
| Zapier::getModulesChoices | ( | ) |
Get list of possibles choices for module.
Return an array with hook informations
- Returns
- array data
@url GET /getmoduleschoices/
- Exceptions
-
RestException
Definition at line 103 of file api_zapier.class.php.
◆ index()
| Zapier::index | ( | $sortfield = "t.rowid", |
|
$sortorder = 'ASC', |
|||
$limit = 100, |
|||
$page = 0, |
|||
$sqlfilters = '' |
|||
| ) |
List hooks.
Get a list of hooks
- Parameters
-
string $sortfield Sort field string $sortorder Sort order int $limit Limit for list int $page Page number string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.date_creation:<:'20160101')"
- Returns
- array Array of order objects
- Exceptions
-
RestException @url GET /hooks/
Definition at line 144 of file api_zapier.class.php.
◆ post()
| Zapier::post | ( | $request_data = null | ) |
Create hook object.
- Parameters
-
array $request_data Request datas
- Returns
- array ID of hook
@url POST /hook/
Definition at line 246 of file api_zapier.class.php.
◆ validate()
|
private |
Validate fields before create or update object.
- Parameters
-
array $data Array of data to validate array $fields Array of fields needed
- Returns
- array
- Exceptions
-
RestException
Definition at line 369 of file api_zapier.class.php.
The documentation for this class was generated from the following file:
- dolibarr_dev/htdocs/zapier/class/api_zapier.class.php