Package DE_EPAGES::Content::API::Object::ContentObject
object interface for ContentObject.
Base |
DE_EPAGES::Object::API::Object::Object |
Functions
- className
- clone
- createURI
- dbPackage
- defaultObject
- exportableChildren
- featureName
- invalidatePageCache
- isAllowedChild
- requiredChildClass
- template
- useFilePathPart
className
Returns the class name, used for DAL access.
Syntax |
$ClassName = $ContentObject->className; |
Return |
|
clone
Inserts a new object into the database as copy from old object.
Syntax |
$Clone = $Object->clone( $hInfo ); $Clone = $Object->clone( $hInfo, $Recursive ); |
Input |
|
Return |
|
createURI
Returns a suggestion for a short url.
Syntax |
$URI = $Object->createURI($Name, $Parent, $LanguageID); |
Input |
|
Return |
|
dbPackage
Returns the database package, used for DAL access.
Syntax |
$DbPackage = $ContentObject->dbPackage; |
Return |
|
defaultObject
Returns the default object (has to be overwritten for products with variation).
Syntax |
$ContentObject = $Object->defaultObject(); |
Return |
|
exportableChildren
Returns all children of the object which should be exported.
Syntax |
$aChildren = $Object->exportableChildren |
Example |
$Description = $Object->exportableChildren; |
Return |
|
featureName
Returns the feature name.
Syntax |
$FeatureName = $Forum->featureName; |
Return |
|
invalidatePageCache
Invalidates page cache (mark at site).
Syntax |
$Object->invalidatePageCache; |
isAllowedChild
Returns if an Object could be the parent of a PossibleChild.
Syntax |
$isAllowed = $Object->isAllowedChild($PossibleChild); |
Return |
|
requiredChildClass
Returns the name of the class a new child is required to be an instance of or undef if no class is allowed (no children).
Syntax |
$RequiredChildClass = $ContentObject->requiredChildClass; |
Return |
|
template
This function is used to overwrite the given template for the purpose that each content object can defined there own template (visualisation).
Syntax |
$Name = $Object->template($Name, $ObjectPageType); |
Input |
|
Return |
|
useFilePathPart
Use FilePathPart for content objects.
Syntax |
$useFilePathPart = $Object->useFilePathPart; |
Return |
|