Warehouses Class Reference

Inheritance diagram for Warehouses:

Collaboration diagram for Warehouses:

Public Member Functions
	__construct ()
	Constructor.
	get ($id)
	Get properties of a warehouse object. More...
	index ($sortfield="t.rowid", $sortorder= 'ASC', $limit=100, $page=0, $category=0, $sqlfilters= '')
	List warehouses. More...
	post ($request_data=null)
	Create warehouse object. More...
	put ($id, $request_data=null)
	Update warehouse. More...
	delete ($id)
	Delete warehouse. 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_warehouses.class.php.

Member Function Documentation

Warehouses::_cleanObjectDatas (   $object )

protected

Clean sensible object datas.

Parameters

Entrepot

$object

Object to clean

Returns

Object Object with cleaned properties

Definition at line 261 of file api_warehouses.class.php.

Referenced by get(), and index().

Warehouses::_validate (   $data )

private

Validate fields before create or update object.

Parameters

array | null

$data

Data to validate

Returns

array

Exceptions

RestException

Definition at line 281 of file api_warehouses.class.php.

Referenced by post().

Warehouses::delete

(

$id

)

Delete warehouse.

Parameters

int

$id

Warehouse ID

Returns

array

Definition at line 227 of file api_warehouses.class.php.

References DolibarrApi\_checkAccessToResource().

Warehouses::get

(

$id

)

Get properties of a warehouse object.

Return an array with warehouse informations

Parameters

int

$id

ID of warehouse

Returns

array|mixed data without useless information

Exceptions

RestException

Definition at line 63 of file api_warehouses.class.php.

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

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

List warehouses.

Get a list of warehouses

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Limit for list
int	$page	Page number
int	$category	Use this param to filter list by category
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.label:like:'WH-%') and (t.date_creation:<:'20160101')"

Returns

array Array of warehouse objects

Exceptions

RestException

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

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

Warehouses::post

(

$request_data = null

)

Create warehouse object.

Parameters

array

$request_data

Request data

Returns

int ID of warehouse

Definition at line 170 of file api_warehouses.class.php.

References _validate().

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

Update warehouse.

Parameters

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

Returns

int

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

References DolibarrApi\_checkAccessToResource().

---

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

• htdocs/product/stock/class/api_warehouses.class.php