All Data Structures Functions Variables Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
MarketingMetricsView Class Reference
Inheritance diagram for MarketingMetricsView:
ConfigurableMetadataView PortletViewInterface MetadataView View CampaignOverallMetricsView MarketingListOverallMetricsView MarketingOverallMetricsView

Public Member Functions

 getConfigurationView ()
 
 renderPortletHeadContent ()
 
 __construct ($viewData, $params, $uniqueLayoutId)
 
 renderContent ()
 
 getPortletParams ()
 
- Public Member Functions inherited from View
 isUniqueToAPage ()
 
 render ()
 
 setCssClasses (array $classes)
 
 getCssClasses ()
 
 getTitle ()
 
 getPostTruncatedTitleContent ()
 

Static Public Member Functions

static getModuleClassName ()
 
static canUserConfigure ()
 
static canUserRemove ()
 
static getPortletRulesType ()
 
static getPortletDescription ()
 
static getDefaultMetadata ()
 

Protected Member Functions

 renderConfigureElementsContent ()
 
 renderMetricsWrapperContent ()
 
 renderOverallListPerformanceContent ()
 
 getOverallListPerformanceTitle ()
 
 renderEmailsInThisListContent ()
 
 getEmailsInThisListTitle ()
 
 renderListGrowthContent ()
 
 resolveChartDataProvider ($type)
 
 getPortletSaveConfigurationUrl ()
 
 renderGroupByConfigurationForm ()
 
 getFormId ()
 
 renderGroupByConfigurationFormLayout ($form)
 
 registerGroupByConfigurationFormLayoutScripts ($form)
 
 resolveForm ()
 
- Protected Member Functions inherited from View
 resolveDefaultClasses ()
 
 renderContainerWrapperId ()
 
 getContainerWrapperTag ()
 
 getId ()
 
 renderContent ()
 
 getViewStyle ()
 
 renderTitleContent ()
 
 resolveCustomViewTemplateFileName ($theme, $view)
 

Protected Attributes

 $params
 
 $controllerId
 
 $moduleId
 
 $uniqueLayoutId
 
 $viewData
 
 $formModel
 
 $formModelClassName
 
- Protected Attributes inherited from View
 $cssClasses = array()
 
 $title
 
 $makeDefaultClassesFromClassHeirarchy = true
 

Additional Inherited Members

Detailed Description

Base class used for displaying the performance metrics for marketing, campaigns, and marketing list related dashboards

Definition at line 40 of file MarketingMetricsView.php.

Constructor & Destructor Documentation

__construct (   $viewData,
  $params,
  $uniqueLayoutId 
)

Some extra assertions are made to ensure this view is used in a way that it supports.

Parameters
array$viewData
array$params
string$uniqueLayoutId

Definition at line 152 of file MarketingMetricsView.php.

Member Function Documentation

static getModuleClassName ( )
static

Override in children class and return form model class name

Exceptions
NotImplementedException

Implements PortletViewInterface.

Definition at line 84 of file MarketingMetricsView.php.

static canUserConfigure ( )
static
Returns
bool

Definition at line 92 of file MarketingMetricsView.php.

static canUserRemove ( )
static
Returns
bool

Definition at line 100 of file MarketingMetricsView.php.

static getPortletRulesType ( )
static

What kind of PortletRules this view follows

Returns
PortletRulesType as string.

Implements PortletViewInterface.

Definition at line 109 of file MarketingMetricsView.php.

static getPortletDescription ( )
static

Override to add a description for the view to be shown when adding a portlet

Implements PortletViewInterface.

Definition at line 117 of file MarketingMetricsView.php.

renderPortletHeadContent ( )
Returns
null

Implements PortletViewInterface.

Definition at line 124 of file MarketingMetricsView.php.

static getDefaultMetadata ( )
static
Returns
array

Definition at line 132 of file MarketingMetricsView.php.

renderContent ( )
Returns
string

Definition at line 167 of file MarketingMetricsView.php.

renderConfigureElementsContent ( )
protected
Returns
string

Definition at line 188 of file MarketingMetricsView.php.

renderMetricsWrapperContent ( )
protected
Returns
string

Definition at line 201 of file MarketingMetricsView.php.

renderOverallListPerformanceContent ( )
protected
Returns
string

Definition at line 213 of file MarketingMetricsView.php.

getOverallListPerformanceTitle ( )
protected
Returns
string

Definition at line 225 of file MarketingMetricsView.php.

renderEmailsInThisListContent ( )
protected
Returns
string

Definition at line 233 of file MarketingMetricsView.php.

getEmailsInThisListTitle ( )
protected
Returns
string

Definition at line 245 of file MarketingMetricsView.php.

renderListGrowthContent ( )
protected
Returns
string

Definition at line 253 of file MarketingMetricsView.php.

resolveChartDataProvider (   $type)
protected
Parameters
string$type
Returns
ChartDataProvider

Definition at line 266 of file MarketingMetricsView.php.

getPortletSaveConfigurationUrl ( )
protected

Call to save the portlet configuration

Definition at line 279 of file MarketingMetricsView.php.

renderGroupByConfigurationForm ( )
protected
Returns
string

Definition at line 294 of file MarketingMetricsView.php.

getFormId ( )
protected
Returns
string

Definition at line 314 of file MarketingMetricsView.php.

renderGroupByConfigurationFormLayout (   $form)
protected
Parameters
$form
Returns
string

Definition at line 323 of file MarketingMetricsView.php.

registerGroupByConfigurationFormLayoutScripts (   $form)
protected
Parameters
$form

Definition at line 333 of file MarketingMetricsView.php.

resolveForm ( )
protected
Returns
CFormModel
Exceptions
NotSupportedException

Definition at line 361 of file MarketingMetricsView.php.


The documentation for this class was generated from the following file:
Generated on Tue May 26 2020 07:10:52