ePages 6.17.43 - DE_EPAGES/Product/API/Table/ProductManufacturer.pm

Package DE_EPAGES::Product::API::Table::ProductManufacturer

interface for table ProductManufacturer

@EXPORT_OK
InsertProductManufacturer
UpdateProductManufacturer
DeleteProductManufacturer
GetAllPKeyProductManufacturers
GetAllInfoProductManufacturers
GetInfoProductManufacturer
ExistsProductManufacturer
GetPKeyProductManufacturerBySiteID
GetInfoProductManufacturerBySiteID
ExistsProductManufacturerBySiteID
GetPKeyProductManufacturersBySiteID
GetInfoProductManufacturersBySiteID

Functions

DeleteProductManufacturer
ExistsProductManufacturer
ExistsProductManufacturerBySiteID
GetAllInfoProductManufacturers
GetAllPKeyProductManufacturers
GetInfoProductManufacturer
GetInfoProductManufacturerBySiteID
GetInfoProductManufacturersBySiteID
GetPKeyProductManufacturerBySiteID
GetPKeyProductManufacturersBySiteID
InsertProductManufacturer
OnDeleteSite
UpdateProductManufacturer

DeleteProductManufacturer

Deletes a(n) ProductManufacturer.

Syntax
DeleteProductManufacturer($ManufacturerID);
DeleteProductManufacturer($hProductManufacturer); # if $hProductManufacturer includes ManufacturerID
Input
$ManufacturerID (int)
manufacturer identifier (primary key)

ExistsProductManufacturer

Returns true if the ProductManufacturer exists.

Syntax
$exists = ExistsProductManufacturer($ManufacturerID);
Input
$ManufacturerID (int)
manufacturer identifier (primary key)
Return
$exists (boolean)
1/0 the ProductManufacturer exists (yes/no)

ExistsProductManufacturerBySiteID

Returns true if a ProductManufacturer by alternate keys SiteID and Name exists.

Syntax
$ManufacturerID = ExistsProductManufacturerBySiteID($SiteID, $Name);
Input
$SiteID (int)
site id
$Name (varchar(100))
manufacturer name
Return
$exists (boolean)
1/0 the i_siteid_name exists (yes/no)

GetAllInfoProductManufacturers

Returns all objects of ProductManufacturer.

Syntax
$ahProductManufacturers = GetAllInfoProductManufacturers();
Return
$ahProductManufacturers (reference to array of hashes)
with following keys:
  • ManufacturerID - manufacturer identifier (primary key)- int
  • SiteID - site id - int
  • Name - manufacturer name - varchar(100)

GetAllPKeyProductManufacturers

Returns all ProductManufacturer identifiers.

Syntax
$aProductManufacturerIDs = GetAllPKeyProductManufacturers();
Return
$aProductManufacturerIDs (reference to array of int)
manufacturer identifier

GetInfoProductManufacturer

Returns the ProductManufacturer by identifier.

Syntax
$hProductManufacturer = GetInfoProductManufacturer($ManufacturerID);
Input
$ManufacturerID (int)
manufacturer identifier (primary key)
Return
$hProductManufacturer (reference to hash)
with following keys:
  • ManufacturerID - manufacturer identifier (primary key)- int
  • SiteID - site id - int
  • Name - manufacturer name - varchar(100)

GetInfoProductManufacturerBySiteID

Returns the object of ProductManufacturer by alternate keys SiteID and Name.

Syntax
$hProductManufacturer = GetInfoProductManufacturerBySiteID($SiteID, $Name);
Input
$SiteID (int)
site id
$Name (varchar(100))
manufacturer name
Return
$hProductManufacturer (reference to hash)
with following keys:
  • ManufacturerID - manufacturer identifier (primary key)- int
  • SiteID - site id - int
  • Name - manufacturer name - varchar(100)

GetInfoProductManufacturersBySiteID

Returns objects of ProductManufacturer by alternate keys SiteID and Name.

Syntax
$ahProductManufacturers = GetInfoProductManufacturersBySiteID($SiteID, $Name);
Input
$SiteID (int)
site id
$Name (varchar(100))
manufacturer name (optional)
Return
$ahProductManufacturers (reference to array of hashes)
with following keys:
  • ManufacturerID - manufacturer identifier (primary key)- int
  • SiteID - site id - int
  • Name - manufacturer name - varchar(100)

GetPKeyProductManufacturerBySiteID

Returns primary key of ProductManufacturer by alternate keys SiteID and Name.

Syntax
$ManufacturerID = GetPKeyProductManufacturerBySiteID($SiteID, $Name);
Input
$SiteID (int)
site id
$Name (varchar(100))
manufacturer name
Return
$ManufacturerID (int)
manufacturer identifier (primary key)

GetPKeyProductManufacturersBySiteID

Returns primary keys of ProductManufacturer by alternate keys SiteID and Name.

Syntax
$aKeys = GetPKeyProductManufacturersBySiteID($SiteID, $Name);
Input
$SiteID (int)
site id
$Name (varchar(100))
manufacturer name (optional)
Return
$aKeys (reference to array of int)
manufacturer identifier (primary key)

InsertProductManufacturer

Creates an entry of ProductManufacturer.

Syntax
$ManufacturerID = InsertProductManufacturer($hProductManufacturer);
Input
$hProductManufacturer (reference to hash)
with following keys:
  • ManufacturerID - manufacturer identifier (primary key)(optional)- int
  • SiteID - site id - int
  • Name - manufacturer name - varchar(100)
Return
$ManufacturerID (int)
manufacturer identifier (primary key)

OnDeleteSite

Deletes ProductManufacturer of this Site when a Site is deleted.

Syntax
OnDeleteSite($hParams);
Input
$hParams (ref.hash.*)
primary key of object Site, key is
  • SiteID

UpdateProductManufacturer

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

Syntax
UpdateProductManufacturer($ManufacturerID, $hProductManufacturer);
UpdateProductManufacturer($hProductManufacturer); # if $hProductManufacturer includes ManufacturerID
Input
$ManufacturerID (int)
manufacturer identifier (primary key)
$hProductManufacturer (reference to hash)
with following keys:
  • SiteID - site id - int
  • Name - manufacturer name - varchar(100)