ePages 6.11.0 - DE_EPAGES/Shop/API/Table/ShopFeature.pm

Package DE_EPAGES::Shop::API::Table::ShopFeature

interface for table ShopFeature

@EXPORT_OK
InsertShopFeature
UpdateShopFeature
DeleteShopFeature
GetAllPKeyShopFeatures
GetAllInfoShopFeatures
GetInfoShopFeature
ExistsShopFeature
GetPKeyShopFeaturesByShopID
GetInfoShopFeaturesByShopID
GetPKeyShopFeaturesByFeatureID
GetInfoShopFeaturesByFeatureID

Functions

DeleteShopFeature
ExistsShopFeature
GetAllInfoShopFeatures
GetAllPKeyShopFeatures
GetInfoShopFeature
GetInfoShopFeaturesByFeatureID
GetInfoShopFeaturesByShopID
GetPKeyShopFeaturesByFeatureID
GetPKeyShopFeaturesByShopID
InsertShopFeature
OnDeleteShop
UpdateShopFeature

DeleteShopFeature

Deletes a(n) ShopFeature.

Syntax
DeleteShopFeature($ShopID, $FeatureID);
DeleteShopFeature($hShopFeature); # if $hShopFeature includes ShopID, FeatureID
Input
$ShopID (int)
shop id (part of primary key)
$FeatureID (int)
feature id (part of primary key)

ExistsShopFeature

Returns true if the ShopFeature exists.

Syntax
$exists = ExistsShopFeature($ShopID, $FeatureID);
Input
$ShopID (int)
shop id
$FeatureID (int)
feature id
Return
$exists (boolean)
1/0 the ShopFeature exists (yes/no)

GetAllInfoShopFeatures

Returns all objects of ShopFeature.

Syntax
$ahShopFeatures = GetAllInfoShopFeatures();
Return
$ahShopFeatures (reference to array of hashes)
with following keys:
  • ShopID - shop id (part of primary key)- int
  • FeatureID - feature id (part of primary key)- int
  • MaxValue - maximum feature value - int
  • CurrentValue - current feature value - int
  • IsVisible - is visible at mbo - bit
  • IsDirty - mark that feature map as possible dirty - bit

GetAllPKeyShopFeatures

Returns all ShopFeature identifiers.

Syntax
$ahShopFeatureIDs = GetAllPKeyShopFeatures();
Return
$ahShopFeatureIDs (reference to array of hashes)
with following keys:
  • ShopID - shop id - int
  • FeatureID - feature id - int

GetInfoShopFeature

Returns the ShopFeature by identifier.

Syntax
$hShopFeature = GetInfoShopFeature($ShopID, $FeatureID);
Input
$ShopID (int)
shop id (part of primary key)
$FeatureID (int)
feature id (part of primary key)
Return
$hShopFeature (reference to hash)
with following keys:
  • ShopID - shop id (part of primary key)- int
  • FeatureID - feature id (part of primary key)- int
  • MaxValue - maximum feature value - int
  • CurrentValue - current feature value - int
  • IsVisible - is visible at mbo - bit
  • IsDirty - mark that feature map as possible dirty - bit

GetInfoShopFeaturesByFeatureID

Returns objects of ShopFeature by alternate key FeatureID.

Syntax
$ahShopFeatures = GetInfoShopFeaturesByFeatureID($FeatureID);
Input
$FeatureID (int)
feature id
Return
$ahShopFeatures (reference to array of hashes)
with following keys:
  • ShopID - shop id (part of primary key)- int
  • FeatureID - feature id (part of primary key)- int
  • MaxValue - maximum feature value - int
  • CurrentValue - current feature value - int
  • IsVisible - is visible at mbo - bit
  • IsDirty - mark that feature map as possible dirty - bit

GetInfoShopFeaturesByShopID

Returns objects of ShopFeature by primary key element ShopID.

Syntax
$ahShopFeatures = GetInfoShopFeaturesByShopID($ShopID);
Input
$ShopID (int)
shop id
Return
$ahShopFeatures (reference to array of hashes)
with following keys:
  • ShopID - shop id (part of primary key)- int
  • FeatureID - feature id (part of primary key)- int
  • MaxValue - maximum feature value - int
  • CurrentValue - current feature value - int
  • IsVisible - is visible at mbo - bit
  • IsDirty - mark that feature map as possible dirty - bit

GetPKeyShopFeaturesByFeatureID

Returns primary keys of ShopFeature by alternate key FeatureID.

Syntax
$ahKeys = GetPKeyShopFeaturesByFeatureID($FeatureID);
Input
$FeatureID (int)
feature id
Return
$ahKeys (reference to array of hashes)
with following keys:
  • ShopID - shop id - int
  • FeatureID - feature id - int

GetPKeyShopFeaturesByShopID

Returns primary keys of ShopFeature by primary key element ShopID.

Syntax
$ahKeys = GetPKeyShopFeaturesByShopID($ShopID);
Input
$ShopID (int)
shop id
Return
$ahKeys (reference to array of hashes)
with following keys:
  • ShopID - shop id - int
  • FeatureID - feature id - int

InsertShopFeature

Creates an entry of ShopFeature.

Syntax
InsertShopFeature($hShopFeature);
Input
$hShopFeature (reference to hash)
with following keys:
  • ShopID - shop id (part of primary key)- int
  • FeatureID - feature id (part of primary key)- int
  • MaxValue - maximum feature value - int
  • CurrentValue - current feature value - int
  • IsVisible - is visible at mbo - bit
  • IsDirty - mark that feature map as possible dirty - bit

OnDeleteShop

Deletes ShopFeature of this model when a(n) Shop is deleted.

Syntax
OnDeleteShop($hParams);
Input
$hParams (ref.hash.*)
primary key of object Shop, key is
  • ShopID

UpdateShopFeature

Updates a(n) ShopFeature if any element was changed.

Syntax
UpdateShopFeature($ShopID, $FeatureID, $hShopFeature);
UpdateShopFeature($hShopFeature); # if $hShopFeature includes ShopID, FeatureID
Input
$ShopID (int)
shop id (part of primary key)
$FeatureID (int)
feature id (part of primary key)
$hShopFeature (reference to hash)
with following keys:
  • MaxValue - maximum feature value - int
  • CurrentValue - current feature value - int
  • IsVisible - is visible at mbo - bit
  • IsDirty - mark that feature map as possible dirty - bit