1. class
  2. Civi
  3. \
  4. Api4
  5. \
  6. ACL

ACL

class ACL extends DAOEntity

ACL Entity.

This entity holds the ACL informatiom. With this entity you add/update/delete an ACL permission which consists of an Operation (e.g. 'View' or 'Edit'), a set of Data that the operation can be performed on (e.g. a group of contacts), and a Role that has permission to do this operation. For more info refer to https://docs.civicrm.org/user/en/latest/initial-set-up/permissions-and-access-control for more info.

Creating a new ACL requires at minimum a entity table, entity ID and object_table

Methods

static GetActions
getActions()

No description

from AbstractEntity
static 
getFields()

No description

from DAOEntity
static array
permissions()

Returns a list of permissions needed to access the various actions in this api.

from AbstractEntity
static string
getEntityName()

Get entity name from called class

from AbstractEntity
static AbstractAction
__callStatic(string $action, null $args)

Magic method to return the action object for an api.

from AbstractEntity
static DAOGetAction
get()

No description

from DAOEntity
static DAOGetAction
save()

No description

from DAOEntity
static DAOCreateAction
create()

No description

from DAOEntity
static DAOUpdateAction
update()

No description

from DAOEntity
static DAODeleteAction
delete()

No description

from DAOEntity
static BasicReplaceAction
replace()

No description

from DAOEntity

Details

in AbstractEntity at line 66
static GetActions getActions()

Return Value

GetActions

in DAOEntity at line 62
static getFields()

in AbstractEntity at line 84
static array permissions()

Returns a list of permissions needed to access the various actions in this api.

Return Value

array

in AbstractEntity at line 99
static protected string getEntityName()

Get entity name from called class

Return Value

string

in AbstractEntity at line 111
static AbstractAction __callStatic(string $action, null $args)

Magic method to return the action object for an api.

Parameters

string $action
null $args

Return Value

AbstractAction

Exceptions

NotImplementedException

in DAOEntity at line 48
static DAOGetAction get()

Return Value

DAOGetAction

in DAOEntity at line 55
static DAOGetAction save()

Return Value

DAOGetAction

in DAOEntity at line 69
static DAOCreateAction create()

Return Value

DAOCreateAction

in DAOEntity at line 76
static DAOUpdateAction update()

Return Value

DAOUpdateAction

in DAOEntity at line 83
static DAODeleteAction delete()

Return Value

DAODeleteAction

in DAOEntity at line 90
static BasicReplaceAction replace()

Return Value

BasicReplaceAction