Tariqa
3.0
|
Public Member Functions | |
__construct ($query, $source_id, $tariqa_service_url, $js_name= 'generic_object', $global=false, $start_date=null, $end_date=null, $from=null, $count=null, $type=null, $template=null) | |
getName () | |
setCurrentPage ($page) | |
setSpecificData ($data) | |
getURL () | |
generate_js ($refresh=false) | |
setResultId ($id) | |
setNavigationId ($id) | |
noNewTab () | |
getSourceId () | |
setTabId ($id) | |
getNavigationId () | |
setStartDate ($start_date) | |
getStartDate () | |
setEndDate ($end_date) | |
getEndDate () | |
setQuery ($query) | |
getQuery () | |
setFrom ($from) | |
getFrom () | |
setCount ($count) | |
getCount () | |
Data Fields | |
const | UNIFIED_QUERY_SYNTAX = 'UQS' |
const | ORIGINAL_SYNTAX = 'OS' |
Helper class to generate a multi AJAX search URL
__construct | ( | $ | query, |
$ | source_id, | ||
$ | tariqa_service_url, | ||
$ | js_name = 'generic_object' , |
||
$ | global = false , |
||
$ | start_date = null , |
||
$ | end_date = null , |
||
$ | from = null , |
||
$ | count = null , |
||
$ | type = null , |
||
$ | template = null |
||
) |
Constructs the object
string | $query | The query |
int | $source_id | The source_identifier |
string | $tariqa_service_url | The URL of the tariqa service |
string | $js_name | The javascript object name [OPTIONAL] |
boolean | $blobal | If true, the javascript variable is global [OPTIONAL] |
int | $start_date | The start date [OPTIONAL] |
int | $end_date | The end_date [OPTIONAL] |
int | $from | The first result to retrieve [OPTIONAL] |
int | $count | The number of results to retrieve [OPTIONAL] |
string | $type | The type of the query syntax [OPTIONAL] |
string | $template | The template name [OPTIONAL] public |
generate_js | ( | $ | refresh = false | ) |
Creates the javascript code for generating the object
bool | $refresh | If true, then also refresh the news [OPTIONAL] public |
getCount | ( | ) |
Gets the number of articles to be fetched public
getEndDate | ( | ) |
Gets the end date public
getFrom | ( | ) |
Gets the from parameter public
getName | ( | ) |
Gets the object's javascript name public
getNavigationId | ( | ) |
Retrieves the navigation id public
getQuery | ( | ) |
Gets the query public
getSourceId | ( | ) |
Gets the source id of the search public
getStartDate | ( | ) |
Gets the start date public
getURL | ( | ) |
Generates the URL public
noNewTab | ( | ) |
The search will not create a new tab public
setCount | ( | $ | count | ) |
Sets the number of articles to be fetched
int | $count | The value public |
setCurrentPage | ( | $ | page | ) |
Sets the current page
int | $page | The page number (0 based) public |
setEndDate | ( | $ | end_date | ) |
Sets the end date
int | $end_date | The date (UNIX timestamp) public |
setFrom | ( | $ | from | ) |
Sets the from parameter
int | $from | The value public |
setNavigationId | ( | $ | id | ) |
Sets the id of the HTML div that will display the navigation of the search
string | $id | The id public |
setQuery | ( | $ | query | ) |
Sets the query
string | $query | The query public |
setResultId | ( | $ | id | ) |
Sets the id of the HTML div that will display the results of the search
string | $id | The id public |
setSpecificData | ( | $ | data | ) |
Sets the engine specific data
string | $data | The data public |
setStartDate | ( | $ | start_date | ) |
Sets the start date
int | $start_date | UNIX timestamp public |
setTabId | ( | $ | id | ) |
Sets the tab identifier
string | $id | The identifier public |
const ORIGINAL_SYNTAX = 'OS' |
const UNIFIED_QUERY_SYNTAX = 'UQS' |