SupplierProposals Class Reference

Inheritance diagram for SupplierProposals:

Collaboration diagram for SupplierProposals:

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='', $pagination_data=false)
	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.

Detailed Description

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

Member Function Documentation

_cleanObjectDatas()

SupplierProposals::_cleanObjectDatas ( $object )

protected

Clean sensible object datas.

Parameters

Object

$object

Object to clean

Returns

Object Object with cleaned properties

Reimplemented from DolibarrApi.

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

References $object.

Referenced by get(), and index().

_validate()

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 323 of file api_supplier_proposals.class.php.

Referenced by post().

delete()

SupplierProposals::delete

(

$id

)

Delete commercial proposal.

Parameters

int

$id

Supplier proposal ID

Returns

array

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

References $id, and DolibarrApi\_checkAccessToResource().

get()

SupplierProposals::get

(

$id

)

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

Return an array with supplier proposal information

Parameters

int

$id

ID of supplier proposal

Returns

Object Object with cleaned properties

Exceptions

RestException

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

References $id, DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().

index()

SupplierProposals::index	(		$sortfield = "t.rowid",
			$sortorder = 'ASC',
			$limit = 100,
			$page = 0,
			$thirdparty_ids = '',
			$sqlfilters = '',
			$properties = '',
			$pagination_data = false )

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') {@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
bool	$pagination_data	If this parameter is set to true the response will include pagination data. Default value is false. Page starts from 0*

Returns

array Array of order objects

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

References _cleanObjectDatas(), DolibarrApi\_filterObjectProperties(), and forgeSQLFromUniversalSearchCriteria().

post()

SupplierProposals::post

(

$request_data = null

)

Create supplier proposal (price request) object.

Parameters

array

$request_data

Request data

Returns

int ID of supplier proposal

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

References _validate().

put()

SupplierProposals::put	(		$id,
			$request_data = null )

Update supplier proposal general fields (won't touch lines of supplier proposal)

Parameters

int	$id	Id of supplier proposal to update
array	$request_data	Datas

Returns

Object Object with cleaned properties

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

References $id, and DolibarrApi\_checkAccessToResource().

---

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

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