MyListView Class Reference

Inheritance diagram for MyListView:
ListView PortletViewInterface ModelView ListViewInterface ConfigurableMetadataView MetadataView View ActiveProjectsPortletView SecuredMyListView AccountsMyListView ContactsMyListView LeadsMyListView MeetingsMyListView OpportunitiesMyListView ProductsMyListView TasksMyListView

Public Member Functions

 __construct ($viewData, $params, $uniqueLayoutId)
 getPortletParams ()
 renderPortletHeadContent ()
 isUniqueToAPage ()
 getConfigurationView ()
 getTitle ()
 getModelClassName ()

Static Public Member Functions

static getDefaultTitle ()
static getDefaultSearchAttributes ()
static canUserConfigure ()
static getDesignerRulesType ()
static getPortletDescription ()
static getDisplayDescription ()
static getPortletRulesType ()

Protected Member Functions

 getShowTableOnEmpty ()
 getEmptyText ()
 makeSearchAttributeData ()
 resolveSearchAttributesMetadataAgainstStateAdapter (&$searchAttributesMetadata)
 makeDataProviderBySearchAttributeData ($searchAttributeData)
 getSortAttributeForDataProvider ()
 resolveSortDescendingForDataProvider ()
 getSearchAttributes ()
 getCGridViewPagerParams ()
 getCGridViewAfterAjaxUpdate ()
 getActionModuleClassName ()
 getDataProvider ()
 getSearchModel ()

Static Protected Member Functions

static getGridTemplate ()
static getPagerCssClass ()
static getConfigViewClassName ()

Protected Attributes

 $params
 $viewData
 $uniqueLayoutId

Detailed Description

The base View for a module's my list view which is a customizable list view by the end user for use in the dashboard.

Definition at line 41 of file MyListView.php.


Member Function Documentation

isUniqueToAPage (  ) 

Tells View that it can render the extending class' divs with and id matching their name. Must be overridden to return false in extending classes that can be rendered multiple times within a page to avoid generating a page with non-unique ids which will fail XHtml validation. For those it will render a class attribute with their name.

Reimplemented from View.

Definition at line 147 of file MyListView.php.

getCGridViewAfterAjaxUpdate (  )  [protected]

Override to not run global eval, since it causes doubling up of ajax requests on the pager. (non-PHPdoc)

See also:
ListView::getCGridViewAfterAjaxUpdate()

Reimplemented from ListView.

Definition at line 209 of file MyListView.php.

getTitle (  ) 

TODO

Reimplemented from ConfigurableMetadataView.

Reimplemented in ActiveProjectsPortletView.

Definition at line 218 of file MyListView.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 ListView.

Definition at line 253 of file MyListView.php.

static getPortletDescription (  )  [static]

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

Implements PortletViewInterface.

Definition at line 261 of file MyListView.php.

static getDisplayDescription (  )  [static]

Override to add a display description. An example would be 'My Contacts'. This display description can then be used by external classes interfacing with the view in order to display information to the user in the user interface.

Reimplemented in AccountsMyListView, ContactsMyListView, LeadsMyListView, MeetingsMyListView, OpportunitiesMyListView, ProductsMyListView, ActiveProjectsPortletView, and TasksMyListView.

Definition at line 270 of file MyListView.php.

static getPortletRulesType (  )  [static]

What kind of PortletRules this view follows.

Returns:
PortletRulesType as string.

Implements PortletViewInterface.

Definition at line 285 of file MyListView.php.

getActionModuleClassName (  )  [protected]

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

Reimplemented from ListView.

Definition at line 310 of file MyListView.php.

getSearchModel (  )  [protected]

Override in non-abstract class to return the proper search model object.

Exceptions:
NotImplementedException 

Reimplemented in AccountsMyListView, ContactsMyListView, LeadsMyListView, MeetingsMyListView, OpportunitiesMyListView, ProductsMyListView, ActiveProjectsPortletView, and TasksMyListView.

Definition at line 329 of file MyListView.php.

static getConfigViewClassName (  )  [static, protected]

Override in non-abstract class to return the proper config view class name.

Exceptions:
NotImplementedException 

Reimplemented in AccountsMyListView, ContactsMyListView, LeadsMyListView, MeetingsMyListView, OpportunitiesMyListView, ProductsMyListView, and TasksMyListView.

Definition at line 338 of file MyListView.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Thu Oct 19 07:10:28 2017