DolibarrApiAccess Class Reference

Dolibarr API access class. More...

Inheritance diagram for DolibarrApiAccess:

Collaboration diagram for DolibarrApiAccess:

Public Member Functions
	__construct ()
	Constructor.
	__isAllowed ()
	Check access.
	__getWWWAuthenticateString ()

Static Public Member Functions
static	verifyAccess (array $m)
	Verify access.

Detailed Description

Dolibarr API access class.

API class for zapier hook.

API class for users.

API class for ticket object.

API class for thirdparties.

API class for contacts.

API class for recruitment.

API class for receptions.

API class for projects.

API class for warehouses.

API class for stock movements.

API class for products.

API class for partnership partnership.

API class for MultiCurrency.

API class for MO.

API class for mymodule myobject.

API class for knowledgemanagement knowledgerecord.

API class for supplier orders.

API class for Interventions.

API class for Expense Reports.

API class for shipments.

API class for donations.

API class for contracts.

API class for invoices.

,external}

API class for orders.

API class for Agenda Events.

API class for categories.

API class for BOM.

API that gives the status of the Dolibarr instance.

API class for dictionaries.

API class for subscriptions.

API class for members types.

API class for members.

API class for accountancy.

@access protected ,external}

Definition at line 44 of file api_access.class.php.

Member Function Documentation

__getWWWAuthenticateString()

DolibarrApiAccess::__getWWWAuthenticateString

(

)

Returns

string string to be used with WWW-Authenticate header

Definition at line 227 of file api_access.class.php.

__isAllowed()

DolibarrApiAccess::__isAllowed

(

)

Check access.

Returns

bool

Exceptions

RestException	401 Forbidden
RestException	503 Technical error

Definition at line 87 of file api_access.class.php.

References dol_now(), dol_syslog(), dolDecrypt(), and dolEncrypt().

verifyAccess()

static DolibarrApiAccess::verifyAccess ( array $m )

static

Verify access.

Parameters

array

$m

Properties of method

@access private

Returns

bool

Definition at line 241 of file api_access.class.php.

---

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

• dolibarr_19.0/htdocs/api/class/api_access.class.php