dolibarr 20.0.0
|
Public Member Functions | |
__construct () | |
Constructor. | |
get ($id) | |
Get properties of a workstation object by id. | |
getByRef ($ref) | |
Get properties of a workstation object by ref. | |
index ($sortfield="t.ref", $sortorder='ASC', $limit=100, $page=0, $sqlfilters='', $properties='') | |
List workstations. | |
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 | |
_fetch ($id, $ref='') | |
Get properties of 1 workstation 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 37 of file api_workstations.class.php.
|
protected |
Clean sensible object datas.
Object | $object | Object to clean |
Reimplemented from DolibarrApi.
Definition at line 188 of file api_workstations.class.php.
References $object.
|
private |
Get properties of 1 workstation object.
Return an array with workstation information.
int | $id | ID of product |
string | $ref | Ref of element |
RestException | 401 |
RestException | 403 |
RestException | 404 |
Definition at line 305 of file api_workstations.class.php.
References DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().
Referenced by get(), and getByRef().
Workstations::get | ( | $id | ) |
Get properties of a workstation object by id.
Return an array with workstation information.
int | $id | ID of workstation |
@url GET {id}
RestException | 401 |
RestException | 403 |
RestException | 404 |
Definition at line 69 of file api_workstations.class.php.
References _fetch().
Workstations::getByRef | ( | $ref | ) |
Get properties of a workstation object by ref.
Return an array with workstation information.
string | $ref | Ref of element |
@url GET ref/{ref}
RestException | 401 |
RestException | 403 |
RestException | 404 |
Definition at line 89 of file api_workstations.class.php.
References _fetch().
Workstations::index | ( | $sortfield = "t.ref", | |
$sortorder = 'ASC', | |||
$limit = 100, | |||
$page = 0, | |||
$sqlfilters = '', | |||
$properties = '' ) |
List workstations.
Get a list of workstations
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.tobuy:=:0) and (t.tosell:=:1)" |
string | $properties | Restrict the data returned to these properties. Ignored if empty. Comma separated list of properties names |
Definition at line 107 of file api_workstations.class.php.
References _cleanObjectDatas(), DolibarrApi\_filterObjectProperties(), and forgeSQLFromUniversalSearchCriteria().