Account Suspended
Account Suspended
This Account has been suspended.
Contact your hosting provider for more information.
 All Data Structures Functions Variables Pages
Public Member Functions | Static Public Member Functions | Data Fields | Protected Member Functions | Static Protected Member Functions | Protected Attributes
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)
 
- Public Member Functions inherited from ChartDataProvider
 getXAxisName ()
 
 getYAxisName ()
 
 getChartData ()
 
 getModel ()
 

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 ()
 
- Protected Member Functions inherited from ChartDataProvider
 resolveCurrencyValueConversionRateForCurrentUserForDisplay ($valueInBaseCurrency)
 

Static Protected Member Functions

static resolveAbbreviatedMonthDisplayLabel ($date)
 
static resolveAbbreviatedDayMonthDisplayLabel ($date)
 
static resolveChartDataBaseGroupElements ()
 
- Static Protected Member Functions inherited from ChartDataProvider
static resolveLabelByValueAndLabels ($value, $labels)
 

Protected Attributes

 $beginDate
 
 $endDate
 
 $groupBy
 
 $marketingList
 
 $campaign
 
- Protected Attributes inherited from ChartDataProvider
 $model
 

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)
staticprotected
Parameters
string$date
Returns
null\

Definition at line 169 of file MarketingChartDataProvider.php.

static resolveAbbreviatedDayMonthDisplayLabel (   $date)
staticprotected
Parameters
string$date
Returns
null

Definition at line 180 of file MarketingChartDataProvider.php.

static resolveChartDataBaseGroupElements ( )
staticprotected
Returns
array

Definition at line 190 of file MarketingChartDataProvider.php.

getXAxisName ( )
Returns
null

Definition at line 198 of file MarketingChartDataProvider.php.

getYAxisName ( )
Returns
null

Definition at line 206 of file MarketingChartDataProvider.php.

setBeginDate (   $beginDate)
Parameters
string$beginDate

Definition at line 214 of file MarketingChartDataProvider.php.

setEndDate (   $endDate)
Parameters
stringendDate

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:
Generated on Mon Jul 13 2020 07:10:52
Account Suspended
Account Suspended
This Account has been suspended.
Contact your hosting provider for more information.