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

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

__construct ( config,
soap 
)

Constructs a tariqaThemes Object

Returns:
Tariqa

Member Function Documentation

DeleteThemeUserDefinedQuery ( token,
theme_id 
)

Deletes a theme user defined query

Parameters:
string$tokenThe session identifier
int$theme_idThe theme identifier
Returns:
boolean
GetTheme ( token,
theme_id 
)

Get the content of a theme

Parameters:
string$tokenThe session identifier
int$theme_idThe theme identifier
Returns:
Theme
GetThemeQueries ( token,
theme_id 
)

Get the list of available queries for a defined contry

Parameters:
string$tokenThe session identifier
int$theme_idThe selected theme identifier
Returns:
Query[]
GetThemeTopic ( token,
topic_id,
queries = false 
)

Get a topic theme

Parameters:
string$tokenThe session identifier
int$topic_idThe topic identifier
boolean$queriesIf true, also get the queries [OPTIONAL]
Returns:
ThemeTopic
GetTopicQuery ( token,
topic_id,
query_id 
)

Get a topic query

Parameters:
string$tokenThe session identifier
int$topic_idThe topic identifier
int$query_idThe query identifier
Returns:
TopicQuery
ListThemes ( token,
no_texts = false,
ids = null 
)

Get the list of available themes

Parameters:
string$tokenThe session identifier
boolean$no_textsIf true, do not fetch the texts [OPTIONAL]
int[]$ids A list of theme ids [OPTIONAL]
Returns:
Theme[]
ListThemeTopics ( token,
theme_id 
)

Lists the topics for a given theme

Parameters:
string$tokenThe session identifier
int$theme_idThe theme identifier
Returns:
ThemeTopic[]
ListThemeTopicsWithQueries ( token,
theme_id 
)

List the topics themes with queries

Parameters:
string$tokenThe session identifier
int$theme_idThe theme identifier
Returns:
ThemeTopicCollection[]
ListThemeUsers ( token,
theme_id 
)

Lists the theme users

Parameters:
string$tokenThe session identifier
int$theme_idThe theme identifier
Returns:
ThemeUsers
ListTopicQueries ( token,
topic_id 
)

Lists the queries for a theme topic

Parameters:
string$tokenThe session identifier
int$topic_idThe topic identifier
Returns:
TopicQuery[]
SetThemeText ( token,
theme_id,
short_text,
long_text 
)

Sets the short text and long text of a theme

Parameters:
string$tokenThe session identifier
int$theme_idThe theme identifier
string$short_textThe short text
string$long_textThe long text
Returns:
boolean
SetThemeUserDefinedQuery ( token,
theme_id,
query 
)

Sets the user defined query for the theme

Parameters:
string$tokenThe session identifier
int$theme_idThe theme identifier
Query$queryThe query
Returns:
int

Field Documentation

$config = null [protected]

Reimplemented from Tariqa.

$soap

Reimplemented from Tariqa.


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