ePages 6.10 - DE_EPAGES/Search/API/Object/PagerSearch.pm

Package DE_EPAGES::Search::API::Object::PagerSearch

object interface for Search.

Base
DE_EPAGES::Presentation::API::Object::Pager
@EXPORT_OK
ReplaceWildcards

Functions

ReplaceWildcards
allItems
countItems
items
new
sortObjects
sqlFrom
sqlSelect
sqlSelectCount
sqlSort
sqlWhere

ReplaceWildcards

replaces * with % and adds on begin and end a %.

Syntax
my $SQLString = ReplaceWildcards($SearchString);
Input
$SearchString (string)
search string can include *
Return
$SQLString (string)
string for sql statement

allItems

Returns all objects of all pages.

Syntax
$aItems = $Pager->allItems;
Return
$aItems (ref.array.object)
list of objects

countItems

returns how many items should be paged.

Syntax
$Object->countItems;
Return
$cItems (integer)
count items

items

load all objects of a page.

Syntax
my $aItems = $Object->items($PageNumber);
Input
$PageNumber (integer)
current page number
Return
$aItems (ref.array)
array tied objects

new

Creates a new search pager object.

Syntax
$Object = $Package->new($hInfo);
Input
$hInfo (ref.hash)
parameters with used keys
  • Servlet - servlet object
Return
$Pager (object)
pager

sortObjects

this function overwrites the standard sort, because the results are already sorted by SQL server to show the right objects at the right page. This function does nothing else.

Syntax
my $aObjects = $Object->sortObjects($aObjects);
Input
$aObjects (ref.array.object)
result objects
Return
$aObjects (ref.array.object)
result objects

sqlFrom

returns the from part of sql statement

Syntax
my $From = $Object->sqlFrom;
Return
$From (string)
part of sql statement

sqlSelect

returns the select part of the sql statement for result columns

Syntax
my $Select = $Object->sqlSelect;
Return
$Select (string)
sql select statement

sqlSelectCount

returns the select part of the sql statement for count of results

Syntax
my $SelectCount = $Object->sqlSelectCount;
Return
$Select (string)
sql select statement

sqlSort

returns the OrderBy part of sql statement

Syntax
my $OrderBy = $Object->sqlSort;
Return
$OrderBy (string)
part of sql statement

sqlWhere

returns the where part of sql statement

Syntax
my $Where = $Object->sqlWhere;
Return
$Where (string)
part of sql statement