ePages 6.11.0 - DE_EPAGES/WebInterfacePoolDB/API/Table/Site.pm

Package DE_EPAGES::WebInterfacePoolDB::API::Table::Site

interface for table Site

@EXPORT_OK
InsertSite
UpdateSite
DeleteSite
GetAllPKeySites
GetAllInfoSites
GetInfoSite
ExistsSite
GetPKeySiteByGUID
GetInfoSiteByGUID
ExistsSiteByGUID
GetPKeySitesByGUID
GetInfoSitesByGUID
GetPKeySiteByStoreID
GetInfoSiteByStoreID
ExistsSiteByStoreID
GetPKeySitesByStoreID
GetInfoSitesByStoreID

Functions

DeleteSite
ExistsSite
ExistsSiteByGUID
ExistsSiteByStoreID
GetAllInfoSites
GetAllPKeySites
GetInfoSite
GetInfoSiteByGUID
GetInfoSiteByStoreID
GetInfoSitesByGUID
GetInfoSitesByStoreID
GetPKeySiteByGUID
GetPKeySiteByStoreID
GetPKeySitesByGUID
GetPKeySitesByStoreID
InsertSite
UpdateSite

DeleteSite

Deletes a(n) Site.

Syntax
DeleteSite($SiteID);
DeleteSite($hSite); # if $hSite includes SiteID
Input
$SiteID (int)
site id (primary key)

ExistsSite

Returns true if the Site exists.

Syntax
$exists = ExistsSite($SiteID);
Input
$SiteID (int)
site id
Return
$exists (boolean)
1/0 the Site exists (yes/no)

ExistsSiteByGUID

Returns true if a Site by alternate key GUID exists.

Syntax
$SiteID = ExistsSiteByGUID($GUID);
Input
$GUID (varchar(36))
site object GUID
Return
$exists (boolean)
1/0 the i_site_guid exists (yes/no)

ExistsSiteByStoreID

Returns true if a Site by alternate keys StoreID and ObjectPath exists.

Syntax
$SiteID = ExistsSiteByStoreID($StoreID, $ObjectPath);
Input
$StoreID (int)
store database id
$ObjectPath (varchar(255))
object path in database
Return
$exists (boolean)
1/0 the i_site_objectpath exists (yes/no)

GetAllInfoSites

Returns all objects of Site.

Syntax
$ahSites = GetAllInfoSites();
Return
$ahSites (reference to array of hashes)
with following keys:
  • SiteID - site id (primary key)- int
  • StoreID - store database id - int
  • GUID - site object GUID - varchar(36)
  • ObjectPath - object path in database - varchar(255)
  • MaxServers - maximum number of parallel processes for this site (optional)- int

GetAllPKeySites

Returns all Site identifiers.

Syntax
$aSiteIDs = GetAllPKeySites();
Return
$aSiteIDs (reference to array of int)
site id

GetInfoSite

Returns the Site by identifier.

Syntax
$hSite = GetInfoSite($SiteID);
Input
$SiteID (int)
site id (primary key)
Return
$hSite (reference to hash)
with following keys:
  • SiteID - site id (primary key)- int
  • StoreID - store database id - int
  • GUID - site object GUID - varchar(36)
  • ObjectPath - object path in database - varchar(255)
  • MaxServers - maximum number of parallel processes for this site (optional)- int

GetInfoSiteByGUID

Returns the object of Site by alternate key GUID.

Syntax
$hSite = GetInfoSiteByGUID($GUID);
Input
$GUID (varchar(36))
site object GUID
Return
$hSite (reference to hash)
with following keys:
  • SiteID - site id (primary key)- int
  • StoreID - store database id - int
  • GUID - site object GUID - varchar(36)
  • ObjectPath - object path in database - varchar(255)
  • MaxServers - maximum number of parallel processes for this site (optional)- int

GetInfoSiteByStoreID

Returns the object of Site by alternate keys StoreID and ObjectPath.

Syntax
$hSite = GetInfoSiteByStoreID($StoreID, $ObjectPath);
Input
$StoreID (int)
store database id
$ObjectPath (varchar(255))
object path in database
Return
$hSite (reference to hash)
with following keys:
  • SiteID - site id (primary key)- int
  • StoreID - store database id - int
  • GUID - site object GUID - varchar(36)
  • ObjectPath - object path in database - varchar(255)
  • MaxServers - maximum number of parallel processes for this site (optional)- int

GetInfoSitesByGUID

Returns objects of Site by alternate key GUID.

Syntax
$ahSites = GetInfoSitesByGUID($GUID);
Input
$GUID (varchar(36))
site object GUID
Return
$ahSites (reference to array of hashes)
with following keys:
  • SiteID - site id (primary key)- int
  • StoreID - store database id - int
  • GUID - site object GUID - varchar(36)
  • ObjectPath - object path in database - varchar(255)
  • MaxServers - maximum number of parallel processes for this site (optional)- int

GetInfoSitesByStoreID

Returns objects of Site by alternate keys StoreID and ObjectPath.

Syntax
$ahSites = GetInfoSitesByStoreID($StoreID, $ObjectPath);
Input
$StoreID (int)
store database id
$ObjectPath (varchar(255))
object path in database (optional)
Return
$ahSites (reference to array of hashes)
with following keys:
  • SiteID - site id (primary key)- int
  • StoreID - store database id - int
  • GUID - site object GUID - varchar(36)
  • ObjectPath - object path in database - varchar(255)
  • MaxServers - maximum number of parallel processes for this site (optional)- int

GetPKeySiteByGUID

Returns primary key of Site by alternate key GUID.

Syntax
$SiteID = GetPKeySiteByGUID($GUID);
Input
$GUID (varchar(36))
site object GUID
Return
$SiteID (int)
site id (primary key)

GetPKeySiteByStoreID

Returns primary key of Site by alternate keys StoreID and ObjectPath.

Syntax
$SiteID = GetPKeySiteByStoreID($StoreID, $ObjectPath);
Input
$StoreID (int)
store database id
$ObjectPath (varchar(255))
object path in database
Return
$SiteID (int)
site id (primary key)

GetPKeySitesByGUID

Returns primary keys of Site by alternate key GUID.

Syntax
$aKeys = GetPKeySitesByGUID($GUID);
Input
$GUID (varchar(36))
site object GUID
Return
$aKeys (reference to array of int)
site id (primary key)

GetPKeySitesByStoreID

Returns primary keys of Site by alternate keys StoreID and ObjectPath.

Syntax
$aKeys = GetPKeySitesByStoreID($StoreID, $ObjectPath);
Input
$StoreID (int)
store database id
$ObjectPath (varchar(255))
object path in database (optional)
Return
$aKeys (reference to array of int)
site id (primary key)

InsertSite

Creates an entry of Site.

Syntax
$SiteID = InsertSite($hSite);
Input
$hSite (reference to hash)
with following keys:
  • SiteID - site id (primary key)(optional)- int
  • StoreID - store database id - int
  • GUID - site object GUID - varchar(36)
  • ObjectPath - object path in database - varchar(255)
  • MaxServers - maximum number of parallel processes for this site (optional)- int
Return
$SiteID (int)
site id (primary key)

UpdateSite

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

Syntax
UpdateSite($SiteID, $hSite);
UpdateSite($hSite); # if $hSite includes SiteID
Input
$SiteID (int)
site id (primary key)
$hSite (reference to hash)
with following keys:
  • StoreID - store database id - int
  • GUID - site object GUID - varchar(36)
  • ObjectPath - object path in database - varchar(255)
  • MaxServers - maximum number of parallel processes for this site (optional)- int
Return
1 (int)
1