dolibarr 20.0.0
|
Public Member Functions | |
__construct () | |
Constructor. | |
get ($id) | |
Get properties of a warehouse object. | |
index ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $category=0, $sqlfilters='', $properties='') | |
List warehouses. | |
post ($request_data=null) | |
Create warehouse object. | |
put ($id, $request_data=null) | |
Update warehouse. | |
delete ($id) | |
Delete warehouse. | |
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. | |
Definition at line 29 of file api_warehouses.class.php.
|
protected |
Clean sensible object datas.
Entrepot | $object | Object to clean |
Reimplemented from DolibarrApi.
Definition at line 270 of file api_warehouses.class.php.
References $object.
|
private |
Validate fields before create or update object.
array | null | $data | Data to validate |
RestException |
Definition at line 290 of file api_warehouses.class.php.
Referenced by post().
Warehouses::delete | ( | $id | ) |
Delete warehouse.
int | $id | Warehouse ID |
Definition at line 236 of file api_warehouses.class.php.
References DolibarrApi\_checkAccessToResource().
Warehouses::get | ( | $id | ) |
Get properties of a warehouse object.
Return an array with warehouse information
int | $id | ID of warehouse |
RestException |
Definition at line 63 of file api_warehouses.class.php.
References DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().
Warehouses::index | ( | $sortfield = "t.rowid", | |
$sortorder = 'ASC', | |||
$limit = 100, | |||
$page = 0, | |||
$category = 0, | |||
$sqlfilters = '', | |||
$properties = '' ) |
List warehouses.
Get a list of warehouses
string | $sortfield | Sort field |
string | $sortorder | Sort order |
int | $limit | Limit for list |
int | $page | Page number |
int | $category | Use this param to filter list by category |
string | $sqlfilters | Other criteria to filter answers separated by a comma. Syntax example "(t.label:like:'WH-%') and (t.date_creation:<:'20160101')" |
string | $properties | Restrict the data returned to these properties. Ignored if empty. Comma separated list of properties names |
RestException |
Definition at line 97 of file api_warehouses.class.php.
References _cleanObjectDatas(), DolibarrApi\_filterObjectProperties(), and forgeSQLFromUniversalSearchCriteria().
Warehouses::post | ( | $request_data = null | ) |
Create warehouse object.
array | $request_data | Request data |
Definition at line 164 of file api_warehouses.class.php.
References DolibarrApi\_checkValForAPI(), _validate(), and sanitizeVal().
Warehouses::put | ( | $id, | |
$request_data = null ) |
Update warehouse.
int | $id | Id of warehouse to update |
array | $request_data | Datas |
Definition at line 195 of file api_warehouses.class.php.
References DolibarrApi\_checkAccessToResource(), DolibarrApi\_checkValForAPI(), and sanitizeVal().