Categories

class Categories extends DolibarrApi (View source)

API class for categories

Properties

protected DoliDB $db from  DolibarrApi
Restler $r from  DolibarrApi
static string[] $FIELDS
Categorie $category

Methods

__construct()

Constructor

string|array<string, mixed>
_checkValForAPI(string $field, string|string[] $value, object $object)

Check and convert a string depending on its type/name.

from  DolibarrApi
object
_filterObjectProperties(object $object, string $properties)

Filter properties that will be returned on object

from  DolibarrApi
object
_cleanObjectDatas(object $object)

Clean sensible object datas

static bool
_checkAccessToResource(string $resource, int $resource_id = 0, string $dbtablename = '', string $feature2 = '', string $dbt_keyfield = 'fk_soc', string $dbt_select = 'rowid')

Check access by user to a given resource

from  DolibarrApi
bool|string
_checkFilters(string $sqlfilters, string $error = '')

Return if a $sqlfilters parameter is valid Function no more used. Kept for backward compatibility with old APIs of modules

from  DolibarrApi
static string
_forge_criteria_callback(string[] $matches)

Function to forge a SQL criteria from a Generic filter string.

from  DolibarrApi
array
get(int $id, bool $include_childs = false)

Get properties of a category object

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

List categories

int
post(array $request_data = null)

Create category object

object
put(int $id, array $request_data = null)

Update category

array
delete(int $id)

Delete category

array
getListForObject(int $id, string $type, string $sortfield = "s.rowid", string $sortorder = 'ASC', int $limit = 0, int $page = 0)

List categories of an object

array
linkObjectById(int $id, string $type, int $object_id)

Link an object to a category by id

array
linkObjectByRef(int $id, string $type, string $object_ref)

Link an object to a category by ref

array
unlinkObjectById(int $id, string $type, int $object_id)

Unlink an object from a category by id

array
unlinkObjectByRef(int $id, string $type, string $object_ref)

Unlink an object from a category by ref

mixed
getObjects(int $id, string $type, int $onlyids = 0)

Get the list of objects in a category.

Details

at line 58
__construct()

Constructor

in DolibarrApi at line 98
protected string|array<string, mixed> _checkValForAPI(string $field, string|string[] $value, object $object)

Check and convert a string depending on its type/name.

Parameters

string $field

Field name
string|string[] $value

Value to check/clean
object $object Object

Return Value

string|array<string, mixed>

Value cleaned

in DolibarrApi at line 156
protected object _filterObjectProperties(object $object, string $properties)

Filter properties that will be returned on object

Parameters

object $object

Object to clean
string $properties

Comma separated list of properties names

Return Value

object

Object with cleaned properties

at line 721
protected object _cleanObjectDatas(object $object)

Clean sensible object datas

Parameters

object $object

Object to clean

Return Value

object

Object with cleaned properties

in DolibarrApi at line 393
static protected bool _checkAccessToResource(string $resource, int $resource_id = 0, string $dbtablename = '', string $feature2 = '', string $dbt_keyfield = 'fk_soc', string $dbt_select = 'rowid')

Check access by user to a given resource

Parameters

string $resource

element to check
int $resource_id

Object ID if we want to check a particular record (optional) is linked to a owned thirdparty (optional).
string $dbtablename

'TableName&SharedElement' with Tablename is table where object is stored. SharedElement is an optional key to define where to check entity. Not used if objectid is null (optional)
string $feature2

Feature to check, second level of permission (optional). Can be or check with 'level1|level2'.
string $dbt_keyfield

Field name for socid foreign key if not fk_soc. Not used if objectid is null (optional)
string $dbt_select

Field name for select if not rowid. Not used if objectid is null (optional)

Return Value

bool

in DolibarrApi at line 421
protected bool|string _checkFilters(string $sqlfilters, string $error = '')

Return if a $sqlfilters parameter is valid Function no more used. Kept for backward compatibility with old APIs of modules

Parameters

string $sqlfilters

sqlfilter string
string $error

Error message

Return Value

bool|string

True if valid, False if not valid

in DolibarrApi at line 439
static protected string _forge_criteria_callback(string[] $matches)

Function to forge a SQL criteria from a Generic filter string.

Function no more used. Kept for backward compatibility with old APIs of modules

Parameters

string[] $matches

Array of found string by regex search. Each entry is 1 and only 1 criteria. Example: "t.ref:like:'SO-%'", "t.date_creation:<:'20160101'", "t.date_creation:<:'2016-01-01 12:30:00'", "t.nature:is:NULL", "t.field2:isnot:NULL"

Return Value

string

Forged criteria. Example: "t.field like 'abc%'"

at line 79
array get(int $id, bool $include_childs = false)

Get properties of a category object

Return an array with category information

Parameters

int $id

ID of category
bool $include_childs

Include child categories list (true or false)

Return Value

array

Data without useless information

Exceptions

RestException

at line 126
array index(string $sortfield = "t.rowid", string $sortorder = 'ASC', int $limit = 100, int $page = 0, string $type = '', string $sqlfilters = '', string $properties = '')

List categories

Get a list of categories according to filters

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', 'actioncomm')
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 these properties. Ignored if empty. Comma separated list of properties names

Return Value

array

Array of category objects

Exceptions

RestException

at line 193
int post(array $request_data = null)

Create category object

Parameters

array $request_data

Request data

Return Value

int

ID of category

at line 228
object put(int $id, array $request_data = null)

Update category

Parameters

int $id

Id of category to update
array $request_data Data

Return Value

object

Updated object

at line 279
array delete(int $id)

Delete category

Parameters

int $id

Category ID

Return Value

array

at line 324
array getListForObject(int $id, string $type, string $sortfield = "s.rowid", string $sortorder = 'ASC', int $limit = 0, int $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', 'actioncomm')
string $sortfield

Sort field
string $sortorder

Sort order
int $limit

Limit for list
int $page

Page number

Return Value

array

Array of category objects

Exceptions

RestException

at line 391
array linkObjectById(int $id, string $type, int $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', 'actioncomm')
int $object_id

ID of object

Return Value

array

Exceptions

RestException

at line 479
array linkObjectByRef(int $id, string $type, string $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 (product, thirdparty, member, ...)

Return Value

array

Exceptions

RestException

at line 562
array unlinkObjectById(int $id, string $type, int $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', 'actioncomm')
int $object_id

ID of the object

Return Value

array

Exceptions

RestException

at line 643
array unlinkObjectByRef(int $id, string $type, string $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', 'actioncomm')
string $object_ref

Reference of the object (product, thirdparty, member, ...)

Return Value

array

Exceptions

RestException

at line 805
mixed getObjects(int $id, string $type, int $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)

Return Value

mixed