|
CWIS Developer Documentation
|
Public Member Functions | |
| GlobalSearchEngine () | |
| Constructs a GlobalSearchEngine object. More... | |
| Search ($SearchString, $StartingResult=0, $NumberOfResults=10) | |
| Performs a keyword search using a specified search string and returns the results, starting with the one numbered with the starting result (default 0) and continuing until reaching the desired number of results (default 10). More... | |
| FieldedSearch ($SearchStrings, $StartingResult=0, $NumberOfResults=10) | |
| Performs a search across multiple fields and returns the trimmed results to the caller. More... | |
| NumberOfResults () | |
| Gets the number of results returned in the last search. More... | |
| SearchTime () | |
| Gets the time taken to perform the previous search, in microseconds. More... | |
| PerformSearch ($SetSpec, $StartingResult, $NumberOfResults) | |
| Performs an OAI-SQ search. More... | |
| SearchSite ($SiteInfo, $SetSpec) | |
| Searches one site with a specification of subset of records to be retrieved. More... | |
| GetMicrotime () | |
| Convenience function for getting the time in microseconds. More... | |
Public Attributes | |
| $NumberOfResultsAvailable | |
| $LastSearchTime | |
Definition at line 18 of file GlobalSearchEngine.php.
| GlobalSearchEngine::FieldedSearch | ( | $SearchStrings, | |
$StartingResult = 0, |
|||
$NumberOfResults = 10 |
|||
| ) |
Performs a search across multiple fields and returns the trimmed results to the caller.
| array | $SearchStrings | The strings to be searche for. |
| int | $StartingResult | The number of the starting result. (OPTIONAL) |
| int | $NumberOfResults | The number of results to return. (OPTIONAL) |
Definition at line 66 of file GlobalSearchEngine.php.
| GlobalSearchEngine::GetMicrotime | ( | ) |
Convenience function for getting the time in microseconds.
Definition at line 194 of file GlobalSearchEngine.php.
Referenced by Search().

| GlobalSearchEngine::GlobalSearchEngine | ( | ) |
Constructs a GlobalSearchEngine object.
Definition at line 25 of file GlobalSearchEngine.php.
| GlobalSearchEngine::NumberOfResults | ( | ) |
Gets the number of results returned in the last search.
Definition at line 74 of file GlobalSearchEngine.php.
References $NumberOfResultsAvailable.
| GlobalSearchEngine::PerformSearch | ( | $SetSpec, | |
| $StartingResult, | |||
| $NumberOfResults | |||
| ) |
Performs an OAI-SQ search.
| string | $SetSpec | The specification of a set of OAI resources |
| int | $StartingResult | The number of the starting result. |
| int | $NumberOfResults | The number of results to retun. |
Compares the search score of two search results.
| array | $ResultA | The first search result to be compared. |
| array | $ResultB | The second search result to be compared. |
Definition at line 98 of file GlobalSearchEngine.php.
References SearchSite().
Referenced by Search().

| GlobalSearchEngine::Search | ( | $SearchString, | |
$StartingResult = 0, |
|||
$NumberOfResults = 10 |
|||
| ) |
Performs a keyword search using a specified search string and returns the results, starting with the one numbered with the starting result (default 0) and continuing until reaching the desired number of results (default 10).
| string | $SearchString | The string to search for. |
| int | $StartingResult | The number of the starting result. (OPTIONAL) |
| int | $NumberOfResults | The number of results to return. (OPTIONAL) |
Definition at line 39 of file GlobalSearchEngine.php.
References GetMicrotime(), and PerformSearch().
| GlobalSearchEngine::SearchSite | ( | $SiteInfo, | |
| $SetSpec | |||
| ) |
Searches one site with a specification of subset of records to be retrieved.
| array | $SiteInfo | An array containing an OAI repository URL |
| string | $SetSpec | The specification of a set of OAI resources |
Definition at line 143 of file GlobalSearchEngine.php.
Referenced by PerformSearch().

| GlobalSearchEngine::SearchTime | ( | ) |
Gets the time taken to perform the previous search, in microseconds.
Definition at line 80 of file GlobalSearchEngine.php.
References $LastSearchTime.
| GlobalSearchEngine::$LastSearchTime |
Definition at line 89 of file GlobalSearchEngine.php.
Referenced by SearchTime().
| GlobalSearchEngine::$NumberOfResultsAvailable |
Definition at line 88 of file GlobalSearchEngine.php.
Referenced by NumberOfResults().