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

Public Member Functions

 __construct ($config, $soap)
 ListNewstickersFeeds ($token)
 GetAllAggregatedRSSFeed ($token)
 GetAggregatedRSSFeed ($token, $feed_id)
 ListAggregatedRSSFeeds ($token, $title=null)
 ListAggregatedRSSFeeds2 ($token, $feeds_list)
 GetCountryAggregatedRSSFeeds ($token, $country)
 GetThemeAggregatedRSSFeeds ($token, $theme_id)
 GetAggregatedRSSArticle ($token, $article_id)
 ListAggregatedRSSArticles ($token, $feed_id=null, $time_range=null, $record_range_from=null, $record_range_no=null, $time_range_count=null, $query=null)
 GetAggregatedRSSArticlesNumber ($token, $feed_id=null, $time_range=null, $time_range_count=null, $query=null)
 GetCountryAggregatedRSSArticles ($token, $country, $time_range=null, $time_range_count=null, $record_range_from=null, $record_range_no=null, $query=null)
 GetCountryAggregatedRSSArticlesNumber ($token, $country, $time_range=null, $time_range_count=null, $record_range_from=null, $record_range_no=null, $query=null)
 GetThemeAggregatedRSSArticles ($token, $theme_id, $time_range=null, $time_range_count=null, $record_range_from=null, $record_range_no=null, $query=null)
 GetAggregatedLatestnewsFeed ($token, $feed_id)
 ListAggregatedLatestnewsFeeds ($token, $title=null)
 GetAggregatedLatestnewsCountryFeeds ($token, $country)
 GetAggregatedLatestnewsThemeFeeds ($token, $theme_id)
 GetAggregatedLatestnewsArticle ($token, $article_id)
 ListAggregatedLatestnewsArticles ($token, $feed_id=null, $time_range=null, $record_range_from=null, $record_range_no=null, $time_range_count=null, $query=null)
 GetAggregatedLatestnewsArticlesNumber ($token, $feed_id=null, $time_range=null, $time_range_count=null, $query=null)
 GetAggregatedLatestnewsCountryArticlesNumber ($token, $country, $time_range=null, $time_range_count=null, $query=null)
 GetAggregatedLatestnewsCountryArticles ($token, $country, $time_range=null, $time_range_count=null, $record_range_from=null, $record_range_no=null, $query=null)
 GetAggregatedLatestnewsThemeArticles ($token, $theme_id, $time_range=null, $time_range_count=null, $record_range_from=null, $record_range_no=null, $query=null)
 CreateAggregatedRSSFeed ($token, $feed, $country, $theme)
 UpdateAggregatedRSSFeed ($token, $feed)
 DeleteAggregatedRSSFeed ($token, $feed_id)
 CreateAggregatedLatestnewsFeed ($token, $feed, $country, $theme)
 UpdateAggregatedLatestnewsFeed ($token, $feed)
 DeleteAggregatedLatestnewsFeed ($token, $feed_id)
 aggregatedSearchIDOL ($token, $query, $extra_data=null)
 aggregatedGetDocumentIDOL ($token, $id, $highlight=null)

Data Fields

 $soap

Protected Attributes

 $config = null

Constructor & Destructor Documentation

__construct ( config,
soap 
)

Constructs a tariqaThemes Object

Returns:
Tariqa

Member Function Documentation

aggregatedGetDocumentIDOL ( token,
id,
highlight = null 
)

Fetches a latest news IDOL document

Parameters:
string$tokenThe token identifier
int$idThe document identifier
string$highlightThe terms to be highlighted [OPTIONAL] public
Returns:
RSS_article
aggregatedSearchIDOL ( token,
query,
extra_data = null 
)

Performs a search in the aggregated databases

Parameters:
string$tokenThe token identifier
AggregatedQuery$queryThe query
string$extra_dataExtra data lines (GET encoded) [OPTIONAL] public
Returns:
AggregatedResultSet
CreateAggregatedLatestnewsFeed ( token,
feed,
country,
theme 
)

Creates a new Latestnews Feed

Parameters:
string$tokenThe session identifier
Latestnews_feed$feedThe new feed to be inserted in the database
Country$countryThe feed country (null if there is not a country for this feed)
Theme$themeThe feed theme (null if there is not a theme for this feed)
Returns:
boolean
CreateAggregatedRSSFeed ( token,
feed,
country,
theme 
)

Creates a new RSS Feed

Parameters:
string$tokenThe session identifier
RSS_feed$feedThe new feed to be inserted in the database
Country$countryThe feed country (null if there is not a country for this feed)
Theme$themeThe feed theme (null if there is not a theme for this feed)
Returns:
boolean
DeleteAggregatedLatestnewsFeed ( token,
feed_id 
)

Deletes a Latestnews Feed

Parameters:
string$tokenThe session identifier
int$feed_idThe feed identificator
Returns:
boolean
DeleteAggregatedRSSFeed ( token,
feed_id 
)

Deletes a RSS Feed

Parameters:
string$tokenThe session identifier
int$feed_idThe feed identificator
Returns:
boolean
GetAggregatedLatestnewsArticle ( token,
article_id 
)

Get an article from Latestnews Aggregator

Parameters:
string$tokenThe session identifier
int$article_idThe article identifier
Returns:
Latestnews_article
GetAggregatedLatestnewsArticlesNumber ( token,
feed_id = null,
time_range = null,
time_range_count = null,
query = null 
)

Get the number of available articles from Latestnews aggregator

Parameters:
string$tokenThe session identifier
int$feed_idThe feed identifier (null means all articles) [OPTIONAL]
int$time_rangeThe time range for articles in days (null means all articles) [OPTIONAL]
int$time_range_countThe number of days starting from time range (null means all articles) [OPTIONAL]
string$queryThe query to search from [OPTIONAL]
Returns:
int
GetAggregatedLatestnewsCountryArticles ( token,
country,
time_range = null,
time_range_count = null,
record_range_from = null,
record_range_no = null,
query = null 
)

Get the list of available latestnews articles for a country

Parameters:
string$tokenThe session identifier
Country$countryThe selected country
int$time_rangeThe time range for articles in days (null means all articles) [OPTIONAL]
int$time_range_countThe time range count for articles in days (null means all articles) [OPTIONAL]
int$record_range_fromThe number of the first article to be retrieved (null means all articles) [OPTIONAL]
int$record_range_noThe number of the first articles to be retrieved from the first article (null means all articles) [OPTIONAL]
string$queryThe query to search from [OPTIONAL]
Returns:
Latestnews_article[]
GetAggregatedLatestnewsCountryArticlesNumber ( token,
country,
time_range = null,
time_range_count = null,
query = null 
)

Get the number of available latestnews articles for a country

Parameters:
string$tokenThe session identifier
Country$countryThe selected country
int$time_rangeThe time range for articles in days (null means all articles) [OPTIONAL]
int$time_range_countThe time range count for articles in days (null means all articles) [OPTIONAL]
string$queryThe query to search from [OPTIONAL]
Returns:
int
GetAggregatedLatestnewsCountryFeeds ( token,
country 
)

Get the list of available latestnews feeds for a selected country

Parameters:
string$tokenThe session identifier
Country$countryThe selected country
Returns:
Latestnews_feed[]
GetAggregatedLatestnewsFeed ( token,
feed_id 
)

Get a feed from Latestnews Aggregator

Parameters:
string$tokenThe session identifier
int$feed_idThe feed identifier
Returns:
Latestnews_feed
GetAggregatedLatestnewsThemeArticles ( token,
theme_id,
time_range = null,
time_range_count = null,
record_range_from = null,
record_range_no = null,
query = null 
)

Get the list of available latestnews articles for a theme

Parameters:
string$tokenThe session identifier
int$theme_idThe selected theme
int$time_rangeThe time range for articles in days (null means all articles) [OPTIONAL]
int$time_range_countThe time range count for articles in days (null means all articles) [OPTIONAL]
int$record_range_fromThe number of the first article to be retrieved (null means all articles) [OPTIONAL]
int$record_range_noThe number of the first articles to be retrieved from the first article (null means all articles) [OPTIONAL]
string$queryThe query to search from [OPTIONAL]
Returns:
RSS_article[]
GetAggregatedLatestnewsThemeFeeds ( token,
theme_id 
)

Get the list of available latestnews feeds for a selected theme

Parameters:
string$tokenThe session identifier
int$theme_idThe selected theme
Returns:
Latestnews_feed[]
GetAggregatedRSSArticle ( token,
article_id 
)

Get an article from the RSS Aggregator

Parameters:
string$tokenThe session identifier
int$article_idThe article identifier
Returns:
RSS_article
GetAggregatedRSSArticlesNumber ( token,
feed_id = null,
time_range = null,
time_range_count = null,
query = null 
)

Get the number of available articles from the Aggregator

Parameters:
string$tokenThe session identifier
int$feed_idThe feed identifier (null means all articles) [OPTIONAL]
int$time_rangeThe time range for articles in days (null means all articles) [OPTIONAL]
int$time_range_countThe time range count for articles in days (null means all articles) [OPTIONAL]
string$queryThe query to search from [OPTIONAL]
Returns:
int
GetAggregatedRSSFeed ( token,
feed_id 
)

Get a feed from RSS Aggregator

Parameters:
string$tokenThe session identifier
int$feed_idThe feed identifier
Returns:
RSS_feed

Get all feeds from the RSS Aggregator

Parameters:
string$tokenThe session identifier
Returns:
RSS_feed[]
GetCountryAggregatedRSSArticles ( token,
country,
time_range = null,
time_range_count = null,
record_range_from = null,
record_range_no = null,
query = null 
)

Get the list of available articles for a country from the RSS Aggregator

Parameters:
string$tokenThe session identifier
Country$countryThe selected country
int$time_rangeThe time range for articles in days (null means all articles) [OPTIONAL]
int$time_range_countThe time range count for articles in days (null means all articles) [OPTIONAL]
int$record_range_fromThe number of the first article to be retrieved (null means all articles) [OPTIONAL]
int$record_range_noThe number of the first articles to be retrieved from the first article (null means all articles) [OPTIONAL]
string$queryThe query to search from [OPTIONAL]
Returns:
RSS_article[]
GetCountryAggregatedRSSArticlesNumber ( token,
country,
time_range = null,
time_range_count = null,
record_range_from = null,
record_range_no = null,
query = null 
)

Get the list of available articles for a country from the RSS Aggregator

Parameters:
string$tokenThe session identifier
Country$countryThe selected country
int$time_rangeThe time range for articles in days (null means all articles) [OPTIONAL]
int$time_range_countThe time range count for articles in days (null means all articles) [OPTIONAL]
int$record_range_fromThe number of the first article to be retrieved (null means all articles) [OPTIONAL]
int$record_range_noThe number of the first articles to be retrieved from the first article (null means all articles) [OPTIONAL]
string$queryThe query to search from [OPTIONAL]
Returns:
int
GetCountryAggregatedRSSFeeds ( token,
country 
)

Get the list of available feeds for a selected country from the RSS aggregator

Parameters:
string$tokenThe session identifier
Country$countryThe selected country
Returns:
RSS_feed[]
GetThemeAggregatedRSSArticles ( token,
theme_id,
time_range = null,
time_range_count = null,
record_range_from = null,
record_range_no = null,
query = null 
)

Get the list of available articles for a theme

Parameters:
string$tokenThe session identifier
int$theme_idThe selected theme
int$time_rangeThe time range for articles in days (null means all articles) [OPTIONAL]
int$time_range_countThe time range count for articles in days (null means all articles) [OPTIONAL]
int$record_range_fromThe number of the first article to be retrieved (null means all articles) [OPTIONAL]
int$record_range_noThe number of the first articles to be retrieved from the first article (null means all articles) [OPTIONAL]
string$queryThe query to search from [OPTIONAL]
Returns:
RSS_article[]
GetThemeAggregatedRSSFeeds ( token,
theme_id 
)

Get the list of available feeds for a selected theme from the RSS Aggregator

Parameters:
string$tokenThe session identifier
int$theme_idThe selected theme
Returns:
RSS_feed[]
ListAggregatedLatestnewsArticles ( token,
feed_id = null,
time_range = null,
record_range_from = null,
record_range_no = null,
time_range_count = null,
query = null 
)

Get the list of available articles from Latestnews aggregator

Parameters:
string$tokenThe session identifier
int$feed_idThe feed identifier (null means all articles) [OPTIONAL]
int$time_rangeThe time range for articles in days (null means all articles) [OPTIONAL]
int$record_range_fromThe number of first article to be retrieved (null means all articles) [OPTIONAL]
int$record_range_noThe number of articles to be retrieved from the first article(null means all articles) [OPTIONAL]
int$time_range_countThe number of days starting from time range (null means all articles) [OPTIONAL]
string$queryThe query to search from [OPTIONAL]
Returns:
Latestnews_article[]
ListAggregatedLatestnewsFeeds ( token,
title = null 
)

Get the list of available feeds from latestnews aggregator

Parameters:
string$tokenThe session identifier
string$titleThe title of the feed (it can be only a part of the title) [OPTIONAL]
Returns:
Latestnews_feed[]
ListAggregatedRSSArticles ( token,
feed_id = null,
time_range = null,
record_range_from = null,
record_range_no = null,
time_range_count = null,
query = null 
)

Get the list of available articles from the Aggregator

Parameters:
string$tokenThe session identifier
int$feed_idThe feed identifier (null means all articles) [OPTIONAL]
int$time_rangeThe time range for articles in days (null means all articles) [OPTIONAL]
int$record_range_fromThe number of the first article to be retrieved (null means all articles) [OPTIONAL]
int$record_range_noThe number of the first articles to be retrieved from the first article (null means all articles) [OPTIONAL]
int$time_range_countThe time range count for articles in days (null means all articles) [OPTIONAL]
string$queryThe query to search from [OPTIONAL]
Returns:
RSS_article[]
ListAggregatedRSSFeeds ( token,
title = null 
)

Get the list of available feeds from RSS Aggregator

Parameters:
string$tokenThe session identifier
string$titleThe title of the feed (it can be only a part of the title) [OPTIONAL]
Returns:
RSS_feed[]
ListAggregatedRSSFeeds2 ( token,
feeds_list 
)

Get the list of available feeds from RSS Aggregator

Parameters:
string$tokenThe session identifier
int[]$feeds_list The list of feeds identifiers to retrieve
Returns:
RSS_feed[]
ListNewstickersFeeds ( token)

Get the newstickers feeds list

Parameters:
string$tokenThe session identifier public
Returns:
RSS_feed[]
UpdateAggregatedLatestnewsFeed ( token,
feed 
)

Updates an existing Latestnews Feed

Parameters:
string$tokenThe session identifier
Latestnews_feed$feedThe new feed to be inserted in the database
Returns:
int (The number of records affected)
UpdateAggregatedRSSFeed ( token,
feed 
)

Updates an existing RSS Feed

Parameters:
string$tokenThe session identifier
RSS_feed$feedThe new feed to be inserted in the database
Returns:
int (The number of records affected)

Field Documentation

$config = null [protected]

Reimplemented from Tariqa.

$soap

Reimplemented from Tariqa.


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