ePages 6.17.52 - DE_EPAGES/CrossSelling/API/Table/AutoCrossSelling.pm

Package DE_EPAGES::CrossSelling::API::Table::AutoCrossSelling

interface for table AutoCrossSelling

@EXPORT_OK
InsertAutoCrossSelling
UpdateAutoCrossSelling
DeleteAutoCrossSelling
GetAllPKeyAutoCrossSellings
GetAllInfoAutoCrossSellings
GetInfoAutoCrossSelling
ExistsAutoCrossSelling
GetPKeyAutoCrossSellingsByProductID1
GetInfoAutoCrossSellingsByProductID1
GetPKeyAutoCrossSellingsByProductID2
GetInfoAutoCrossSellingsByProductID2
GetAllInfoAutoCrossSellingsByShopID

Functions

DeleteAutoCrossSelling
ExistsAutoCrossSelling
GetAllInfoAutoCrossSellings
GetAllInfoAutoCrossSellingsByShopID
GetAllPKeyAutoCrossSellings
GetInfoAutoCrossSelling
GetInfoAutoCrossSellingsByProductID1
GetInfoAutoCrossSellingsByProductID2
GetPKeyAutoCrossSellingsByProductID1
GetPKeyAutoCrossSellingsByProductID2
InsertAutoCrossSelling
UpdateAutoCrossSelling

DeleteAutoCrossSelling

Deletes a(n) AutoCrossSelling.

Syntax
DeleteAutoCrossSelling($ProductID1, $ProductID2);
DeleteAutoCrossSelling($hAutoCrossSelling); # if $hAutoCrossSelling includes ProductID1, ProductID2
Input
$ProductID1 (int)
product id 1 (part of primary key)
$ProductID2 (int)
product id 2 (part of primary key)

ExistsAutoCrossSelling

Returns true if the AutoCrossSelling exists.

Syntax
$exists = ExistsAutoCrossSelling($ProductID1, $ProductID2);
Input
$ProductID1 (int)
product id 1 (part of primary key)
$ProductID2 (int)
product id 2 (part of primary key)
Return
$exists (boolean)
1/0 the AutoCrossSelling exists (yes/no)

GetAllInfoAutoCrossSellings

Returns all objects of AutoCrossSelling.

Syntax
$ahAutoCrossSellings = GetAllInfoAutoCrossSellings();
Return
$ahAutoCrossSellings (reference to array of hashes)
with following keys:
  • ProductID1 - product id 1 (part of primary key)- int
  • ProductID2 - product id 2 (part of primary key)- int
  • Counter - correlation counter - int

GetAllInfoAutoCrossSellingsByShopID

Returns an iterator on auto cross-sellings that exist for the given shop.

Syntax
$Iterator = GetAllInfoAutoCrossSellingsByShopID($ShopID);
Example
my $Shop = LoadObjectByPath('/Shops/DemoShop');
my $Iterator = GetAllInfoAutoCrossSellingsByShopID($Shop->id);
while (my $hInfoAutoCrossSellings = <$Iterator>) {
   print $hInfoAutoCrossSellings->{$_}
     foreach (keys %{ $hInfoAutoCrossSelling });
}
Input
$ShopID (int)
shop id
Return
$Iterator (Iterator of reference of hashes)
iterator object with elements:
  • ProductID1 - product id 1 (part of primary key)- int
  • ProductID2 - product id 2 (part of primary key)- int
  • Counter - correlation counter - int

GetAllPKeyAutoCrossSellings

Returns all AutoCrossSelling identifiers.

Syntax
$ahAutoCrossSellingIDs = GetAllPKeyAutoCrossSellings();
Return
$ahAutoCrossSellingIDs (reference to array of hashes)
with following keys:
  • ProductID1 - product id 1 (part of primary key)- int
  • ProductID2 - product id 2 (part of primary key)- int

GetInfoAutoCrossSelling

Returns the AutoCrossSelling by identifier.

Syntax
$hAutoCrossSelling = GetInfoAutoCrossSelling($ProductID1, $ProductID2);
Input
$ProductID1 (int)
product id 1 (part of primary key)
$ProductID2 (int)
product id 2 (part of primary key)
Return
$hAutoCrossSelling (reference to hash)
with following keys:
  • ProductID1 - product id 1 (part of primary key)- int
  • ProductID2 - product id 2 (part of primary key)- int
  • Counter - correlation counter - int

GetInfoAutoCrossSellingsByProductID1

Returns objects of AutoCrossSelling by primary key element ProductID1.

Syntax
$ahAutoCrossSellings = GetInfoAutoCrossSellingsByProductID1($ProductID1);
Input
$ProductID1 (int)
product id 1
Return
$ahAutoCrossSellings (reference to array of hashes)
with following keys:
  • ProductID1 - product id 1 (part of primary key)- int
  • ProductID2 - product id 2 (part of primary key)- int
  • Counter - correlation counter - int

GetInfoAutoCrossSellingsByProductID2

Returns objects of AutoCrossSelling by alternate key ProductID2.

Syntax
$ahAutoCrossSellings = GetInfoAutoCrossSellingsByProductID2($ProductID2);
Input
$ProductID2 (int)
product id 2
Return
$ahAutoCrossSellings (reference to array of hashes)
with following keys:
  • ProductID1 - product id 1 (part of primary key)- int
  • ProductID2 - product id 2 (part of primary key)- int
  • Counter - correlation counter - int

GetPKeyAutoCrossSellingsByProductID1

Returns primary keys of AutoCrossSelling by primary key element ProductID1.

Syntax
$ahKeys = GetPKeyAutoCrossSellingsByProductID1($ProductID1);
Input
$ProductID1 (int)
product id 1
Return
$ahKeys (reference to array of hashes)
with following keys:
  • ProductID1 - product id 1 (part of primary key)- int
  • ProductID2 - product id 2 (part of primary key)- int

GetPKeyAutoCrossSellingsByProductID2

Returns primary keys of AutoCrossSelling by alternate key ProductID2.

Syntax
$ahKeys = GetPKeyAutoCrossSellingsByProductID2($ProductID2);
Input
$ProductID2 (int)
product id 2
Return
$ahKeys (reference to array of hashes)
with following keys:
  • ProductID1 - product id 1 (part of primary key)- int
  • ProductID2 - product id 2 (part of primary key)- int

InsertAutoCrossSelling

Creates an entry of AutoCrossSelling.

Syntax
InsertAutoCrossSelling($hAutoCrossSelling);
Input
$hAutoCrossSelling (reference to hash)
with following keys:
  • ProductID1 - product id 1 (part of primary key)- int
  • ProductID2 - product id 2 (part of primary key)- int
  • Counter - correlation counter - int

UpdateAutoCrossSelling

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

Syntax
UpdateAutoCrossSelling($ProductID1, $ProductID2, $hAutoCrossSelling);
UpdateAutoCrossSelling($hAutoCrossSelling); # if $hAutoCrossSelling includes ProductID1, ProductID2
Input
$ProductID1 (int)
product id 1 (part of primary key)
$ProductID2 (int)
product id 2 (part of primary key)
$hAutoCrossSelling (reference to hash)
with following keys:
  • Counter - correlation counter - int
Return
1 (int)
1