UsersModalSearchView Class Reference

Inheritance diagram for UsersModalSearchView:
SearchView ModelView ConfigurableMetadataView MetadataView View

Static Public Member Functions

static getDefaultMetadata ()
static getDesignerRulesType ()
static getModelForMetadataClassName ()

Detailed Description

Definition at line 37 of file UsersModalSearchView.php.


Member Function Documentation

static getDefaultMetadata (  )  [static]

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

For search view, there should only be two panels. The second panel is hidden by default in the user interface and is where the 'advanced search' inputs are placed.

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 search layout with two panels. Each panel has 1 row with 2 cells each

            <?php
                $metadata = array(
                    'global' => array(
                        'panels' => array(
                            array(
                                'title' => 'Basic Search',
                                'rows' => array(
                                    array('cells' =>
                                        array(
                                            array(
                                                'elements' => array(
                                                    array('attributeName' => 'name', 'type' => 'Text'),
                                                ),
                                            ),
                                            array(
                                                'elements' => array(
                                                    array('attributeName' => 'officePhone', 'type' => 'Text'),
                                                ),
                                            ),
                                        )
                                    ),
                                ),
                            ),
                            array(
                                'title' => 'Advanced Search',
                                'rows' => array(
                                    array('cells' =>
                                        array(
                                            array(
                                                'elements' => array(
                                                    array('attributeName' => 'industry', 'type' => 'DropDown'),
                                                ),
                                            ),
                                            array(
                                                'elements' => array(
                                                    array('attributeName' => 'officeFax', 'type' => 'Text'),
                                                ),
                                            ),
                                        )
                                    ),
                                ),
                            ),
                        ),
                    ),
                );
            ?>

Reimplemented from SearchView.

Definition at line 39 of file UsersModalSearchView.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 SearchView.

Definition at line 94 of file UsersModalSearchView.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 99 of file UsersModalSearchView.php.


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