baseSearchInterface
Search Interface definition, defines what should be include in a search object to make building search systems a little easier and more conformant. Should be used via either baseSearch or as a standalone implmentation.
Calls to baseSearchInterface::search() expect a baseResultSet to be returned.
Methods
public abstract reset()
Resets the search fields to defaults
public abstract canSearchRun()
Returns true if the search can be run, false otherwise
public abstract search()
Runs the search using the class data, returning a resultSet
public abstract buildSelect($inQuery)
Builds the SELECT statement for the search query, query is passed by reference
public abstract buildWhere($inQuery)
Builds the WHERE statement for the search query, query is passed by reference
public abstract buildOrderBy($inQuery)
Builds the ORDER BY statement for the search query, query is passed by reference
public abstract buildLimit($inQuery)
Builds the LIMIT statement for the search query, query is passed by reference
public abstract getOffset()
Return the current offset
public abstract getLimit()
Return the current limit
Posted by: Scorpio Documentor (Writer), in Base on 19 Nov 2009 @ 20:30
Tags: base, basesearchinterface,
This
work is licenced under a
Creative Commons Licence.