void liveSearch(
object
$spunq, object
$class
)
|
|
liveSearch::liveSearch()
// purpose: constructor
Parameters:
|
object |
$spunq: |
// spunq core object |
|
object |
$class: |
// current class object |
void __construct(
object
$spunq, object
$class
)
|
|
liveSearch::__construct()
// purpose: constructor for php 5
Parameters:
|
object |
$spunq: |
// spunq core object |
|
object |
$class: |
// current class object |
array addTagsToResults(
$results
)
|
|
liveSearch::addTagsToResults()
// purpose: adds related tags to the result array
Parameters:
API Tags:
| Return: | // completed userdata array |
liveSearch::cleanupKeyword()
// purpose: escapes some characters, eg slashes
liveSearch::createXMLHeader()
// purpose: creates necessary headers for xml response
liveSearch::fullClassSearch()
// purpose: executes a full-text search in the current class
API Tags:
liveSearch::getAllIfEmpty()
// purpose: gets all (e.g. contacts) if nothing has been entered
API Tags:
array getMatchingFolders(
)
|
|
liveSearch::getMatchingFolders()
// purpose: searches folders in the given class containing the keyword
API Tags:
array getSuggestions(
string
$keyword, [string
$order_by = ""], [string
$direction = ""]
)
|
|
liveSearch::getSuggestions()
// purpose: livesearch main function, produces result
Parameters:
|
string |
$keyword: |
// spunq core object |
|
string |
$order_by: |
// order_by field for query |
|
string |
$direction: |
// direction for query (ASC, DESC) |
void setDirection(
string
$direction
)
|
|
liveSearch::setDirection()
// purpose: set direction class variable
Parameters:
|
string |
$direction: |
// direction for query (ASC, DESC) |
void setOrderBy(
string
$order_by
)
|
|
liveSearch::setOrderBy()
// purpose: set order_by class variable
Parameters:
|
string |
$order_by: |
// order_by field for query |
array sortObjects(
$oid_string
)
|
|
liveSearch::sortObjects()
// purpose: sorts objects given by oid1::oid2::oid3... string
Parameters:
API Tags:
