ePages 6.10 - DE_EPAGES/Search/API/Table/SearchSort.pm

Package DE_EPAGES::Search::API::Table::SearchSort

interface for table SearchSort

@EXPORT_OK
InsertSearchSort
UpdateSearchSort
DeleteSearchSort
GetAllPKeySearchSorts
GetAllInfoSearchSorts
GetInfoSearchSort
ExistsSearchSort
GetPKeySearchSortBySearchDefinitionID
GetInfoSearchSortBySearchDefinitionID
ExistsSearchSortBySearchDefinitionID
GetPKeySearchSortsBySearchDefinitionID
GetInfoSearchSortsBySearchDefinitionID

Functions

DeleteSearchSort
ExistsSearchSort
ExistsSearchSortBySearchDefinitionID
GetAllInfoSearchSorts
GetAllPKeySearchSorts
GetInfoSearchSort
GetInfoSearchSortBySearchDefinitionID
GetInfoSearchSortsBySearchDefinitionID
GetPKeySearchSortBySearchDefinitionID
GetPKeySearchSortsBySearchDefinitionID
InsertSearchSort
UpdateSearchSort

DeleteSearchSort

Deletes a(n) SearchSort.

Syntax
DeleteSearchSort($SearchSortID);
DeleteSearchSort($hSearchSort); # if $hSearchSort includes SearchSortID
Input
$SearchSortID (int)
search parameter id (primary key)

ExistsSearchSort

Returns true if the SearchSort exists.

Syntax
$exists = ExistsSearchSort($SearchSortID);
Input
$SearchSortID (int)
search parameter id
Return
$exists (boolean)
1/0 the SearchSort exists (yes/no)

ExistsSearchSortBySearchDefinitionID

Returns true if a SearchSort by alternate keys SearchDefinitionID and Parameter exists.

Syntax
$SearchSortID = ExistsSearchSortBySearchDefinitionID($SearchDefinitionID, $Parameter);
Input
$SearchDefinitionID (int)
search definition id
$Parameter (varchar(255))
name of search parameter
Return
$exists (boolean)
1/0 the u_searchsort exists (yes/no)

GetAllInfoSearchSorts

Returns all objects of SearchSort.

Syntax
$ahSearchSorts = GetAllInfoSearchSorts();
Return
$ahSearchSorts (reference to array of hashes)
with following keys:
  • SearchSortID - search parameter id (primary key)- int
  • SearchDefinitionID - search definition id - int
  • Parameter - name of search parameter - varchar(255)
  • OrderByPart - pre/built where part of parameter line (optional)- varchar(255)

GetAllPKeySearchSorts

Returns all SearchSort identifiers.

Syntax
$aSearchSortIDs = GetAllPKeySearchSorts();
Return
$aSearchSortIDs (reference to array of int)
search parameter id

GetInfoSearchSort

Returns the SearchSort by identifier.

Syntax
$hSearchSort = GetInfoSearchSort($SearchSortID);
Input
$SearchSortID (int)
search parameter id (primary key)
Return
$hSearchSort (reference to hash)
with following keys:
  • SearchSortID - search parameter id (primary key)- int
  • SearchDefinitionID - search definition id - int
  • Parameter - name of search parameter - varchar(255)
  • OrderByPart - pre/built where part of parameter line (optional)- varchar(255)

GetInfoSearchSortBySearchDefinitionID

Returns the object of SearchSort by alternate keys SearchDefinitionID and Parameter.

Syntax
$hSearchSort = GetInfoSearchSortBySearchDefinitionID($SearchDefinitionID, $Parameter);
Input
$SearchDefinitionID (int)
search definition id
$Parameter (varchar(255))
name of search parameter
Return
$hSearchSort (reference to hash)
with following keys:
  • SearchSortID - search parameter id (primary key)- int
  • SearchDefinitionID - search definition id - int
  • Parameter - name of search parameter - varchar(255)
  • OrderByPart - pre/built where part of parameter line (optional)- varchar(255)

GetInfoSearchSortsBySearchDefinitionID

Returns objects of SearchSort by alternate keys SearchDefinitionID and Parameter.

Syntax
$ahSearchSorts = GetInfoSearchSortsBySearchDefinitionID($SearchDefinitionID, $Parameter);
Input
$SearchDefinitionID (int)
search definition id
$Parameter (varchar(255))
name of search parameter (optional)
Return
$ahSearchSorts (reference to array of hashes)
with following keys:
  • SearchSortID - search parameter id (primary key)- int
  • SearchDefinitionID - search definition id - int
  • Parameter - name of search parameter - varchar(255)
  • OrderByPart - pre/built where part of parameter line (optional)- varchar(255)

GetPKeySearchSortBySearchDefinitionID

Returns primary key of SearchSort by alternate keys SearchDefinitionID and Parameter.

Syntax
$SearchSortID = GetPKeySearchSortBySearchDefinitionID($SearchDefinitionID, $Parameter);
Input
$SearchDefinitionID (int)
search definition id
$Parameter (varchar(255))
name of search parameter
Return
$SearchSortID (int)
search parameter id (primary key)

GetPKeySearchSortsBySearchDefinitionID

Returns primary keys of SearchSort by alternate keys SearchDefinitionID and Parameter.

Syntax
$aKeys = GetPKeySearchSortsBySearchDefinitionID($SearchDefinitionID, $Parameter);
Input
$SearchDefinitionID (int)
search definition id
$Parameter (varchar(255))
name of search parameter (optional)
Return
$aKeys (reference to array of int)
search parameter id (primary key)

InsertSearchSort

Creates an entry of SearchSort.

Syntax
$SearchSortID = InsertSearchSort($hSearchSort);
Input
$hSearchSort (reference to hash)
with following keys:
  • SearchSortID - search parameter id (primary key)(optional)- int
  • SearchDefinitionID - search definition id - int
  • Parameter - name of search parameter - varchar(255)
  • OrderByPart - pre/built where part of parameter line (optional)- varchar(255)
Return
$SearchSortID (int)
search parameter id (primary key)

UpdateSearchSort

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

Syntax
UpdateSearchSort($SearchSortID, $hSearchSort);
UpdateSearchSort($hSearchSort); # if $hSearchSort includes SearchSortID
Input
$SearchSortID (int)
search parameter id (primary key)
$hSearchSort (reference to hash)
with following keys:
  • SearchDefinitionID - search definition id - int
  • Parameter - name of search parameter - varchar(255)
  • OrderByPart - pre/built where part of parameter line (optional)- varchar(255)