ePages 6.10 - DE_EPAGES/Permission/API/Object/Role.pm

Package DE_EPAGES::Permission::API::Object::Role

object interface for Role.

Base
DE_EPAGES::Permission::API::Object::MetaAction

Functions

actions
addAction
className
dbPackage
existsAction
exportXMLActions
exportXMLElements
removeAction

actions

Returns all actions that are included in the role.

Syntax
$aActions = $Role->actions;
Example
foreach my $Action @{$Role->actions} {
    print $Action->alias, "\n";
}
Return
$aActions (ref.array.object)
list of action objects

addAction

Adds an action to the role.

Syntax
$Role->addAction( $Action );
Input
$Action (object)
action object

className

Returns the class name, used for DAL access.

Syntax
$ClassName = $Role->className;
Return
$ClassName (String)
class name

dbPackage

Returns the database package, used for DAL access.

Syntax
$DbPackage = $Role->dbPackage;
Return
$DbPackage (String)
database package name

existsAction

Returns true if the role contains the action.

Syntax
$Exists = $Role->existsAction( $Action );
Input
$Action (object)
action object
Return
$Exists (boolean)
true if the role contains the action

exportXMLActions

Exports role actions.

Syntax
$Object->exportXMLActions( $Driver, $hAttributes );
Input
$Driver (object)
xml export driver with support function addObject
$hAttributes (ref.hash.string)
plain attributes

exportXMLElements

Call function exportXMLActions to export role actions.

Syntax
$Object->exportXMLElements($Driver, $hAllAttributes);
Input
$Driver (object)
export driver
$hAllAttributes (ref.hash)
all attributes of object,
see $Object->allAttributes

removeAction

Removes an action from the role.

Syntax
$Role->removeAction( $Action );
Input
$Action (object)
action object