ePages 6.10 - DE_EPAGES/Presentation/API/Table/Template.pm

Package DE_EPAGES::Presentation::API::Table::Template

interface for table Template

@EXPORT_OK
InsertTemplate
UpdateTemplate
DeleteTemplate
GetAllPKeyTemplates
GetAllInfoTemplates
GetInfoTemplate
ExistsTemplate
GetPKeyTemplatesByObjectID
GetInfoTemplatesByObjectID
GetPKeyTemplatesByPageTypeID
GetInfoTemplatesByPageTypeID
GetPKeyTemplatesByCartridgeID
GetInfoTemplatesByCartridgeID

Functions

DeleteTemplate
ExistsTemplate
GetAllInfoTemplates
GetAllPKeyTemplates
GetInfoTemplate
GetInfoTemplatesByCartridgeID
GetInfoTemplatesByObjectID
GetInfoTemplatesByPageTypeID
GetPKeyTemplatesByCartridgeID
GetPKeyTemplatesByObjectID
GetPKeyTemplatesByPageTypeID
InsertTemplate
OnDeleteCartridge
OnDeleteObject
UpdateTemplate

DeleteTemplate

Deletes a(n) Template.

Syntax
DeleteTemplate($ObjectID, $PageTypeID, $Name);
DeleteTemplate($hTemplate); # if $hTemplate includes ObjectID, PageTypeID, Name
Input
$ObjectID (int)
object id (part of primary key)
$PageTypeID (int)
page type id (part of primary key)
$Name (varchar(255))
symbolic template name (part of primary key)

ExistsTemplate

Returns true if the Template exists.

Syntax
$exists = ExistsTemplate($ObjectID, $PageTypeID, $Name);
Input
$ObjectID (int)
object id
$PageTypeID (int)
page type id
$Name (varchar(255))
symbolic template name
Return
$exists (boolean)
1/0 the Template exists (yes/no)

GetAllInfoTemplates

Returns all objects of Template.

Syntax
$ahTemplates = GetAllInfoTemplates();
Return
$ahTemplates (reference to array of hashes)
with following keys:
  • ObjectID - object id (part of primary key)- int
  • PageTypeID - page type id (part of primary key)- int
  • Name - symbolic template name (part of primary key)- varchar(255)
  • FileName - template file name - varchar(255)
  • CartridgeID - cartridge id - int

GetAllPKeyTemplates

Returns all Template identifiers.

Syntax
$ahTemplateIDs = GetAllPKeyTemplates();
Return
$ahTemplateIDs (reference to array of hashes)
with following keys:
  • ObjectID - object id - int
  • PageTypeID - page type id - int
  • Name - symbolic template name - varchar(255)

GetInfoTemplate

Returns the Template by identifier.

Syntax
$hTemplate = GetInfoTemplate($ObjectID, $PageTypeID, $Name);
Input
$ObjectID (int)
object id (part of primary key)
$PageTypeID (int)
page type id (part of primary key)
$Name (varchar(255))
symbolic template name (part of primary key)
Return
$hTemplate (reference to hash)
with following keys:
  • ObjectID - object id (part of primary key)- int
  • PageTypeID - page type id (part of primary key)- int
  • Name - symbolic template name (part of primary key)- varchar(255)
  • FileName - template file name - varchar(255)
  • CartridgeID - cartridge id - int

GetInfoTemplatesByCartridgeID

Returns objects of Template by alternate key CartridgeID.

Syntax
$ahTemplates = GetInfoTemplatesByCartridgeID($CartridgeID);
Input
$CartridgeID (int)
cartridge id
Return
$ahTemplates (reference to array of hashes)
with following keys:
  • ObjectID - object id (part of primary key)- int
  • PageTypeID - page type id (part of primary key)- int
  • Name - symbolic template name (part of primary key)- varchar(255)
  • FileName - template file name - varchar(255)
  • CartridgeID - cartridge id - int

GetInfoTemplatesByObjectID

Returns objects of Template by primary key element ObjectID, PageTypeID.

Syntax
$ahTemplates = GetInfoTemplatesByObjectID($ObjectID, $PageTypeID);
Input
$ObjectID (int)
object id
$PageTypeID (int)
page type id (optional)
Return
$ahTemplates (reference to array of hashes)
with following keys:
  • ObjectID - object id (part of primary key)- int
  • PageTypeID - page type id (part of primary key)- int
  • Name - symbolic template name (part of primary key)- varchar(255)
  • FileName - template file name - varchar(255)
  • CartridgeID - cartridge id - int

GetInfoTemplatesByPageTypeID

Returns objects of Template by alternate key PageTypeID.

Syntax
$ahTemplates = GetInfoTemplatesByPageTypeID($PageTypeID);
Input
$PageTypeID (int)
page type id
Return
$ahTemplates (reference to array of hashes)
with following keys:
  • ObjectID - object id (part of primary key)- int
  • PageTypeID - page type id (part of primary key)- int
  • Name - symbolic template name (part of primary key)- varchar(255)
  • FileName - template file name - varchar(255)
  • CartridgeID - cartridge id - int

GetPKeyTemplatesByCartridgeID

Returns primary keys of Template by alternate key CartridgeID.

Syntax
$ahKeys = GetPKeyTemplatesByCartridgeID($CartridgeID);
Input
$CartridgeID (int)
cartridge id
Return
$ahKeys (reference to array of hashes)
with following keys:
  • ObjectID - object id - int
  • PageTypeID - page type id - int
  • Name - symbolic template name - varchar(255)

GetPKeyTemplatesByObjectID

Returns primary keys of Template by primary key element ObjectID, PageTypeID.

Syntax
$ahKeys = GetPKeyTemplatesByObjectID($ObjectID, $PageTypeID);
Input
$ObjectID (int)
object id
$PageTypeID (int)
page type id (optional)
Return
$ahKeys (reference to array of hashes)
with following keys:
  • ObjectID - object id - int
  • PageTypeID - page type id - int
  • Name - symbolic template name - varchar(255)

GetPKeyTemplatesByPageTypeID

Returns primary keys of Template by alternate key PageTypeID.

Syntax
$ahKeys = GetPKeyTemplatesByPageTypeID($PageTypeID);
Input
$PageTypeID (int)
page type id
Return
$ahKeys (reference to array of hashes)
with following keys:
  • ObjectID - object id - int
  • PageTypeID - page type id - int
  • Name - symbolic template name - varchar(255)

InsertTemplate

Creates an entry of Template.

Syntax
InsertTemplate($hTemplate);
Input
$hTemplate (reference to hash)
with following keys:
  • ObjectID - object id (part of primary key)- int
  • PageTypeID - page type id (part of primary key)- int
  • Name - symbolic template name (part of primary key)- varchar(255)
  • FileName - template file name - varchar(255)
  • CartridgeID - cartridge id - int

OnDeleteCartridge

Deletes Template of this model when a(n) Cartridge is deleted.

Syntax
OnDeleteCartridge($hParams);
Input
$hParams (ref.hash.*)
primary key of object Cartridge, key is
  • CartridgeID

OnDeleteObject

Deletes Template of this model when a(n) Object is deleted.

Syntax
OnDeleteObject($hParams);
Input
$hParams (ref.hash.*)
primary key of object Object, key is
  • ObjectID

UpdateTemplate

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

Syntax
UpdateTemplate($ObjectID, $PageTypeID, $Name, $hTemplate);
UpdateTemplate($hTemplate); # if $hTemplate includes ObjectID, PageTypeID, Name
Input
$ObjectID (int)
object id (part of primary key)
$PageTypeID (int)
page type id (part of primary key)
$Name (varchar(255))
symbolic template name (part of primary key)
$hTemplate (reference to hash)
with following keys:
  • FileName - template file name - varchar(255)
  • CartridgeID - cartridge id - int