class Access extends ConcreteObject (View source)

Properties

$error from ConcreteObject
protected int $paID
protected int[] $paIDList
protected ListItem[]|null $listItems
Key $pk
bool|int|string $paIsInUse

Methods

loadError($error)

No description

isError()

No description

getError()

No description

setPropertiesFromArray($arr)

No description

static 
camelcase($file)

No description

static 
uncamelcase($string)

No description

setListItems(ListItem[] $listItems)

No description

setPermissionKey(Key $permissionKey)

No description

object
getPermissionObject()

Get the object associated to the permission (for example, a Page instance).

object
getPermissionObjectToCheck()

Get the object to be used to check the permission (for example, a Page instance).

int
getPermissionAccessID()

No description

bool|int|string
isPermissionAccessInUse()

No description

int[]
getPermissionAccessIDList()

No description

Entity[]
validateAndFilterAccessEntities(Entity[] $accessEntities)

No description

bool
validateAccessEntities(Entity[] $accessEntities)

No description

bool
validate()

No description

static 
createByMerge($permissions)

No description

getAccessListItems(int $accessType = PermissionKey::ACCESS_TYPE_INCLUDE, Entity[] $filterEntities = [], bool $checkCache = true)

No description

clearWorkflows()

No description

attachWorkflow(Workflow $wf)

No description

removeWorkflow(Workflow $wf)

No description

getWorkflows()

No description

duplicate(Access|null|false $newPA = false)

No description

markAsInUse()

No description

addListItem(Entity $pae, Duration|null|false $durationObject = false, int $accessType = PermissionKey::ACCESS_TYPE_INCLUDE)

No description

removeListItem(Entity $pe)

No description

save(array $args = [])

No description

static Access
create(Key $pk)

No description

static Access|null
getByID(int $paID, Key $pk, bool $checkPA = true)

No description

deliverAccessListItems(string $q, int $accessType, Entity[] $filterEntities)

No description

string
getCacheIdentifier(int $accessType, Entity[] $filterEntities = [])

No description

string
buildAssignmentFilterString(int $accessType, Entity[] $filterEntities)

No description

Details

loadError($error)

Parameters

$error

isError()

getError()

setPropertiesFromArray($arr)

Parameters

$arr

static camelcase($file)

Parameters

$file

static uncamelcase($string)

Parameters

$string

setListItems(ListItem[] $listItems)

Parameters

ListItem[] $listItems

setPermissionKey(Key $permissionKey)

Parameters

Key $permissionKey

object getPermissionObject()

Get the object associated to the permission (for example, a Page instance).

Return Value

object

object getPermissionObjectToCheck()

Get the object to be used to check the permission (for example, a Page instance).

Return Value

object

int getPermissionAccessID()

Return Value

int

bool|int|string isPermissionAccessInUse()

Return Value

bool|int|string

int[] getPermissionAccessIDList()

Return Value

int[]

Entity[] validateAndFilterAccessEntities(Entity[] $accessEntities)

Parameters

Entity[] $accessEntities

Return Value

Entity[]

bool validateAccessEntities(Entity[] $accessEntities)

Parameters

Entity[] $accessEntities

Return Value

bool

bool validate()

Return Value

bool

static createByMerge($permissions)

Parameters

$permissions

ListItem[] getAccessListItems(int $accessType = PermissionKey::ACCESS_TYPE_INCLUDE, Entity[] $filterEntities = [], bool $checkCache = true)

Parameters

int $accessType
Entity[] $filterEntities
bool $checkCache

Return Value

ListItem[]

clearWorkflows()

attachWorkflow(Workflow $wf)

Parameters

Workflow $wf

removeWorkflow(Workflow $wf)

Parameters

Workflow $wf

Workflow[] getWorkflows()

Return Value

Workflow[]

Access duplicate(Access|null|false $newPA = false)

Parameters

Access|null|false $newPA

Return Value

Access

markAsInUse()

addListItem(Entity $pae, Duration|null|false $durationObject = false, int $accessType = PermissionKey::ACCESS_TYPE_INCLUDE)

Parameters

Entity $pae
Duration|null|false $durationObject
int $accessType

removeListItem(Entity $pe)

Parameters

Entity $pe

save(array $args = [])

Parameters

array $args

static Access create(Key $pk)

Parameters

Key $pk

Return Value

Access

static Access|null getByID(int $paID, Key $pk, bool $checkPA = true)

Parameters

int $paID
Key $pk
bool $checkPA

Return Value

Access|null

protected ListItem[] deliverAccessListItems(string $q, int $accessType, Entity[] $filterEntities)

Parameters

string $q
int $accessType
Entity[] $filterEntities

Return Value

ListItem[]

protected string getCacheIdentifier(int $accessType, Entity[] $filterEntities = [])

Parameters

int $accessType
Entity[] $filterEntities

Return Value

string

protected string buildAssignmentFilterString(int $accessType, Entity[] $filterEntities)

Parameters

int $accessType
Entity[] $filterEntities

Return Value

string