ePages 6.11.0 - DE_EPAGES/ShopConfiguration/API/Object/FeatureCollection.pm

Package DE_EPAGES::ShopConfiguration::API::Object::FeatureCollection

object interface for FeatureCollection.

Base
DE_EPAGES::Object::API::Object::Object

Functions

className
dbPackage
exportXMLElements
featureIsVisible
featureMaxValue
testApplyFeatures

className

Returns the class name, used for DAL access.

Syntax
$ClassName = $FeatureCollection->className;
Return
$ClassName (String)
class name

dbPackage

Returns the database package, used for DAL access.

Syntax
$DbPackage = $FeatureCollection->dbPackage;
Return
$DbPackage (String)
database package name

exportXMLElements

Exports xml data of multilinguagal attributes of this object.

Syntax
$Object->exportXMLElements($Driver, $hAllAttributes);
Input
$Driver (object)
export driver
$hAllAttributes (ref.hash)
all attributes of object,
see $Object->allAttributes

featureIsVisible

Returns true if the feature is visible in MBO for this shoptype.

Syntax
$IsVisible = $Collection->featureIsVisible( $FeatureRef );
Input
$FeatureRef (object)
feature object
Return
$IsVisible (boolean)
true if the feature is visible

featureMaxValue

Returns or sets the maximum value of a feature in a feature collection.

Syntax
$MaxValue = $Collection->featureMaxValue( $FeatureRef );
$Collection->featureMaxValue( $FeatureRef, $NewValue, $IsVisible );
Example
my $OldMaxValue = $Collection->featureMaxValue( $FeatureRefProducts );
$Collection->featureMaxValue( $FeatureRefProducts, $OldMaxValue + 10 );
my $NewMaxValue = $Collection->featureMaxValue( $FeatureRefProducts );
Input
$FeatureRef (object)
feature object
$NewValue (int)
maximum allowed value
$IsVisible (boolean)
is visible at shop
Return
$MaxValue (int)
maximum allowed value

testApplyFeatures

Tests if the configured feature set can be applied to all shops that currently use this shop type of feature pack according to the installed license.

Syntax
$hExceedFeatures = $Collection->testApplyFeatures;
Input
$hNewFeatureValues (ref.hash)
feature set as (alias => value) hash
Return
$hExceedFeatures (ref.hash)
exceeded features by value, for example:
{ Pages => 15, Products => 10000 }.
If the hash contains no keys, then the feature set can be applied
with the current license.