Package DE_EPAGES::Presentation::API::Object::PageType
object interface for PageType.
Base |
DE_EPAGES::Object::API::Object::Object |
Functions
- addHelpTopic
- addHelpTopicExt
- basePageTypes
- className
- dbPackage
- deleteTemplate
- directHelpTopics
- directHelpTopicsExt
- directMenus
- directSubPageTypes
- directTemplates
- existsDirectMenu
- existsDirectTemplate
- existsHelpTopic
- existsHelpTopicExt
- existsTemplate
- helpTopics
- helpTopicsExt
- insertMenu
- insertTemplate
- loginViewAction
- menu
- menus
- removeHelpTopic
- removeHelpTopicExt
- setTemplateFile
- setTemplateType
- subPageTypes
- template
- templateType
- templateTypeAlias
- templateTypeFolder
- templateTypeFolders
- templates
- updateHelpTopic
- updateHelpTopicExt
- updateTemplate
addHelpTopic
Assign the specified Helptopic to the PageType
Syntax |
$PageType->addHelpTopic($HelpTopic,$Position); |
Input |
|
addHelpTopicExt
Assign the specified Helptopic to the PageType
Syntax |
$PageType->addHelpTopicExt($HelpTopic,$Position); |
Input |
|
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 and object id
Syntax |
$Deleted = $PageType->deleteTemplate( $Name, $Object ); |
Input |
|
Return |
|
directHelpTopics
Returns all HelpTopics that are directly defined on this page type.
Syntax |
$aHelpTopics = $PageType->directHelpTopics; |
Return |
|
directHelpTopicsExt
Returns all HelpTopicsExt that are directly defined on this page type.
Syntax |
$aHelpTopicsExt = $PageType->directHelpTopicsExt; |
Return |
|
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
Returns all direct templates of a page type.
Syntax |
$aTemplates = $PageType->directTemplates($Object); $aTemplates = $PageType->directTemplates; |
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 and object exists for this page type and is directly assigned to it.
Syntax |
$Exists = $PageType->existsDirectTemplate( $Name,$Object ) $Exists = $PageType->existsDirectTemplate( $Name ) |
Example |
if( $PageType->existsDirectTemplate( 'ProviderDefault', LoadRootObject() ) ) { ... } |
Input |
|
Return |
|
existsHelpTopic
Returns true if the HelpTopic is assigned to this page type.
Syntax |
$Exists = $PageType->existsHelpTopic( $HelpTopic ); |
Input |
|
Return |
|
existsHelpTopicExt
Returns true if the HelpTopic is assigned to this page type.
Syntax |
$Exists = $PageType->existsHelpTopicExt( $HelpTopic ); |
Input |
|
Return |
|
existsTemplate
Returns true if an template with this name and objectid exists for this page type.
Syntax |
$Exists = $PageType->existsTemplate( $Name,$Object ) $Exists = $PageType->existsTemplate( $Name ) |
Example |
if( $PageType->existsTemplate( 'ProviderDefault', LoadRootObject() ) ) { ... } |
Input |
|
Return |
|
helpTopics
Returns all HelpTopics of this page type, including inherited from the base page type.
Syntax |
$aHelpTopics = $PageType->helpTopics; |
Return |
|
helpTopicsExt
Returns all HelpTopicsExt of this page type, including inherited from the base page type.
Syntax |
$aHelpTopicsExt = $PageType->helpTopicsExt; |
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
Syntax |
$PageType->insertTemplate( $hTemplate ); |
Input |
|
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 |
|
removeHelpTopic
remove a specified Helptopic from the PageType
Syntax |
$PageType->removeHelpTopic($HelpTopic); |
Input |
|
removeHelpTopicExt
remove a specified Helptopic from the PageType
Syntax |
$PageType->removeHelpTopicExt($HelpTopic); |
Input |
|
setTemplateFile
Sets the template (layout option) for a given object. Reverts to the standard template if "FileName" is undefined.
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( $Name,$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 all TemplateTypeFolder objects 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($Object); $aTemplates = $PageType->templates; |
Input |
|
Return |
|
updateHelpTopic
Updates the position of a help topic.
Syntax |
$PageType->updateHelpTopic($HelpTopic, { Position => $Position }); |
Input |
|
updateHelpTopicExt
Updates the position of an extended help topic.
Syntax |
$PageType->updateHelpTopicExt($HelpTopic, { Position => $Position }); |
Input |
|
updateTemplate
Updates attributes of a template.
Syntax |
$PageType->updateTemplate( $Name, $Object, $hTemplate); |
Input |
|