MarketingChartDataProvider Class Reference

Inheritance diagram for MarketingChartDataProvider:
ChartDataProvider MarketingGroupByEmailMessagesChartDataProvider MarketingListGrowthChartDataProvider AutoresponderGroupedChartDataProvider MarketingEmailsInThisListChartDataProvider MarketingListPerformanceChartDataProvider

Public Member Functions

 getXAxisName ()
 getYAxisName ()
 setBeginDate ($beginDate)
 setEndDate ($endDate)
 setGroupBy ($groupBy)
 setMarketingList (MarketingList $marketingList)
 setCampaign (Campaign $campaign)

Static Public Member Functions

static makeGroupedDateTimeData ($beginDate, $endDate, $groupBy, $treatDatesAsDefinitive=true)

Data Fields

const NEW_SUBSCRIBERS_COUNT = 'newSubscribersCount'
const EXISTING_SUBSCRIBERS_COUNT = 'existingSubscribersCount'
const UNIQUE_OPEN_RATE = 'uniqueOpenRate'
const UNIQUE_CLICK_THROUGH_RATE = 'uniqueClickThroughRate'
const QUEUED = 'queued'
const SENT = 'sent'
const FAILED_TO_SEND = 'failed'
const UNIQUE_OPENS = 'uniqueOpens'
const UNIQUE_CLICKS = 'uniqueClicks'
const BOUNCED = 'bounced'
const UNSUBSCRIBED = 'optedOut'
const SKIPPED = 'skipped'
const DAY_DATE = 'dayDate'
const FIRST_DAY_OF_WEEK_DATE = 'firstDayOfWeekDate'
const FIRST_DAY_OF_MONTH_DATE = 'firstDayOfMonthDate'
const COUNT = 'count(*)'

Protected Member Functions

 resolveDateBalloonLabel ($displayLabel)
 resolveIndexGroupByToUse ()
 resolveGroupBy ($modelClassName, $attributeName)
 resolveChartDataStructure ()

Static Protected Member Functions

static resolveAbbreviatedMonthDisplayLabel ($date)
static resolveAbbreviatedDayMonthDisplayLabel ($date)
static resolveChartDataBaseGroupElements ()

Protected Attributes

 $beginDate
 $endDate
 $groupBy
 $marketingList
 $campaign

Detailed Description

Base date provider for working with marketing metrics that have a begin date, end date, and group by

Definition at line 40 of file MarketingChartDataProvider.php.


Member Function Documentation

static makeGroupedDateTimeData ( beginDate,
endDate,
groupBy,
treatDatesAsDefinitive = true 
) [static]

Given a begin date, end date and grouping type, return array of data that includes information on how the grouping breaks up by the date range including the start/end dateTime for each range and a display label

Parameters:
string $beginDate
string $endDate
string $groupBy
boolean $treatDatesAsDefinitive - if the group begin/end dates should be restricted by the passed begin end dates, then set this true. If you want the true begin month or end month to be returned then set to false.
Exceptions:
NotSupportedException 
Returns:
array

Definition at line 102 of file MarketingChartDataProvider.php.

static resolveAbbreviatedMonthDisplayLabel ( date  )  [static, protected]
Parameters:
string $date
Returns:
null\

Definition at line 169 of file MarketingChartDataProvider.php.

static resolveAbbreviatedDayMonthDisplayLabel ( date  )  [static, protected]
Parameters:
string $date
Returns:
null

Definition at line 180 of file MarketingChartDataProvider.php.

static resolveChartDataBaseGroupElements (  )  [static, protected]
getXAxisName (  ) 
Returns:
null

Reimplemented from ChartDataProvider.

Definition at line 198 of file MarketingChartDataProvider.php.

getYAxisName (  ) 
Returns:
null

Reimplemented from ChartDataProvider.

Definition at line 206 of file MarketingChartDataProvider.php.

setBeginDate ( beginDate  ) 
Parameters:
string $beginDate

Definition at line 214 of file MarketingChartDataProvider.php.

setEndDate ( endDate  ) 
Parameters:
string endDate

Definition at line 223 of file MarketingChartDataProvider.php.

setGroupBy ( groupBy  ) 
Parameters:
string $groupBy

Definition at line 232 of file MarketingChartDataProvider.php.

resolveDateBalloonLabel ( displayLabel  )  [protected]
Parameters:
string $displayLabel
Returns:
string

Definition at line 260 of file MarketingChartDataProvider.php.

resolveIndexGroupByToUse (  )  [protected]
Returns:
string
Exceptions:
NotSupportedException 

Definition at line 277 of file MarketingChartDataProvider.php.

resolveGroupBy ( modelClassName,
attributeName 
) [protected]
Parameters:
string $modelClassName
string $attributeName
Returns:
string
Exceptions:
NotSupportedException 

Definition at line 303 of file MarketingChartDataProvider.php.

resolveChartDataStructure (  )  [protected]
Returns:
array

Definition at line 332 of file MarketingChartDataProvider.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Thu Dec 12 07:11:05 2019