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

Package DE_EPAGES::Permission::API::Object::Group

object interface for Group.

Base
DE_EPAGES::Permission::API::Object::Trustee

Functions

addMember
className
dbPackage
deleteXML
deleteXMLEnd
directMembers
existsMember
exportXMLElements
importXML
importXMLEnd
removeMember

addMember

Adds a user or group as member of this group.

Syntax
$Group->addMember( $Trustee );
Return
$Trustee (object)
user or group object

className

Returns the class name, used for DAL access.

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

dbPackage

Returns the database package, used for DAL access.

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

deleteXML

calls SUPER and push Group on stack.

Syntax
$Group = $ObjectPackage->deleteXML($Handler, $hElement, $Class, $hAttributes);
Return
$Group (object)
imported object (possible undefined if deleted)

deleteXMLEnd

pop Group from stack and calls SUPER.

Syntax
$ObjectPackage->deleteXMLEnd($Handler, $hElement);

directMembers

Returns all users and groups that are directly assigned as members to this group.

Syntax
$aTrustees = $Group->directMembers;
Return
$aTrustees (array ref)
list of group members

existsMember

Tests if the user or group is a member of this group.

Syntax
$Exists = $Group->existsMember( $Trustee );
Input
$Trustee (object)
Trustee object
Return
$Exists (boolean)
true if the Group contains the Trustee

exportXMLElements

pop Group from stack and calls SUPER.

Syntax
$ObjectPackage->exportXMLElements($Driver, $allAttributes);

importXML

calls SUPER and push Group on stack.

Syntax
$Group = $ObjectPackage->importXML($Handler, $hElement, $Class, $hAttributes);
Return
$Group (object)
imported object

importXMLEnd

pop Group from stack and calls SUPER.

Syntax
$ObjectPackage->importXMLEnd($Handler, $hElement);

removeMember

Removes a user or group from this group.

Syntax
$Group->removeMember( $Trustee );
Return
$Trustee (object)
user or group object