Mage_Adminhtml_Block_System_Config_Form_Field_Array_Abstract Class Reference

Inheritance diagram for Mage_Adminhtml_Block_System_Config_Form_Field_Array_Abstract:

List of all members.

Public Member Functions
	__construct ()
	addColumn ($name, $params)
Protected Member Functions
	_getElementHtml (Varien_Data_Form_Element_Abstract $element)
	_renderCellTemplate ($columnName)
Protected Attributes
	$_columns = array()
	$_addAfter = true
	$_addButtonLabel

---

Detailed Description

Definition at line 34 of file Abstract.php.

---

Constructor & Destructor Documentation

__construct

(

)

Check if columns are defined, set template

Reimplemented from Varien_Object.

Reimplemented in Mage_Adminhtml_Block_System_Config_Form_Field_Regexceptions.

Definition at line 63 of file Abstract.php.

    {
        if (empty($this->_columns)) {
            throw new Exception('At least one column must be defined.');
        }
        if (!$this->_addButtonLabel) {
            $this->_addButtonLabel = Mage::helper('adminhtml')->__('Add');
        }
        parent::__construct();
        if (!$this->getTemplate()) {
            $this->setTemplate('system/config/form/field/array.phtml');
        }
    }

---

Member Function Documentation

_getElementHtml

(

Varien_Data_Form_Element_Abstract $

element

)

[protected]

Get the grid and scripts contents

Parameters:

Varien_Data_Form_Element_Abstract

$element

Returns:

string

Reimplemented from Mage_Adminhtml_Block_System_Config_Form_Field.

Definition at line 103 of file Abstract.php.

    {
        $this->setElement($element);
        $html = $this->_toHtml();
        $this->_arrayRowsCache = null; // doh, the object is used as singleton!
        return $html;
    }

_renderCellTemplate

(

$

columnName

)

[protected]

Render array cell for prototypeJS template

Parameters:

string

$columnName

Returns:

string

Definition at line 145 of file Abstract.php.

    {
        if (empty($this->_columns[$columnName])) {
            throw new Exception('Wrong column name specified.');
        }
        $column     = $this->_columns[$columnName];
        $inputName  = $this->getElement()->getName() . '[#{_id}][' . $columnName . ']';

        if ($column['renderer']) {
            return $column['renderer']->setInputName($inputName)->setColumnName($columnName)->setColumn($column)
                ->toHtml();
        }

        return '<input type="text" name="' . $inputName . '" value="#{' . $columnName . '}" ' .
            ($column['size'] ? 'size="' . $column['size'] . '"' : '') . ' class="' .
            (isset($column['class']) ? $column['class'] : 'input-text') . '"'.
            (isset($column['style']) ? ' style="'.$column['style'] . '"' : '') . '/>';
    }

addColumn	(	$	name,
		$	params
	)

Add a column to array-grid

Parameters:

	string	$name
	array	$params

Definition at line 83 of file Abstract.php.

    {
        $this->_columns[$name] = array(
            'label'     => empty($params['label']) ? 'Column' : $params['label'],
            'size'      => empty($params['size'])  ? false    : $params['size'],
            'style'     => empty($params['style'])  ? null    : $params['style'],
            'class'     => empty($params['class'])  ? null    : $params['class'],
            'renderer'  => false,
        );
        if ((!empty($params['renderer'])) && ($params['renderer'] instanceof Mage_Core_Block_Abstract)) {
            $this->_columns[$name]['renderer'] = $params['renderer'];
        }
    }

---

Member Data Documentation

$_addAfter = true [protected]

Definition at line 48 of file Abstract.php.

$_addButtonLabel [protected]

Definition at line 55 of file Abstract.php.

$_columns = array() [protected]

Definition at line 41 of file Abstract.php.

---

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

• app/code/core/Mage/Adminhtml/Block/System/Config/Form/Field/Array/Abstract.php