Class tariqaThemes

Description

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

Tariqa
   |
   --tariqaThemes
Variable Summary
array $config
boolean $soap
Method Summary
Tariqa __construct ( $config,  $soap)
boolean DeleteThemeUserDefinedQuery (string $token, int $theme_id)
Theme GetTheme (string $token, int $theme_id)
Query[] GetThemeQueries (string $token, int $theme_id)
ThemeTopic GetThemeTopic (string $token, int $topic_id)
TopicQuery GetTopicQuery (string $token, int $topic_id, int $query_id)
Theme[] ListThemes (string $token, [boolean $no_texts = false])
ThemeTopic[] ListThemeTopics (string $token, int $theme_id)
ThemeTopicCollection[] ListThemeTopicsWithQueries (string $token, int $theme_id)
ThemeUsers ListThemeUsers (string $token, int $theme_id)
TopicQuery[] ListTopicQueries (string $token, int $topic_id)
boolean SetThemeText (string $token, int $theme_id, string $short_text, string $long_text)
int SetThemeUserDefinedQuery (string $token, int $theme_id, Query $query)
Variables
array $config = null (line 8)

Configuration array

  • access: protected
boolean $soap (line 14)

The class is called using SOAP

  • access: public
Methods
Constructor __construct (line 21)

Constructs a tariqaThemes Object

  • access: public
Tariqa __construct ( $config,  $soap)
  • $config
  • $soap
DeleteThemeUserDefinedQuery (line 550)

Deletes a theme user defined query

  • access: public
boolean DeleteThemeUserDefinedQuery (string $token, int $theme_id)
  • string $token: The session identifier
  • int $theme_id: The theme identifier
GetTheme (line 33)

Get the content of a theme

  • access: public
Theme GetTheme (string $token, int $theme_id)
  • string $token: The session identifier
  • int $theme_id: The theme identifier
GetThemeQueries (line 166)

Get the list of available queries for a defined contry

  • access: public
Query[] GetThemeQueries (string $token, int $theme_id)
  • string $token: The session identifier
  • int $theme_id: The selected theme identifier
GetThemeTopic (line 336)

Get a topic theme

  • access: public
ThemeTopic GetThemeTopic (string $token, int $topic_id)
  • string $token: The session identifier
  • int $topic_id: The topic identifier
GetTopicQuery (line 430)

Get a topic query

  • access: public
TopicQuery GetTopicQuery (string $token, int $topic_id, int $query_id)
  • string $token: The session identifier
  • int $topic_id: The topic identifier
  • int $query_id: The query identifier
ListThemes (line 78)

Get the list of available themes

  • access: public
Theme[] ListThemes (string $token, [boolean $no_texts = false])
  • string $token: The session identifier
  • boolean $no_texts: If true, do not fetch the texts [OPTIONAL]
ListThemeTopics (line 285)

Lists the topics for a given theme

  • access: public
ThemeTopic[] ListThemeTopics (string $token, int $theme_id)
  • string $token: The session identifier
  • int $theme_id: The theme identifier
ListThemeTopicsWithQueries (line 474)

List the topics themes with queries

  • access: public
ThemeTopicCollection[] ListThemeTopicsWithQueries (string $token, int $theme_id)
  • string $token: The session identifier
  • int $theme_id: The theme identifier
ListThemeUsers (line 507)

Lists the theme users

  • access: public
ThemeUsers ListThemeUsers (string $token, int $theme_id)
  • string $token: The session identifier
  • int $theme_id: The theme identifier
ListTopicQueries (line 374)

Lists the queries for a theme topic

  • access: public
TopicQuery[] ListTopicQueries (string $token, int $topic_id)
  • string $token: The session identifier
  • int $topic_id: The topic identifier
SetThemeText (line 128)

Sets the short text and long text of a theme

  • access: public
boolean SetThemeText (string $token, int $theme_id, string $short_text, string $long_text)
  • string $token: The session identifier
  • int $theme_id: The theme identifier
  • string $short_text: The short text
  • string $long_text: The long text
SetThemeUserDefinedQuery (line 223)

Sets the user defined query for the theme

  • access: public
int SetThemeUserDefinedQuery (string $token, int $theme_id, Query $query)
  • string $token: The session identifier
  • int $theme_id: The theme identifier
  • Query $query: The query

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