ProductsMyListConfigView Class Reference

Inheritance diagram for ProductsMyListConfigView:
MyListConfigView ModalConfigEditView EditView DetailsView ModelView ConfigurableMetadataView MetadataView View

Static Public Member Functions

static getDefaultMetadata ()
static getDisplayDescription ()
static getModelForMetadataClassName ()

Detailed Description

View for showing the configuration parameters for the

See also:
ProductsMyListView.

Definition at line 40 of file ProductsMyListConfigView.php.


Member Function Documentation

static getDefaultMetadata (  )  [static]

Returns meta data for use in automatically generating the view. The meta data is comprised of panels, rows, and then cells. Each cell can have 1 or more elements.

The element takes 3 parameters. The first parameter is 'attributeName'. The second parameter is 'type' and refers to the element type. Using a type of 'Text' would utilize the TextElement class. The third parameter is 'wide' and refers to how many cells the field should span. An example of the 'wide' => true usage would be for a text description field. Here is an example meta data that defines a 2 row x 2 cell layout.

            <?php
                $metadata = array(
                    'panels' => array(
                        array(
                            'rows' => array(
                                array('cells' =>
                                    array(
                                        array(
                                            'elements' => array(
                                                array('field' => 'name', 'type' => 'Text'),
                                            ),
                                        ),
                                        array(
                                            'elements' => array(
                                                array('field' => 'officePhone', 'type' => 'Text'),
                                            ),
                                        ),
                                    )
                                ),
                                array('cells' =>
                                    array(
                                        array(
                                            'elements' => array(
                                                array('field' => 'industry', 'type' => 'DropDown'),
                                            ),
                                        ),
                                        array(
                                            'elements' => array(
                                                array('field' => 'officeFax', 'type' => 'Text'),
                                            ),
                                        ),
                                    )
                                ),
                            ),
                        ),
                    ),
                );
            ?>

Reimplemented from DetailsView.

Definition at line 42 of file ProductsMyListConfigView.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 from MyListConfigView.

Definition at line 85 of file ProductsMyListConfigView.php.

static getModelForMetadataClassName (  )  [static]

Override in each sub-class if you have a different model form to use than the primary model for the module for this view

Returns:
null or a ModelForm class name

Reimplemented from MetadataView.

Definition at line 90 of file ProductsMyListConfigView.php.


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