Inheritance diagram for Users:

Collaboration diagram for Users:

Public Member Functions
	__construct ()
	Constructor.

	index ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $user_ids='0', $category=0, $sqlfilters='', $properties='')
	List Users.

	get ($id, $includepermissions=0)
	Get properties of an user object.

	getByLogin ($login, $includepermissions=0)
	Get properties of an user object by login.

	getByEmail ($email, $includepermissions=0)
	Get properties of an user object by Email.

	getInfo ($includepermissions=0)
	Get more properties of a user.

	post ($request_data=null)
	Create user account.

	put ($id, $request_data=null)
	Update user account.

	setPassword ($id, $send_password=false)
	Update a user password.

	getGroups ($id)
	List the groups of a user.

	setGroup ($id, $group, $entity=1)
	Add a user into a group.

	listGroups ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $group_ids='0', $sqlfilters='', $properties='')
	List Groups.

	infoGroups ($group, $load_members=0)
	Get properties of an group object.

	delete ($id)
	Delete account/user.

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
	_cleanUserGroupListDatas ($objectList)
	Clean sensible user group list datas.

	_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 33 of file api_users.class.php.

Member Function Documentation

◆ _cleanObjectDatas()

Users::_cleanObjectDatas ( $object )

protected

Clean sensible object datas.

Parameters

Object $object Object to clean

Returns: Object Object with cleaned properties

Reimplemented from DolibarrApi.

Definition at line 738 of file api_users.class.php.

References $object.

Referenced by get(), getByEmail(), getByLogin(), getGroups(), getInfo(), index(), infoGroups(), and listGroups().

◆ _cleanUserGroupListDatas()

Users::_cleanUserGroupListDatas ( $objectList )

private

Clean sensible user group list datas.

Parameters

array<UserGroup> $objectList Array of object to clean

Returns: array<UserGroup> Array of cleaned object properties

Definition at line 795 of file api_users.class.php.

References $object.

Referenced by getInfo().

◆ _validate()

Users::_validate ( $data )

private

Validate fields before create or update object.

Parameters

?array<string,mixed> $data Data to validate

Returns: array<string,mixed>

Exceptions

RestException

Definition at line 843 of file api_users.class.php.

◆ delete()

Users::delete ( $id )

Delete account/user.

Parameters

int $id Account ID

Returns: array @phan-return array{success:array{code:int,message:string}} @phpstan-return array{success:array{code:int,message:string}}

Exceptions

RestException	403 Not allowed
RestException	404 User not found

Definition at line 704 of file api_users.class.php.

References $id, and DolibarrApi\_checkAccessToResource().

◆ get()

Users::get	(		$id,
			$includepermissions = 0 )

Get properties of an user object.

Parameters

int	$id	ID of user
int	$includepermissions	Set this to 1 to have the array of permissions loaded (not done by default for performance purpose)

Returns: array|mixed data without useless information @phan-return Object @phpstan-return Object

Exceptions

RestException	401 Insufficient rights
RestException	404 User or group not found

Definition at line 155 of file api_users.class.php.

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

◆ getByEmail()

Users::getByEmail	(		$email,
			$includepermissions = 0 )

Get properties of an user object by Email.

Parameters

string	$email	Email of user
int	$includepermissions	Set this to 1 to have the array of permissions loaded (not done by default for performance purpose)

Returns: array|mixed Data without useless information @phan-return Object @phpstan-return Object[

@url GET email/{email}

Exceptions

RestException	400 Bad request
RestException	401 Insufficient rights
RestException	404 User or group not found

Definition at line 237 of file api_users.class.php.

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

◆ getByLogin()

Users::getByLogin	(		$login,
			$includepermissions = 0 )

Get properties of an user object by login.

Parameters

string	$login	Login of user
int	$includepermissions	Set this to 1 to have the array of permissions loaded (not done by default for performance purpose)

Returns: array|mixed Data without useless information @phan-return Object @phpstan-return Object

@url GET login/{login}

Exceptions

RestException	400 Bad request
RestException	401 Insufficient rights
RestException	404 User or group not found

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

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

◆ getGroups()

Users::getGroups ( $id )

List the groups of a user.

Parameters

int $id Id of user

Returns: array Array of group objects @phan-return Object[] @phpstan-return Object[]

Exceptions

RestException	403 Not allowed
RestException	404 Not found

@url GET {id}/groups

Definition at line 513 of file api_users.class.php.

References $id, and _cleanObjectDatas().

◆ getInfo()

Users::getInfo ( $includepermissions = 0 )

Get more properties of a user.

@url GET /info

Parameters

int $includepermissions Set this to 1 to have the array of permissions loaded (not done by default for performance purpose)

Returns: array|mixed Data without useless information

Exceptions

RestException	401 Insufficient rights
RestException	404 User or group not found

Definition at line 274 of file api_users.class.php.

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

◆ index()

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

List Users.

Get a list of Users

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Limit for list
int	$page	Page number
string	$user_ids	User ids filter field. Example: '1' or '1,2,3' {@pattern /^[0-9,]*$/i}
int	$category	Use this param to filter list by category
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

Returns: array Array of User objects @phan-return Object[] @phpstan-return Object[]

Definition at line 76 of file api_users.class.php.

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

◆ infoGroups()

Users::infoGroups	(		$group,
			$load_members = 0 )

Get properties of an group object.

Return an array with group information

@url GET /groups/{group}

Parameters

int	$group	ID of group
int	$load_members	Load members list or not {@min 0} {@max 1}

Returns: object object of User objects

Exceptions

RestException	403 Not allowed
RestException	404 User not found

Definition at line 676 of file api_users.class.php.

References _cleanObjectDatas(), and getDolGlobalString().

◆ listGroups()

Users::listGroups	(	$sortfield = "t.rowid",
		$sortorder = 'ASC',
		$limit = 100,
		$page = 0,
		$group_ids = '0',
		$sqlfilters = '',
		$properties = '' )

List Groups.

Return an array with a list of Groups

@url GET /groups

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Limit for list
int	$page	Page number
string	$group_ids	Groups ids filter field. Example: '1' or '1,2,3' {@pattern /^[0-9,]*$/i}
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

Returns: array Array of User objects @phan-return Object[] @phpstan-return Object[]

Exceptions

RestException	403 Not allowed
RestException	404 User not found
RestException	503 Error

Definition at line 604 of file api_users.class.php.

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

◆ post()

Users::post ( $request_data = null )

Create user account.

Parameters

array $request_data New user data @phan-param ?array<string,mixed> $request_data @phpstan-param ?array<string,mixed> $request_data

Returns: int

Exceptions

RestException 401 Not allowed

Definition at line 316 of file api_users.class.php.

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

◆ put()

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

Update user account.

Parameters

int	$id	Id of account to update
array	$request_data	Datas @phan-param ?array<string,mixed> $request_data @phpstan-param ?array<string,mixed> $request_data

Returns: Object Updated object

Exceptions

RestException	403 Not allowed
RestException	404 Not found
RestException	500 System error

Definition at line 373 of file api_users.class.php.

References $id, DolibarrApi\_checkAccessToResource(), DolibarrApi\_checkValForAPI(), and sanitizeVal().

◆ setGroup()

Users::setGroup	(	$id,
		$group,
		$entity = 1 )

Add a user into a group.

Parameters

int	$id	User ID
int	$group	Group ID
int	$entity	Entity ID (valid only for superadmin in multicompany transverse mode)

Returns: int 1 if success

Exceptions

RestException	403 Not allowed
RestException	404 User not found
RestException	500 System error

@url GET {id}/setGroup/{group}

Definition at line 549 of file api_users.class.php.

References $id, DolibarrApi\_checkAccessToResource(), and getDolGlobalString().

◆ setPassword()

Users::setPassword	(		$id,
			$send_password = false )

Update a user password.

Parameters

int	$id	User ID
bool	$send_password	Only if set to true, the new password will send to the user

Returns: int 1 if password changed, 2 if password changed and sent

Exceptions

RestException	403 Not allowed
RestException	404 User not found
RestException	500 System error

@url GET {id}/setPassword

Definition at line 458 of file api_users.class.php.

References $id, DolibarrApi\_checkAccessToResource(), and getDolGlobalString().

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

dolibarr_dev/htdocs/user/class/api_users.class.php

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _cleanObjectDatas()

◆ _cleanUserGroupListDatas()

◆ _validate()

◆ delete()

◆ get()

◆ getByEmail()

◆ getByLogin()

◆ getGroups()

◆ getInfo()

◆ index()

◆ infoGroups()

◆ listGroups()

◆ post()

◆ put()

◆ setGroup()

◆ setPassword()