MyListConfigView Class Reference

Inheritance diagram for MyListConfigView:
ModalConfigEditView EditView DetailsView ModelView ConfigurableMetadataView MetadataView View AccountsMyListConfigView ContactsMyListConfigView LeadsMyListConfigView MeetingsMyListConfigView OpportunitiesMyListConfigView ProductsMyListConfigView TasksMyListConfigView

Public Member Functions

 __construct (ConfigurableMetadataModel $model, $searchModel, $params)
 validate ()
 setMetadataFromPost ($postArray)
 getViewMetadata ()
 getSearchModelPostArrayName ()

Static Public Member Functions

static getDesignerRulesType ()
static getDisplayDescription ()

Protected Member Functions

 getModel ()
 afterResolveMetadataWithRenderedElements (&$metadataWithRenderedElements, $form)

Static Protected Member Functions

static getActiveFormClassName ()

Detailed Description

The base configuration view class for my list type views.

Definition at line 40 of file MyListConfigView.php.


Member Function Documentation

static getActiveFormClassName (  )  [static, protected]

An override to utilize a special ActiveForm that will not display any indications in the user interface that an attribute is required.

Reimplemented from ModalConfigEditView.

Definition at line 62 of file MyListConfigView.php.

validate (  ) 

Supports both validating both models. The MyListForm model and the SearchModel

See also:
ModalConfigEditView::validate()

Reimplemented from ModalConfigEditView.

Definition at line 71 of file MyListConfigView.php.

setMetadataFromPost ( postArray  ) 

Supports setting metadata on both models. The MyListForm model and the SearchModel

See also:
ModalConfigEditView::setMetadataFromPost()

Reimplemented from ModalConfigEditView.

Definition at line 82 of file MyListConfigView.php.

getViewMetadata (  ) 

Supports getting metadata on both models. The MyListForm model and the SearchModel

See also:
ModalConfigEditView::getViewMetadata()

Reimplemented from ModalConfigEditView.

Definition at line 101 of file MyListConfigView.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 EditView.

Definition at line 117 of file MyListConfigView.php.

getModel (  )  [protected]

Override because the config form is using the searchModel as its model and not the formModel.

See also:
DetailsView::getModel()

Reimplemented from DetailsView.

Definition at line 126 of file MyListConfigView.php.

afterResolveMetadataWithRenderedElements ( &$  metadataWithRenderedElements,
form 
) [protected]

Override to support the 'title' from MyListForm being rendered into the view. This is special because this view can be modified in the designer tool, however the MyListForm is not compatible with the SearchForm in designer so this special override is in place to manually ensure the MyListForm attributes, currently only 'title' can be placed.

See also:
DetailsView::afterResolveMetadataWithRenderedElements()

Reimplemented from DetailsView.

Definition at line 138 of file MyListConfigView.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 AccountsMyListConfigView, ContactsMyListConfigView, LeadsMyListConfigView, MeetingsMyListConfigView, OpportunitiesMyListConfigView, ProductsMyListConfigView, and TasksMyListConfigView.

Definition at line 153 of file MyListConfigView.php.


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