Supplierproposals Class Reference

Inheritance diagram for Supplierproposals:

Collaboration diagram for Supplierproposals:

Public Member Functions
	__construct ()
	Constructor.
	get ($id)
	Get properties of a supplier proposal (price request) object. More...
	index ($sortfield="t.rowid", $sortorder= 'ASC', $limit=100, $page=0, $thirdparty_ids= '', $sqlfilters= '')
	List supplier proposals. More...
Public Member Functions inherited from DolibarrApi
	__construct ($db, $cachedir= '', $refreshCache=false)
	Constructor. More...

Protected Member Functions
	_cleanObjectDatas ($object)
	Clean sensible object datas. More...
Protected Member Functions inherited from DolibarrApi
	_checkValForAPI ($field, $value, $object)
	Check and convert a string depending on its type/name. More...
	_cleanObjectDatas ($object)
	Clean sensible object datas. More...
	_checkFilters ($sqlfilters, &$error= '')
	Return if a $sqlfilters parameter is valid. More...

Private Member Functions
	_validate ($data)
	Validate fields before create or update object. More...

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. More...
static	_forge_criteria_callback ($matches)
	Function to forge a SQL criteria from a Generic filter string. More...

Detailed Description

Definition at line 30 of file api_supplier_proposals.class.php.

Member Function Documentation

Supplierproposals::_cleanObjectDatas (   $object )

protected

Clean sensible object datas.

Parameters

Object

$object

Object to clean

Returns

Object Object with cleaned properties

Definition at line 211 of file api_supplier_proposals.class.php.

Referenced by get(), and index().

Supplierproposals::_validate (   $data )

private

Validate fields before create or update object.

Parameters

array

$data

Array with data to verify

Returns

array

Exceptions

RestException

Definition at line 191 of file api_supplier_proposals.class.php.

Supplierproposals::get

(

$id

)

Get properties of a supplier proposal (price request) object.

Return an array with supplier proposal informations

Parameters

int

$id

ID of supplier proposal

Returns

array|mixed data without useless information

Exceptions

RestException

Definition at line 65 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 = ''
	)

List supplier proposals.

Get a list of supplier proposals

Parameters

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') { /^[0-9,]*$/i}
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.datec:<:'20160101')"

Returns

array Array of order objects

Definition at line 97 of file api_supplier_proposals.class.php.

References DolibarrApi\_checkFilters(), _cleanObjectDatas(), and db.

---

The documentation for this class was generated from the following file:

• htdocs/supplier_proposal/class/api_supplier_proposals.class.php