Warehouses Class Reference

Inheritance diagram for Warehouses:

Collaboration diagram for Warehouses:

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

Member Function Documentation

_cleanObjectDatas()

Warehouses::_cleanObjectDatas ( $object )

protected

Clean sensible object datas.

Parameters

Entrepot

$object

Object to clean

Returns

Object Object with cleaned properties

Reimplemented from DolibarrApi.

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

References $object.

Referenced by get(), and index().

_validate()

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 290 of file api_warehouses.class.php.

Referenced by post().

delete()

Warehouses::delete

(

$id

)

Delete warehouse.

Parameters

int

$id

Warehouse ID

Returns

array

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

References $id, and DolibarrApi\_checkAccessToResource().

get()

Warehouses::get

(

$id

)

Get properties of a warehouse object.

Return an array with warehouse information

Parameters

int

$id

ID of warehouse

Returns

Object Object with cleaned properties

Exceptions

RestException

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

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

index()

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

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')"
string	$properties	Restrict the data returned to these properties. Ignored if empty. Comma separated list of properties names

Returns

array Array of warehouse objects

Exceptions

RestException

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

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

post()

Warehouses::post

(

$request_data = null

)

Create warehouse object.

Parameters

array

$request_data

Request data

Returns

int ID of warehouse

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

References DolibarrApi\_checkValForAPI(), _validate(), and sanitizeVal().

put()

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

Update warehouse.

Parameters

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

Returns

Object Updated object

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

References $id, DolibarrApi\_checkAccessToResource(), DolibarrApi\_checkValForAPI(), and sanitizeVal().

---

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

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