dolibarr  18.0.0-alpha
Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
Warehouses Class Reference
Inheritance diagram for Warehouses:
Inheritance graph
[legend]
Collaboration diagram for Warehouses:
Collaboration graph
[legend]

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
 _checkValForAPI ($field, $value, $object)
 Check and convert a string depending on its type/name. More...
 
 _checkFilters ($sqlfilters, &$error='')
 Return if a $sqlfilters parameter is valid Function no more used. 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_warehouses.class.php.

Member Function Documentation

◆ _cleanObjectDatas()

Warehouses::_cleanObjectDatas (   $object)
protected

Clean sensible object datas.

Parameters
Entrepot$objectObject to clean
Returns
Object Object with cleaned properties

Reimplemented from DolibarrApi.

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

◆ _validate()

Warehouses::_validate (   $data)
private

Validate fields before create or update object.

Parameters
array | null$dataData to validate
Returns
array
Exceptions
RestException

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

◆ delete()

Warehouses::delete (   $id)

Delete warehouse.

Parameters
int$idWarehouse ID
Returns
array

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

◆ get()

Warehouses::get (   $id)

Get properties of a warehouse object.

Return an array with warehouse informations

Parameters
int$idID of warehouse
Returns
array|mixed data without useless information
Exceptions
RestException

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

◆ index()

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

List warehouses.

Get a list of warehouses

Parameters
string$sortfieldSort field
string$sortorderSort order
int$limitLimit for list
int$pagePage number
int$categoryUse this param to filter list by category
string$sqlfiltersOther 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.

◆ post()

Warehouses::post (   $request_data = null)

Create warehouse object.

Parameters
array$request_dataRequest data
Returns
int ID of warehouse

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

◆ put()

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

Update warehouse.

Parameters
int$idId of warehouse to update
array$request_dataDatas
Returns
int

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


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