ePages 6.11.0 - DE_EPAGES/Object/API/Table/LocalizedTextAttribute.pm

Package DE_EPAGES::Object::API::Table::LocalizedTextAttribute

interface for table LocalizedTextAttribute

@EXPORT_OK
InsertLocalizedTextAttribute
UpdateLocalizedTextAttribute
DeleteLocalizedTextAttribute
GetAllPKeyLocalizedTextAttributes
GetAllInfoLocalizedTextAttributes
GetInfoLocalizedTextAttribute
ExistsLocalizedTextAttribute
GetPKeyLocalizedTextAttributesByObjectID
GetInfoLocalizedTextAttributesByObjectID
GetPKeyLocalizedTextAttributesByAttributeID
GetInfoLocalizedTextAttributesByAttributeID
GetPKeyLocalizedTextAttributesByLanguageID
GetInfoLocalizedTextAttributesByLanguageID

Functions

DeleteLocalizedTextAttribute
ExistsLocalizedTextAttribute
GetAllInfoLocalizedTextAttributes
GetAllPKeyLocalizedTextAttributes
GetInfoLocalizedTextAttribute
GetInfoLocalizedTextAttributesByAttributeID
GetInfoLocalizedTextAttributesByLanguageID
GetInfoLocalizedTextAttributesByObjectID
GetPKeyLocalizedTextAttributesByAttributeID
GetPKeyLocalizedTextAttributesByLanguageID
GetPKeyLocalizedTextAttributesByObjectID
InsertLocalizedTextAttribute
OnDeleteAttribute
OnDeleteLanguage
OnDeleteObject
UpdateLocalizedTextAttribute

DeleteLocalizedTextAttribute

Deletes a(n) LocalizedTextAttribute.

Syntax
DeleteLocalizedTextAttribute($ObjectID, $AttributeID, $LanguageID);
DeleteLocalizedTextAttribute($hLocalizedTextAttribute); # if $hLocalizedTextAttribute includes ObjectID, AttributeID, LanguageID
Input
$ObjectID (int)
object id (part of primary key)
$AttributeID (int)
attribute id (part of primary key)
$LanguageID (int)
language id (part of primary key)

ExistsLocalizedTextAttribute

Returns true if the LocalizedTextAttribute exists.

Syntax
$exists = ExistsLocalizedTextAttribute($ObjectID, $AttributeID, $LanguageID);
Input
$ObjectID (int)
object id
$AttributeID (int)
attribute id
$LanguageID (int)
language id
Return
$exists (boolean)
1/0 the LocalizedTextAttribute exists (yes/no)

GetAllInfoLocalizedTextAttributes

Returns all objects of LocalizedTextAttribute.

Syntax
$ahLocalizedTextAttributes = GetAllInfoLocalizedTextAttributes();
Return
$ahLocalizedTextAttributes (reference to array of hashes)
with following keys:
  • ObjectID - object id (part of primary key)- int
  • AttributeID - attribute id (part of primary key)- int
  • LanguageID - language id (part of primary key)- int
  • Value - localized value >= 256 characters - text

GetAllPKeyLocalizedTextAttributes

Returns all LocalizedTextAttribute identifiers.

Syntax
$ahLocalizedTextAttributeIDs = GetAllPKeyLocalizedTextAttributes();
Return
$ahLocalizedTextAttributeIDs (reference to array of hashes)
with following keys:
  • ObjectID - object id - int
  • AttributeID - attribute id - int
  • LanguageID - language id - int

GetInfoLocalizedTextAttribute

Returns the LocalizedTextAttribute by identifier.

Syntax
$hLocalizedTextAttribute = GetInfoLocalizedTextAttribute($ObjectID, $AttributeID, $LanguageID);
Input
$ObjectID (int)
object id (part of primary key)
$AttributeID (int)
attribute id (part of primary key)
$LanguageID (int)
language id (part of primary key)
Return
$hLocalizedTextAttribute (reference to hash)
with following keys:
  • ObjectID - object id (part of primary key)- int
  • AttributeID - attribute id (part of primary key)- int
  • LanguageID - language id (part of primary key)- int
  • Value - localized value >= 256 characters - text

GetInfoLocalizedTextAttributesByAttributeID

Returns objects of LocalizedTextAttribute by alternate key AttributeID.

Syntax
$ahLocalizedTextAttributes = GetInfoLocalizedTextAttributesByAttributeID($AttributeID);
Input
$AttributeID (int)
attribute id
Return
$ahLocalizedTextAttributes (reference to array of hashes)
with following keys:
  • ObjectID - object id (part of primary key)- int
  • AttributeID - attribute id (part of primary key)- int
  • LanguageID - language id (part of primary key)- int
  • Value - localized value >= 256 characters - text

GetInfoLocalizedTextAttributesByLanguageID

Returns objects of LocalizedTextAttribute by alternate key LanguageID.

Syntax
$ahLocalizedTextAttributes = GetInfoLocalizedTextAttributesByLanguageID($LanguageID);
Input
$LanguageID (int)
language id
Return
$ahLocalizedTextAttributes (reference to array of hashes)
with following keys:
  • ObjectID - object id (part of primary key)- int
  • AttributeID - attribute id (part of primary key)- int
  • LanguageID - language id (part of primary key)- int
  • Value - localized value >= 256 characters - text

GetInfoLocalizedTextAttributesByObjectID

Returns objects of LocalizedTextAttribute by primary key element ObjectID, AttributeID.

Syntax
$ahLocalizedTextAttributes = GetInfoLocalizedTextAttributesByObjectID($ObjectID, $AttributeID);
Input
$ObjectID (int)
object id
$AttributeID (int)
attribute id (optional)
Return
$ahLocalizedTextAttributes (reference to array of hashes)
with following keys:
  • ObjectID - object id (part of primary key)- int
  • AttributeID - attribute id (part of primary key)- int
  • LanguageID - language id (part of primary key)- int
  • Value - localized value >= 256 characters - text

GetPKeyLocalizedTextAttributesByAttributeID

Returns primary keys of LocalizedTextAttribute by alternate key AttributeID.

Syntax
$ahKeys = GetPKeyLocalizedTextAttributesByAttributeID($AttributeID);
Input
$AttributeID (int)
attribute id
Return
$ahKeys (reference to array of hashes)
with following keys:
  • ObjectID - object id - int
  • AttributeID - attribute id - int
  • LanguageID - language id - int

GetPKeyLocalizedTextAttributesByLanguageID

Returns primary keys of LocalizedTextAttribute by alternate key LanguageID.

Syntax
$ahKeys = GetPKeyLocalizedTextAttributesByLanguageID($LanguageID);
Input
$LanguageID (int)
language id
Return
$ahKeys (reference to array of hashes)
with following keys:
  • ObjectID - object id - int
  • AttributeID - attribute id - int
  • LanguageID - language id - int

GetPKeyLocalizedTextAttributesByObjectID

Returns primary keys of LocalizedTextAttribute by primary key element ObjectID, AttributeID.

Syntax
$ahKeys = GetPKeyLocalizedTextAttributesByObjectID($ObjectID, $AttributeID);
Input
$ObjectID (int)
object id
$AttributeID (int)
attribute id (optional)
Return
$ahKeys (reference to array of hashes)
with following keys:
  • ObjectID - object id - int
  • AttributeID - attribute id - int
  • LanguageID - language id - int

InsertLocalizedTextAttribute

Creates an entry of LocalizedTextAttribute.

Syntax
InsertLocalizedTextAttribute($hLocalizedTextAttribute);
Input
$hLocalizedTextAttribute (reference to hash)
with following keys:
  • ObjectID - object id (part of primary key)- int
  • AttributeID - attribute id (part of primary key)- int
  • LanguageID - language id (part of primary key)- int
  • Value - localized value >= 256 characters - text

OnDeleteAttribute

Deletes LocalizedTextAttribute of this model when a(n) Attribute is deleted.

Syntax
OnDeleteAttribute($hParams);
Input
$hParams (ref.hash.*)
primary key of object Attribute, key is
  • AttributeID

OnDeleteLanguage

Deletes LocalizedTextAttribute of this model when a(n) Language is deleted.

Syntax
OnDeleteLanguage($hParams);
Input
$hParams (ref.hash.*)
primary key of object Language, key is
  • LanguageID

OnDeleteObject

Deletes LocalizedTextAttribute of this model when a(n) Object is deleted.

Syntax
OnDeleteObject($hParams);
Input
$hParams (ref.hash.*)
primary key of object Object, key is
  • ObjectID

UpdateLocalizedTextAttribute

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

Syntax
UpdateLocalizedTextAttribute($ObjectID, $AttributeID, $LanguageID, $hLocalizedTextAttribute);
UpdateLocalizedTextAttribute($hLocalizedTextAttribute); # if $hLocalizedTextAttribute includes ObjectID, AttributeID, LanguageID
Input
$ObjectID (int)
object id (part of primary key)
$AttributeID (int)
attribute id (part of primary key)
$LanguageID (int)
language id (part of primary key)
$hLocalizedTextAttribute (reference to hash)
with following keys:
  • Value - localized value >= 256 characters - text
Return
1 (int)
1