ePages 6.11.0 - DE_EPAGES/ShopConfiguration/API/Table/ProviderStore.pm

Package DE_EPAGES::ShopConfiguration::API::Table::ProviderStore

interface for table ProviderStore

@EXPORT_OK
InsertProviderStore
UpdateProviderStore
DeleteProviderStore
GetAllPKeyProviderStores
GetAllInfoProviderStores
GetInfoProviderStore
ExistsProviderStore
GetPKeyProviderStoresByProviderID
GetInfoProviderStoresByProviderID

Functions

DeleteProviderStore
ExistsProviderStore
GetAllInfoProviderStores
GetAllPKeyProviderStores
GetInfoProviderStore
GetInfoProviderStoresByProviderID
GetPKeyProviderStoresByProviderID
InsertProviderStore
OnDeleteStore
UpdateProviderStore

DeleteProviderStore

Deletes a(n) ProviderStore.

Syntax
DeleteProviderStore($StoreID);
DeleteProviderStore($hProviderStore); # if $hProviderStore includes StoreID
Input
$StoreID (integer)
store identifier (primary key)

ExistsProviderStore

Returns true if the ProviderStore exists.

Syntax
$exists = ExistsProviderStore($StoreID);
Input
$StoreID (integer)
store identifier
Return
$exists (boolean)
1/0 the ProviderStore exists (yes/no)

GetAllInfoProviderStores

Returns all objects of ProviderStore.

Syntax
$ahProviderStores = GetAllInfoProviderStores();
Return
$ahProviderStores (reference to array of hashes)
with following keys:
  • StoreID - store identifier (primary key)- integer
  • ProviderID - site id - int

GetAllPKeyProviderStores

Returns all ProviderStore identifiers.

Syntax
$aProviderStoreIDs = GetAllPKeyProviderStores();
Return
$aProviderStoreIDs (reference to array of integer)
store identifier

GetInfoProviderStore

Returns the ProviderStore by identifier.

Syntax
$hProviderStore = GetInfoProviderStore($StoreID);
Input
$StoreID (integer)
store identifier (primary key)
Return
$hProviderStore (reference to hash)
with following keys:
  • StoreID - store identifier (primary key)- integer
  • ProviderID - site id - int

GetInfoProviderStoresByProviderID

Returns objects of ProviderStore by alternate key ProviderID.

Syntax
$ahProviderStores = GetInfoProviderStoresByProviderID($ProviderID);
Input
$ProviderID (int)
site id
Return
$ahProviderStores (reference to array of hashes)
with following keys:
  • StoreID - store identifier (primary key)- integer
  • ProviderID - site id - int

GetPKeyProviderStoresByProviderID

Returns primary keys of ProviderStore by alternate key ProviderID.

Syntax
$aKeys = GetPKeyProviderStoresByProviderID($ProviderID);
Input
$ProviderID (int)
site id
Return
$aKeys (reference to array of integer)
store identifier (primary key)

InsertProviderStore

Creates an entry of ProviderStore.

Syntax
InsertProviderStore($hProviderStore);
Input
$hProviderStore (reference to hash)
with following keys:
  • StoreID - store identifier (primary key)- integer
  • ProviderID - site id - int

OnDeleteStore

Deletes ProviderStore of this model when a(n) Store is deleted.

Syntax
OnDeleteStore($hParams);
Input
$hParams (ref.hash.*)
primary key of object Store, key is
  • StoreID

UpdateProviderStore

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

Syntax
UpdateProviderStore($StoreID, $hProviderStore);
UpdateProviderStore($hProviderStore); # if $hProviderStore includes StoreID
Input
$StoreID (integer)
store identifier (primary key)
$hProviderStore (reference to hash)
with following keys:
  • ProviderID - site id - int
Return
1 (integer)
1