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

Package DE_EPAGES::Shop::API::Table::ShopCurrency

interface for table ShopCurrency

@EXPORT_OK
InsertShopCurrency
UpdateShopCurrency
DeleteShopCurrency
GetAllPKeyShopCurrencies
GetAllInfoShopCurrencies
GetInfoShopCurrency
ExistsShopCurrency
GetPKeyShopCurrenciesByShopID
GetInfoShopCurrenciesByShopID
GetPKeyShopCurrenciesByCurrencyID
GetInfoShopCurrenciesByCurrencyID

Functions

DeleteShopCurrency
ExistsShopCurrency
GetAllInfoShopCurrencies
GetAllPKeyShopCurrencies
GetInfoShopCurrenciesByCurrencyID
GetInfoShopCurrenciesByShopID
GetInfoShopCurrency
GetPKeyShopCurrenciesByCurrencyID
GetPKeyShopCurrenciesByShopID
InsertShopCurrency
OnDeleteCurrency
UpdateShopCurrency

DeleteShopCurrency

Deletes a(n) ShopCurrency.

Syntax
DeleteShopCurrency($ShopID, $CurrencyID);
DeleteShopCurrency($hShopCurrency); # if $hShopCurrency includes ShopID, CurrencyID
Input
$ShopID (int)
shop id (part of primary key)
$CurrencyID (char(3))
alpha currency code (ISO 4217) (part of primary key)

ExistsShopCurrency

Returns true if the ShopCurrency exists.

Syntax
$exists = ExistsShopCurrency($ShopID, $CurrencyID);
Input
$ShopID (int)
shop id
$CurrencyID (char(3))
alpha currency code (ISO 4217)
Return
$exists (boolean)
1/0 the ShopCurrency exists (yes/no)

GetAllInfoShopCurrencies

Returns all objects of ShopCurrency.

Syntax
$ahShopCurrencys = GetAllInfoShopCurrencies();
Return
$ahShopCurrencys (reference to array of hashes)
with following keys:
  • ShopID - shop id (part of primary key)- int
  • CurrencyID - alpha currency code (ISO 4217) (part of primary key)- char(3)
  • IsActivated - currency is activated at storefront - bit
  • Position - sort order number - int

GetAllPKeyShopCurrencies

Returns all ShopCurrency identifiers.

Syntax
$ahShopCurrencyIDs = GetAllPKeyShopCurrencies();
Return
$ahShopCurrencyIDs (reference to array of hashes)
with following keys:
  • ShopID - shop id - int
  • CurrencyID - alpha currency code (ISO 4217) - char(3)

GetInfoShopCurrenciesByCurrencyID

Returns objects of ShopCurrency by alternate key CurrencyID.

Syntax
$ahShopCurrencies = GetInfoShopCurrenciesByCurrencyID($CurrencyID);
Input
$CurrencyID (char(3))
alpha currency code (ISO 4217)
Return
$ahShopCurrencies (reference to array of hashes)
with following keys:
  • ShopID - shop id (part of primary key)- int
  • CurrencyID - alpha currency code (ISO 4217) (part of primary key)- char(3)
  • IsActivated - currency is activated at storefront - bit
  • Position - sort order number - int

GetInfoShopCurrenciesByShopID

Returns objects of ShopCurrency by primary key element ShopID.

Syntax
$ahShopCurrencies = GetInfoShopCurrenciesByShopID($ShopID);
Input
$ShopID (int)
shop id
Return
$ahShopCurrencies (reference to array of hashes)
with following keys:
  • ShopID - shop id (part of primary key)- int
  • CurrencyID - alpha currency code (ISO 4217) (part of primary key)- char(3)
  • IsActivated - currency is activated at storefront - bit
  • Position - sort order number - int

GetInfoShopCurrency

Returns the ShopCurrency by identifier.

Syntax
$hShopCurrency = GetInfoShopCurrency($ShopID, $CurrencyID);
Input
$ShopID (int)
shop id (part of primary key)
$CurrencyID (char(3))
alpha currency code (ISO 4217) (part of primary key)
Return
$hShopCurrency (reference to hash)
with following keys:
  • ShopID - shop id (part of primary key)- int
  • CurrencyID - alpha currency code (ISO 4217) (part of primary key)- char(3)
  • IsActivated - currency is activated at storefront - bit
  • Position - sort order number - int

GetPKeyShopCurrenciesByCurrencyID

Returns primary keys of ShopCurrency by alternate key CurrencyID.

Syntax
$ahKeys = GetPKeyShopCurrenciesByCurrencyID($CurrencyID);
Input
$CurrencyID (char(3))
alpha currency code (ISO 4217)
Return
$ahKeys (reference to array of hashes)
with following keys:
  • ShopID - shop id - int
  • CurrencyID - alpha currency code (ISO 4217) - char(3)

GetPKeyShopCurrenciesByShopID

Returns primary keys of ShopCurrency by primary key element ShopID.

Syntax
$ahKeys = GetPKeyShopCurrenciesByShopID($ShopID);
Input
$ShopID (int)
shop id
Return
$ahKeys (reference to array of hashes)
with following keys:
  • ShopID - shop id - int
  • CurrencyID - alpha currency code (ISO 4217) - char(3)

InsertShopCurrency

Creates an entry of ShopCurrency.

Syntax
InsertShopCurrency($hShopCurrency);
Input
$hShopCurrency (reference to hash)
with following keys:
  • ShopID - shop id (part of primary key)- int
  • CurrencyID - alpha currency code (ISO 4217) (part of primary key)- char(3)
  • IsActivated - currency is activated at storefront - bit
  • Position - sort order number - int

OnDeleteCurrency

Deletes ShopCurrency of this model when a(n) Currency is deleted.

Syntax
OnDeleteCurrency($hParams);
Input
$hParams (ref.hash.*)
primary key of object Currency, key is
  • CurrencyID

UpdateShopCurrency

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

Syntax
UpdateShopCurrency($ShopID, $CurrencyID, $hShopCurrency);
UpdateShopCurrency($hShopCurrency); # if $hShopCurrency includes ShopID, CurrencyID
Input
$ShopID (int)
shop id (part of primary key)
$CurrencyID (char(3))
alpha currency code (ISO 4217) (part of primary key)
$hShopCurrency (reference to hash)
with following keys:
  • IsActivated - currency is activated at storefront - bit
  • Position - sort order number - int