ePages 6.10 - DE_EPAGES/Object/API/Table/SiteLocaleMap.pm

Package DE_EPAGES::Object::API::Table::SiteLocaleMap

interface for table SiteLocaleMap

@EXPORT_OK
InsertSiteLocaleMap
UpdateSiteLocaleMap
DeleteSiteLocaleMap
GetAllPKeySiteLocaleMaps
GetAllInfoSiteLocaleMaps
GetInfoSiteLocaleMap
ExistsSiteLocaleMap
GetPKeySiteLocaleMapsBySiteID
GetInfoSiteLocaleMapsBySiteID
GetPKeySiteLocaleMapsByLocaleID
GetInfoSiteLocaleMapsByLocaleID

Functions

DeleteSiteLocaleMap
ExistsSiteLocaleMap
GetAllInfoSiteLocaleMaps
GetAllPKeySiteLocaleMaps
GetInfoSiteLocaleMap
GetInfoSiteLocaleMapsByLocaleID
GetInfoSiteLocaleMapsBySiteID
GetPKeySiteLocaleMapsByLocaleID
GetPKeySiteLocaleMapsBySiteID
InsertSiteLocaleMap
OnDeleteLocale
UpdateSiteLocaleMap

DeleteSiteLocaleMap

Deletes a(n) SiteLocaleMap.

Syntax
DeleteSiteLocaleMap($SiteID, $LocaleID);
DeleteSiteLocaleMap($hSiteLocaleMap); # if $hSiteLocaleMap includes SiteID, LocaleID
Input
$SiteID (int)
site id (part of primary key)
$LocaleID (varchar(5))
locale id, example en_GB (part of primary key)

ExistsSiteLocaleMap

Returns true if the SiteLocaleMap exists.

Syntax
$exists = ExistsSiteLocaleMap($SiteID, $LocaleID);
Input
$SiteID (int)
site id
$LocaleID (varchar(5))
locale id, example en_GB
Return
$exists (boolean)
1/0 the SiteLocaleMap exists (yes/no)

GetAllInfoSiteLocaleMaps

Returns all objects of SiteLocaleMap.

Syntax
$ahSiteLocaleMaps = GetAllInfoSiteLocaleMaps();
Return
$ahSiteLocaleMaps (reference to array of hashes)
with following keys:
  • SiteID - site id (part of primary key)- int
  • LocaleID - locale id, example en_GB (part of primary key)- varchar(5)
  • Position - sort order number - int

GetAllPKeySiteLocaleMaps

Returns all SiteLocaleMap identifiers.

Syntax
$ahSiteLocaleMapIDs = GetAllPKeySiteLocaleMaps();
Return
$ahSiteLocaleMapIDs (reference to array of hashes)
with following keys:
  • SiteID - site id - int
  • LocaleID - locale id, example en_GB - varchar(5)

GetInfoSiteLocaleMap

Returns the SiteLocaleMap by identifier.

Syntax
$hSiteLocaleMap = GetInfoSiteLocaleMap($SiteID, $LocaleID);
Input
$SiteID (int)
site id (part of primary key)
$LocaleID (varchar(5))
locale id, example en_GB (part of primary key)
Return
$hSiteLocaleMap (reference to hash)
with following keys:
  • SiteID - site id (part of primary key)- int
  • LocaleID - locale id, example en_GB (part of primary key)- varchar(5)
  • Position - sort order number - int

GetInfoSiteLocaleMapsByLocaleID

Returns objects of SiteLocaleMap by alternate key LocaleID.

Syntax
$ahSiteLocaleMaps = GetInfoSiteLocaleMapsByLocaleID($LocaleID);
Input
$LocaleID (varchar(5))
locale id, example en_GB
Return
$ahSiteLocaleMaps (reference to array of hashes)
with following keys:
  • SiteID - site id (part of primary key)- int
  • LocaleID - locale id, example en_GB (part of primary key)- varchar(5)
  • Position - sort order number - int

GetInfoSiteLocaleMapsBySiteID

Returns objects of SiteLocaleMap by primary key element SiteID.

Syntax
$ahSiteLocaleMaps = GetInfoSiteLocaleMapsBySiteID($SiteID);
Input
$SiteID (int)
site id
Return
$ahSiteLocaleMaps (reference to array of hashes)
with following keys:
  • SiteID - site id (part of primary key)- int
  • LocaleID - locale id, example en_GB (part of primary key)- varchar(5)
  • Position - sort order number - int

GetPKeySiteLocaleMapsByLocaleID

Returns primary keys of SiteLocaleMap by alternate key LocaleID.

Syntax
$ahKeys = GetPKeySiteLocaleMapsByLocaleID($LocaleID);
Input
$LocaleID (varchar(5))
locale id, example en_GB
Return
$ahKeys (reference to array of hashes)
with following keys:
  • SiteID - site id - int
  • LocaleID - locale id, example en_GB - varchar(5)

GetPKeySiteLocaleMapsBySiteID

Returns primary keys of SiteLocaleMap by primary key element SiteID.

Syntax
$ahKeys = GetPKeySiteLocaleMapsBySiteID($SiteID);
Input
$SiteID (int)
site id
Return
$ahKeys (reference to array of hashes)
with following keys:
  • SiteID - site id - int
  • LocaleID - locale id, example en_GB - varchar(5)

InsertSiteLocaleMap

Creates an entry of SiteLocaleMap.

Syntax
InsertSiteLocaleMap($hSiteLocaleMap);
Input
$hSiteLocaleMap (reference to hash)
with following keys:
  • SiteID - site id (part of primary key)- int
  • LocaleID - locale id, example en_GB (part of primary key)- varchar(5)
  • Position - sort order number - int

OnDeleteLocale

Deletes SiteLocaleMap of this model when a(n) Locale is deleted.

Syntax
OnDeleteLocale($hParams);
Input
$hParams (ref.hash.*)
primary key of object Locale, key is
  • LocaleID

UpdateSiteLocaleMap

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

Syntax
UpdateSiteLocaleMap($SiteID, $LocaleID, $hSiteLocaleMap);
UpdateSiteLocaleMap($hSiteLocaleMap); # if $hSiteLocaleMap includes SiteID, LocaleID
Input
$SiteID (int)
site id (part of primary key)
$LocaleID (varchar(5))
locale id, example en_GB (part of primary key)
$hSiteLocaleMap (reference to hash)
with following keys:
  • Position - sort order number - int