ePages 6.11.0 - DE_EPAGES/Search/API/Table/SearchFrom.pm

Package DE_EPAGES::Search::API::Table::SearchFrom

interface for table SearchFrom

@EXPORT_OK
InsertSearchFrom
UpdateSearchFrom
DeleteSearchFrom
GetAllPKeySearchFroms
GetAllInfoSearchFroms
GetInfoSearchFrom
ExistsSearchFrom
GetPKeySearchFromByClassID
GetInfoSearchFromByClassID
ExistsSearchFromByClassID
GetPKeySearchFromsByClassID
GetInfoSearchFromsByClassID

Functions

DeleteSearchFrom
ExistsSearchFrom
ExistsSearchFromByClassID
GetAllInfoSearchFroms
GetAllPKeySearchFroms
GetInfoSearchFrom
GetInfoSearchFromByClassID
GetInfoSearchFromsByClassID
GetPKeySearchFromByClassID
GetPKeySearchFromsByClassID
InsertSearchFrom
OnDeleteClass
UpdateSearchFrom

DeleteSearchFrom

Deletes a(n) SearchFrom.

Syntax
DeleteSearchFrom($SearchFromID);
DeleteSearchFrom($hSearchFrom); # if $hSearchFrom includes SearchFromID
Input
$SearchFromID (int)
search from id (primary key)

ExistsSearchFrom

Returns true if the SearchFrom exists.

Syntax
$exists = ExistsSearchFrom($SearchFromID);
Input
$SearchFromID (int)
search from id
Return
$exists (boolean)
1/0 the SearchFrom exists (yes/no)

ExistsSearchFromByClassID

Returns true if a SearchFrom by alternate keys ClassID and TableShortCut exists.

Syntax
$SearchFromID = ExistsSearchFromByClassID($ClassID, $TableShortCut);
Input
$ClassID (int)
class id
$TableShortCut (varchar(255))
short cut for table
Return
$exists (boolean)
1/0 the u_searchfrom_class exists (yes/no)

GetAllInfoSearchFroms

Returns all objects of SearchFrom.

Syntax
$ahSearchFroms = GetAllInfoSearchFroms();
Return
$ahSearchFroms (reference to array of hashes)
with following keys:
  • SearchFromID - search from id (primary key)- int
  • ClassID - class id - int
  • TableShortCut - short cut for table - varchar(255)
  • TableName - table name - varchar(255)
  • PrimaryKey - primary key - varchar(30)
  • IsMaster - is master table of class - bit
  • Extension - performance extension (optional)- varchar(255)

GetAllPKeySearchFroms

Returns all SearchFrom identifiers.

Syntax
$aSearchFromIDs = GetAllPKeySearchFroms();
Return
$aSearchFromIDs (reference to array of int)
search from id

GetInfoSearchFrom

Returns the SearchFrom by identifier.

Syntax
$hSearchFrom = GetInfoSearchFrom($SearchFromID);
Input
$SearchFromID (int)
search from id (primary key)
Return
$hSearchFrom (reference to hash)
with following keys:
  • SearchFromID - search from id (primary key)- int
  • ClassID - class id - int
  • TableShortCut - short cut for table - varchar(255)
  • TableName - table name - varchar(255)
  • PrimaryKey - primary key - varchar(30)
  • IsMaster - is master table of class - bit
  • Extension - performance extension (optional)- varchar(255)

GetInfoSearchFromByClassID

Returns the object of SearchFrom by alternate keys ClassID and TableShortCut.

Syntax
$hSearchFrom = GetInfoSearchFromByClassID($ClassID, $TableShortCut);
Input
$ClassID (int)
class id
$TableShortCut (varchar(255))
short cut for table
Return
$hSearchFrom (reference to hash)
with following keys:
  • SearchFromID - search from id (primary key)- int
  • ClassID - class id - int
  • TableShortCut - short cut for table - varchar(255)
  • TableName - table name - varchar(255)
  • PrimaryKey - primary key - varchar(30)
  • IsMaster - is master table of class - bit
  • Extension - performance extension (optional)- varchar(255)

GetInfoSearchFromsByClassID

Returns objects of SearchFrom by alternate keys ClassID and TableShortCut.

Syntax
$ahSearchFroms = GetInfoSearchFromsByClassID($ClassID, $TableShortCut);
Input
$ClassID (int)
class id
$TableShortCut (varchar(255))
short cut for table (optional)
Return
$ahSearchFroms (reference to array of hashes)
with following keys:
  • SearchFromID - search from id (primary key)- int
  • ClassID - class id - int
  • TableShortCut - short cut for table - varchar(255)
  • TableName - table name - varchar(255)
  • PrimaryKey - primary key - varchar(30)
  • IsMaster - is master table of class - bit
  • Extension - performance extension (optional)- varchar(255)

GetPKeySearchFromByClassID

Returns primary key of SearchFrom by alternate keys ClassID and TableShortCut.

Syntax
$SearchFromID = GetPKeySearchFromByClassID($ClassID, $TableShortCut);
Input
$ClassID (int)
class id
$TableShortCut (varchar(255))
short cut for table
Return
$SearchFromID (int)
search from id (primary key)

GetPKeySearchFromsByClassID

Returns primary keys of SearchFrom by alternate keys ClassID and TableShortCut.

Syntax
$aKeys = GetPKeySearchFromsByClassID($ClassID, $TableShortCut);
Input
$ClassID (int)
class id
$TableShortCut (varchar(255))
short cut for table (optional)
Return
$aKeys (reference to array of int)
search from id (primary key)

InsertSearchFrom

Creates an entry of SearchFrom.

Syntax
$SearchFromID = InsertSearchFrom($hSearchFrom);
Input
$hSearchFrom (reference to hash)
with following keys:
  • SearchFromID - search from id (primary key)(optional)- int
  • ClassID - class id - int
  • TableShortCut - short cut for table - varchar(255)
  • TableName - table name - varchar(255)
  • PrimaryKey - primary key - varchar(30)
  • IsMaster - is master table of class - bit
  • Extension - performance extension (optional)- varchar(255)
Return
$SearchFromID (int)
search from id (primary key)

OnDeleteClass

Deletes SearchFrom of this model when a(n) Class is deleted.

Syntax
OnDeleteClass($hParams);
Input
$hParams (ref.hash.*)
primary key of object Class, key is
  • ClassID

UpdateSearchFrom

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

Syntax
UpdateSearchFrom($SearchFromID, $hSearchFrom);
UpdateSearchFrom($hSearchFrom); # if $hSearchFrom includes SearchFromID
Input
$SearchFromID (int)
search from id (primary key)
$hSearchFrom (reference to hash)
with following keys:
  • ClassID - class id - int
  • TableShortCut - short cut for table - varchar(255)
  • TableName - table name - varchar(255)
  • PrimaryKey - primary key - varchar(30)
  • IsMaster - is master table of class - bit
  • Extension - performance extension (optional)- varchar(255)
Return
1 (int)
1