Inheritance diagram for SupplierOrders:

Collaboration diagram for SupplierOrders:

Public Member Functions
	__construct ()
	Constructor.

	get ($id)
	Get properties of a supplier order object. More...

	index ($sortfield="t.rowid", $sortorder= 'ASC', $limit=100, $page=0, $thirdparty_ids= '', $product_ids= '', $status= '', $sqlfilters= '')
	List orders. More...

	post ($request_data=null)
	Create supplier order object. More...

	put ($id, $request_data=null)
	Update supplier order. More...

	delete ($id)
	Delete supplier order. More...

	validate ($id, $idwarehouse=0, $notrigger=0)
	Validate an order. 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
	_cleanObjectDatas ($object)
	Executed method when API is called without parameter. More...

	_checkFilters ($sqlfilters)
	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 user access to a resource. More...

static	_forge_criteria_callback ($matches)
	Function to forge a SQL criteria. More...

Detailed Description

Definition at line 29 of file api_supplier_orders.class.php.

Member Function Documentation

SupplierOrders::_cleanObjectDatas ( $object )

protected

Clean sensible object datas.

Parameters

Object $object Object to clean

Returns: Object Object with cleaned properties

Definition at line 345 of file api_supplier_orders.class.php.

Referenced by get(), and index().

SupplierOrders::_validate ( $data )

private

Validate fields before create or update object.

Parameters

array $data Datas to validate

Returns: array

Exceptions

RestException

Definition at line 367 of file api_supplier_orders.class.php.

Referenced by post().

SupplierOrders::delete ( $id )

Delete supplier order.

Parameters

int $id Supplier order ID

Returns: array Array of result

Definition at line 263 of file api_supplier_orders.class.php.

References DolibarrApi\_checkAccessToResource().

SupplierOrders::get ( $id )

Get properties of a supplier order object.

Return an array with supplier order information

Parameters

int $id ID of supplier order

Returns: array|mixed data without useless information

Exceptions

RestException

Definition at line 64 of file api_supplier_orders.class.php.

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

SupplierOrders::index	(	$sortfield = `"t.rowid"`,
		$sortorder = `'ASC'`,
		$limit = `100`,
		$page = `0`,
		$thirdparty_ids = `''`,
		$product_ids = `''`,
		$status = `''`,
		$sqlfilters = `''`
	)

List orders.

Get a list of supplier orders

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 orders of (example '1' or '1,2,3') { /^[0-9,]*$/i}
string	$product_ids	Product ids to filter orders of (example '1' or '1,2,3') { /^[0-9,]*$/i}
string	$status	Filter by order status : draft \| validated \| approved \| running \| received_start \| received_end \| cancelled \| refused
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

Exceptions

RestException

Definition at line 100 of file api_supplier_orders.class.php.

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

SupplierOrders::post ( $request_data = null )

Create supplier order object.

Example: {"ref": "auto", "ref_supplier": "1234", "socid": "1", "multicurrency_code": "SEK", "multicurrency_tx": 1, "tva_tx": 25, "note": "Imported via the REST API"}

Parameters

array $request_data Request datas

Returns: int ID of supplier order

Definition at line 195 of file api_supplier_orders.class.php.

References _validate(), and dol_now().

SupplierOrders::put	(	$id,
		$request_data = `null`
	)

Update supplier order.

Parameters

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

Returns: int

Definition at line 231 of file api_supplier_orders.class.php.

References DolibarrApi\_checkAccessToResource().

SupplierOrders::validate	(	$id,
		$idwarehouse = `0`,
		$notrigger = `0`
	)

Validate an order.

Parameters

int	$id	Order ID
int	$idwarehouse	Warehouse ID
int	$notrigger	1=Does not execute triggers, 0= execute triggers

POST {id}/validate

Returns: array FIXME An error 403 is returned if the request has an empty body. Error message: "Forbidden: Content type `text/plain` is not supported." Workaround: send this in the body { "idwarehouse": 0, "notrigger": 0 }

Definition at line 308 of file api_supplier_orders.class.php.

References DolibarrApi\_checkAccessToResource().

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

htdocs/fourn/class/api_supplier_orders.class.php

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation