ePages 6.10 - DE_EPAGES/MediaGallery/API/Table/MediaGalleryAttribute.pm

Package DE_EPAGES::MediaGallery::API::Table::MediaGalleryAttribute

interface for table MediaGalleryAttribute

@EXPORT_OK
InsertMediaGalleryAttribute
UpdateMediaGalleryAttribute
DeleteMediaGalleryAttribute
GetAllPKeyMediaGalleryAttributes
GetAllInfoMediaGalleryAttributes
GetInfoMediaGalleryAttribute
ExistsMediaGalleryAttribute
GetPKeyMediaGalleryAttributesByObjectID
GetInfoMediaGalleryAttributesByObjectID
GetPKeyMediaGalleryAttributesByAttributeID
GetInfoMediaGalleryAttributesByAttributeID
GetPKeyMediaGalleryAttributesBySiteID
GetInfoMediaGalleryAttributesBySiteID

Functions

DeleteMediaGalleryAttribute
ExistsMediaGalleryAttribute
GetAllInfoMediaGalleryAttributes
GetAllPKeyMediaGalleryAttributes
GetInfoMediaGalleryAttribute
GetInfoMediaGalleryAttributesByAttributeID
GetInfoMediaGalleryAttributesByObjectID
GetInfoMediaGalleryAttributesBySiteID
GetPKeyMediaGalleryAttributesByAttributeID
GetPKeyMediaGalleryAttributesByObjectID
GetPKeyMediaGalleryAttributesBySiteID
InsertMediaGalleryAttribute
UpdateMediaGalleryAttribute

DeleteMediaGalleryAttribute

Deletes a(n) MediaGalleryAttribute.

Syntax
DeleteMediaGalleryAttribute($ObjectID, $AttributeID);
DeleteMediaGalleryAttribute($hMediaGalleryAttribute); # if $hMediaGalleryAttribute includes ObjectID, AttributeID
Input
$ObjectID (int)
object id (part of primary key)
$AttributeID (int)
attribute id (part of primary key)

ExistsMediaGalleryAttribute

Returns true if the MediaGalleryAttribute exists.

Syntax
$exists = ExistsMediaGalleryAttribute($ObjectID, $AttributeID);
Input
$ObjectID (int)
object id
$AttributeID (int)
attribute id
Return
$exists (boolean)
1/0 the MediaGalleryAttribute exists (yes/no)

GetAllInfoMediaGalleryAttributes

Returns all objects of MediaGalleryAttribute.

Syntax
$ahMediaGalleryAttributeIDs = GetAllInfoMediaGalleryAttributes();
Return
$ahMediaGalleryAttributeIDs (reference to array of hashes)
with following keys:
  • ObjectID - object id (part of primary key)- int
  • AttributeID - attribute id (part of primary key)- int
  • SiteID - site id - int
  • FilePath - path of image file from MediaGallery root, delimiter is a slash - varchar(255)
  • FileName - name of image file - varchar(255)

GetAllPKeyMediaGalleryAttributes

Returns all MediaGalleryAttribute identifiers.

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

GetInfoMediaGalleryAttribute

Returns the MediaGalleryAttribute by identifier.

Syntax
$hMediaGalleryAttribute = GetInfoMediaGalleryAttribute($ObjectID, $AttributeID);
Input
$ObjectID (int)
object id (part of primary key)
$AttributeID (int)
attribute id (part of primary key)
Return
$hMediaGalleryAttribute (reference to hash)
with following keys:
  • ObjectID - object id (part of primary key)- int
  • AttributeID - attribute id (part of primary key)- int
  • SiteID - site id - int
  • FilePath - path of image file from MediaGallery root, delimiter is a slash - varchar(255)
  • FileName - name of image file - varchar(255)

GetInfoMediaGalleryAttributesByAttributeID

Returns objects of MediaGalleryAttribute by alternate key AttributeID.

Syntax
$ahMediaGalleryAttributes = GetInfoMediaGalleryAttributesByAttributeID($AttributeID);
Input
$AttributeID (int)
attribute id
Return
$ahMediaGalleryAttributes (reference to array of hashes)
with following keys:
  • ObjectID - object id (part of primary key)- int
  • AttributeID - attribute id (part of primary key)- int
  • SiteID - site id - int
  • FilePath - path of image file from MediaGallery root, delimiter is a slash - varchar(255)
  • FileName - name of image file - varchar(255)

GetInfoMediaGalleryAttributesByObjectID

Returns objects of MediaGalleryAttribute by primary key element ObjectID.

Syntax
$ahMediaGalleryAttributes = GetInfoMediaGalleryAttributesByObjectID($ObjectID);
Input
$ObjectID (int)
object id
Return
$ahMediaGalleryAttributes (reference to array of hashes)
with following keys:
  • ObjectID - object id (part of primary key)- int
  • AttributeID - attribute id (part of primary key)- int
  • SiteID - site id - int
  • FilePath - path of image file from MediaGallery root, delimiter is a slash - varchar(255)
  • FileName - name of image file - varchar(255)

GetInfoMediaGalleryAttributesBySiteID

Returns objects of MediaGalleryAttribute by alternate key SiteID.

Syntax
$ahMediaGalleryAttributes = GetInfoMediaGalleryAttributesBySiteID($SiteID);
Input
$SiteID (int)
site id
Return
$ahMediaGalleryAttributes (reference to array of hashes)
with following keys:
  • ObjectID - object id (part of primary key)- int
  • AttributeID - attribute id (part of primary key)- int
  • SiteID - site id - int
  • FilePath - path of image file from MediaGallery root, delimiter is a slash - varchar(255)
  • FileName - name of image file - varchar(255)

GetPKeyMediaGalleryAttributesByAttributeID

Returns primary keys of MediaGalleryAttribute by alternate key AttributeID.

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

GetPKeyMediaGalleryAttributesByObjectID

Returns primary keys of MediaGalleryAttribute by primary key element ObjectID.

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

GetPKeyMediaGalleryAttributesBySiteID

Returns primary keys of MediaGalleryAttribute by alternate key SiteID.

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

InsertMediaGalleryAttribute

Creates an entry of MediaGalleryAttribute.

Syntax
InsertMediaGalleryAttribute($hMediaGalleryAttribute);
Input
$hMediaGalleryAttribute (reference to hash)
with following keys:
  • ObjectID - object id (part of primary key)- int
  • AttributeID - attribute id (part of primary key)- int
  • SiteID - site id - int
  • FilePath - path of image file from MediaGallery root, delimiter is a slash - varchar(255)
  • FileName - name of image file - varchar(255)

UpdateMediaGalleryAttribute

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

Syntax
UpdateMediaGalleryAttribute($ObjectID, $AttributeID, $hMediaGalleryAttribute);
UpdateMediaGalleryAttribute($hMediaGalleryAttribute); # if $hMediaGalleryAttribute includes ObjectID, AttributeID
Input
$ObjectID (int)
object id (part of primary key)
$AttributeID (int)
attribute id (part of primary key)
$hMediaGalleryAttribute (reference to hash)
with following keys:
  • SiteID - site id - int
  • FilePath - path of image file from MediaGallery root, delimiter is a slash - varchar(255)
  • FileName - name of image file - varchar(255)