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

Package DE_EPAGES::Search::API::Table::SearchTerm

interface for table SearchTerm

@EXPORT_OK
InsertSearchTerm
UpdateSearchTerm
DeleteSearchTerm
GetAllPKeySearchTerms
GetAllInfoSearchTerms
GetInfoSearchTerm
ExistsSearchTerm
GetPKeySearchTermBySiteID
GetInfoSearchTermBySiteID
ExistsSearchTermBySiteID
GetPKeySearchTermsBySiteID
GetInfoSearchTermsBySiteID

Functions

DeleteSearchTerm
ExistsSearchTerm
ExistsSearchTermBySiteID
GetAllInfoSearchTerms
GetAllPKeySearchTerms
GetInfoSearchTerm
GetInfoSearchTermBySiteID
GetInfoSearchTermsBySiteID
GetPKeySearchTermBySiteID
GetPKeySearchTermsBySiteID
InsertSearchTerm
UpdateSearchTerm

DeleteSearchTerm

Deletes a(n) SearchTerm.

Syntax
DeleteSearchTerm($SearchTermID);
DeleteSearchTerm($hSearchTerm); # if $hSearchTerm includes SearchTermID
Input
$SearchTermID (int)
search term id (primary key)

ExistsSearchTerm

Returns true if the SearchTerm exists.

Syntax
$exists = ExistsSearchTerm($SearchTermID);
Input
$SearchTermID (int)
search term id
Return
$exists (boolean)
1/0 the SearchTerm exists (yes/no)

ExistsSearchTermBySiteID

Returns true if a SearchTerm by alternate keys SiteID and Term exists.

Syntax
$SearchTermID = ExistsSearchTermBySiteID($SiteID, $Term);
Input
$SiteID (int)
site id
$Term (nvarchar(40))
Search term which was entered in the storefront.
Return
$exists (boolean)
1/0 the u_searchterm_site exists (yes/no)

GetAllInfoSearchTerms

Returns all objects of SearchTerm.

Syntax
$ahSearchTerms = GetAllInfoSearchTerms();
Return
$ahSearchTerms (reference to array of hashes)
with following keys:
  • SearchTermID - search term id (primary key)- int
  • SiteID - site id - int
  • Term - Search term which was entered in the storefront. - nvarchar(40)
  • CountResults - Number of results which were provided by searching the term. - int
  • CountRequests - Number of times the search term was entered in the storefront search. - int

GetAllPKeySearchTerms

Returns all SearchTerm identifiers.

Syntax
$aSearchTermIDs = GetAllPKeySearchTerms();
Return
$aSearchTermIDs (reference to array of int)
search term id

GetInfoSearchTerm

Returns the SearchTerm by identifier.

Syntax
$hSearchTerm = GetInfoSearchTerm($SearchTermID);
Input
$SearchTermID (int)
search term id (primary key)
Return
$hSearchTerm (reference to hash)
with following keys:
  • SearchTermID - search term id (primary key)- int
  • SiteID - site id - int
  • Term - Search term which was entered in the storefront. - nvarchar(40)
  • CountResults - Number of results which were provided by searching the term. - int
  • CountRequests - Number of times the search term was entered in the storefront search. - int

GetInfoSearchTermBySiteID

Returns the object of SearchTerm by alternate keys SiteID and Term.

Syntax
$hSearchTerm = GetInfoSearchTermBySiteID($SiteID, $Term);
Input
$SiteID (int)
site id
$Term (nvarchar(40))
Search term which was entered in the storefront.
Return
$hSearchTerm (reference to hash)
with following keys:
  • SearchTermID - search term id (primary key)- int
  • SiteID - site id - int
  • Term - Search term which was entered in the storefront. - nvarchar(40)
  • CountResults - Number of results which were provided by searching the term. - int
  • CountRequests - Number of times the search term was entered in the storefront search. - int

GetInfoSearchTermsBySiteID

Returns objects of SearchTerm by alternate keys SiteID and Term.

Syntax
$ahSearchTerms = GetInfoSearchTermsBySiteID($SiteID, $Term);
Input
$SiteID (int)
site id
$Term (nvarchar(40))
Search term which was entered in the storefront. (optional)
Return
$ahSearchTerms (reference to array of hashes)
with following keys:
  • SearchTermID - search term id (primary key)- int
  • SiteID - site id - int
  • Term - Search term which was entered in the storefront. - nvarchar(40)
  • CountResults - Number of results which were provided by searching the term. - int
  • CountRequests - Number of times the search term was entered in the storefront search. - int

GetPKeySearchTermBySiteID

Returns primary key of SearchTerm by alternate keys SiteID and Term.

Syntax
$SearchTermID = GetPKeySearchTermBySiteID($SiteID, $Term);
Input
$SiteID (int)
site id
$Term (nvarchar(40))
Search term which was entered in the storefront.
Return
$SearchTermID (int)
search term id (primary key)

GetPKeySearchTermsBySiteID

Returns primary keys of SearchTerm by alternate keys SiteID and Term.

Syntax
$aKeys = GetPKeySearchTermsBySiteID($SiteID, $Term);
Input
$SiteID (int)
site id
$Term (nvarchar(40))
Search term which was entered in the storefront. (optional)
Return
$aKeys (reference to array of int)
search term id (primary key)

InsertSearchTerm

Creates an entry of SearchTerm.

Syntax
$SearchTermID = InsertSearchTerm($hSearchTerm);
Input
$hSearchTerm (reference to hash)
with following keys:
  • SearchTermID - search term id (primary key)(optional)- int
  • SiteID - site id - int
  • Term - Search term which was entered in the storefront. - nvarchar(40)
  • CountResults - Number of results which were provided by searching the term. - int
  • CountRequests - Number of times the search term was entered in the storefront search. - int
Return
$SearchTermID (int)
search term id (primary key)

UpdateSearchTerm

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

Syntax
UpdateSearchTerm($SearchTermID, $hSearchTerm);
UpdateSearchTerm($hSearchTerm); # if $hSearchTerm includes SearchTermID
Input
$SearchTermID (int)
search term id (primary key)
$hSearchTerm (reference to hash)
with following keys:
  • SiteID - site id - int
  • Term - Search term which was entered in the storefront. - nvarchar(40)
  • CountResults - Number of results which were provided by searching the term. - int
  • CountRequests - Number of times the search term was entered in the storefront search. - int