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

Package DE_EPAGES::Presentation::API::Table::UserHelpDisabled

interface for table UserHelpDisabled

@EXPORT_OK
InsertUserHelpDisabled
DeleteUserHelpDisabled
GetAllPKeyUserHelpDisableds
ExistsUserHelpDisabled
GetPKeyUserHelpDisabledsByUserID
GetInfoUserHelpDisabledsByUserID
GetPKeyUserHelpDisabledsByPageTypeID
GetInfoUserHelpDisabledsByPageTypeID

Functions

DeleteUserHelpDisabled
ExistsUserHelpDisabled
GetAllPKeyUserHelpDisableds
GetInfoUserHelpDisabledsByPageTypeID
GetInfoUserHelpDisabledsByUserID
GetPKeyUserHelpDisabledsByPageTypeID
GetPKeyUserHelpDisabledsByUserID
InsertUserHelpDisabled
OnDeletePageType
OnDeleteUser

DeleteUserHelpDisabled

Deletes a(n) UserHelpDisabled.

Syntax
DeleteUserHelpDisabled($UserID, $PageTypeID);
DeleteUserHelpDisabled($hUserHelpDisabled); # if $hUserHelpDisabled includes UserID, PageTypeID
Input
$UserID (int)
user id (part of primary key)
$PageTypeID (int)
pagetype id (part of primary key)

ExistsUserHelpDisabled

Returns true if the UserHelpDisabled exists.

Syntax
$exists = ExistsUserHelpDisabled($UserID, $PageTypeID);
Input
$UserID (int)
user id
$PageTypeID (int)
pagetype id
Return
$exists (boolean)
1/0 the UserHelpDisabled exists (yes/no)

GetAllPKeyUserHelpDisableds

Returns all UserHelpDisabled identifiers.

Syntax
$ahUserHelpDisabledIDs = GetAllPKeyUserHelpDisableds();
Return
$ahUserHelpDisabledIDs (reference to array of hashes)
with following keys:
  • UserID - user id - int
  • PageTypeID - pagetype id - int

GetInfoUserHelpDisabledsByPageTypeID

Returns objects of UserHelpDisabled by alternate key PageTypeID.

Syntax
$ahUserHelpDisableds = GetInfoUserHelpDisabledsByPageTypeID($PageTypeID);
Input
$PageTypeID (int)
pagetype id
Return
$ahUserHelpDisableds (reference to array of hashes)
with following keys:
  • UserID - user id (part of primary key)- int
  • PageTypeID - pagetype id (part of primary key)- int

GetInfoUserHelpDisabledsByUserID

Returns objects of UserHelpDisabled by primary key element UserID.

Syntax
$ahUserHelpDisableds = GetInfoUserHelpDisabledsByUserID($UserID);
Input
$UserID (int)
user id
Return
$ahUserHelpDisableds (reference to array of hashes)
with following keys:
  • UserID - user id (part of primary key)- int
  • PageTypeID - pagetype id (part of primary key)- int

GetPKeyUserHelpDisabledsByPageTypeID

Returns primary keys of UserHelpDisabled by alternate key PageTypeID.

Syntax
$ahKeys = GetPKeyUserHelpDisabledsByPageTypeID($PageTypeID);
Input
$PageTypeID (int)
pagetype id
Return
$ahKeys (reference to array of hashes)
with following keys:
  • UserID - user id - int
  • PageTypeID - pagetype id - int

GetPKeyUserHelpDisabledsByUserID

Returns primary keys of UserHelpDisabled by primary key element UserID.

Syntax
$ahKeys = GetPKeyUserHelpDisabledsByUserID($UserID);
Input
$UserID (int)
user id
Return
$ahKeys (reference to array of hashes)
with following keys:
  • UserID - user id - int
  • PageTypeID - pagetype id - int

InsertUserHelpDisabled

Creates an entry of UserHelpDisabled.

Syntax
InsertUserHelpDisabled($hUserHelpDisabled);
Input
$hUserHelpDisabled (reference to hash)
with following keys:
  • UserID - user id (part of primary key)- int
  • PageTypeID - pagetype id (part of primary key)- int

OnDeletePageType

Deletes UserHelpDisabled of this model when a(n) PageType is deleted.

Syntax
OnDeletePageType($hParams);
Input
$hParams (ref.hash.*)
primary key of object PageType, key is
  • PageTypeID

OnDeleteUser

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

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