ModulePermissionsEditAndDetailsView Class Reference

Inheritance diagram for ModulePermissionsEditAndDetailsView:
EditAndDetailsView DetailsView ModelView ConfigurableMetadataView MetadataView View

Public Member Functions

 __construct ($renderType, $controllerId, $moduleId, $model, $modelId, $metadata, $title=null)
 getTitle ()
 isUniqueToAPage ()

Static Public Member Functions

static getDefaultMetadata ()
static getDesignerRulesType ()

Protected Member Functions

 renderFormLayout ($form=null)
 getFormLayoutMetadata ()

Static Protected Member Functions

static assertMetadataIsValid (array $metadata)

Detailed Description

Definition at line 37 of file ModulePermissionsEditAndDetailsView.php.


Constructor & Destructor Documentation

__construct ( renderType,
controllerId,
moduleId,
model,
modelId,
metadata,
title = null 
)

Constructs a module permissions view specifying the controller as well as the model that will have its details displayed.

Definition at line 48 of file ModulePermissionsEditAndDetailsView.php.


Member Function Documentation

getTitle (  ) 

TODO

Reimplemented from EditAndDetailsView.

Definition at line 67 of file ModulePermissionsEditAndDetailsView.php.

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 72 of file ModulePermissionsEditAndDetailsView.php.

renderFormLayout ( form = null  )  [protected]

Override to produce a form layout that does not follow the standard form layout for EditView.

Reimplemented from DetailsView.

Definition at line 91 of file ModulePermissionsEditAndDetailsView.php.

static getDesignerRulesType (  )  [static]

This view is not editable in the designer tool.

Reimplemented from EditAndDetailsView.

Definition at line 161 of file ModulePermissionsEditAndDetailsView.php.

static assertMetadataIsValid ( array $  metadata  )  [static, protected]

This ModelView metadata validity check is not valid on this view because this view follows a different metadata structure.

Reimplemented from DetailsView.

Definition at line 170 of file ModulePermissionsEditAndDetailsView.php.

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 174 of file ModulePermissionsEditAndDetailsView.php.

getFormLayoutMetadata (  )  [protected]

Merges view metadata with dynamically generated metadata based on $model

Reimplemented from DetailsView.

Definition at line 183 of file ModulePermissionsEditAndDetailsView.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Fri Nov 24 07:10:27 2017