Fuman
\

\Fuman_Acl

Access Control List for Table, Action, Service

Summary

Methods
Properties
Constants
addTableAction()
removeTableAction()
removeTable()
addTableSubset()
addTableActionSubset()
getTableActionSubset()
getTableActionConfiguration()
addUniqueNameAction()
addAction()
removeAction()
hasAction()
getTableUniqueNames()
isActionAllowed()
isActionAllowedForTable()
isActionAllowedForRecord()
getActionDescriptorsForTable()
copyTableActions()
reset()
isServiceAllowed()
getUniqueNameActions()
getUniqueNameActionConfiguration()
getActions()
setActions()
createInstance()
addHashProtectedTableUniqueName()
isHashProtectedTable()
isHashProtectedTableUniqueName()
No public properties found
TABLE_ACTION_SUBSET_COLUMN_KEY
_createActionContainer()
$_actions
$_hashProtectedTableUniqueNames
N/A
No private methods found
No private properties found
N/A

Constants

TABLE_ACTION_SUBSET_COLUMN_KEY

TABLE_ACTION_SUBSET_COLUMN_KEY

Properties

$_actions

$_actions : array

List of actions

Type

array

$_hashProtectedTableUniqueNames

$_hashProtectedTableUniqueNames :

Type

Methods

addTableAction()

addTableAction(string  $actionClassName, string  $tableUniqueName, \stdClass|null  $configuration = null, \Fuman_Db_Where|null  $subset = null, boolean  $createTable = true) : void

Add Table to Action

Parameters

string $actionClassName
string $tableUniqueName
\stdClass|null $configuration
\Fuman_Db_Where|null $subset
boolean $createTable

removeTableAction()

removeTableAction(string  $actionClassName, string  $tableUniqueName) : void

Removes table from action

Parameters

string $actionClassName
string $tableUniqueName

removeTable()

removeTable(string  $tableUniqueName) : void

Removes table from all actions

Parameters

string $tableUniqueName

addTableSubset()

addTableSubset(string  $tableUniqueName, \Fuman_Db_Where  $subset) : void

Adds subset to all actions of passed table

Parameters

string $tableUniqueName
\Fuman_Db_Where $subset

addTableActionSubset()

addTableActionSubset(string  $actionClassName, string  $tableUniqueName, \Fuman_Db_Where  $subset) : void

Adds subset to table

Parameters

string $actionClassName
string $tableUniqueName
\Fuman_Db_Where $subset

getTableActionSubset()

getTableActionSubset(string  $actionClassName, string  $tableUniqueName) : \Fuman_Db_Where|null

Gets subset for table and actionName

Parameters

string $actionClassName
string $tableUniqueName

Returns

\Fuman_Db_Where|null

getTableActionConfiguration()

getTableActionConfiguration(string  $actionClassName, string  $tableUniqueName) : null|\stdClass

Gets configuration for table and actionName

Parameters

string $actionClassName
string $tableUniqueName

Returns

null|\stdClass

addUniqueNameAction()

addUniqueNameAction(string  $actionClassName, string  $uniqueName, null|\stdClass  $configuration = null) : void

Add unique name action

Parameters

string $actionClassName
string $uniqueName
null|\stdClass $configuration

addAction()

addAction(string  $actionClassName) : void

Adds action

Parameters

string $actionClassName

removeAction()

removeAction(string  $actionClassName) : void

Removes action

Parameters

string $actionClassName

hasAction()

hasAction(string  $actionClassName) : boolean

Has action

Parameters

string $actionClassName

Returns

boolean

getTableUniqueNames()

getTableUniqueNames() : array

Gets all table unique names which have been added

Returns

array

isActionAllowed()

isActionAllowed(string  $actionClassName) : boolean

Is action allowed

Parameters

string $actionClassName

Returns

boolean

isActionAllowedForTable()

isActionAllowedForTable(string  $actionClassName, \Fuman_Table  $table) : boolean

Is action allowed for table

Parameters

string $actionClassName
\Fuman_Table $table

Returns

boolean

isActionAllowedForRecord()

isActionAllowedForRecord(string  $actionClassName, \Fuman_Db_Record  $record) : boolean

Is action allowed for record of table

Parameters

string $actionClassName
\Fuman_Db_Record $record

Returns

boolean

getActionDescriptorsForTable()

getActionDescriptorsForTable(string  $tableUniqueName) : array<mixed,\Fuman_Action_Descriptor>

Get all actions of table

Parameters

string $tableUniqueName

Returns

array<mixed,\Fuman_Action_Descriptor>

copyTableActions()

copyTableActions(string  $tableSourceUniqueName, string  $tableTargetUniqueName) : void

Copies table action of source to target

Parameters

string $tableSourceUniqueName
string $tableTargetUniqueName

reset()

reset() : void

Resets ACL

isServiceAllowed()

isServiceAllowed(string  $service) : boolean

Is service allowed

Parameters

string $service

Returns

boolean

getUniqueNameActions()

getUniqueNameActions() : array

Gets all unique name actions

Returns

array

getUniqueNameActionConfiguration()

getUniqueNameActionConfiguration(string  $actionClassName, string  $uniqueName) : \stdClass

Gets config of unique name action

Parameters

string $actionClassName
string $uniqueName

Returns

\stdClass

getActions()

getActions() : array

Gets actions

Returns

array

setActions()

setActions(array<mixed,object>  $actions) : void

Set actions

Parameters

array<mixed,object> $actions

createInstance()

createInstance() : object

Create appropriate Fuman_Acl instance defined in config (config: application.acl_classname)

Returns

object

addHashProtectedTableUniqueName()

addHashProtectedTableUniqueName(string  $tableUniqueName)

Adds a table unique name to be hash protected in request

Parameters

string $tableUniqueName

isHashProtectedTable()

isHashProtectedTable(\Fuman_Table  $table) : boolean

Is the table unique name hash protected

Parameters

\Fuman_Table $table

Returns

boolean

isHashProtectedTableUniqueName()

isHashProtectedTableUniqueName(string  $tableUniqueName) : boolean

Is the table unique name hash protected

Parameters

string $tableUniqueName

Returns

boolean

_createActionContainer()

_createActionContainer(string  $actionClassName) : void

Creates action container

Parameters

string $actionClassName