Package DE_EPAGES::Content::API::Object::ContentObject
object interface for ContentObject.
Base |
DE_EPAGES::Shop::API::Object::ShopObject |
Functions
- addImageInformations
- canInvalidatePageCache
- className
- clone
- createURI
- dbPackage
- defaultObject
- exportableChildren
- featureName
- getFieldContent
- getImageInfo
- isAllowedChild
- requiredChildClass
- template
- useFilePathPart
addImageInformations
rewrite the JSON attribute ImageInformations for content objects. Should be called by "set" and "clone" functions on the changed content object like products
Syntax |
$Object->addImageInformations($aAllImageAttributes, $hNewValues); |
Input |
|
canInvalidatePageCache
Overwrites method DE_EPAGES::Object::API::Object::Object->canInvalidatePageCache to invalidate page cache.
Syntax |
$CanInvalidate = $Object->canInvalidatePageCache; |
Return |
|
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 |
|
getFieldContent
Returns the value of a text field in product. If a subproduct doesn't define any new value, the value of the master product will be used. LanguageID is optional. It is used to get the translation of the value. This function exists, because ContentObject doesn't have getWithParent, but a unified interface was needed to get a text from a UI Object. See EPC-342
Syntax |
$FieldValue = $Product->getFieldContent($FieldName, $LanguageID); |
Example |
$FieldValue = $Product->getFieldContent('Text', 'de'); $FieldValue = $Product->getFieldContent('Description'); |
Input |
|
Return |
|
getImageInfo
get width, height and size for a filename or filenames.
Syntax |
$hImageInfo = $Object->getImageInfo; |
Input |
|
Return |
|
isAllowedChild
Returns if an Object could be the parent of a PossibleChild.
Syntax |
$isAllowed = $Object->isAllowedChild($PossibleChild); |
Input |
|
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 |
|