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

Public Member Functions

 __construct ($config, $soap)
 ListNewsletters ($token, $category_id=null)
 getNewsletter ($token, $newsletter_id)
 listIndarNewsletters ($token)
 getIndarNewsletter ($token, $newsletter_id)
 listNewslettersCategories ($token)
 getNewsletterCategory ($token, $category_id)
 canEditNewsletter ($token, $user_id, $newsletter_ids)
 canEditNewsletterCategory ($token, $user_id, $category_ids)
 saveNewsletter ($token, $newsletter)
 deleteNewsletter ($token, $newsletter_id)

Data Fields

 $soap

Protected Attributes

 $config = null

Constructor & Destructor Documentation

__construct ( config,
soap 
)

Constructs a tariqaThemes Object

Returns:
Tariqa

Member Function Documentation

canEditNewsletter ( token,
user_id,
newsletter_ids 
)

Tells if an user can edit a newsletter

Parameters:
string$tokenThe session identifier
string$user_idThe user identifier
int[]$newsletter_ids An array of newsletter identifiers public
Returns:
int[]
canEditNewsletterCategory ( token,
user_id,
category_ids 
)

Tells if an user can edit a newsletter category

Parameters:
string$tokenThe session identifier
string$user_idThe user identifier
int[]$category_ids An array of newsletter categories identifiers public
Returns:
int[]
deleteNewsletter ( token,
newsletter_id 
)

Deletes a newsletter

Parameters:
string$tokenThe session identifier
int$newsletter_idThe newsletter identifier public
Returns:
boolean
getIndarNewsletter ( token,
newsletter_id 
)

Get the content of a newsletter

Parameters:
string$tokenThe session identifier
int$newsletter_idThe newsletter identifier
Returns:
Newsletter
getNewsletter ( token,
newsletter_id 
)

Get the content of a newsletter

Parameters:
string$tokenThe session identifier
int$newsletter_idThe newsletter identifier
Returns:
Newsletter
getNewsletterCategory ( token,
category_id 
)

Gets a newsletter category

Parameters:
string$tokenThe session identifier
int$category_idThe category identifier public
Returns:
NewsletterCategory
listIndarNewsletters ( token)

Get the list of available newsletters

Parameters:
string$tokenThe session identifier
Returns:
Newsletter[]
ListNewsletters ( token,
category_id = null 
)

Get the list of available newsletters

Parameters:
string$tokenThe session identifier
int$category_idThe category identifier [OPTIONAL]
Returns:
Newsletter[]

Lists the newsletters categories

Parameters:
string$tokenThe session identifier public
Returns:
NewsletterCategory[]
saveNewsletter ( token,
newsletter 
)

Saves or updates a newsletter into the database database (for insert, just set the newsletter_id to null)

Parameters:
string$tokenThe session identifier
Newsletter$newsletterThe newsletter public
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: