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

	post ($request_data=null)
	Create a warehouse.

	put ($id, $request_data=null)
	Update a warehouse.

	delete ($id)
	Delete a warehouse.

	listProducts ($id=0, $sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $includestockdata=0, $includesubproducts=false, $includeparentid=false, $includetrans=false, $properties='', $pagination_data=false)
	List products in a warehouse.

Public Member Functions inherited from DolibarrApi
	__construct ($db, $cachedir='', $refreshCache=false)
	Constructor.

Protected Member Functions
	_cleanObjectDatas ($object)
	Clean sensible object datas @phpstan-template T.

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

Member Function Documentation

◆ _cleanObjectDatas()

Warehouses::_cleanObjectDatas ( $object )

protected

Clean sensible object datas @phpstan-template T.

Parameters

Entrepot $object Object to clean

Returns: Object Object with cleaned properties @phpstan-param T $object @phpstan-return T

Reimplemented from DolibarrApi.

Definition at line 474 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<string,string> $data Data to validate

Returns: array<string,string>

Exceptions

RestException 400 Bad Request

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

Referenced by post().

◆ delete()

Warehouses::delete ( $id )

Delete a warehouse.

Since: 5.0.0 Initial implementation

Parameters

int $id Warehouse ID

Returns: array @phan-return array{success:array{code:int,message:string}} @phpstan-return array{success:array{code:int,message:string}}

@url DELETE {id}

Exceptions

RestException	400 Bad Request
RestException	403 Not allowed
RestException	404 Not found
RestException	500 Internal Server Error

Definition at line 336 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

Since: 5.0.0 Initial implementation

Parameters

int $id ID of warehouse

Returns: Object Object with cleaned properties

@url GET {id}

Exceptions

RestException	400 Bad Request
RestException	403 Not allowed
RestException	404 Not found

Definition at line 74 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 = '',
		$pagination_data = false )

List warehouses.

Get a list of warehouses

Since: 4.0.0 Initial implementation; 23.0.0 Data pagination

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
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 warehouse objects @phan-return Entrepot[] @phpstan-return Entrepot[]

@url GET

Exceptions

RestException	400 Bad Request
RestException	403 Not allowed
RestException	500 Internal Server Error

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

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

◆ listProducts()

Warehouses::listProducts	(	$id = 0,
		$sortfield = "t.rowid",
		$sortorder = 'ASC',
		$limit = 100,
		$page = 0,
		$includestockdata = 0,
		$includesubproducts = false,
		$includeparentid = false,
		$includetrans = false,
		$properties = '',
		$pagination_data = false )

List products in a warehouse.

Get a list of products for a warehouse

Since: 23.0.0 Initial implementation

Parameters

int	$id	warehouse ID {@min 1} {@from body} {@required true}
string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Limit for list
int	$page	Page number
int	$includestockdata	1=Load also information about stock (slower), 0=No stock data (faster) (default)
bool	$includesubproducts	Load information about subproducts
bool	$includeparentid	Load also ID of parent product (if product is a variant of a parent product)
bool	$includetrans	Load also the translations of product label and description
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 product in warehouse

@phan-return Product[] @phpstan-return Product[]

@url GET /{id}/products

Exceptions

RestException	400 Bad Request
RestException	403 Not allowed
RestException	404 Not found
RestException	500 Internal Server Error

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

References $id, and DolibarrApi\_filterObjectProperties().

◆ post()

Warehouses::post ( $request_data = null )

Create a warehouse.

Since: 5.0.0 Initial implementation

Parameters

array $request_data Request data @phan-param ?array<string,string> $request_data @phpstan-param ?array<string,string> $request_data

Returns: int ID of warehouse

@url POST

Exceptions

RestException	400 Bad Request
RestException	403 Not allowed
RestException	500 Internal Server Error

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

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

◆ put()

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

Update a warehouse.

Since: 5.0.0 Initial implementation

Parameters

int	$id	ID of warehouse to update
array	$request_data	Data @phan-param ?array<string,string> $request_data @phpstan-param ?array<string,string> $request_data

Returns: Object Updated object

@url PUT {id}

Exceptions

RestException	400 Bad Request
RestException	403 Not allowed
RestException	404 Not found
RestException	500 Internal Server Error

Definition at line 266 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_23.0/htdocs/product/stock/class/api_warehouses.class.php

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _cleanObjectDatas()

◆ _validate()

◆ delete()

◆ get()

◆ index()

◆ listProducts()

◆ post()

◆ put()