Tariqa SOAP
 All Data Structures Namespaces Files Functions Variables Enumerations
tariqaQueriesAndSources Class Reference
Inheritance diagram for tariqaQueriesAndSources:
Tariqa

Public Member Functions

 __construct ($config, $soap)
 GetHomePageFlavours ($token)
 GetHomepageQueries ($token)
 GetVideoQueries ($token)
 ListQuickSearchSources ($token)
 GetSource ($token, $source_id)
 ListSources ($token)
 ListFullSearchSources ($token)
 GetFlavour ($token, $flavour_id)
 ListFlavours ($token)
 _getEngine ($token, $engine_id)
 GetEngine ($token, $engine_id)
 ListEngines ($token)
 GetQuery ($token, $query_id, $get_source=false, $get_engine=false)
 ListQueries ($token, $source_id=null, $weblogs_data=false)
 GetCountryQueries ($token, $country, $flavour_id=null)
 GetRegionQueries ($token, $region_id, $flavour_id=null)
 ListNewStickerGroups ($token)
 filterQueries ($queries, $user_id, $no_articles=true, $token=null)

Data Fields

 $soap

Protected Attributes

 $config = null

Constructor & Destructor Documentation

__construct ( config,
soap 
)

Constructs a tariqaThemes Object

Returns:
Tariqa

Member Function Documentation

_getEngine ( token,
engine_id 
)

Get the content of an engine without authentication

Parameters:
string$tokenThe session identifier
string$engine_idThe engine identifier
Returns:
Engine
filterQueries ( queries,
user_id,
no_articles = true,
token = null 
)

Filters the list of queries

Parameters:
Query[]$queries The list of queries
string$user_idThe user identifier
boolean$no_articlesIf true, then also include the queries with no results (this is only for aggregated RSS) [OPTIONAL]
string$tokenThe session identifier [OPTIONAL] public
Returns:
Query[]
GetCountryQueries ( token,
country,
flavour_id = null 
)

Get the list of available queries for a defined contry

Parameters:
string$tokenThe session identifier
Country$countryThe selected country
int$flavour_idThe flavour identifier [OPTIONAL]
Returns:
Query[]
GetEngine ( token,
engine_id 
)

Get the content of an engine

Parameters:
string$tokenThe session identifier
string$engine_idThe engine identifier
Returns:
Engine
GetFlavour ( token,
flavour_id 
)

Get the content of flavour

Parameters:
string$tokenThe session identifier
int$flavour_idThe flavour identifier
Returns:
Flavour
GetHomePageFlavours ( token)

Get the list of available Flavours for the homepage

Parameters:
string$tokenThe session identifier
Returns:
Flavour[]
GetHomepageQueries ( token)

Get the list of available queries for the homepage

Parameters:
string$tokenThe session identifier
Returns:
Query[]
GetQuery ( token,
query_id,
get_source = false,
get_engine = false 
)

Get the content of a query

Parameters:
string$tokenThe session identifier
int$query_idThe query identifier
boolean$get_sourceIf set to true, also fetch the source [OPTIONAL]
boolean$get_engineIf set to true, also fetch the engine [OPTIONAL]
Returns:
Query
GetRegionQueries ( token,
region_id,
flavour_id = null 
)

Get the list of available queries for a defined region

Parameters:
string$tokenThe session identifier
int$region_idThe selected country
int$flavour_idThe flavour identifier [OPTIONAL]
Returns:
Query[]
GetSource ( token,
source_id 
)

Get the content of a source

Parameters:
string$tokenThe session identifier
int$source_idThe source identifier
Returns:
Source
GetVideoQueries ( token)

Get the list of available queries for the homepage

Parameters:
string$tokenThe session identifier
Returns:
Query[]
ListEngines ( token)

Get the list of available engines

Parameters:
string$tokenThe session identifier
Returns:
Engine[]
ListFlavours ( token)

Get the list of available flavours

Parameters:
string$tokenThe session identifier
Returns:
Flavour[]
ListFullSearchSources ( token)

Lists the full search sources

Parameters:
string$tokenThe session identifier public
Returns:
FullSearchSource[]
ListNewStickerGroups ( token)

Lists the news stickers groups

Parameters:
string$tokenThe session identifier
Returns:
NewStickerGroup[]
ListQueries ( token,
source_id = null,
weblogs_data = false 
)

Get the list of available queries

Parameters:
string$tokenThe session identifier
int$source_idThe source identifier of the queries to retrieve [OPTIONAL]
boolean$weblogs_dataIf true, then get also the weblogs data [OPTIONAL]
Returns:
Query[]
ListQuickSearchSources ( token)

Get the list of quicksearch sources

Parameters:
string$tokenThe session identifier
Returns:
QuickSearchSource[]
ListSources ( token)

Get the list of available sources

Parameters:
string$tokenThe session identifier
Returns:
Source[]

Field Documentation

$config = null [protected]

Reimplemented from Tariqa.

$soap

Reimplemented from Tariqa.


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