GroupUserMembershipEditView Class Reference

Inheritance diagram for GroupUserMembershipEditView:
EditView DetailsView ModelView ConfigurableMetadataView MetadataView View

Public Member Functions

 __construct ($controllerId, $moduleId, $model, $modelId, $title)
 isUniqueToAPage ()

Static Public Member Functions

static getDefaultMetadata ()
static getDesignerRulesType ()

Protected Member Functions

 renderFormLayout ($form=null)

Static Protected Member Functions

static assertMetadataIsValid (array $metadata)

Detailed Description

View to show the group user membership interface for adding and removing users from a group.

Definition at line 41 of file GroupUserMembershipEditView.php.


Constructor & Destructor Documentation

__construct ( controllerId,
moduleId,
model,
modelId,
title 
)

Constructs a user membershipview specifying the controller as well as the model that will have its details displayed.

Parameters:
string $controllerId
string $moduleId
GroupUserMembershipForm $model
null|string $modelId
string $title

Definition at line 52 of file GroupUserMembershipEditView.php.


Member Function Documentation

renderFormLayout ( form = null  )  [protected]

Render a form layout. Calls appropriate widget for rendering 2 multi-select lists to display both the non-members and members of a group.

Parameters:
$form 
Returns:
A string containing the element's content.

Reimplemented from DetailsView.

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

static getDesignerRulesType (  )  [static]

This view is not editable in the designer tool.

Reimplemented from EditView.

Definition at line 117 of file GroupUserMembershipEditView.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 126 of file GroupUserMembershipEditView.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 130 of file GroupUserMembershipEditView.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Sun Oct 22 07:10:25 2017