Tariqa  3.0
 All Data Structures Namespaces Files Functions Variables Enumerations
multiAjaxSearch Class Reference

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'

Detailed Description

Helper class to generate a multi AJAX search URL


Constructor & Destructor Documentation

__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

Parameters:
string$queryThe query
int$source_idThe source_identifier
string$tariqa_service_urlThe URL of the tariqa service
string$js_nameThe javascript object name [OPTIONAL]
boolean$blobalIf true, the javascript variable is global [OPTIONAL]
int$start_dateThe start date [OPTIONAL]
int$end_dateThe end_date [OPTIONAL]
int$fromThe first result to retrieve [OPTIONAL]
int$countThe number of results to retrieve [OPTIONAL]
string$typeThe type of the query syntax [OPTIONAL]
string$templateThe template name [OPTIONAL] public
Returns:
void

Member Function Documentation

generate_js ( refresh = false)

Creates the javascript code for generating the object

Parameters:
bool$refreshIf true, then also refresh the news [OPTIONAL] public
Returns:
string
getCount ( )

Gets the number of articles to be fetched public

Returns:
int

Gets the end date public

Returns:
int
getFrom ( )

Gets the from parameter public

Returns:
int
getName ( )

Gets the object's javascript name public

Returns:
string

Retrieves the navigation id public

Returns:
string
getQuery ( )

Gets the query public

Returns:
string

Gets the source id of the search public

Returns:
int

Gets the start date public

Returns:
int
getURL ( )

Generates the URL public

Returns:
string
noNewTab ( )

The search will not create a new tab public

Returns:
void
setCount ( count)

Sets the number of articles to be fetched

Parameters:
int$countThe value public
Returns:
void
setCurrentPage ( page)

Sets the current page

Parameters:
int$pageThe page number (0 based) public
Returns:
void
setEndDate ( end_date)

Sets the end date

Parameters:
int$end_dateThe date (UNIX timestamp) public
Returns:
void
setFrom ( from)

Sets the from parameter

Parameters:
int$fromThe value public
Returns:
void
setNavigationId ( id)

Sets the id of the HTML div that will display the navigation of the search

Parameters:
string$idThe id public
Returns:
void
setQuery ( query)

Sets the query

Parameters:
string$queryThe query public
Returns:
void
setResultId ( id)

Sets the id of the HTML div that will display the results of the search

Parameters:
string$idThe id public
Returns:
void
setSpecificData ( data)

Sets the engine specific data

Parameters:
string$dataThe data public
Returns:
void
setStartDate ( start_date)

Sets the start date

Parameters:
int$start_dateUNIX timestamp public
Returns:
void
setTabId ( id)

Sets the tab identifier

Parameters:
string$idThe identifier public
Returns:
void

Field Documentation

const ORIGINAL_SYNTAX = 'OS'
const UNIFIED_QUERY_SYNTAX = 'UQS'

The documentation for this class was generated from the following file: