ePages 6.11.0 - DE_EPAGES/Permission/API/Table/RoleAction.pm

Package DE_EPAGES::Permission::API::Table::RoleAction

interface for table RoleAction

@EXPORT_OK
InsertRoleAction
DeleteRoleAction
GetAllPKeyRoleActions
ExistsRoleAction
GetPKeyRoleActionsByRoleID
GetInfoRoleActionsByRoleID
GetPKeyRoleActionsByActionID
GetInfoRoleActionsByActionID

Functions

DeleteRoleAction
ExistsRoleAction
GetAllPKeyRoleActions
GetInfoRoleActionsByActionID
GetInfoRoleActionsByRoleID
GetPKeyRoleActionsByActionID
GetPKeyRoleActionsByRoleID
InsertRoleAction

DeleteRoleAction

Deletes a(n) RoleAction.

Syntax
DeleteRoleAction($RoleID, $ActionID);
DeleteRoleAction($hRoleAction); # if $hRoleAction includes RoleID, ActionID
Input
$RoleID (int)
role id (part of primary key)
$ActionID (int)
action id (part of primary key)

ExistsRoleAction

Returns true if the RoleAction exists.

Syntax
$exists = ExistsRoleAction($RoleID, $ActionID);
Input
$RoleID (int)
role id
$ActionID (int)
action id
Return
$exists (boolean)
1/0 the RoleAction exists (yes/no)

GetAllPKeyRoleActions

Returns all RoleAction identifiers.

Syntax
$ahRoleActionIDs = GetAllPKeyRoleActions();
Return
$ahRoleActionIDs (reference to array of hashes)
with following keys:
  • RoleID - role id - int
  • ActionID - action id - int

GetInfoRoleActionsByActionID

Returns objects of RoleAction by alternate key ActionID.

Syntax
$ahRoleActions = GetInfoRoleActionsByActionID($ActionID);
Input
$ActionID (int)
action id
Return
$ahRoleActions (reference to array of hashes)
with following keys:
  • RoleID - role id (part of primary key)- int
  • ActionID - action id (part of primary key)- int

GetInfoRoleActionsByRoleID

Returns objects of RoleAction by primary key element RoleID.

Syntax
$ahRoleActions = GetInfoRoleActionsByRoleID($RoleID);
Input
$RoleID (int)
role id
Return
$ahRoleActions (reference to array of hashes)
with following keys:
  • RoleID - role id (part of primary key)- int
  • ActionID - action id (part of primary key)- int

GetPKeyRoleActionsByActionID

Returns primary keys of RoleAction by alternate key ActionID.

Syntax
$ahKeys = GetPKeyRoleActionsByActionID($ActionID);
Input
$ActionID (int)
action id
Return
$ahKeys (reference to array of hashes)
with following keys:
  • RoleID - role id - int
  • ActionID - action id - int

GetPKeyRoleActionsByRoleID

Returns primary keys of RoleAction by primary key element RoleID.

Syntax
$ahKeys = GetPKeyRoleActionsByRoleID($RoleID);
Input
$RoleID (int)
role id
Return
$ahKeys (reference to array of hashes)
with following keys:
  • RoleID - role id - int
  • ActionID - action id - int

InsertRoleAction

Creates an entry of RoleAction.

Syntax
InsertRoleAction($hRoleAction);
Input
$hRoleAction (reference to hash)
with following keys:
  • RoleID - role id (part of primary key)- int
  • ActionID - action id (part of primary key)- int