dolibarr 20.0.0
|
Public Member Functions | |
__construct () | |
Constructor. | |
delete ($id) | |
Delete commercial proposal. | |
get ($id) | |
Get properties of a supplier proposal (price request) object. | |
post ($request_data=null) | |
Create supplier proposal (price request) object. | |
put ($id, $request_data=null) | |
Update supplier proposal general fields (won't touch lines of supplier proposal) | |
index ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $thirdparty_ids='', $sqlfilters='', $properties='') | |
List supplier proposals. | |
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 30 of file api_supplier_proposals.class.php.
|
protected |
Clean sensible object datas.
Object | $object | Object to clean |
Reimplemented from DolibarrApi.
Definition at line 322 of file api_supplier_proposals.class.php.
References $object.
|
private |
Validate fields before create or update object.
array | $data | Array with data to verify |
RestException |
Definition at line 302 of file api_supplier_proposals.class.php.
Referenced by post().
SupplierProposals::delete | ( | $id | ) |
Delete commercial proposal.
int | $id | Supplier proposal ID |
Definition at line 60 of file api_supplier_proposals.class.php.
References DolibarrApi\_checkAccessToResource().
SupplierProposals::get | ( | $id | ) |
Get properties of a supplier proposal (price request) object.
Return an array with supplier proposal information
int | $id | ID of supplier proposal |
RestException |
Definition at line 96 of file api_supplier_proposals.class.php.
References DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().
SupplierProposals::index | ( | $sortfield = "t.rowid", | |
$sortorder = 'ASC', | |||
$limit = 100, | |||
$page = 0, | |||
$thirdparty_ids = '', | |||
$sqlfilters = '', | |||
$properties = '' ) |
List supplier proposals.
Get a list of supplier proposals
string | $sortfield | Sort field |
string | $sortorder | Sort order |
int | $limit | Limit for list |
int | $page | Page number |
string | $thirdparty_ids | Thirdparty ids to filter supplier proposals (example '1' or '1,2,3') {@pattern /^[0-9,]*$/i} |
string | $sqlfilters | Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.datec:<:'20160101')" |
string | $properties | Restrict the data returned to these properties. Ignored if empty. Comma separated list of properties names |
Definition at line 222 of file api_supplier_proposals.class.php.
References _cleanObjectDatas(), DolibarrApi\_filterObjectProperties(), and forgeSQLFromUniversalSearchCriteria().
SupplierProposals::post | ( | $request_data = null | ) |
Create supplier proposal (price request) object.
array | $request_data | Request data |
Definition at line 121 of file api_supplier_proposals.class.php.
References _validate().
SupplierProposals::put | ( | $id, | |
$request_data = null ) |
Update supplier proposal general fields (won't touch lines of supplier proposal)
int | $id | Id of supplier proposal to update |
array | $request_data | Datas |
Definition at line 159 of file api_supplier_proposals.class.php.
References DolibarrApi\_checkAccessToResource().