ListView Class Reference

Inheritance diagram for ListView:
ModelView ListViewInterface ConfigurableMetadataView MetadataView View AListView AutorespondersListView CalendarItemsListView DaysMeetingsFromCalendarModalListView ImportErrorsListView ImportTempTableListView JobLogsModalListView LatestActivitiesListView LeaderboardListView MashableInboxListView ModalListView MyListView NotificationsForUserListView RelatedListView SecuredListView SocialItemsListView UsersListView

Public Member Functions

 __construct ($controllerId, $moduleId, $modelClassName, $dataProvider, $selectedIds, $gridIdSuffix=null, $gridViewPagerParams=array(), $listAttributesSelector=null, $kanbanBoard=null)
 getRowsAreSelectable ()
 setRowsAreSelectable ($value)
 getSummaryCloneId ()
 getTableColumnGroup ()
 setEmptyText ($text)
 getGridViewId ()
 getLinkString ($attributeString, $attribute)
 getRelatedLinkString ($attributeString, $attributeName, $moduleId)
 getModuleId ()
 getControllerId ()

Static Public Member Functions

static getDefaultMetadata ()
static canRenderRowMenuColumnByElementAndData ($element, $data)
static resolveRelatedListStringContent ($modelId, $linkStringContent)
static getDesignerRulesType ()

Protected Member Functions

 getKanbanBoard ()
 setKanbanBoard ($kanbanBoard)
 renderContent ()
 getGridViewWidgetPath ()
 getCGridViewParams ()
 getCGridViewPagerParams ()
 getShowTableOnEmpty ()
 getEmptyText ()
 getCGridViewFirstColumn ()
 getCGridViewColumns ()
 resolveMetadata ()
 getResolvedMetadata ()
 getCGridViewBeforeAjaxUpdate ()
 getCGridViewAfterAjaxUpdate ()
 getCGridViewAjaxUrl ()
 getCGridViewSelectableRowsCount ()
 getCGridViewLastColumn ()
 getGridViewMenuColumn ()
 getGridViewActionRoute ($action, $moduleId=null)
 getListActionId ()
 getActionModuleClassName ()
 getDataProvider ()
 renderScripts ()
 processColumnInfoToFetchColumnData ($columnInformation)
 isHeaderHidden ()

Static Protected Member Functions

static getGridTemplate ()
static getPagerCssClass ()
static getSummaryText ()
static getSummaryCssClass ()

Protected Attributes

 $controllerId
 $moduleId
 $dataProvider
 $renderViewToolBarDuringRenderContent = true
 $rowsAreSelectable = false
 $gridId
 $gridIdSuffix
 $selectedIds
 $gridViewPagerParams = array()
 $emptyText = null

Detailed Description

The base View for a module's list view.

Definition at line 40 of file ListView.php.


Constructor & Destructor Documentation

__construct ( controllerId,
moduleId,
modelClassName,
dataProvider,
selectedIds,
gridIdSuffix = null,
gridViewPagerParams = array(),
listAttributesSelector = null,
kanbanBoard = null 
)

Constructs a list view specifying the controller as well as the model that will have its details displayed.isDisplayAttributeACalculationOrModifier

Reimplemented in ContactWebFormsListView, and TasksListView.

Definition at line 95 of file ListView.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 View.

Reimplemented in LatestActivitiesListView, AutorespondersListView, CalendarItemsListView, CampaignItemsRelatedListView, ImportTempTableListView, MarketingListMembersListView, DaysMeetingsFromCalendarModalListView, MissionsPortletListView, ProductsRelatedListView, ActiveProjectsListView, ProjectsFeedListView, SocialItemsListView, TasksForRelatedKanbanView, and TasksListView.

Definition at line 142 of file ListView.php.

getRowsAreSelectable (  ) 

For a Kanban Board view, the rows are never selectable.

Returns:
bool

Reimplemented in GameRewardsRedeemListView, and LeaderboardListView.

Definition at line 187 of file ListView.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 in CalendarItemsListView, CampaignItemsRelatedListView, ImportTempTableListView, ProductsRelatedListView, TasksForRelatedKanbanView, and StarredListView.

Definition at line 321 of file ListView.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 MetadataView.

Reimplemented in AListView, AccountAccountAffiliationsRelatedListView, AccountAffiliationsForContactRelatedListView, ContactAffiliationsForAccountRelatedListView, AccountsForMixedModelsSearchListView, AccountsListView, AccountsModalListView, AccountsMyListView, AccountsRelatedListView, LatestActivitiesListView, AutorespondersListView, CalendarItemsListView, SharedCalendarsModalListView, CampaignItemsRelatedListView, CampaignsListView, CampaignsRelatedListView, ContactsForMixedModelsSearchListView, ContactsListView, ContactsModalListView, ContactsMyListView, ContactsForOpportunityRelatedListView, ContactsRelatedListView, ContactWebFormEntryListView, ContactWebFormsListView, ConversationsListView, ArchivedEmailMatchingListView, EmailTemplatesListView, EmailTemplatesModalListView, GameRewardsListView, GameRewardsModalListView, GameRewardsRedeemListView, GameRewardTransactionsRelatedListView, LeaderboardListView, ImportErrorsListView, JobLogsModalListView, LeadsForMixedModelsSearchListView, LeadsListView, LeadsModalListView, LeadsMyListView, MarketingListMembersListView, MarketingListsListView, MarketingListsModalListView, MarketingListsForContactRelatedListView, MarketingListsRelatedListView, MashableInboxListView, DaysMeetingsFromCalendarModalListView, MeetingsMyListView, UpcomingMeetingsRelatedListView, MissionsListView, NotificationsForUserListView, OpportunitiesForMixedModelsSearchListView, OpportunitiesListView, OpportunitiesModalListView, OpportunitiesMyListView, OpportunitiesForContactRelatedListView, OpportunitiesRelatedListView, ProductsListView, ProductsModalListView, ProductsMyListView, ProductsForAccountRelatedListView, ProductsForContactRelatedListView, ProductsForOpportunityRelatedListView, ProductsRelatedListView, ProductTemplatesListView, ProductTemplatesModalListView, ActiveProjectsListView, ActiveProjectsPortletView, ProjectsFeedListView, ProjectsListView, ProjectsModalListView, ProjectsRelatedListView, ReportsListView, ReportsModalListView, SocialItemsListView, OpenTasksRelatedListView, TasksForProjectKanbanView, TasksForRelatedKanbanView, TasksListView, TasksMyListView, UsersByModelModalListView, UsersListView, UsersModalListView, ByTimeWorkflowInQueuesListView, WorkflowMessageInQueuesListView, WorkflowsListView, and AuditEventsModalListView.

Definition at line 434 of file ListView.php.

static canRenderRowMenuColumnByElementAndData ( element,
data 
) [static]

As you are rendering row columns, you can override this method to make it dependent on values within the data which is most likely a model.

Parameters:
$element 
$data 
Returns:
bool

Reimplemented in AccountContactAffiliationsRelatedListView.

Definition at line 446 of file ListView.php.

static getDesignerRulesType (  )  [static]

Override in each sub-class if you have applicable designer rules for handling the modification of metadata layouts

Returns:
null or a DesignerRules Class;

Reimplemented from MetadataView.

Reimplemented in ModalListView, MyListView, RelatedListView, AccountsForMixedModelsSearchListView, CalendarItemsListView, ContactsForMixedModelsSearchListView, LeadsForMixedModelsSearchListView, OpportunitiesForMixedModelsSearchListView, ActiveProjectsListView, ProjectsFeedListView, TasksForRelatedKanbanView, and UsersByModelModalListView.

Definition at line 541 of file ListView.php.

getActionModuleClassName (  )  [protected]

Module class name for models linked from rows in the grid view.

Reimplemented in MyListView, and RelatedListView.

Definition at line 549 of file ListView.php.

processColumnInfoToFetchColumnData ( columnInformation  )  [protected]

Process input column information to fetch column data

Reimplemented in AccountContactAffiliationsRelatedListView, and ProductsRelatedListView.

Definition at line 589 of file ListView.php.

isHeaderHidden (  )  [protected]

Checks if header cells have to be hidden

Returns:
bool

Reimplemented in ActiveProjectsListView, and ProjectsFeedListView.

Definition at line 605 of file ListView.php.


Field Documentation

$rowsAreSelectable = false [protected]

True/false to decide if each row in the list view widget will have a checkbox.

Reimplemented in MashableInboxListView.

Definition at line 58 of file ListView.php.

$gridId [protected]

Unique identifier of the list view widget. Allows for multiple list view widgets on a single page.

See also:
$

Definition at line 65 of file ListView.php.

$gridIdSuffix [protected]

Additional unique identifier.

See also:
$gridId

Definition at line 71 of file ListView.php.

$selectedIds [protected]

Array of model ids. Each id is for a different row checked off

Definition at line 76 of file ListView.php.

$gridViewPagerParams = array() [protected]

Array containing CGridViewPagerParams

Definition at line 81 of file ListView.php.


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