Class flSearchResults
flSearchResults Class
Class to provide access to search results.
-
flSearchResults
implements
Iterator,
Countable
Package: fusionLib
Copyright:
Copyright (c) 2008 - 2013 fusionLib. All rights reserved.
Located at system/libs/Search/flSearchResults.php
Methods summary
public
|
#
__construct( array $results = array(), integer $total = 0 )
Construct the result object.
Construct the result object.
Parameters
- $results
- of results from the search.
- $total
- total number of results if no limits were applied.
|
public
string
|
#
next( )
Get the next result in the list.
Get the next result in the list.
Returns
string
The document name or false.
Implementation of
Iterator::next()
|
public
string
|
#
rewind( )
Rewind to the 1st element.
Rewind to the 1st element.
Returns
string
The document name or false.
Implementation of
Iterator::rewind()
|
public
integer
|
#
key( )
The key of the current result.
The key of the current result.
Returns
integer
The index of the result within the current set.
Implementation of
Iterator::key()
|
public
string
|
#
current( )
Return the current result information.
Return the current result information.
Returns
string
The document name of the currently selected point in the list.
Implementation of
Iterator::current()
|
public
boolean
|
#
valid( )
Test if the current position in the results is valid.
Test if the current position in the results is valid.
Returns
boolean
true if the position is valid; else false.
Implementation of
Iterator::valid()
|
public
integer
|
#
total( )
Return the total number of available documents matching the query.
Return the total number of available documents matching the query.
Returns
integer
The total number of available documents matching the query.
|
public
integer
|
#
count( )
Return the count of the results held in the current set.
Return the count of the results held in the current set.
Returns
integer
The number of results available.
Implementation of
Countable::count()
|