Magento – How to Add an Input Renderer for Custom Customer Attribute

adminformadminhtmlcustomermagento-1.8

I added a custom attribute for customer collection named customer_mode.

It have 2 values first, and second in the following maner:

$data = array(
'customer' => array(
    'customer_mode' => array(
        'label'      => 'Customer Mode',
        'sort_order' => 285,
        'required'   => false,
        'type' => 'int',
        'default' => 1 // First
    )
));

In back office admin area I want to show this field not as int but as an custom input type (select box).

I added the Input renderer:

<?php

/**
 * Class Company_Customer_Block_Adminhtml_Customer_Edit_Form_Renderer_CustomerModeType
 *
 * @author Alexandru Olaru <alxolr@gmail.com>
 */
class Company_Customer_Block_Adminhtml_Customer_Edit_Form_Renderer_Mode extends
    Varien_Data_Form_Element_Select
{
    public function __construct(array $attributes)
    {
        parent::__construct($attributes);

        $this->setValues(
            array(
                array(
                    'label' => Mage::helper('company_customer')->__('First'),
                    'value' => 1,
                ),
                array(
                    'label' => Mage::helper('company_customer')->__('Second'),
                    'value' => 2,
                )
            )
        );
    }
}

Now my problem is what value should I put on the input_renderer ?

$data = array(
    'customer' => array(
        'customer_mode' => array(
            'label'      => 'Customer Mode',
            'sort_order' => 285,
            'required'   => false,
            'type' => 'int',
            'default' => 1,
            'input_renderer' => **????**
        )
    )
);

Best Answer

You will need to create customer attribute this way

<?php
$installer = $this;
$installer->startSetup();


$installer->addAttribute("customer", "customer_mode",  array(
    "type"     => "int",
    "backend"  => "",
    "label"    => "Customer Mode",
    "input"    => "select",
    "source"   => "customer/eav_entity_attribute_source_customeroptions",
    "visible"  => true,
    "required" => false,
    "default" => "",
    "frontend" => "",
    "unique"     => false,
    "note"       => ""

    ));

$attribute   = Mage::getSingleton("eav/config")->getAttribute("customer", "customer_mode");


$used_in_forms=array();

$used_in_forms[]="adminhtml_customer";
$used_in_forms[]="checkout_register";
$used_in_forms[]="customer_account_create";
$used_in_forms[]="customer_account_edit";
$used_in_forms[]="adminhtml_checkout";
        $attribute->setData("used_in_forms", $used_in_forms)
        ->setData("is_used_for_customer_segment", true)
        ->setData("is_system", 0)
        ->setData("is_user_defined", 1)
        ->setData("is_visible", 1)
        ->setData("sort_order", 100)
        ;
        $attribute->save();
$installer->endSetup();

Create your own model class like

Namespace_Module_Model_Eav_Entity_Attribute_Source_Customeroptions

Add below functions in that class

public function getAllOptions()
{
    if (is_null($this->_options)) {
        $this->_options = array(

            array(
                "label" => Mage::helper("eav")->__("First"),
                "value" =>  1
            ),

            array(
                "label" => Mage::helper("eav")->__("Second"),
                "value" =>  2
            ),

        );
    }
    return $this->_options;
}

/**
 * Retrieve option array
 *
 * @return array
 */
public function getOptionArray()
{
    $_options = array();
    foreach ($this->getAllOptions() as $option) {
        $_options[$option["value"]] = $option["label"];
    }
    return $_options;
}

/**
 * Get a text for option value
 *
 * @param string|integer $value
 * @return string
 */
public function getOptionText($value)
{
    $options = $this->getAllOptions();
    foreach ($options as $option) {
        if ($option["value"] == $value) {
            return $option["label"];
        }
    }
    return false;
}

Your setup class should be Mage_Customer_Model_Entity_Setup in your config.xml

<customerattribute_setup>
        <setup>
          <module>Namespace_Module</module>
          <class>Mage_Customer_Model_Entity_Setup</class>
        </setup>
        <connection>
          <use>core_setup</use>
        </connection>
</customerattribute_setup>

Related Solutions

Magento – How to create forms for a custom adminhtml module

To create your own form you need the following:

In your controller you need to load the Form Container Widget:

class Vendor_ProductUploader_Adminhtml_Product_Uploader_AttachmentController
extends Mage_Adminhtml_Controller_Action {

public function newAction() {
    $this->loadLayout()->_addContent($this->getLayout()->createBlock('vendor_productuploader/adminhtml_attachment'))->renderLayout();
}

Next you need to create the Form Container (this one is missing in your code posted above):

class Vendor_ProductUploader_Block_Adminhtml_Attachment
    extends Mage_Adminhtml_Block_Widget_Form_Container {

public function __construct() {
    parent::__construct();

    $this->_blockGroup = 'vendor_productuploader';
    $this->_mode = 'attachment';
    $this->_controller = 'adminhtml';

}

public function getHeaderText() {
    return Mage::helper('vendor_productuploader')->__("My form header");
}

public function getBackUrl() {
    return $this->getUrl('*/*/');
}

The last item you need is in your form, at the end you need to set the form you created with:

$this->setForm($form);

Adminhtml – Add Custom Template for Custom Product Attribute

First of all...nice question. Got me really interested.
Here is an example on how you can create an attribute that has a custom renderer (template) and the value is saved serialized.
For this example I created an attribute that will have 2 text inputs, but you can basically put anything in there.

I recommend creating a custom module to handle your attribute. Let's call this extension Easylife_Attr.
You will need the following files.
app/etc/module/Easylife_Attr.xml - the declaration file.

<?xml version="1.0"?>
<config>
    <modules>
        <Easylife_Attr>
            <codePool>local</codePool>
            <active>true</active>
            <depends>
                <Mage_Catalog /><!-- should depend on mage_catalog-->
                <Mage_Adminhtml /><!-- should depend on mage_adminhtml-->
            </depends>
        </Easylife_Attr>
    </modules>
</config>

app/code/local/Easylife/Attr/etc/config.xml - the configuration file

<?xml version="1.0"?>
<config>
    <modules>
        <Easylife_Attr>
            <version>0.0.1</version>
        </Easylife_Attr>
    </modules>
    <global>
        <resources>
            <easylife_attr_setup>
                <setup>
                    <module>Easylife_Attr</module>
                    <class>Mage_Catalog_Model_Resource_Setup</class><!-- use the catalog setup so you can add your attribute -->
                </setup>
            </easylife_attr_setup>
        </resources>
        <models>
            <easylife_attr>
                <class>Easylife_Attr_Model</class>
            </easylife_attr>
        </models>
        <blocks>
            <easylife_attr>
                <class>Easylife_Attr_Block</class>
            </easylife_attr>
        </blocks>
    </global>
    <adminhtml>
        <events>
            <adminhtml_catalog_product_edit_prepare_form><!-- event needed to add a template to a certain attribute -->
                <observers>
                    <easylife>
                        <class>Easylife_Attr_Model_Observer</class>
                        <method>convertCustomValues</method>
                    </easylife>
                </observers>
            </adminhtml_catalog_product_edit_prepare_form>
        </events>
    </adminhtml>
</config>

app/code/local/Easylife/Attr/sql/easylife_attr_setup/install-0.0.1.php - the install script. It will add your attribute

<?php
$this->addAttribute('catalog_product', 'custom_values', array(
    'group'         => 'Custom values', //the tab name where the attribute will be placed
    'input'         => 'textarea', //this is not really important
    'type'          => 'text', //attribute type should be text to support long values
    'label'         => 'Custom values', //the attribute label
    'backend'       => 'easylife_attr/custom',  //a custom backend model that will handle serialization and deserialization
    'visible'       => true,
    'required'      => false,
    'visible_on_front' => true,
    'global'        => Mage_Catalog_Model_Resource_Eav_Attribute::SCOPE_GLOBAL, //scope can be anything but if it's not global you will need some changes to support store view values
));

Now the fun part.

app/code/local/Easylife/Attr/Model/Observer.php - the observe that will change the attribute template

<?php
class Easylife_Attr_Model_Observer {
    public function convertCustomValues($observer) {
        $form = $observer->getEvent()->getForm();
        $customValues = $form->getElement('custom_values');
        if ($customValues) {
            $customValues->setRenderer(
                Mage::app()->getLayout()->createBlock('easylife_attr/adminhtml_product_custom')
            ); //set a custom renderer to your attribute
        }
    }
}

app/code/local/Easylife/Attr/Block/Adminhtml/Product/Custom.php - the custom renderer block

<?php
class Easylife_Attr_Block_Adminhtml_Product_Custom
    extends Mage_Adminhtml_Block_Widget
    implements Varien_Data_Form_Element_Renderer_Interface {
    public function __construct()
    {
        $this->setTemplate('easylife_attr/product/custom.phtml'); //set a template
    }
    public function render(Varien_Data_Form_Element_Abstract $element) {
        $this->setElement($element);
        return $this->toHtml();
    }
}

app/design/adminhtml/default/default/template/easylife_attr/product/custom.phtml - the template for the attribute.

<?php
$_htmlId = $this->getElement()->getHtmlId();
$_htmlClass = $this->getElement()->getClass();
$_htmlName = $this->getElement()->getName();
$_readonly = $this->getElement()->getReadonly();
$value = $this->getElement()->getValue();
//get the values for the 2 text elements
$someField = (isset($value['some_field']) ? $value['some_field'] : '');
$otherField = (isset($value['other_field']) ? $value['other_field'] : '');

?>
<tr> <!-- should be wrapped in a tr element to fit in the admin template -->
    <td class="label"><?php echo $this->getElement()->getLabel(); ?></td>
    <td colspan="10" class="grid">
        <table cellspacing="0" class="data border">
            <col width="120" />
            <col />
            <thead>
            <tr class="headings">
                <th><?php echo $this->__('Some field')?></th>
                <th><?php echo $this->__('Other Field')?></th>
            </tr>
            </thead>
            <tbody id="<?php echo $_htmlId; ?>_container"></tbody>
            <tfoot>
            <tr>
                <td><input type="text" name="<?php echo $_htmlName; ?>[some_field]" value="<?php echo $someField?>"<?php echo ($_readonly) ? ' readonly="readonly"' : ''?>> </td>
                <td><input type="text" name="<?php echo $_htmlName; ?>[other_field]" value="<?php echo $otherField?>"<?php echo ($_readonly) ? ' readonly="readonly"' : ''?>></td>
            </tr>
            </tfoot>
        </table>
    </td>
</tr>

app/code/local/Easylife/Attr/Model/Custom.php - the model that handles the serialization and deserialization.

<?php
class Easylife_Attr_Model_Custom extends Mage_Eav_Model_Entity_Attribute_Backend_Abstract{
    public function beforeSave($object) 
    {
        //before sabing the product check if the attribute `custom_values` is array.
        //if it is, serialize it for saving in the db
        $attributeCode = $this->getAttribute()->getAttributeCode();
        $data = $object->getData($attributeCode);
        if (is_array($data)) {
            $data = array_filter($data);
            $object->setData($attributeCode, serialize($data));
        }
        return parent::beforeSave($object);
    }
    public function afterLoad($object) {
        //after loading the product, check if the value for custom_values is not an array. If it's not try to unserialize the value.
        $attributeCode = $this->getAttribute()->getAttributeCode();
        $data = $object->getData($attributeCode);
        if (!is_array($data)) {
            $object->setData($attributeCode, @unserialize($data));
        }
        return parent::afterLoad($object);
    }
}

That's it. Here is how the attribute would look in the backend:

Custom template attribute

Best Answer

Related Solutions

Magento – How to create forms for a custom adminhtml module

Adminhtml – Add Custom Template for Custom Product Attribute

Related Topic