ePages 6.14.0 - DE_EPAGES/MeinPaket/API/Table/MeinPaketSite.pm

Package DE_EPAGES::MeinPaket::API::Table::MeinPaketSite

interface for table MeinPaketSite

@EXPORT_OK
InsertMeinPaketSite
UpdateMeinPaketSite
DeleteMeinPaketSite
GetAllPKeyMeinPaketSites
GetAllInfoMeinPaketSites
GetInfoMeinPaketSite
ExistsMeinPaketSite
GetPKeyMeinPaketSiteByAlias
GetInfoMeinPaketSiteByAlias
ExistsMeinPaketSiteByAlias
GetPKeyMeinPaketSitesByAlias
GetInfoMeinPaketSitesByAlias

Functions

DeleteMeinPaketSite
ExistsMeinPaketSite
ExistsMeinPaketSiteByAlias
GetAllInfoMeinPaketSites
GetAllPKeyMeinPaketSites
GetInfoMeinPaketSite
GetInfoMeinPaketSiteByAlias
GetInfoMeinPaketSitesByAlias
GetPKeyMeinPaketSiteByAlias
GetPKeyMeinPaketSitesByAlias
InsertMeinPaketSite
UpdateMeinPaketSite

DeleteMeinPaketSite

Deletes a(n) MeinPaketSite.

Syntax
DeleteMeinPaketSite($MeinPaketSiteID);
DeleteMeinPaketSite($hMeinPaketSite); # if $hMeinPaketSite includes MeinPaketSiteID
Input
$MeinPaketSiteID (int)
MeinPaket Site identifier (primary key)

ExistsMeinPaketSite

Returns true if the MeinPaketSite exists.

Syntax
$exists = ExistsMeinPaketSite($MeinPaketSiteID);
Input
$MeinPaketSiteID (int)
MeinPaket Site identifier
Return
$exists (boolean)
1/0 the MeinPaketSite exists (yes/no)

ExistsMeinPaketSiteByAlias

Returns true if a MeinPaketSite by alternate key Alias exists.

Syntax
$MeinPaketSiteID = ExistsMeinPaketSiteByAlias($Alias);
Input
$Alias (varchar(255))
Alias of MeinPaket Environment
Return
$exists (boolean)
1/0 the u_meinpaketsite_alias exists (yes/no)

GetAllInfoMeinPaketSites

Returns all objects of MeinPaketSite.

Syntax
$ahMeinPaketSites = GetAllInfoMeinPaketSites();
Return
$ahMeinPaketSites (reference to array of hashes)
with following keys:
  • MeinPaketSiteID - MeinPaket Site identifier (primary key)- int
  • CategoryListIsUpdating - True if categories are being updated - bit
  • CategoryListVersionHash - VersionHash of Category List (optional)- varchar(32)
  • CategoryListUpdateTime - Date of last Update of MeinPaket Category List (optional)- datetime
  • CategoryListCount - Number of Categories in MeinPaket Category List (optional)- int
  • Alias - Alias of MeinPaket Environment - varchar(255)

GetAllPKeyMeinPaketSites

Returns all MeinPaketSite identifiers.

Syntax
$aMeinPaketSiteIDs = GetAllPKeyMeinPaketSites();
Return
$aMeinPaketSiteIDs (reference to array of int)
MeinPaket Site identifier

GetInfoMeinPaketSite

Returns the MeinPaketSite by identifier.

Syntax
$hMeinPaketSite = GetInfoMeinPaketSite($MeinPaketSiteID);
Input
$MeinPaketSiteID (int)
MeinPaket Site identifier (primary key)
Return
$hMeinPaketSite (reference to hash)
with following keys:
  • MeinPaketSiteID - MeinPaket Site identifier (primary key)- int
  • CategoryListIsUpdating - True if categories are being updated - bit
  • CategoryListVersionHash - VersionHash of Category List (optional)- varchar(32)
  • CategoryListUpdateTime - Date of last Update of MeinPaket Category List (optional)- datetime
  • CategoryListCount - Number of Categories in MeinPaket Category List (optional)- int
  • Alias - Alias of MeinPaket Environment - varchar(255)

GetInfoMeinPaketSiteByAlias

Returns the object of MeinPaketSite by alternate key Alias.

Syntax
$hMeinPaketSite = GetInfoMeinPaketSiteByAlias($Alias);
Input
$Alias (varchar(255))
Alias of MeinPaket Environment
Return
$hMeinPaketSite (reference to hash)
with following keys:
  • MeinPaketSiteID - MeinPaket Site identifier (primary key)- int
  • CategoryListIsUpdating - True if categories are being updated - bit
  • CategoryListVersionHash - VersionHash of Category List (optional)- varchar(32)
  • CategoryListUpdateTime - Date of last Update of MeinPaket Category List (optional)- datetime
  • CategoryListCount - Number of Categories in MeinPaket Category List (optional)- int
  • Alias - Alias of MeinPaket Environment - varchar(255)

GetInfoMeinPaketSitesByAlias

Returns objects of MeinPaketSite by alternate key Alias.

Syntax
$ahMeinPaketSites = GetInfoMeinPaketSitesByAlias($Alias);
Input
$Alias (varchar(255))
Alias of MeinPaket Environment
Return
$ahMeinPaketSites (reference to array of hashes)
with following keys:
  • MeinPaketSiteID - MeinPaket Site identifier (primary key)- int
  • CategoryListIsUpdating - True if categories are being updated - bit
  • CategoryListVersionHash - VersionHash of Category List (optional)- varchar(32)
  • CategoryListUpdateTime - Date of last Update of MeinPaket Category List (optional)- datetime
  • CategoryListCount - Number of Categories in MeinPaket Category List (optional)- int
  • Alias - Alias of MeinPaket Environment - varchar(255)

GetPKeyMeinPaketSiteByAlias

Returns primary key of MeinPaketSite by alternate key Alias.

Syntax
$MeinPaketSiteID = GetPKeyMeinPaketSiteByAlias($Alias);
Input
$Alias (varchar(255))
Alias of MeinPaket Environment
Return
$MeinPaketSiteID (int)
MeinPaket Site identifier (primary key)

GetPKeyMeinPaketSitesByAlias

Returns primary keys of MeinPaketSite by alternate key Alias.

Syntax
$aKeys = GetPKeyMeinPaketSitesByAlias($Alias);
Input
$Alias (varchar(255))
Alias of MeinPaket Environment
Return
$aKeys (reference to array of int)
MeinPaket Site identifier (primary key)

InsertMeinPaketSite

Creates an entry of MeinPaketSite.

Syntax
InsertMeinPaketSite($hMeinPaketSite);
Input
$hMeinPaketSite (reference to hash)
with following keys:
  • MeinPaketSiteID - MeinPaket Site identifier (primary key)(optional)- int
  • CategoryListIsUpdating - True if categories are being updated - bit
  • CategoryListVersionHash - VersionHash of Category List (optional)- varchar(32)
  • CategoryListUpdateTime - Date of last Update of MeinPaket Category List (optional)- datetime
  • CategoryListCount - Number of Categories in MeinPaket Category List (optional)- int
  • Alias - Alias of MeinPaket Environment - varchar(255)

UpdateMeinPaketSite

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

Syntax
UpdateMeinPaketSite($MeinPaketSiteID, $hMeinPaketSite);
UpdateMeinPaketSite($hMeinPaketSite); # if $hMeinPaketSite includes MeinPaketSiteID
Input
$MeinPaketSiteID (int)
MeinPaket Site identifier (primary key)
$hMeinPaketSite (reference to hash)
with following keys:
  • CategoryListIsUpdating - True if categories are being updated - bit
  • CategoryListVersionHash - VersionHash of Category List (optional)- varchar(32)
  • CategoryListUpdateTime - Date of last Update of MeinPaket Category List (optional)- datetime
  • CategoryListCount - Number of Categories in MeinPaket Category List (optional)- int
  • Alias - Alias of MeinPaket Environment - varchar(255)