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 workstations.

API class for webhooks.

API class for users.

API class for ticket object.

API class for supplier proposal.

API class for thirdparties.

API class for contacts.

API class for salaries.

API class for recruitment.

API class for receptions.

API class for projects.

API class for warehouses.

API class for stock movements.

API class for Product lots.

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 Leaves.

API class for supplier orders.

API class for Interventions.

API class for Expense Reports.

API class for shipments.

API for handling Object of table llx_eventorganization_conferenceorboothattendee.

API class for donations.

API class for contracts.

API class for paiement.

API class for invoices.

,external}

API class for orders.

API class for mass mailings.

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 that gives shows links between objects in an Dolibarr instance.

API for handling Object of table llx_c_email_templates.

API class for subscriptions.

API class for members types.

API class for members.

API class for accountancy.

@access protected ,external}

Since

5.0.0 Initial implementation

@access protected ,external}

Since

23.0.0 Initial implementation

@access protected ,external}

Since

7.0.0 Initial implementation

@access protected ,external}

Since

4.0.0 Initial implementation

@access protected ,external}

Since

3.8.0 Initial implementation

@access protected ,external}

@access protected }

Definition at line 48 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 355 of file api_access.class.php.

__isAllowed()

DolibarrApiAccess::__isAllowed

(

)

Check access.

Returns

bool

Exceptions

RestException	401 Forbidden
RestException	503 Technical error

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

References $mysoc, dol_getdate(), dol_mktime(), dol_now(), dol_string_nounprintableascii(), dol_syslog(), dolDecrypt(), dolEncrypt(), dolibarr_set_const(), getDolGlobalInt(), getDolGlobalString(), and isModEnabled().

verifyAccess()

static DolibarrApiAccess::verifyAccess ( array $m )

static

Verify access.

Parameters

array{class:array{DolibarrApiAccess:array{properties:array{requires?:bool}}}}

$m Properties of method

@access private

Returns

bool

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

---

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

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