ePages 6.11.0 - DE_EPAGES/Presentation/API/Table/FormLoop.pm

Package DE_EPAGES::Presentation::API::Table::FormLoop

interface for table FormLoop

@EXPORT_OK
InsertFormLoop
UpdateFormLoop
DeleteFormLoop
GetAllPKeyFormLoops
GetAllInfoFormLoops
GetInfoFormLoop
ExistsFormLoop
GetPKeyFormLoopByFormID
GetInfoFormLoopByFormID
ExistsFormLoopByFormID
GetPKeyFormLoopsByFormID
GetInfoFormLoopsByFormID

Functions

DeleteFormLoop
ExistsFormLoop
ExistsFormLoopByFormID
GetAllInfoFormLoops
GetAllPKeyFormLoops
GetInfoFormLoop
GetInfoFormLoopByFormID
GetInfoFormLoopsByFormID
GetPKeyFormLoopByFormID
GetPKeyFormLoopsByFormID
InsertFormLoop
UpdateFormLoop

DeleteFormLoop

Deletes a(n) FormLoop.

Syntax
DeleteFormLoop($LoopID);
DeleteFormLoop($hFormLoop); # if $hFormLoop includes LoopID
Input
$LoopID (int)
form loop identifier (primary key)

ExistsFormLoop

Returns true if the FormLoop exists.

Syntax
$exists = ExistsFormLoop($LoopID);
Input
$LoopID (int)
form loop identifier
Return
$exists (boolean)
1/0 the FormLoop exists (yes/no)

ExistsFormLoopByFormID

Returns true if a FormLoop by alternate keys FormID and Name exists.

Syntax
$LoopID = ExistsFormLoopByFormID($FormID, $Name);
Input
$FormID (int)
form id
$Name (varchar(255))
name of form loop
Return
$exists (boolean)
1/0 the u_formloop_form exists (yes/no)

GetAllInfoFormLoops

Returns all objects of FormLoop.

Syntax
$ahFormLoops = GetAllInfoFormLoops();
Return
$ahFormLoops (reference to array of hashes)
with following keys:
  • LoopID - form loop identifier (primary key)- int
  • FormID - form id - int
  • Name - name of form loop - varchar(255)
  • MinCount - count of minimum form elements needed - int

GetAllPKeyFormLoops

Returns all FormLoop identifiers.

Syntax
$aFormLoopIDs = GetAllPKeyFormLoops();
Return
$aFormLoopIDs (reference to array of int)
form loop identifier

GetInfoFormLoop

Returns the FormLoop by identifier.

Syntax
$hFormLoop = GetInfoFormLoop($LoopID);
Input
$LoopID (int)
form loop identifier (primary key)
Return
$hFormLoop (reference to hash)
with following keys:
  • LoopID - form loop identifier (primary key)- int
  • FormID - form id - int
  • Name - name of form loop - varchar(255)
  • MinCount - count of minimum form elements needed - int

GetInfoFormLoopByFormID

Returns the object of FormLoop by alternate keys FormID and Name.

Syntax
$hFormLoop = GetInfoFormLoopByFormID($FormID, $Name);
Input
$FormID (int)
form id
$Name (varchar(255))
name of form loop
Return
$hFormLoop (reference to hash)
with following keys:
  • LoopID - form loop identifier (primary key)- int
  • FormID - form id - int
  • Name - name of form loop - varchar(255)
  • MinCount - count of minimum form elements needed - int

GetInfoFormLoopsByFormID

Returns objects of FormLoop by alternate keys FormID and Name.

Syntax
$ahFormLoops = GetInfoFormLoopsByFormID($FormID, $Name);
Input
$FormID (int)
form id
$Name (varchar(255))
name of form loop (optional)
Return
$ahFormLoops (reference to array of hashes)
with following keys:
  • LoopID - form loop identifier (primary key)- int
  • FormID - form id - int
  • Name - name of form loop - varchar(255)
  • MinCount - count of minimum form elements needed - int

GetPKeyFormLoopByFormID

Returns primary key of FormLoop by alternate keys FormID and Name.

Syntax
$LoopID = GetPKeyFormLoopByFormID($FormID, $Name);
Input
$FormID (int)
form id
$Name (varchar(255))
name of form loop
Return
$LoopID (int)
form loop identifier (primary key)

GetPKeyFormLoopsByFormID

Returns primary keys of FormLoop by alternate keys FormID and Name.

Syntax
$aKeys = GetPKeyFormLoopsByFormID($FormID, $Name);
Input
$FormID (int)
form id
$Name (varchar(255))
name of form loop (optional)
Return
$aKeys (reference to array of int)
form loop identifier (primary key)

InsertFormLoop

Creates an entry of FormLoop.

Syntax
$LoopID = InsertFormLoop($hFormLoop);
Input
$hFormLoop (reference to hash)
with following keys:
  • LoopID - form loop identifier (primary key)(optional)- int
  • FormID - form id - int
  • Name - name of form loop - varchar(255)
  • MinCount - count of minimum form elements needed - int
Return
$LoopID (int)
form loop identifier (primary key)

UpdateFormLoop

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

Syntax
UpdateFormLoop($LoopID, $hFormLoop);
UpdateFormLoop($hFormLoop); # if $hFormLoop includes LoopID
Input
$LoopID (int)
form loop identifier (primary key)
$hFormLoop (reference to hash)
with following keys:
  • FormID - form id - int
  • Name - name of form loop - varchar(255)
  • MinCount - count of minimum form elements needed - int
Return
1 (int)
1