ePages 6.10 - DE_EPAGES/Permission/API/Table/GroupMember.pm

Package DE_EPAGES::Permission::API::Table::GroupMember

interface for table GroupMember

@EXPORT_OK
InsertGroupMember
DeleteGroupMember
GetAllPKeyGroupMembers
ExistsGroupMember
GetPKeyGroupMembersByGroupID
GetInfoGroupMembersByGroupID
GetPKeyGroupMembersByTrusteeID
GetInfoGroupMembersByTrusteeID

Functions

DeleteGroupMember
ExistsGroupMember
GetAllPKeyGroupMembers
GetInfoGroupMembersByGroupID
GetInfoGroupMembersByTrusteeID
GetPKeyGroupMembersByGroupID
GetPKeyGroupMembersByTrusteeID
InsertGroupMember

DeleteGroupMember

Deletes a(n) GroupMember.

Syntax
DeleteGroupMember($GroupID, $TrusteeID);
DeleteGroupMember($hGroupMember); # if $hGroupMember includes GroupID, TrusteeID
Input
$GroupID (int)
user group id (part of primary key)
$TrusteeID (int)
trustee id (part of primary key)

ExistsGroupMember

Returns true if the GroupMember exists.

Syntax
$exists = ExistsGroupMember($GroupID, $TrusteeID);
Input
$GroupID (int)
user group id
$TrusteeID (int)
trustee id
Return
$exists (boolean)
1/0 the GroupMember exists (yes/no)

GetAllPKeyGroupMembers

Returns all GroupMember identifiers.

Syntax
$ahGroupMemberIDs = GetAllPKeyGroupMembers();
Return
$ahGroupMemberIDs (reference to array of hashes)
with following keys:
  • GroupID - user group id - int
  • TrusteeID - trustee id - int

GetInfoGroupMembersByGroupID

Returns objects of GroupMember by primary key element GroupID.

Syntax
$ahGroupMembers = GetInfoGroupMembersByGroupID($GroupID);
Input
$GroupID (int)
user group id
Return
$ahGroupMembers (reference to array of hashes)
with following keys:
  • GroupID - user group id (part of primary key)- int
  • TrusteeID - trustee id (part of primary key)- int

GetInfoGroupMembersByTrusteeID

Returns objects of GroupMember by alternate key TrusteeID.

Syntax
$ahGroupMembers = GetInfoGroupMembersByTrusteeID($TrusteeID);
Input
$TrusteeID (int)
trustee id
Return
$ahGroupMembers (reference to array of hashes)
with following keys:
  • GroupID - user group id (part of primary key)- int
  • TrusteeID - trustee id (part of primary key)- int

GetPKeyGroupMembersByGroupID

Returns primary keys of GroupMember by primary key element GroupID.

Syntax
$ahKeys = GetPKeyGroupMembersByGroupID($GroupID);
Input
$GroupID (int)
user group id
Return
$ahKeys (reference to array of hashes)
with following keys:
  • GroupID - user group id - int
  • TrusteeID - trustee id - int

GetPKeyGroupMembersByTrusteeID

Returns primary keys of GroupMember by alternate key TrusteeID.

Syntax
$ahKeys = GetPKeyGroupMembersByTrusteeID($TrusteeID);
Input
$TrusteeID (int)
trustee id
Return
$ahKeys (reference to array of hashes)
with following keys:
  • GroupID - user group id - int
  • TrusteeID - trustee id - int

InsertGroupMember

Creates an entry of GroupMember.

Syntax
InsertGroupMember($hGroupMember);
Input
$hGroupMember (reference to hash)
with following keys:
  • GroupID - user group id (part of primary key)- int
  • TrusteeID - trustee id (part of primary key)- int