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
Member Function Documentation
Get the content of an engine without authentication
- Parameters:
-
string | $token | The session identifier |
string | $engine_id | The 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_id | The user identifier |
boolean | $no_articles | If true, then also include the queries with no results (this is only for aggregated RSS) [OPTIONAL] |
string | $token | The session identifier [OPTIONAL] public |
- Returns:
- Query[]
Get the list of available queries for a defined contry
- Parameters:
-
string | $token | The session identifier |
Country | $country | The selected country |
int | $flavour_id | The flavour identifier [OPTIONAL] |
- Returns:
- Query[]
Get the content of an engine
- Parameters:
-
string | $token | The session identifier |
string | $engine_id | The engine identifier |
- Returns:
- Engine
Get the content of flavour
- Parameters:
-
string | $token | The session identifier |
int | $flavour_id | The flavour identifier |
- Returns:
- Flavour
Get the list of available Flavours for the homepage
- Parameters:
-
string | $token | The session identifier |
- Returns:
- Flavour[]
Get the list of available queries for the homepage
- Parameters:
-
string | $token | The session identifier |
- Returns:
- Query[]
GetQuery |
( |
$ |
token, |
|
|
$ |
query_id, |
|
|
$ |
get_source = false , |
|
|
$ |
get_engine = false |
|
) |
| |
Get the content of a query
- Parameters:
-
string | $token | The session identifier |
int | $query_id | The query identifier |
boolean | $get_source | If set to true, also fetch the source [OPTIONAL] |
boolean | $get_engine | If set to true, also fetch the engine [OPTIONAL] |
- Returns:
- Query
Get the list of available queries for a defined region
- Parameters:
-
string | $token | The session identifier |
int | $region_id | The selected country |
int | $flavour_id | The flavour identifier [OPTIONAL] |
- Returns:
- Query[]
Get the content of a source
- Parameters:
-
string | $token | The session identifier |
int | $source_id | The source identifier |
- Returns:
- Source
Get the list of available queries for the homepage
- Parameters:
-
string | $token | The session identifier |
- Returns:
- Query[]
Get the list of available engines
- Parameters:
-
string | $token | The session identifier |
- Returns:
- Engine[]
Get the list of available flavours
- Parameters:
-
string | $token | The session identifier |
- Returns:
- Flavour[]
Lists the full search sources
- Parameters:
-
string | $token | The session identifier public |
- Returns:
- FullSearchSource[]
Lists the news stickers groups
- Parameters:
-
string | $token | The session identifier |
- Returns:
- NewStickerGroup[]
ListQueries |
( |
$ |
token, |
|
|
$ |
source_id = null , |
|
|
$ |
weblogs_data = false |
|
) |
| |
Get the list of available queries
- Parameters:
-
string | $token | The session identifier |
int | $source_id | The source identifier of the queries to retrieve [OPTIONAL] |
boolean | $weblogs_data | If true, then get also the weblogs data [OPTIONAL] |
- Returns:
- Query[]
Get the list of quicksearch sources
- Parameters:
-
string | $token | The session identifier |
- Returns:
- QuickSearchSource[]
Get the list of available sources
- Parameters:
-
string | $token | The session identifier |
- Returns:
- Source[]
Field Documentation
$config = null [protected] |
The documentation for this class was generated from the following file: