Class tariqaAggregator

Description

Located in /Tariqa.code/tariqaAggregator.class.php (line 2)

Tariqa
   |
   --tariqaAggregator
Variable Summary
array $config
boolean $soap
Method Summary
Tariqa __construct ( $config,  $soap)
boolean CreateAggregatedLatestnewsFeed (string $token, Latestnews_feed $feed, Country $country, Theme $theme)
boolean CreateAggregatedRSSFeed (string $token, RSS_feed $feed, Country $country, Theme $theme)
boolean DeleteAggregatedLatestnewsFeed (string $token, int $feed_id)
boolean DeleteAggregatedRSSFeed (string $token, int $feed_id)
Latestnews_article GetAggregatedLatestnewsArticle (string $token, int $article_id)
int GetAggregatedLatestnewsArticlesNumber (string $token, [int $feed_id = null], [int $time_range = null], [int $time_range_count = null])
Latestnews_article[] GetAggregatedLatestnewsCountryArticles (string $token, Country $country, [int $time_range = null], [int $time_range_count = null], [int $record_range_from = null], [int $record_range_no = null])
int GetAggregatedLatestnewsCountryArticlesNumber (string $token, Country $country, [int $time_range = null], [int $time_range_count = null])
Latestnews_feed[] GetAggregatedLatestnewsCountryFeeds (string $token, Country $country)
Latestnews_feed GetAggregatedLatestnewsFeed (string $token, int $feed_id)
RSS_article[] GetAggregatedLatestnewsThemeArticles (string $token, int $theme_id, [int $time_range = null], [int $time_range_count = null], [int $record_range_from = null], [int $record_range_no = null])
Latestnews_feed[] GetAggregatedLatestnewsThemeFeeds (string $token, int $theme_id)
RSS_article GetAggregatedRSSArticle (string $token, int $article_id)
int GetAggregatedRSSArticlesNumber (string $token, [int $feed_id = null], [int $time_range = null], [int $time_range_count = null])
RSS_feed GetAggregatedRSSFeed (string $token, int $feed_id)
RSS_article[] GetCountryAggregatedRSSArticles (string $token, Country $country, [int $time_range = null], [int $time_range_count = null], [int $record_range_from = null], [int $record_range_no = null])
int GetCountryAggregatedRSSArticlesNumber (string $token, Country $country, [int $time_range = null], [int $time_range_count = null], [int $record_range_from = null], [int $record_range_no = null])
RSS_feed[] GetCountryAggregatedRSSFeeds (string $token, Country $country)
RSS_article[] GetThemeAggregatedRSSArticles (string $token, int $theme_id, [int $time_range = null], [int $time_range_count = null], [int $record_range_from = null], [int $record_range_no = null])
RSS_feed[] GetThemeAggregatedRSSFeeds (string $token, int $theme_id)
Latestnews_article[] ListAggregatedLatestnewsArticles (string $token, [int $feed_id = null], [int $time_range = null], [int $record_range_from = null], [int $record_range_no = null], [int $time_range_count = null])
Latestnews_feed[] ListAggregatedLatestnewsFeeds (string $token)
RSS_article[] ListAggregatedRSSArticles (string $token, [int $feed_id = null], [int $time_range = null], [int $record_range_from = null], [int $record_range_no = null], [int $time_range_count = null])
RSS_feed[] ListAggregatedRSSFeeds (string $token)
int UpdateAggregatedLatestnewsFeed (string $token, Latestnews_feed $feed)
int UpdateAggregatedRSSFeed (string $token, RSS_feed $feed)
Variables
array $config = null (line 7)

Configuration array

  • access: protected
boolean $soap (line 13)

The class is called using SOAP

  • access: public
Methods
Constructor __construct (line 20)

Constructs a tariqaThemes Object

  • access: public
Tariqa __construct ( $config,  $soap)
  • $config
  • $soap
CreateAggregatedLatestnewsFeed (line 1358)

Creates a new Latestnews Feed

  • access: public
boolean CreateAggregatedLatestnewsFeed (string $token, Latestnews_feed $feed, Country $country, Theme $theme)
  • string $token: The session identifier
  • Latestnews_feed $feed: The new feed to be inserted in the database
  • Country $country: The feed country (null if there is not a country for this feed)
  • Theme $theme: The feed theme (null if there is not a theme for this feed)
CreateAggregatedRSSFeed (line 1160)

Creates a new RSS Feed

  • access: public
boolean CreateAggregatedRSSFeed (string $token, RSS_feed $feed, Country $country, Theme $theme)
  • string $token: The session identifier
  • RSS_feed $feed: The new feed to be inserted in the database
  • Country $country: The feed country (null if there is not a country for this feed)
  • Theme $theme: The feed theme (null if there is not a theme for this feed)
DeleteAggregatedLatestnewsFeed (line 1504)

Deletes a Latestnews Feed

  • access: public
boolean DeleteAggregatedLatestnewsFeed (string $token, int $feed_id)
  • string $token: The session identifier
  • int $feed_id: The feed identificator
DeleteAggregatedRSSFeed (line 1305)

Deletes a RSS Feed

  • access: public
boolean DeleteAggregatedRSSFeed (string $token, int $feed_id)
  • string $token: The session identifier
  • int $feed_id: The feed identificator
GetAggregatedLatestnewsArticle (line 795)

Get an article from Latestnews Aggregator

  • access: public
Latestnews_article GetAggregatedLatestnewsArticle (string $token, int $article_id)
  • string $token: The session identifier
  • int $article_id: The article identifier
GetAggregatedLatestnewsArticlesNumber (line 906)

Get the number of available articles from Latestnews aggregator

  • access: public
int GetAggregatedLatestnewsArticlesNumber (string $token, [int $feed_id = null], [int $time_range = null], [int $time_range_count = null])
  • string $token: The session identifier
  • int $feed_id: The feed identifier (null means all articles) [OPTIONAL]
  • int $time_range: The time range for articles in days (null means all articles) [OPTIONAL]
  • int $time_range_count: The number of days starting from time range (null means all articles) [OPTIONAL]
GetAggregatedLatestnewsCountryArticles (line 1024)

Get the list of available latestnews articles for a country

  • access: public
Latestnews_article[] GetAggregatedLatestnewsCountryArticles (string $token, Country $country, [int $time_range = null], [int $time_range_count = null], [int $record_range_from = null], [int $record_range_no = null])
  • string $token: The session identifier
  • Country $country: The selected country
  • int $time_range: The time range for articles in days (null means all articles) [OPTIONAL]
  • int $time_range_count: The time range count for articles in days (null means all articles) [OPTIONAL]
  • int $record_range_from: The number of the first article to be retrieved (null means all articles) [OPTIONAL]
  • int $record_range_no: The number of the first articles to be retrieved from the first article (null means all articles) [OPTIONAL]
GetAggregatedLatestnewsCountryArticlesNumber (line 947)

Get the number of available latestnews articles for a country

  • access: public
int GetAggregatedLatestnewsCountryArticlesNumber (string $token, Country $country, [int $time_range = null], [int $time_range_count = null])
  • string $token: The session identifier
  • Country $country: The selected country
  • int $time_range: The time range for articles in days (null means all articles) [OPTIONAL]
  • int $time_range_count: The time range count for articles in days (null means all articles) [OPTIONAL]
GetAggregatedLatestnewsCountryFeeds (line 689)

Get the list of available latestnews feeds for a selected country

  • access: public
Latestnews_feed[] GetAggregatedLatestnewsCountryFeeds (string $token, Country $country)
  • string $token: The session identifier
  • Country $country: The selected country
GetAggregatedLatestnewsFeed (line 590)

Get a feed from Latestnews Aggregator

  • access: public
Latestnews_feed GetAggregatedLatestnewsFeed (string $token, int $feed_id)
  • string $token: The session identifier
  • int $feed_id: The feed identifier
GetAggregatedLatestnewsThemeArticles (line 1093)

Get the list of available latestnews articles for a theme

  • access: public
RSS_article[] GetAggregatedLatestnewsThemeArticles (string $token, int $theme_id, [int $time_range = null], [int $time_range_count = null], [int $record_range_from = null], [int $record_range_no = null])
  • string $token: The session identifier
  • int $theme_id: The selected theme
  • int $time_range: The time range for articles in days (null means all articles) [OPTIONAL]
  • int $time_range_count: The time range count for articles in days (null means all articles) [OPTIONAL]
  • int $record_range_from: The number of the first article to be retrieved (null means all articles) [OPTIONAL]
  • int $record_range_no: The number of the first articles to be retrieved from the first article (null means all articles) [OPTIONAL]
GetAggregatedLatestnewsThemeFeeds (line 743)

Get the list of available latestnews feeds for a selected theme

  • access: public
Latestnews_feed[] GetAggregatedLatestnewsThemeFeeds (string $token, int $theme_id)
  • string $token: The session identifier
  • int $theme_id: The selected theme
GetAggregatedRSSArticle (line 233)

Get an article from the RSS Aggregator

  • access: public
RSS_article GetAggregatedRSSArticle (string $token, int $article_id)
  • string $token: The session identifier
  • int $article_id: The article identifier
GetAggregatedRSSArticlesNumber (line 342)

Get the number of available articles from the Aggregator

  • access: public
int GetAggregatedRSSArticlesNumber (string $token, [int $feed_id = null], [int $time_range = null], [int $time_range_count = null])
  • string $token: The session identifier
  • int $feed_id: The feed identifier (null means all articles) [OPTIONAL]
  • int $time_range: The time range for articles in days (null means all articles) [OPTIONAL]
  • int $time_range_count: The time range count for articles in days (null means all articles) [OPTIONAL]
GetAggregatedRSSFeed (line 31)

Get a feed from RSS Aggregator

  • access: public
RSS_feed GetAggregatedRSSFeed (string $token, int $feed_id)
  • string $token: The session identifier
  • int $feed_id: The feed identifier
GetCountryAggregatedRSSArticles (line 382)

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

  • access: public
RSS_article[] GetCountryAggregatedRSSArticles (string $token, Country $country, [int $time_range = null], [int $time_range_count = null], [int $record_range_from = null], [int $record_range_no = null])
  • string $token: The session identifier
  • Country $country: The selected country
  • int $time_range: The time range for articles in days (null means all articles) [OPTIONAL]
  • int $time_range_count: The time range count for articles in days (null means all articles) [OPTIONAL]
  • int $record_range_from: The number of the first article to be retrieved (null means all articles) [OPTIONAL]
  • int $record_range_no: The number of the first articles to be retrieved from the first article (null means all articles) [OPTIONAL]
GetCountryAggregatedRSSArticlesNumber (line 450)

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

  • access: public
int GetCountryAggregatedRSSArticlesNumber (string $token, Country $country, [int $time_range = null], [int $time_range_count = null], [int $record_range_from = null], [int $record_range_no = null])
  • string $token: The session identifier
  • Country $country: The selected country
  • int $time_range: The time range for articles in days (null means all articles) [OPTIONAL]
  • int $time_range_count: The time range count for articles in days (null means all articles) [OPTIONAL]
  • int $record_range_from: The number of the first article to be retrieved (null means all articles) [OPTIONAL]
  • int $record_range_no: The number of the first articles to be retrieved from the first article (null means all articles) [OPTIONAL]
GetCountryAggregatedRSSFeeds (line 129)

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

  • access: public
RSS_feed[] GetCountryAggregatedRSSFeeds (string $token, Country $country)
  • string $token: The session identifier
  • Country $country: The selected country
GetThemeAggregatedRSSArticles (line 527)

Get the list of available articles for a theme

  • access: public
RSS_article[] GetThemeAggregatedRSSArticles (string $token, int $theme_id, [int $time_range = null], [int $time_range_count = null], [int $record_range_from = null], [int $record_range_no = null])
  • string $token: The session identifier
  • int $theme_id: The selected theme
  • int $time_range: The time range for articles in days (null means all articles) [OPTIONAL]
  • int $time_range_count: The time range count for articles in days (null means all articles) [OPTIONAL]
  • int $record_range_from: The number of the first article to be retrieved (null means all articles) [OPTIONAL]
  • int $record_range_no: The number of the first articles to be retrieved from the first article (null means all articles) [OPTIONAL]
GetThemeAggregatedRSSFeeds (line 182)

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

  • access: public
RSS_feed[] GetThemeAggregatedRSSFeeds (string $token, int $theme_id)
  • string $token: The session identifier
  • int $theme_id: The selected theme
ListAggregatedLatestnewsArticles (line 846)

Get the list of available articles from Latestnews aggregator

  • access: public
Latestnews_article[] ListAggregatedLatestnewsArticles (string $token, [int $feed_id = null], [int $time_range = null], [int $record_range_from = null], [int $record_range_no = null], [int $time_range_count = null])
  • string $token: The session identifier
  • int $feed_id: The feed identifier (null means all articles) [OPTIONAL]
  • int $time_range: The time range for articles in days (null means all articles) [OPTIONAL]
  • int $record_range_from: The number of first article to be retrieved (null means all articles) [OPTIONAL]
  • int $record_range_no: The number of articles to be retrieved from the first article(null means all articles) [OPTIONAL]
  • int $time_range_count: The number of days starting from time range (null means all articles) [OPTIONAL]
ListAggregatedLatestnewsFeeds (line 637)

Get the list of available feeds from latestnews aggregator

  • access: public
Latestnews_feed[] ListAggregatedLatestnewsFeeds (string $token)
  • string $token: The session identifier
ListAggregatedRSSArticles (line 283)

Get the list of available articles from the Aggregator

  • access: public
RSS_article[] ListAggregatedRSSArticles (string $token, [int $feed_id = null], [int $time_range = null], [int $record_range_from = null], [int $record_range_no = null], [int $time_range_count = null])
  • string $token: The session identifier
  • int $feed_id: The feed identifier (null means all articles) [OPTIONAL]
  • int $time_range: The time range for articles in days (null means all articles) [OPTIONAL]
  • int $record_range_from: The number of the first article to be retrieved (null means all articles) [OPTIONAL]
  • int $record_range_no: The number of the first articles to be retrieved from the first article (null means all articles) [OPTIONAL]
  • int $time_range_count: The time range count for articles in days (null means all articles) [OPTIONAL]
ListAggregatedRSSFeeds (line 78)

Get the list of available feeds from RSS Aggregator

  • access: public
RSS_feed[] ListAggregatedRSSFeeds (string $token)
  • string $token: The session identifier
UpdateAggregatedLatestnewsFeed (line 1453)

Updates an existing Latestnews Feed

  • return: (The number of records affected)
  • access: public
int UpdateAggregatedLatestnewsFeed (string $token, Latestnews_feed $feed)
  • string $token: The session identifier
  • Latestnews_feed $feed: The new feed to be inserted in the database
UpdateAggregatedRSSFeed (line 1254)

Updates an existing RSS Feed

  • return: (The number of records affected)
  • access: public
int UpdateAggregatedRSSFeed (string $token, RSS_feed $feed)
  • string $token: The session identifier
  • RSS_feed $feed: The new feed to be inserted in the database

Documentation generated on Thu, 10 Dec 2009 15:21:44 +0100 by phpDocumentor 1.4.1