Inheritance diagram for Categories:

Collaboration diagram for Categories:

Public Member Functions
	__construct ()
	Constructor.

	get ($id, $include_childs=false)
	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...

	getListForObject ($id, $type, $sortfield="s.rowid", $sortorder='ASC', $limit=0, $page=0)
	List categories of an object. More...

	linkObjectById ($id, $type, $object_id)
	Link an object to a category by id. More...

	linkObjectByRef ($id, $type, $object_ref)
	Link an object to a category by ref. More...

	unlinkObjectById ($id, $type, $object_id)
	Unlink an object from a category by id. More...

	unlinkObjectByRef ($id, $type, $object_ref)
	Unlink an object from a category by ref. More...

	getObjects ($id, $type, $onlyids=0)
	Get the list of objects in a category. 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 36 of file api_categories.class.php.

Member Function Documentation

◆ _cleanObjectDatas()

Categories::_cleanObjectDatas ( $object )

protected

Clean sensible object datas.

Parameters

Categorie $object Object to clean

Returns: Object Object with cleaned properties

Reimplemented from DolibarrApi.

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

◆ _validate()

Categories::_validate ( $data )

private

Validate fields before create or update object.

Parameters

array | null $data Data to validate

Returns: array

Exceptions

RestException

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

◆ delete()

Categories::delete ( $id )

Delete category.

Parameters

int $id Category ID

Returns: array

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

◆ get()

Categories::get	(	$id,
		$include_childs = `false`
	)

Get properties of a category object.

Return an array with category informations

Parameters

int	$id	ID of category
bool	$include_childs	Include child categories list (true or false)

Returns: array|mixed data without useless information

Exceptions

RestException

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

◆ getListForObject()

Categories::getListForObject	(	$id,
		$type,
		$sortfield = `"s.rowid"`,
		$sortorder = `'ASC'`,
		$limit = `0`,
		$page = `0`
	)

List categories of an object.

Get the list of categories linked to an object

Parameters

int	$id	Object ID
string	$type	Type of category ('member', 'customer', 'supplier', 'product', 'contact', 'project')
string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Limit for list
int	$page	Page number

Returns: array Array of category objects

Exceptions

RestException @url GET /object/{type}/{id}

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

◆ getObjects()

Categories::getObjects	(	$id,
		$type,
		$onlyids = `0`
	)

Get the list of objects in a category.

Parameters

int	$id	ID of category
string	$type	Type of category ('member', 'customer', 'supplier', 'product', 'contact', 'project')
int	$onlyids	Return only ids of objects (consume less memory)

Returns: mixed

@url GET {id}/objects

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

◆ index()

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

List categories.

Get a list of categories

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Limit for list
int	$page	Page number
string	$type	Type of category ('member', 'customer', 'supplier', 'product', 'contact')
string	$sqlfilters	Other 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 133 of file api_categories.class.php.

◆ linkObjectById()

Categories::linkObjectById	(	$id,
		$type,
		$object_id
	)

Link an object to a category by id.

Parameters

int	$id	ID of category
string	$type	Type of category ('member', 'customer', 'supplier', 'product', 'contact')
int	$object_id	ID of object

Returns: array

Exceptions

RestException @url POST {id}/objects/{type}/{object_id}

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

◆ linkObjectByRef()

Categories::linkObjectByRef	(	$id,
		$type,
		$object_ref
	)

Link an object to a category by ref.

Parameters

int	$id	ID of category
string	$type	Type of category ('member', 'customer', 'supplier', 'product', 'contact')
string	$object_ref	Reference of object

Returns: array

Exceptions

RestException @url POST {id}/objects/{type}/ref/{object_ref}

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

◆ post()

Categories::post ( $request_data = null )

Create category object.

Parameters

array $request_data Request data

Returns: int ID of category

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

◆ put()

Categories::put	(	$id,
		$request_data = `null`
	)

Update category.

Parameters

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

Returns: int

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

◆ unlinkObjectById()

Categories::unlinkObjectById	(	$id,
		$type,
		$object_id
	)

Unlink an object from a category by id.

Parameters

int	$id	ID of category
string	$type	Type of category ('member', 'customer', 'supplier', 'product', 'contact')
int	$object_id	ID of the object

Returns: array

Exceptions

RestException @url DELETE {id}/objects/{type}/{object_id}

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

◆ unlinkObjectByRef()

Categories::unlinkObjectByRef	(	$id,
		$type,
		$object_ref
	)

Unlink an object from a category by ref.

Parameters

int	$id	ID of category
string	$type	Type of category ('member', 'customer', 'supplier', 'product', 'contact')
string	$object_ref	Reference of the object

Returns: array

Exceptions

RestException @url DELETE {id}/objects/{type}/ref/{object_ref}

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

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

dolibarr_dev/htdocs/categories/class/api_categories.class.php

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _cleanObjectDatas()

◆ _validate()

◆ delete()

◆ get()

◆ getListForObject()

◆ getObjects()

◆ index()

◆ linkObjectById()

◆ linkObjectByRef()

◆ post()

◆ put()

◆ unlinkObjectById()

◆ unlinkObjectByRef()