dolibarr 21.0.0-alpha
|
Public Member Functions | |
__construct () | |
Constructor. | |
get ($id) | |
Get properties of a partnership object. | |
index ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $sqlfilters='', $properties='') | |
List partnerships. | |
post ($request_data=null) | |
Create partnership object. | |
put ($id, $request_data=null) | |
Update partnership. | |
delete ($id) | |
Delete partnership. | |
![]() | |
__construct ($db, $cachedir='', $refreshCache=false) | |
Constructor. | |
Protected Member Functions | |
_cleanObjectDatas ($object) | |
Clean sensible object datas. | |
![]() | |
_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 | _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 36 of file api_partnerships.class.php.
Partnerships::__construct | ( | ) |
|
protected |
Clean sensible object datas.
Object | $object | Object to clean |
Reimplemented from DolibarrApi.
Definition at line 310 of file api_partnerships.class.php.
References $object, and _cleanObjectDatas().
Referenced by _cleanObjectDatas(), get(), and index().
|
private |
Validate fields before create or update object.
array | $data | Array of data to validate |
RestException |
Definition at line 374 of file api_partnerships.class.php.
Referenced by post().
Partnerships::delete | ( | $id | ) |
Delete partnership.
int | $id | Partnership ID |
RestException |
@url DELETE partnerships/{id}
Definition at line 276 of file api_partnerships.class.php.
References $id, and DolibarrApi\_checkAccessToResource().
Partnerships::get | ( | $id | ) |
Get properties of a partnership object.
Return an array with partnership information
int | $id | ID of partnership |
@url GET partnerships/{id}
RestException | 403 Not allowed |
RestException | 404 Not found |
Definition at line 69 of file api_partnerships.class.php.
References $id, DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().
Partnerships::index | ( | $sortfield = "t.rowid", | |
$sortorder = 'ASC', | |||
$limit = 100, | |||
$page = 0, | |||
$sqlfilters = '', | |||
$properties = '' ) |
List partnerships.
Get a list of partnerships
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')" |
string | $properties | Restrict the data returned to these properties. Ignored if empty. Comma separated list of properties names |
RestException |
@url GET /partnerships/
Definition at line 105 of file api_partnerships.class.php.
References _cleanObjectDatas(), DolibarrApi\_filterObjectProperties(), and forgeSQLFromUniversalSearchCriteria().
Partnerships::post | ( | $request_data = null | ) |
Create partnership object.
array | $request_data | Request datas |
RestException |
@url POST partnerships/
Definition at line 189 of file api_partnerships.class.php.
References DolibarrApi\_checkValForAPI(), _validate(), and sanitizeVal().
Partnerships::put | ( | $id, | |
$request_data = null ) |
Update partnership.
int | $id | Id of partnership to update |
array | $request_data | Datas |
RestException |
@url PUT partnerships/{id}
Definition at line 228 of file api_partnerships.class.php.
References $id, DolibarrApi\_checkAccessToResource(), DolibarrApi\_checkValForAPI(), and sanitizeVal().