Package DE_EPAGES::Presentation::API::Object::Template
object interface for Template.
Base |
DE_EPAGES::Object::API::Object::DALObject |
Functions
- _getDirectTemplateMap
- className
- dbPackage
- existsDirectTemplateMap
- getDefaultTemplateMap
- getDefaultTemplateType
- getDirectTemplateMap
- getTemplateMap
- getTemplateType
- getTemplateTypes
- id
- primaryKey
- setTemplateMap
_getDirectTemplateMap
Returns the direct template map for the template and the given object. Returns undef if nothing was found.
Syntax |
$TemplateMap = $Template->_getDirectTemplateMap($Object); |
Input |
|
Return |
|
className
Returns the class name, used for DAL access.
Syntax |
$ClassName = $Template->className; |
Return |
|
dbPackage
Returns the database package, used for DAL access.
Syntax |
$DbPackage = $Template->dbPackage; |
Return |
|
existsDirectTemplateMap
Returns true if a direct template map exists else false.
Syntax |
$Exists = $Template->existsDirectTemplateMap($Object); |
Input |
|
Return |
|
getDefaultTemplateMap
Returns the default template map for this template.
Syntax |
$TemplateMap = $Template->getDefaultTemplateMap; |
Return |
|
getDefaultTemplateType
Returns the default template type for this template.
Syntax |
$TemplateType = $Template->getDefaultTemplateType; |
Return |
|
getDirectTemplateMap
Returns the direct template map for the template and the given object. Throws an error if nothing was found.
Syntax |
$TemplateMap = $Template->getDirectTemplateMap($Object); |
Input |
|
Return |
|
getTemplateMap
Returns a the template map for a specific object, considers inheritance (e.g. on ProductType or Category trees). If the the presentation has to be customized for this object in particular a direct template map is required. In those cases the method getDirectTemplateMap shall be used!
Syntax |
$TemplateMap = $Template->getTemplateMap($Object); |
Input |
|
Return |
|
getTemplateType
Returns a specific template type for this template.
Syntax |
$TemplateType = $Template->getTemplateType($TemplateTypeAlias); |
Input |
|
Return |
|
getTemplateTypes
Returns all template types for this template.
Syntax |
$aTemplateTypes = $Template->getTemplateTypes; |
Return |
|
id
Returns the Template id.
Syntax |
$TemplateID = $Template->id; |
Return |
|
primaryKey
Returns the name of the primary key.
Syntax |
$PrimaryKey = $Template->primaryKey; |
Return |
|
setTemplateMap
Selects the template type to be used with a given object. If there is already an existing template map it will be deleted before inserting the new one. Omit $TemplateType param if you just want to deleted the existing template map.
Syntax |
$TemplateMap = $Template->setTemplateMap($Object, $TemplateType); |
Input |
|
Return |
|