ePages 6.0 Patch 6 - DE_EPAGES/Catalog/API/Table/CategoryProductMap.pm

Package DE_EPAGES::Catalog::API::Table::CategoryProductMap

interface for table CategoryProductMap

@EXPORT_OK
InsertCategoryProductMap
UpdateCategoryProductMap
DeleteCategoryProductMap
GetAllPKeyCategoryProductMaps
GetAllInfoCategoryProductMaps
GetInfoCategoryProductMap
ExistsCategoryProductMap
GetPKeyCategoryProductMapByCategoryID
GetInfoCategoryProductMapByCategoryID
ExistsCategoryProductMapByCategoryID
GetPKeyCategoryProductMapsByCategoryID
GetInfoCategoryProductMapsByCategoryID
GetPKeyCategoryProductMapsByProductID
GetInfoCategoryProductMapsByProductID

Functions

DeleteCategoryProductMap
ExistsCategoryProductMap
ExistsCategoryProductMapByCategoryID
GetAllInfoCategoryProductMaps
GetAllPKeyCategoryProductMaps
GetInfoCategoryProductMap
GetInfoCategoryProductMapByCategoryID
GetInfoCategoryProductMapsByCategoryID
GetInfoCategoryProductMapsByProductID
GetPKeyCategoryProductMapByCategoryID
GetPKeyCategoryProductMapsByCategoryID
GetPKeyCategoryProductMapsByProductID
InsertCategoryProductMap
UpdateCategoryProductMap

DeleteCategoryProductMap

Deletes a(n) CategoryProductMap.

Syntax
DeleteCategoryProductMap($CategoryProductMapID);
DeleteCategoryProductMap($hCategoryProductMap); # if $hCategoryProductMap includes CategoryProductMapID
Input
$CategoryProductMapID (int)
categoryproductmap id (primary key)

ExistsCategoryProductMap

Returns true if the CategoryProductMap exists.

Syntax
$exists = ExistsCategoryProductMap($CategoryProductMapID);
Input
$CategoryProductMapID (int)
categoryproductmap id
Return
$exists (boolean)
1/0 the CategoryProductMap exists (yes/no)

ExistsCategoryProductMapByCategoryID

Returns true if a CategoryProductMap by alternate keys CategoryID and ProductID exists.

Syntax
$CategoryProductMapID = ExistsCategoryProductMapByCategoryID($CategoryID, $ProductID);
Input
$CategoryID (int)
category id
$ProductID (int)
product id
Return
$exists (boolean)
1/0 the u_catprod_category exists (yes/no)

GetAllInfoCategoryProductMaps

Returns all objects of CategoryProductMap.

Syntax
$ahCategoryProductMapIDs = GetAllInfoCategoryProductMaps();
Return
$ahCategoryProductMapIDs (reference to array of hashes)
with following keys:
  • CategoryProductMapID - categoryproductmap id (primary key)- int
  • CategoryID - category id - int
  • ProductID - product id - int
  • Position - position of product in category - int

GetAllPKeyCategoryProductMaps

Returns all CategoryProductMap identifiers.

Syntax
$aCategoryProductMapIDs = GetAllPKeyCategoryProductMaps();
Return
$aCategoryProductMapIDs (reference to array of int)
categoryproductmap id

GetInfoCategoryProductMap

Returns the CategoryProductMap by identifier.

Syntax
$hCategoryProductMap = GetInfoCategoryProductMap($CategoryProductMapID);
Input
$CategoryProductMapID (int)
categoryproductmap id (primary key)
Return
$hCategoryProductMap (reference to hash)
with following keys:
  • CategoryProductMapID - categoryproductmap id (primary key)- int
  • CategoryID - category id - int
  • ProductID - product id - int
  • Position - position of product in category - int

GetInfoCategoryProductMapByCategoryID

Returns the object of CategoryProductMap by alternate keys CategoryID and ProductID.

Syntax
$hCategoryProductMap = GetInfoCategoryProductMapByCategoryID($CategoryID, $ProductID);
Input
$CategoryID (int)
category id
$ProductID (int)
product id
Return
$hCategoryProductMap (reference to hash)
with following keys:
  • CategoryProductMapID - categoryproductmap id (primary key)- int
  • CategoryID - category id - int
  • ProductID - product id - int
  • Position - position of product in category - int

GetInfoCategoryProductMapsByCategoryID

Returns objects of CategoryProductMap by alternate keys CategoryID and ProductID.

Syntax
$ahCategoryProductMaps = GetInfoCategoryProductMapsByCategoryID($CategoryID, $ProductID);
Input
$CategoryID (int)
category id
$ProductID (int)
product id (optional)
Return
$ahCategoryProductMaps (reference to array of hashes)
with following keys:
  • CategoryProductMapID - categoryproductmap id (primary key)- int
  • CategoryID - category id - int
  • ProductID - product id - int
  • Position - position of product in category - int

GetInfoCategoryProductMapsByProductID

Returns objects of CategoryProductMap by alternate key ProductID.

Syntax
$ahCategoryProductMaps = GetInfoCategoryProductMapsByProductID($ProductID);
Input
$ProductID (int)
product id
Return
$ahCategoryProductMaps (reference to array of hashes)
with following keys:
  • CategoryProductMapID - categoryproductmap id (primary key)- int
  • CategoryID - category id - int
  • ProductID - product id - int
  • Position - position of product in category - int

GetPKeyCategoryProductMapByCategoryID

Returns primary key of CategoryProductMap by alternate keys CategoryID and ProductID.

Syntax
$CategoryProductMapID = GetPKeyCategoryProductMapByCategoryID($CategoryID, $ProductID);
Input
$CategoryID (int)
category id
$ProductID (int)
product id
Return
$CategoryProductMapID (int)
categoryproductmap id (primary key)

GetPKeyCategoryProductMapsByCategoryID

Returns primary keys of CategoryProductMap by alternate keys CategoryID and ProductID.

Syntax
$aKeys = GetPKeyCategoryProductMapsByCategoryID($CategoryID, $ProductID);
Input
$CategoryID (int)
category id
$ProductID (int)
product id (optional)
Return
$aKeys (reference to array of int)
categoryproductmap id (primary key)

GetPKeyCategoryProductMapsByProductID

Returns primary keys of CategoryProductMap by alternate key ProductID.

Syntax
$aKeys = GetPKeyCategoryProductMapsByProductID($ProductID);
Input
$ProductID (int)
product id
Return
$aKeys (reference to array of int)
categoryproductmap id (primary key)

InsertCategoryProductMap

Creates an entry of CategoryProductMap.

Syntax
$CategoryProductMapID = InsertCategoryProductMap($hCategoryProductMap);
Input
$hCategoryProductMap (reference to hash)
with following keys:
  • CategoryProductMapID - categoryproductmap id (primary key)(optional)- int
  • CategoryID - category id - int
  • ProductID - product id - int
  • Position - position of product in category - int
Return
$CategoryProductMapID (int)
categoryproductmap id (primary key)

UpdateCategoryProductMap

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

Syntax
UpdateCategoryProductMap($CategoryProductMapID, $hCategoryProductMap);
UpdateCategoryProductMap($hCategoryProductMap); # if $hCategoryProductMap includes CategoryProductMapID
Input
$CategoryProductMapID (int)
categoryproductmap id (primary key)
$hCategoryProductMap (reference to hash)
with following keys:
  • CategoryID - category id - int
  • ProductID - product id - int
  • Position - position of product in category - int