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 () | |
| getTypeCssClassForCGridView () | |
| getKanbanCssClassForCGridView () | |
| getCGridViewPagerParams () | |
| getShowTableOnEmpty () | |
| getEmptyText () | |
| getCGridViewFirstColumn () | |
| getCGridViewColumns () | |
| resolveMetadata () | |
| getResolvedMetadata () | |
| getCGridViewBeforeAjaxUpdate () | |
| getCGridViewAfterAjaxUpdate () | |
| getCGridViewAjaxUrl () | |
| getCGridViewSelectableRowsCount () | |
| getCGridViewLastColumn () | |
| getGridViewMenuColumn () | |
| getGridViewActionRoute ($action, $moduleId=null) | |
| getListActionId () | |
| getActionModuleClassName () | |
| getDataProvider () | |
| renderScripts () | |
| processColumnInfoToFetchColumnData ($columnInformation) | |
| isHeaderHidden () | |
| resolveRowMenuColumnClass () | |
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 | |
The base View for a module's list view.
Definition at line 40 of file ListView.php.
| __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, TasksForRelatedKanbanView, TasksKanbanView, and TasksListView.
Definition at line 95 of file ListView.php.
| renderContent | ( | ) | [protected] |
Renders content for a list view. Utilizes a CActiveDataprovider and a CGridView widget. and form layout.
Reimplemented from View.
Reimplemented in LatestActivitiesListView, AutorespondersListView, CalendarItemsListView, CampaignItemsRelatedListView, ImportTempTableListView, MarketingListMembersListView, DaysMeetingsFromCalendarModalListView, MissionsPortletListView, ProductsRelatedListView, ActiveProjectsListView, ProjectsFeedListView, SocialItemsListView, TasksForRelatedKanbanView, TasksKanbanView, TasksListView, and TasksMyListView.
Definition at line 142 of file ListView.php.
| getRowsAreSelectable | ( | ) |
For a Kanban Board view, the rows are never selectable.
Reimplemented in ExportListView, 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, TasksKanbanView, and StarredListView.
Definition at line 337 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, ExportListView, 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, ProjectsForMixedModelsSearchListView, ProjectsListView, ProjectsModalListView, ProjectsRelatedListView, ReportsListView, ReportsModalListView, StarredReportsPortletView, SocialItemsListView, OpenTasksRelatedListView, TasksForProjectKanbanView, TasksForRelatedKanbanView, TasksKanbanView, TasksListView, TasksMyListView, UsersByModelModalListView, UsersListView, UsersModalListView, ByTimeWorkflowInQueuesListView, WorkflowMessageInQueuesListView, WorkflowsListView, AuditEventsModalListView, and ImagesModalListView.
Definition at line 450 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.
| $element | ||
| $data |
Reimplemented in AccountContactAffiliationsRelatedListView.
Definition at line 462 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
Reimplemented from MetadataView.
Reimplemented in ModalListView, MyListView, RelatedListView, AccountsForMixedModelsSearchListView, CalendarItemsListView, ContactsForMixedModelsSearchListView, LeadsForMixedModelsSearchListView, OpportunitiesForMixedModelsSearchListView, ActiveProjectsListView, ActiveProjectsPortletView, ProjectsFeedListView, ProjectsForMixedModelsSearchListView, StarredReportsPortletView, TasksForRelatedKanbanView, TasksKanbanView, TasksMyListView, and UsersByModelModalListView.
Definition at line 557 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 565 of file ListView.php.
| processColumnInfoToFetchColumnData | ( | $ | columnInformation | ) | [protected] |
Process input column information to fetch column data
Reimplemented in AccountContactAffiliationsRelatedListView, ProductsListView, and ProductsRelatedListView.
Definition at line 605 of file ListView.php.
| isHeaderHidden | ( | ) | [protected] |
Checks if header cells have to be hidden
Reimplemented in ActiveProjectsListView, and ProjectsFeedListView.
Definition at line 621 of file ListView.php.
| resolveRowMenuColumnClass | ( | ) | [protected] |
Resolve row menu column class.
Reimplemented in OpenTasksRelatedListView.
Definition at line 630 of file ListView.php.
$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.
Definition at line 65 of file ListView.php.
$gridIdSuffix [protected] |
$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.