Inheritance diagram for Receptions:

Collaboration diagram for Receptions:

Public Member Functions
	__construct ()
	Constructor.

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

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

	post ($request_data=null)
	Create reception object. More...

	deleteLine ($id, $lineid)
	Get lines of an reception. More...

	put ($id, $request_data=null)
	Update reception general fields (won't touch lines of reception) More...

	delete ($id)
	Delete reception. More...

	validate ($id, $notrigger=0)
	Validate a reception. More...

	close ($id, $notrigger=0)
	Classify the reception as invoiced. 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 29 of file api_receptions.class.php.

Member Function Documentation

Receptions::_cleanObjectDatas ( $object )

protected

Clean sensible object datas.

Parameters

Object $object Object to clean

Returns: Object Object with cleaned properties

Definition at line 673 of file api_receptions.class.php.

Referenced by close(), get(), index(), and validate().

Receptions::_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 710 of file api_receptions.class.php.

Referenced by post().

Receptions::close	(	$id,
		$notrigger = `0`
	)

Classify the reception as invoiced.

Parameters

int $id Id of the reception

POST {id}/setinvoiced

Returns: int

Exceptions

RestException	400
RestException	401
RestException	404
RestException	405 Create a reception using an existing order.

Parameters

int $orderid Id of the order

POST /createfromorder/{orderid}

Returns: int

Exceptions

RestException	400
RestException	401
RestException	404
RestException	405 Close a reception (Classify it as "Delivered")

Parameters

int	$id	Reception ID
int	$notrigger	Disabled triggers

POST {id}/close

Returns: int

Definition at line 635 of file api_receptions.class.php.

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

Receptions::delete ( $id )

Delete reception.

Parameters

int $id Reception ID

Returns: array

Definition at line 468 of file api_receptions.class.php.

References DolibarrApi\_checkAccessToResource().

Receptions::deleteLine	(	$id,
		$lineid
	)

Get lines of an reception.

Parameters

int $id Id of reception

GET {id}/lines

Returns: int Add a line to given reception

Parameters

int	$id	Id of reception to update
array	$request_data	ShipmentLine data

POST {id}/lines

Returns: int Update a line to given reception

Parameters

int	$id	Id of reception to update
int	$lineid	Id of line to update
array	$request_data	ShipmentLine data

PUT {id}/lines/{lineid}

Returns: object Delete a line to given reception

Parameters

int	$id	Id of reception to update
int	$lineid	Id of line to delete

DELETE {id}/lines/{lineid}

Returns: int

Exceptions

RestException	401
RestException	404

Definition at line 400 of file api_receptions.class.php.

References DolibarrApi\_checkAccessToResource().

Receptions::get ( $id )

Get properties of a reception object.

Return an array with reception informations

Parameters

int $id ID of reception

Returns: array|mixed data without useless information

Exceptions

RestException

Definition at line 66 of file api_receptions.class.php.

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

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

List receptions.

Get a list of receptions

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 receptions of (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.date_creation:<:'20160101')"

Returns: array Array of reception objects

Exceptions

RestException

Definition at line 102 of file api_receptions.class.php.

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

Receptions::post ( $request_data = null )

Create reception object.

Parameters

array $request_data Request data

Returns: int ID of reception

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

References _validate().

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

Update reception general fields (won't touch lines of reception)

Parameters

int	$id	Id of reception to update
array	$request_data	Datas

Returns: int

Definition at line 433 of file api_receptions.class.php.

References DolibarrApi\_checkAccessToResource().

Receptions::validate	(	$id,
		$notrigger = `0`
	)

Validate a reception.

This may record stock movements if module stock is enabled and option to decrease stock on reception is on.

Parameters

int	$id	Reception ID
int	$notrigger	1=Does not execute triggers, 0= execute triggers

POST {id}/validate

Returns: array

Definition at line 513 of file api_receptions.class.php.

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

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

htdocs/reception/class/api_receptions.class.php

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation