Ui_Form_GridOptions Class Reference

This is a generic grid options form. More...

Inheritance diagram for Ui_Form_GridOptions:

List of all members.

Public Member Functions
	init ()
	Initialize grid options form.
	setOptions (array $options)
	Set topic and gridId from options 'namespace' param.

---

Detailed Description

This is a generic grid options form.

Copyright:

2011-2012 Perforce Software. All rights reserved

License:

Please see LICENSE.txt in top-level folder of this distribution.

Version:

2012.2/486814

---

Member Function Documentation

Ui_Form_GridOptions::init

(

)

Initialize grid options form.

Reimplemented from P4Cms_Form_PubSubForm.

    {
        // set class to identify as p4cms-ui component
        $this->setAttrib('class',    'p4cms-ui')
             ->setAttrib('dojoType', 'p4cms.ui.grid.Form');

        // turn off CSRF protection - its not useful here (form data are
        // used for filtering the data grid and may be exposed in the URL)
        $this->setCsrfProtection(false);

        // call parent to publish the form.
        parent::init();
    }

Ui_Form_GridOptions::setOptions

(

array $

options

)

Set topic and gridId from options 'namespace' param.

Parameters:

array

$options

Zend provides no description for this parameter.

    {
        // set topic and gridId if namespace is defined
        if (isset($options['namespace'])) {
            $this->setTopic($options['namespace'] . '.form');
            $this->setAttrib('gridId', $options['namespace'] . '.instance');
            unset($options['namespace']);
        }

        parent::setOptions($options);
    }

---

The documentation for this class was generated from the following file:

• GridOptions.php