CampaignItemsRelatedListView Class Reference

Inheritance diagram for CampaignItemsRelatedListView:
RelatedListView ListView PortletViewInterface RelatedPortletViewInterface ModelView ListViewInterface ConfigurableMetadataView MetadataView View

Public Member Functions

 __construct ($viewData, $params, $uniqueLayoutId)
 getModelClassName ()

Static Public Member Functions

static getDefaultMetadata ()
static getModuleClassName ()

Protected Member Functions

 renderContent ()
 getGridViewWidgetPath ()
 getRelationAttributeName ()
 getUniquePageId ()
 getEmptyText ()
 getCGridViewLastColumn ()
 getWrapperDivClass ()
 getCGridViewParams ()
 getCGridViewColumns ()
 makeSearchAttributeData ()
 renderConfigurationForm ()
 renderConfigurationFormLayout ($form)
 registerConfigurationFormLayoutScripts ($form)
 getConfigurationForm ()
 resolveCampaignItemsConfigFormFromRequest (&$campaignItemsConfigurationForm)
 saveUserSettingsFromConfigForm (&$campaignItemsConfigurationForm)
 restoreUserSettingsToConfigFrom (&$campaignItemsConfigurationForm, $excludeFromRestore)
 getPortletDetailsUrl ()

Protected Attributes

 $showStageFilter = true

Static Protected Attributes

static $persistantCampaignItemsPortletConfigs

Detailed Description

Definition at line 37 of file CampaignItemsRelatedListView.php.


Member Function Documentation

renderContent (  )  [protected]

Renders content for a list view. Utilizes a CActiveDataprovider and a CGridView widget. and form layout.

Returns:
A string containing the element's content.

Reimplemented from ListView.

Definition at line 55 of file CampaignItemsRelatedListView.php.

static getDefaultMetadata (  )  [static]

Returns meta data for use in automatically generating the view. The meta data is comprised of columns. The parameters match the parameters used in CGridView. See link below for more information. http://www.yiiframework.com/doc/api/1.1/CGridView/

The below example is a simple listview with the 'id' and 'name' attributes The 'name' column has a hyperlink to the detail view for that record.

            <?php
                $metadata = array(
                    array(
                        'class' => 'CDataColumn',
                        'name'  => 'id',
                    ),
                    array(
                        'class'           => 'CLinkColumn',
                        'header'          => Zurmo::t('Core', 'Name'),
                        'labelExpression' => '$data->name',
                        'urlExpression'   => 'Yii::app()->createUrl("/{$this->grid->getOwner()->getModule()->getId()}/{$this->grid->getOwner()->getId()}/details", array("id" => $data->id))',
                    )
                );
            ?>

Reimplemented from ListView.

Definition at line 77 of file CampaignItemsRelatedListView.php.

getCGridViewColumns (  )  [protected]

Get the meta data and merge with standard CGridView column elements to create a column array that fits the CGridView columns API

Reimplemented from ListView.

Definition at line 138 of file CampaignItemsRelatedListView.php.

makeSearchAttributeData (  )  [protected]

Override to filter by email message stage

Reimplemented from RelatedListView.

Definition at line 154 of file CampaignItemsRelatedListView.php.

renderConfigurationForm (  )  [protected]
Returns:
string

Definition at line 196 of file CampaignItemsRelatedListView.php.

renderConfigurationFormLayout ( form  )  [protected]
Parameters:
CampaignItemsConfigurationForm $form
Returns:
string

Definition at line 218 of file CampaignItemsRelatedListView.php.

registerConfigurationFormLayoutScripts ( form  )  [protected]
Parameters:
CampaignItemsConfigurationForm $form

Definition at line 245 of file CampaignItemsRelatedListView.php.

getConfigurationForm (  )  [protected]
resolveCampaignItemsConfigFormFromRequest ( &$  campaignItemsConfigurationForm  )  [protected]
Parameters:
CampaignItemsConfigurationForm $campaignItemsConfigurationForm

Definition at line 282 of file CampaignItemsRelatedListView.php.

saveUserSettingsFromConfigForm ( &$  campaignItemsConfigurationForm  )  [protected]
Parameters:
CampaignItemsConfigurationForm $campaignItemsConfigurationForm
Returns:
array

Definition at line 297 of file CampaignItemsRelatedListView.php.

restoreUserSettingsToConfigFrom ( &$  campaignItemsConfigurationForm,
excludeFromRestore 
) [protected]
Parameters:
CampaignItemsConfigurationForm $campaignItemsConfigurationForm
string $excludeFromRestore
Returns:
CampaignItemsConfigurationForm

Definition at line 322 of file CampaignItemsRelatedListView.php.

getPortletDetailsUrl (  )  [protected]

After a portlet action is completed, the portlet must be refreshed. This is the url to correctly refresh the portlet content.

Definition at line 346 of file CampaignItemsRelatedListView.php.


Field Documentation

$persistantCampaignItemsPortletConfigs [static, protected]
Initial value:
 array(
            'filteredByStage'
        )

Definition at line 39 of file CampaignItemsRelatedListView.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Mon May 22 07:10:23 2017