dolibarr  7.0.0-beta
Public Member Functions | List of all members
Categories Class Reference
+ Inheritance diagram for Categories:
+ Collaboration diagram for Categories:

Public Member Functions

 __construct ()
 Constructor.
 
 get ($id)
 Get properties of a category object. More...
 
 index ($sortfield="t.rowid", $sortorder= 'ASC', $limit=100, $page=0, $type= '', $sqlfilters= '')
 List categories. More...
 
 post ($request_data=NULL)
 Create category object. More...
 
 put ($id, $request_data=NULL)
 Update category. More...
 
 delete ($id)
 Delete category. More...
 
 _cleanObjectDatas ($object)
 Clean sensible object datas. More...
 
 _validate ($data)
 Validate fields before create or update object. More...
 
- Public Member Functions inherited from DolibarrApi
 __construct ($db, $cachedir='', $refreshCache=false)
 Constructor. More...
 
 _cleanObjectDatas ($object)
 Executed method when API is called without parameter. More...
 
 _checkFilters ($sqlfilters)
 Return if a $sqlfilters parameter is valid. More...
 

Additional Inherited Members

- Static Public 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_categories.class.php.

Member Function Documentation

Categories::_cleanObjectDatas (   $object)

Clean sensible object datas.

Parameters
Categorie$objectObject to clean
Returns
array Array of cleaned object properties

Definition at line 269 of file api_categories.class.php.

Referenced by get(), and index().

Categories::_validate (   $data)

Validate fields before create or update object.

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

Definition at line 325 of file api_categories.class.php.

Referenced by post().

Categories::delete (   $id)

Delete category.

Parameters
int$idCategory ID
Returns
array

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

References DolibarrApi\_checkAccessToResource().

Categories::get (   $id)

Get properties of a category object.

Return an array with category informations

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

Definition at line 73 of file api_categories.class.php.

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

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

List categories.

Get a list of categories

Parameters
string$sortfieldSort field
string$sortorderSort order
int$limitLimit for list
int$pagePage number
string$typeType of category ('member', 'customer', 'supplier', 'product', 'contact')
string$sqlfiltersOther criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.date_creation:<:'20160101')"
Returns
array Array of category objects
Exceptions
RestException

Definition at line 106 of file api_categories.class.php.

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

Categories::post (   $request_data = NULL)

Create category object.

Parameters
array$request_dataRequest data
Returns
int ID of category

Definition at line 175 of file api_categories.class.php.

References _validate().

Categories::put (   $id,
  $request_data = NULL 
)

Update category.

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

Definition at line 200 of file api_categories.class.php.

References DolibarrApi\_checkAccessToResource().


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