Public Member Functions |
| __construct ($config, $soap) |
| GetTheme ($token, $theme_id) |
| ListThemes ($token, $no_texts=false, $ids=null) |
| SetThemeText ($token, $theme_id, $short_text, $long_text) |
| GetThemeQueries ($token, $theme_id) |
| SetThemeUserDefinedQuery ($token, $theme_id, $query) |
| ListThemeTopics ($token, $theme_id) |
| GetThemeTopic ($token, $topic_id, $queries=false) |
| ListTopicQueries ($token, $topic_id) |
| GetTopicQuery ($token, $topic_id, $query_id) |
| ListThemeTopicsWithQueries ($token, $theme_id) |
| ListThemeUsers ($token, $theme_id) |
| DeleteThemeUserDefinedQuery ($token, $theme_id) |
Data Fields |
| $soap |
Protected Attributes |
| $config = null |
Constructor & Destructor Documentation
Member Function Documentation
Deletes a theme user defined query
- Parameters:
-
string | $token | The session identifier |
int | $theme_id | The theme identifier |
- Returns:
- boolean
Get the content of a theme
- Parameters:
-
string | $token | The session identifier |
int | $theme_id | The theme identifier |
- Returns:
- Theme
Get the list of available queries for a defined contry
- Parameters:
-
string | $token | The session identifier |
int | $theme_id | The selected theme identifier |
- Returns:
- Query[]
Get a topic theme
- Parameters:
-
string | $token | The session identifier |
int | $topic_id | The topic identifier |
boolean | $queries | If true, also get the queries [OPTIONAL] |
- Returns:
- ThemeTopic
Get a topic query
- Parameters:
-
string | $token | The session identifier |
int | $topic_id | The topic identifier |
int | $query_id | The query identifier |
- Returns:
- TopicQuery
ListThemes |
( |
$ |
token, |
|
|
$ |
no_texts = false , |
|
|
$ |
ids = null |
|
) |
| |
Get the list of available themes
- Parameters:
-
string | $token | The session identifier |
boolean | $no_texts | If true, do not fetch the texts [OPTIONAL] |
| int[] | $ids A list of theme ids [OPTIONAL] |
- Returns:
- Theme[]
Lists the topics for a given theme
- Parameters:
-
string | $token | The session identifier |
int | $theme_id | The theme identifier |
- Returns:
- ThemeTopic[]
List the topics themes with queries
- Parameters:
-
string | $token | The session identifier |
int | $theme_id | The theme identifier |
- Returns:
- ThemeTopicCollection[]
Lists the theme users
- Parameters:
-
string | $token | The session identifier |
int | $theme_id | The theme identifier |
- Returns:
- ThemeUsers
Lists the queries for a theme topic
- Parameters:
-
string | $token | The session identifier |
int | $topic_id | The topic identifier |
- Returns:
- TopicQuery[]
SetThemeText |
( |
$ |
token, |
|
|
$ |
theme_id, |
|
|
$ |
short_text, |
|
|
$ |
long_text |
|
) |
| |
Sets the short text and long text of a theme
- Parameters:
-
string | $token | The session identifier |
int | $theme_id | The theme identifier |
string | $short_text | The short text |
string | $long_text | The long text |
- Returns:
- boolean
Sets the user defined query for the theme
- Parameters:
-
string | $token | The session identifier |
int | $theme_id | The theme identifier |
Query | $query | The query |
- Returns:
- int
Field Documentation
$config = null [protected] |
The documentation for this class was generated from the following file: