Package DE_EPAGES::Presentation::API::Object::PageType
object interface for PageType.
Base |
DE_EPAGES::Object::API::Object::Object |
Functions
- basePageType
- basePageTypes
- className
- dbPackage
- deleteTemplate
- directMenus
- directSubPageTypes
- directTemplates
- existsDirectMenu
- existsDirectTemplate
- existsTemplate
- getDirectTemplate
- getDirectTemplates
- getTemplate
- getTemplates
- insertMenu
- insertTemplate
- loginViewAction
- menu
- menus
- setTemplateFile
- setTemplateType
- subPageTypes
- template
- templateType
- templateTypeAlias
- templateTypeFolder
- templateTypeFolders
- templates
- updateTemplate
basePageType
Returns the direct base page type or undef if there is no base page type. Optimized version of $PageType->get('BasePageType')
Syntax |
$BasePageType = $Class->basePageType; |
Return |
|
basePageTypes
Returns all base page types recursively in ascending order, i.e. the main page type (which has no other base page type) is the first array element. This array includes the given page type as last element.
Syntax |
$aBasePageTypes = $PageType->basePageTypes; |
Return |
|
className
Returns the class name, used for DAL access.
Syntax |
$ClassName = $PageType->className; |
Return |
|
dbPackage
Returns the database package, used for DAL access.
Syntax |
$DbPackage = $PageType->dbPackage; |
Return |
|
deleteTemplate
Deletes a template of the page type
Syntax |
$PageType->deleteTemplate( $TemplateName ); |
Input |
|
directMenus
Returns all menus that are directly defined on this page type.
Syntax |
$aMenus = $PageType->directMenus; |
Return |
|
directSubPageTypes
Returns all direct sub page types of a page type (not recursively).
Syntax |
$aSubPageTypes = $PageType->directSubPageTypes; |
Return |
|
directTemplates
Obsolete. Returns all direct templates as a hash of a page type.
Syntax |
$ahTemplates = $PageType->directTemplates; $ahTemplates = $PageType->directTemplates($Object); |
Input |
|
Return |
|
existsDirectMenu
Returns true if the menu is directly defined on this page type.
Syntax |
$Exists = $PageType->existsDirectMenu( $Name ); |
Input |
|
Return |
|
existsDirectTemplate
Returns true if an template with this name exists for this page type and is directly assigned to it.
Syntax |
$Exists = $PageType->existsDirectTemplate( $Name ) |
Example |
if( $PageType->existsDirectTemplate( 'ProviderDefault' ) ) { ... } |
Input |
|
Return |
|
existsTemplate
Returns true if the template exists for this page type
Syntax |
$Exists = $PageType->existsTemplate( $Name ) |
Example |
if( $PageType->existsTemplate( 'ProviderDefault' ) ) { ... } |
Input |
|
Return |
|
getDirectTemplate
Returns the direct template object by its name
Syntax |
$Template = $PageType->getDirectTemplate($Name); |
Input |
|
Return |
|
getDirectTemplates
Returns all direct template objects of the page type.
Syntax |
$aTemplates = $PageType->getDirectTemplates; |
Return |
|
getTemplate
Returns the template object by its name
Syntax |
$Template = $PageType->getTemplate($Name); |
Input |
|
Return |
|
getTemplates
Returns all template objects of the page type.
Syntax |
$aTemplates = $PageType->getTemplates; |
Return |
|
insertMenu
Adds a menu to this page type.
Syntax |
$Menu = $PageType->insertMenu( $hMenu ); |
Input |
|
Return |
|
insertTemplate
Creates a new template for the page type, also creates a template type and the default template map for the root object.
Syntax |
my $Template = $PageType->insertTemplate( $hTemplate ); |
Input |
|
Return |
|
loginViewAction
Returns the view action for the login page using the 'LoginViewAction' attribute. If the current page type returns undef for this attribute, then it's base page type is used.
Syntax |
$LoginViewAction = $PageType->loginViewAction; |
Return |
|
menu
Returns the menu by name.
Syntax |
$Menu = $PageType->menu( $Name ); |
Example |
$Menu = $PageType->menu( 'Tabs' ); |
Input |
|
Return |
|
menus
Returns all menus of this page type, including inherited menus from the base page type.
Syntax |
$aMenus = $PageType->menus; |
Return |
|
setTemplateFile
OBSOLETE! - will be removed with ePages 6.14.0 - use "setTemplateType" instead!
Syntax |
$PageType->setTemplateFile($hTemplate); |
Example |
$PageType->setTemplateFile( { Name => 'Content-Variation', Object => $ProductType, FileName => 'SF/SF-Product.Content-Variation.html', CartridgeID => GetPKeyCartridgeByPackage('DE_EPAGES::Product'), } ); |
Input |
|
setTemplateType
Sets the template type (layout option) for a given object. Reverts to the standard template if no TemplateTypeAlias given Occures an error via templateTypeFolder if no TemplateTypeFolderAlias given
Syntax |
$PageType->setTemplateType( $Object, $TemplateTypeFolderAlias, $TemplateTypeAlias ); |
Example |
$PageType->setTemplateType( $Catalog, 'Content-Base', # i.e. alias of System/PageTypes/SF-Category/TemplateTypes/Content-Base '4_img_img_txt_img', # i.e. alias of System/PageTypes/SF-Category/TemplateTypes/Content-Base/4_img_img_txt_img ); |
Input |
|
subPageTypes
Returns all known sub page types of a page type recursively.
Syntax |
$aSubPageTypes = $PageType->subPageTypes; |
Return |
|
template
Returns information about a template.
Syntax |
$hTemplate = $PageType->template($TemplateName, $Object); |
Input |
|
Return |
|
templateType
Returns the template type object with the given requirements.
Syntax |
$TemplateType = $PageType->templateType( $FolderAlias, $TemplateTypeAlias ); |
Input |
|
Return |
|
templateTypeAlias
gets the active template type (layout option) for a given object and template type folder.
Syntax |
my $TemplateTypeAlias = $PageType->templateTypeAlias( $Object, $TemplateTypeFolderAlias ); |
Example |
my $TemplateTypeAlias = $PageType->templateTypeAlias( $Catalog, 'Content-Base', # i.e. alias of System/PageTypes/SF-Category/TemplateTypes/Content-Base ); |
Input |
|
Return |
|
templateTypeFolder
Returns the requested TemplateTypeFolder object of this PageType.
Syntax |
$TemplateTypeFolder = $PageType->templateTypeFolder( $Alias ); |
Input |
|
Return |
|
templateTypeFolders
Returns all TemplateTypeFolder objects of this PageType.
Syntax |
$aTemplateTypeFolders = $PageType->templateTypeFolders; |
Return |
|
templates
Returns all templates of a page type and object.
Syntax |
$aTemplates = $PageType->templates; $aTemplates = $PageType->templates($Object); |
Input |
|
Return |
|
updateTemplate
OBSOLETE! Updates attributes of a template.
Syntax |
$PageType->updateTemplate( $Name, $Object, $hAttributes); |
Input |
|