Fuel Campaign Monitor Class
This class extends the Fuel_advanced_module class.
Properties Reference
| Property | Default Value | Description |
|---|---|---|
| protected | ||
| _cm | N/A | |
Function Reference [+]
$this->fuel->campaign_monitor->initialize([$params=array()])
Initialize the page analysis object. Accepts an associative array as input, containing backup preferences. Also will set the values in the config as properties of this object.
Returns
void
Parameters
(array) $params config preferences
$this->fuel->campaign_monitor->connect()
Connects to the Campaign Monitor API and returns the CampaignMonitor object.
Returns
object
$this->fuel->campaign_monitor->client_id()
Returns the client ID specified in the config.
Returns
int
$this->fuel->campaign_monitor->campaigns('$client_id', ['$limit'=NULL])
Returns the campaign data for a given client.
Returns
array
Parameters
(int) $client_id The client ID (int) $limit The number of campaigns to return (optional)
$this->fuel->campaign_monitor->campaign_summary('$campaign_id')
Returns a data summary for a particicular campaign.
Returns
array
Parameters
(int) $campaign_id The campaign ID
$this->fuel->campaign_monitor->summaries()
Returns a data summary for multiple campaigns.
Returns
array
$this->fuel->campaign_monitor->render(['$return'=FALSE])
Renders the campaign information into HTML.
Returns
mixed (string or void)
Parameters
(boolean) $return Determines whether to return it as a string or to output it (optional)