Tariqa  3.0
 All Data Structures Namespaces Files Functions Variables Enumerations
AggregatorsIDOLEngine Class Reference
Inheritance diagram for AggregatorsIDOLEngine:
searchEngine RSS_aggregatorIDOLEngine

Public Member Functions

 __construct ($newsConfig)
 listArticles ($query)
 multimediaMimeType ($url)
 getArticle ($article_id)
 newsSection ($flavour, $filtering, $flavour_query)
 multiAjaxSearch ($query, $from, $count, $startDate=null, $endDate=null)
 getSavePost ($query_txt, $query, $start_date=null, $end_date=null, $additional_parameters=array())

Static Public Member Functions

static sortArticles ($a1, $a2)

Data Fields

const ARTICLE_SHORT = 'short'
const ARTICLE_LONG = 'long'

Detailed Description

Base class for fetching the news results from the RSS_aggregator or LatestNews_aggregator engine

Author:
Cosmin Popescu

Constructor & Destructor Documentation

__construct ( newsConfig)

Constructs the object

Parameters:
array$newsConfigThe news configuration array public
Returns:
void

Reimplemented from searchEngine.

Reimplemented in RSS_aggregatorIDOLEngine.


Member Function Documentation

getArticle ( article_id)

Gets a specific article

Parameters:
string$article_idThe article identifier public
Returns:
tariqaFullDocument

Reimplemented from searchEngine.

getSavePost ( query_txt,
query,
start_date = null,
end_date = null,
additional_parameters = array() 
)

Gets the POST data used for saving a search in the briefcase

Parameters:
string$query_txtThe query string text
Query$queryThe query
int$start_dateThe start date (unix timestamp) [OPTIONAL]
int$end_dateThe end date (unix timestamp) [OPTIONAL]
array$additional_parametersAdditional parameters [OPTIONAL] public
Returns:
string

Reimplemented from searchEngine.

listArticles ( query)

Fetches a list of articles

Parameters:
newsQuery$queryThe query public
Returns:
tariqaSearchResultSet

Reimplemented from searchEngine.

multiAjaxSearch ( query,
from,
count,
startDate = null,
endDate = null 
)

Gets the multi ajax search object

Parameters:
string$queryThe query string
int$fromThe first result to display
int$countThe number of results to display
DateTime$startDateThe start date [OPTIONAL]
DateTime$endDateThe end date [OPTIONAL] public
Returns:
multiAjaxSearch

Reimplemented from searchEngine.

multimediaMimeType ( url)

Returns true if an extension comes from a multimedia file

Parameters:
string$urlThe url to check for extension public
Returns:
boolean
newsSection ( flavour,
filtering,
flavour_query 
)

Gets the multi ajax search object for any page but the search page. For example country pages, home page, news wires page etc.

Parameters:
Flavour$flavourThe flavour
array$filteringThe filtering data
Query$flavour_queryThe flavour current query public
Returns:
multiAjaxSearch
static sortArticles ( a1,
a2 
) [static]

Function used for sorting the articles by date

Parameters:
RSS_article$a1The first article
RSS_article$a2The second article

public

Returns:
boolean

Field Documentation

const ARTICLE_LONG = 'long'
const ARTICLE_SHORT = 'short'

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