ePages 6.11.0 - DE_EPAGES/Trigger/API/Table/HookFunction.pm

Package DE_EPAGES::Trigger::API::Table::HookFunction

interface for table HookFunction

@EXPORT_OK
InsertHookFunction
UpdateHookFunction
DeleteHookFunction
GetAllPKeyHookFunctions
GetAllInfoHookFunctions
GetInfoHookFunction
ExistsHookFunction
GetPKeyHookFunctionByHookID
GetInfoHookFunctionByHookID
ExistsHookFunctionByHookID
GetPKeyHookFunctionsByHookID
GetInfoHookFunctionsByHookID

Functions

DeleteHookFunction
ExistsHookFunction
ExistsHookFunctionByHookID
GetAllInfoHookFunctions
GetAllPKeyHookFunctions
GetInfoHookFunction
GetInfoHookFunctionByHookID
GetInfoHookFunctionsByHookID
GetPKeyHookFunctionByHookID
GetPKeyHookFunctionsByHookID
InsertHookFunction
UpdateHookFunction

DeleteHookFunction

Deletes a(n) HookFunction.

Syntax
DeleteHookFunction($HookFunctionID);
DeleteHookFunction($hHookFunction); # if $hHookFunction includes HookFunctionID
Input
$HookFunctionID (integer)
identifier, internal key (primary key)

ExistsHookFunction

Returns true if the HookFunction exists.

Syntax
$exists = ExistsHookFunction($HookFunctionID);
Input
$HookFunctionID (integer)
identifier, internal key
Return
$exists (boolean)
1/0 the HookFunction exists (yes/no)

ExistsHookFunctionByHookID

Returns true if a HookFunction by alternate keys HookID and FunctionName exists.

Syntax
$HookFunctionID = ExistsHookFunctionByHookID($HookID, $FunctionName);
Input
$HookID (integer)
hook desciption identifier, dont use this internal key for registration
$FunctionName (varchar(255))
perl package and function name of hook function (TriggerHook calls this functions in order of OrderNo )
Return
$exists (boolean)
1/0 the u_hookfunction_hook exists (yes/no)

GetAllInfoHookFunctions

Returns all objects of HookFunction.

Syntax
$ahHookFunctionIDs = GetAllInfoHookFunctions();
Return
$ahHookFunctionIDs (reference to array of hashes)
with following keys:
  • HookFunctionID - identifier, internal key (primary key)- integer
  • HookID - hook desciption identifier, dont use this internal key for registration - integer
  • OrderNo - order number for hook execution - integer
  • FunctionName - perl package and function name of hook function (TriggerHook calls this functions in order of OrderNo ) - varchar(255)

GetAllPKeyHookFunctions

Returns all HookFunction identifiers.

Syntax
$aHookFunctionIDs = GetAllPKeyHookFunctions();
Return
$aHookFunctionIDs (reference to array of integer)
identifier, internal key

GetInfoHookFunction

Returns the HookFunction by identifier.

Syntax
$hHookFunction = GetInfoHookFunction($HookFunctionID);
Input
$HookFunctionID (integer)
identifier, internal key (primary key)
Return
$hHookFunction (reference to hash)
with following keys:
  • HookFunctionID - identifier, internal key (primary key)- integer
  • HookID - hook desciption identifier, dont use this internal key for registration - integer
  • OrderNo - order number for hook execution - integer
  • FunctionName - perl package and function name of hook function (TriggerHook calls this functions in order of OrderNo ) - varchar(255)

GetInfoHookFunctionByHookID

Returns the object of HookFunction by alternate keys HookID and FunctionName.

Syntax
$hHookFunction = GetInfoHookFunctionByHookID($HookID, $FunctionName);
Input
$HookID (integer)
hook desciption identifier, dont use this internal key for registration
$FunctionName (varchar(255))
perl package and function name of hook function (TriggerHook calls this functions in order of OrderNo )
Return
$hHookFunction (reference to hash)
with following keys:
  • HookFunctionID - identifier, internal key (primary key)- integer
  • HookID - hook desciption identifier, dont use this internal key for registration - integer
  • OrderNo - order number for hook execution - integer
  • FunctionName - perl package and function name of hook function (TriggerHook calls this functions in order of OrderNo ) - varchar(255)

GetInfoHookFunctionsByHookID

Returns objects of HookFunction by alternate keys HookID and FunctionName.

Syntax
$ahHookFunctions = GetInfoHookFunctionsByHookID($HookID, $FunctionName);
Input
$HookID (integer)
hook desciption identifier, dont use this internal key for registration
$FunctionName (varchar(255))
perl package and function name of hook function (TriggerHook calls this functions in order of OrderNo ) (optional)
Return
$ahHookFunctions (reference to array of hashes)
with following keys:
  • HookFunctionID - identifier, internal key (primary key)- integer
  • HookID - hook desciption identifier, dont use this internal key for registration - integer
  • OrderNo - order number for hook execution - integer
  • FunctionName - perl package and function name of hook function (TriggerHook calls this functions in order of OrderNo ) - varchar(255)

GetPKeyHookFunctionByHookID

Returns primary key of HookFunction by alternate keys HookID and FunctionName.

Syntax
$HookFunctionID = GetPKeyHookFunctionByHookID($HookID, $FunctionName);
Input
$HookID (integer)
hook desciption identifier, dont use this internal key for registration
$FunctionName (varchar(255))
perl package and function name of hook function (TriggerHook calls this functions in order of OrderNo )
Return
$HookFunctionID (integer)
identifier, internal key (primary key)

GetPKeyHookFunctionsByHookID

Returns primary keys of HookFunction by alternate keys HookID and FunctionName.

Syntax
$aKeys = GetPKeyHookFunctionsByHookID($HookID, $FunctionName);
Input
$HookID (integer)
hook desciption identifier, dont use this internal key for registration
$FunctionName (varchar(255))
perl package and function name of hook function (TriggerHook calls this functions in order of OrderNo ) (optional)
Return
$aKeys (reference to array of integer)
identifier, internal key (primary key)

InsertHookFunction

Creates an entry of HookFunction.

Syntax
$HookFunctionID = InsertHookFunction($hHookFunction);
Input
$hHookFunction (reference to hash)
with following keys:
  • HookFunctionID - identifier, internal key (primary key)(optional)- integer
  • HookID - hook desciption identifier, dont use this internal key for registration - integer
  • OrderNo - order number for hook execution - integer
  • FunctionName - perl package and function name of hook function (TriggerHook calls this functions in order of OrderNo ) - varchar(255)
Return
$HookFunctionID (integer)
identifier, internal key (primary key)

UpdateHookFunction

Updates a(n) HookFunction if any element was changed.

Syntax
UpdateHookFunction($HookFunctionID, $hHookFunction);
UpdateHookFunction($hHookFunction); # if $hHookFunction includes HookFunctionID
Input
$HookFunctionID (integer)
identifier, internal key (primary key)
$hHookFunction (reference to hash)
with following keys:
  • HookID - hook desciption identifier, dont use this internal key for registration - integer
  • OrderNo - order number for hook execution - integer
  • FunctionName - perl package and function name of hook function (TriggerHook calls this functions in order of OrderNo ) - varchar(255)