Class tariqaLatestNews

Description

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

Tariqa
   |
   --tariqaLatestNews
Variable Summary
array $config
boolean $soap
Method Summary
Tariqa __construct ( $config,  $soap)
Resultset fetchLatestNews (string $token, string $query, [float $range = null], [int $page_number = null], [int $page_size = null], [boolean $paginal = true])
Article getLatestNewsArticle (string $token, string $id)
LatestNewsDocument[] latestNewsFetch (string $token, LatestNewsResultset $resultset, [int $first = null], [int $count = null])
LatestNewsDocument latestNewsGetDocument (string $token, int $id)
LatestNewsResultset latestNewsSearch (string $token, string $query, [float $range = null])
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
fetchLatestNews (line 243)

Fetch the articles from the LatestNews database

  • access: public
Resultset fetchLatestNews (string $token, string $query, [float $range = null], [int $page_number = null], [int $page_size = null], [boolean $paginal = true])
  • string $token: Session Identifier
  • string $query: SQL query
  • float $range: Time range in days (you may use fractions!) [OPTIONAL]
  • int $page_number: Which page of articles to fetch [OPTIONAL]
  • int $page_size: How many articles should be displayed on each page [OPTIONAL]
  • boolean $paginal: If set to true, the results are paginated, else page_number represents the first result, and page_size the number of results [OPTIONAL]
getLatestNewsArticle (line 369)

Fetch the articles from the LatestNews database

  • access: public
Article getLatestNewsArticle (string $token, string $id)
  • string $token: Session Identifier
  • string $id: Article ID
latestNewsFetch (line 90)

Fetch the articles from the LatestNews database

  • access: public
LatestNewsDocument[] latestNewsFetch (string $token, LatestNewsResultset $resultset, [int $first = null], [int $count = null])
  • string $token: Session Identifier
  • LatestNewsResultset $resultset: The resultset returned by a latestNewsSearch() operation
  • int $first: [OPTIONAL]
  • int $count: [OPTIONAL]
latestNewsGetDocument (line 179)

Get a LatestNews Document

  • access: public
LatestNewsDocument latestNewsGetDocument (string $token, int $id)
  • string $token: Session Identifier
  • int $id: Article ID
latestNewsSearch (line 32)

Search for articles in the LatestNews database

  • access: public
LatestNewsResultset latestNewsSearch (string $token, string $query, [float $range = null])
  • string $token: Session Identifier
  • string $query: SQL query
  • float $range: Time range in days (you may use fractions!) [OPTIONAL]

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