Categories Class Reference

Inheritance diagram for Categories:

Collaboration diagram for Categories:

Public Member Functions
	__construct ()
	Constructor.
	get ($id, $include_childs=false)
	Get properties of a category object.
	index ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $type='', $sqlfilters='', $properties='')
	List categories.
	post ($request_data=null)
	Create category object.
	put ($id, $request_data=null)
	Update category.
	delete ($id)
	Delete category.
	getListForObject ($id, $type, $sortfield="s.rowid", $sortorder='ASC', $limit=0, $page=0)
	List categories of an object.
	linkObjectById ($id, $type, $object_id)
	Link an object to a category by id.
	linkObjectByRef ($id, $type, $object_ref)
	Link an object to a category by ref.
	unlinkObjectById ($id, $type, $object_id)
	Unlink an object from a category by id.
	unlinkObjectByRef ($id, $type, $object_ref)
	Unlink an object from a category by ref.
	getObjects ($id, $type, $onlyids=0)
	Get the list of objects in a category.
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 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 678 of file api_categories.class.php.

Referenced by get(), and index().

_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 736 of file api_categories.class.php.

Referenced by post().

delete()

Categories::delete

(

$id

)

Delete category.

Parameters

int

$id

Category ID

Returns

array

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

References DolibarrApi\_checkAccessToResource().

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.

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

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 316 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 759 of file api_categories.class.php.

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

index()

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

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

Returns

array Array of category objects

Exceptions

RestException

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

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

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 366 of file api_categories.class.php.

References Contact().

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 446 of file api_categories.class.php.

References Contact().

post()

Categories::post

(

$request_data = null

)

Create category object.

Parameters

array

$request_data

Request data

Returns

int ID of category

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

References _validate().

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 226 of file api_categories.class.php.

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

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 526 of file api_categories.class.php.

References Contact().

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 604 of file api_categories.class.php.

References Contact().

---

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

• dolibarr_19.0/htdocs/categories/class/api_categories.class.php