ePages 6.17.17 - DE_EPAGES/Content/API/Object/Category.pm

Package DE_EPAGES::Content::API::Object::Category

object interface for Category.

Base
DE_EPAGES::Content::API::Object::ContentObject

Functions

clone
createURI
featureName
recursivSubCategories

clone

Inserts a new category object into the database as copy from old category object.

Syntax
$Clone = $Category->clone( $hInfo );
$Clone = $Category->clone( $hInfo, $Recursive );
Input
$hInfo (hash ref)
hash with attribute values that are different in the clone object.
Note that the clone cannot have the same Parent and the same Alias.
$Recursive (boolean)
clone child object too (optional, default is false)
Return
$Clone (object)
the new category object

createURI

Returns a suggestion for a short url.

Syntax
$URI = $Object->createURI($Name, $Parent, $LanguageID);
Input
$Name (string)
Name of category
$Parent (object)
parant object
$LanguageID (integer)
id of language
Return
$URI (string)
suggested URI

featureName

Returns the feature name.

Syntax
$FeatureName = $Category->featureName;
Return
$FeatureName (String)
feature name (undef means no feature count)

recursivSubCategories

Returns all sub categories, recurive depth can limit bei $MaxLevel.

Syntax
$aSubCategories = $category->recursivSubCategories;
Input
$MaxLevel (integer)
maximum depth of category tree
Return
$aSubCategories (reference to array of object)
list of sub categories