ePages 6.11.0 - DE_EPAGES/Presentation/API/Table/EventFavorite.pm

Package DE_EPAGES::Presentation::API::Table::EventFavorite

interface for table EventFavorite

@EXPORT_OK
InsertEventFavorite
UpdateEventFavorite
DeleteEventFavorite
GetAllPKeyEventFavorites
GetAllInfoEventFavorites
GetInfoEventFavorite
ExistsEventFavorite
GetPKeyEventFavoritesByUserID
GetInfoEventFavoritesByUserID
GetPKeyEventFavoritesByObjectID
GetInfoEventFavoritesByObjectID

Functions

DeleteEventFavorite
ExistsEventFavorite
GetAllInfoEventFavorites
GetAllPKeyEventFavorites
GetInfoEventFavorite
GetInfoEventFavoritesByObjectID
GetInfoEventFavoritesByUserID
GetPKeyEventFavoritesByObjectID
GetPKeyEventFavoritesByUserID
InsertEventFavorite
OnDeleteObject
OnDeleteUser
UpdateEventFavorite

DeleteEventFavorite

Deletes a(n) EventFavorite.

Syntax
DeleteEventFavorite($EventFavoriteID);
DeleteEventFavorite($hEventFavorite); # if $hEventFavorite includes EventFavoriteID
Input
$EventFavoriteID (int)
view anchor indentifier (primary key)

ExistsEventFavorite

Returns true if the EventFavorite exists.

Syntax
$exists = ExistsEventFavorite($EventFavoriteID);
Input
$EventFavoriteID (int)
view anchor indentifier
Return
$exists (boolean)
1/0 the EventFavorite exists (yes/no)

GetAllInfoEventFavorites

Returns all objects of EventFavorite.

Syntax
$ahEventFavorites = GetAllInfoEventFavorites();
Return
$ahEventFavorites (reference to array of hashes)
with following keys:
  • EventFavoriteID - view anchor indentifier (primary key)- int
  • ObjectID - object id (optional)- int
  • UserID - user id - int
  • Name - title or name of page - nvarchar(255)
  • URI - Uniform Resource Identifiers of get request - varchar(500)

GetAllPKeyEventFavorites

Returns all EventFavorite identifiers.

Syntax
$aEventFavoriteIDs = GetAllPKeyEventFavorites();
Return
$aEventFavoriteIDs (reference to array of int)
view anchor indentifier

GetInfoEventFavorite

Returns the EventFavorite by identifier.

Syntax
$hEventFavorite = GetInfoEventFavorite($EventFavoriteID);
Input
$EventFavoriteID (int)
view anchor indentifier (primary key)
Return
$hEventFavorite (reference to hash)
with following keys:
  • EventFavoriteID - view anchor indentifier (primary key)- int
  • ObjectID - object id (optional)- int
  • UserID - user id - int
  • Name - title or name of page - nvarchar(255)
  • URI - Uniform Resource Identifiers of get request - varchar(500)

GetInfoEventFavoritesByObjectID

Returns objects of EventFavorite by alternate key ObjectID.

Syntax
$ahEventFavorites = GetInfoEventFavoritesByObjectID($ObjectID);
Input
$ObjectID (int)
object id
Return
$ahEventFavorites (reference to array of hashes)
with following keys:
  • EventFavoriteID - view anchor indentifier (primary key)- int
  • ObjectID - object id (optional)- int
  • UserID - user id - int
  • Name - title or name of page - nvarchar(255)
  • URI - Uniform Resource Identifiers of get request - varchar(500)

GetInfoEventFavoritesByUserID

Returns objects of EventFavorite by alternate key UserID.

Syntax
$ahEventFavorites = GetInfoEventFavoritesByUserID($UserID);
Input
$UserID (int)
user id
Return
$ahEventFavorites (reference to array of hashes)
with following keys:
  • EventFavoriteID - view anchor indentifier (primary key)- int
  • ObjectID - object id (optional)- int
  • UserID - user id - int
  • Name - title or name of page - nvarchar(255)
  • URI - Uniform Resource Identifiers of get request - varchar(500)

GetPKeyEventFavoritesByObjectID

Returns primary keys of EventFavorite by alternate key ObjectID.

Syntax
$aKeys = GetPKeyEventFavoritesByObjectID($ObjectID);
Input
$ObjectID (int)
object id
Return
$aKeys (reference to array of int)
view anchor indentifier (primary key)

GetPKeyEventFavoritesByUserID

Returns primary keys of EventFavorite by alternate key UserID.

Syntax
$aKeys = GetPKeyEventFavoritesByUserID($UserID);
Input
$UserID (int)
user id
Return
$aKeys (reference to array of int)
view anchor indentifier (primary key)

InsertEventFavorite

Creates an entry of EventFavorite.

Syntax
$EventFavoriteID = InsertEventFavorite($hEventFavorite);
Input
$hEventFavorite (reference to hash)
with following keys:
  • EventFavoriteID - view anchor indentifier (primary key)(optional)- int
  • ObjectID - object id (optional)- int
  • UserID - user id - int
  • Name - title or name of page - nvarchar(255)
  • URI - Uniform Resource Identifiers of get request - varchar(500)
Return
$EventFavoriteID (int)
view anchor indentifier (primary key)

OnDeleteObject

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

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

OnDeleteUser

Deletes EventFavorite of this model when a(n) User is deleted.

Syntax
OnDeleteUser($hParams);
Input
$hParams (ref.hash.*)
primary key of object User, key is
  • UserID

UpdateEventFavorite

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

Syntax
UpdateEventFavorite($EventFavoriteID, $hEventFavorite);
UpdateEventFavorite($hEventFavorite); # if $hEventFavorite includes EventFavoriteID
Input
$EventFavoriteID (int)
view anchor indentifier (primary key)
$hEventFavorite (reference to hash)
with following keys:
  • ObjectID - object id (optional)- int
  • UserID - user id - int
  • Name - title or name of page - nvarchar(255)
  • URI - Uniform Resource Identifiers of get request - varchar(500)
Return
1 (int)
1