Magento 1.9 Admin – Add Custom Dropdown Category Attribute

adminattributesdropdown-attributefrontendmagento-1.9

I have followed a few tutorials on the net and ran a few searches on SO. What I want to do is create a custom select box on the admin category section. So users can select an option yes or no.

I followed a tutorial and so far came with this, but nothing appears once I delete my var/cache folder. This is my setup.

/app/code/local/Adept_Catlanding/sql/adept_catlanding_setup/mysql4-install-0.3.0.php
/app/code/local/Adept_Catlanding/etc/config.xml
/app/etc/modules/Adept_Catlanding.xml

These are the code files:

Adept_Catlanding.xml

<?xml version="1.0" encoding="UTF-8"?>
<config>
    <modules>
        <Adept_Catlanding>
            <active>true</active>
            <codePool>local</codePool>
        </Adept_Catlanding>
    </modules>
</config>

mysql4-install-0.3.0.php

<?php

$installer = $this;
$installer->startSetup();

/**
 * This is an entity associated with catalog_category
 * @var  integer
 */
$entityTypeId     = $installer->getEntityTypeId('catalog_category');

/**
 * Use the default attribute set for catalog_category -- this refers to the table `eav_attribute_set`
 * In my case, it's 3, but this function should automatically get that for you.
 * @var integer
 */
$attributeSetId   = $installer->getDefaultAttributeSetId($entityTypeId);

/**
 * This determines what group (tab) that the field will be placed. "General Information" 
 * is the default tab, and I'm okay with this, but see `eav_attribute_group` for other
 * groups
 * @var integer
 */
$attributeGroupId = $installer->getDefaultAttributeGroupId($entityTypeId, $attributeSetId);

/**
 * Let's set up our attribute, customize the type as needed (e.g. int, varchar, decimal)
 * Note where I've used `internal_title` and change to your variable.
 */
$installer->addAttribute('catalog_category', 'internal_title',  array(
    'type'     => 'varchar', /* Type - see eav_entity_* for the different types */
    'label'    => 'Enable Brand link?', /* Your label */
    'input'    => 'select', /* This refers to the type of form field should display*/
    'global'   => Mage_Catalog_Model_Resource_Eav_Attribute::SCOPE_STORE,
    'visible'           => TRUE,
    'required'          => FALSE,
    'user_defined'      => FALSE,
    'default'           => ''
));

/**
 * Now, add the attribute to the proper attribute group - again, replace the variable title
 * with yours.
 */
$installer->addAttributeToGroup(
    $entityTypeId,
    $attributeSetId,
    $attributeGroupId,
    'brandislinked',
    '2' /* Refers to the sort order of fields - see `eav_entity_attribute` for reference on the location of other fields.  I want this right below the active field, so 2 works for me.*/
);

$installer->endSetup();

config.xml

<?xml version="1.0" encoding="UTF-8"?>
<config>
    <modules>
        <Adept_Catlanding>
            <!-- Make sure that the version number matches the filename on your install script! -->
            <version>0.3.0</version>
        </Adept_Catlanding>
    </modules>
    <global>
        <resources>
            <adept_catlanding_setup>
                <setup>
                    <module>Adept_Catlanding</module>
                    <!-- This next line is absolutely critical so that we call the appropriate setup class --> 
                    <class>Mage_Catalog_Model_Resource_Setup</class>
                    <connection>
                        <use>core_setup</use>
                    </connection>
                </setup>
            </adept_catlanding_setup>
            <adept_catlanding_setup_write>
              <connection>
                <use>core_write</use>
              </connection>
            </adept_catlanding_setup_write>
            <adept_catlanding_setup_read>
              <connection>
                <use>core_read</use>
              </connection>
            </adept_catlanding_setup_read>
        </resources>
    </global>
</config>

I am using Magento 1.9 CE for the development environment and EE for the live environment.

Best Answer

try like this in installer script,

<?php 
$installer = $this;
$installer->startSetup();
//First Remove the custom attribute this after install again
$nameAttribute  = array(
    'type' => 'varchar',
    'label'=> 'Enable Brand link',
    'input' => 'select',
    'global' => Mage_Catalog_Model_Resource_Eav_Attribute::SCOPE_GLOBAL,
    'visible' => true,
    'required' => false,
    'user_defined' => true,
    'default' => '',
    'group' => "General Information"
);
$installer->addAttribute('catalog_category', 'internal_title', $nameAttribute); 
$installer->endSetup();

Related Solutions

Magento – Create a sortable and filterable custom attribute to stand-alone entity

When adding the product attribute, set used_in_product_listing, used_for_sort_by and filterable to true.

You can do that with the following update script:

$installer = Mage::getResourceModel('catalog/setup', 'catalog_setup');
$installer->startSetup();
$installer->updateAttribute('catalog_product', 'product_type', 'used_in_product_listing', 1);
$installer->updateAttribute('catalog_product', 'product_type', 'used_for_sort_by', 1);
$installer->updateAttribute('catalog_product', 'product_type', 'is_filterable', 1);
$installer->endSetup();

Thats all, if if you are NOT using the flat catalog.

If you enable the flat catalog product feature, then you need to ensure that your custom source model implements the methods getFlatColums(), getFlatIndexes() and getFlatUpdateSelect().
If they are missing, your attribute won't be included in the generated flat tables, even if used_in_product_listing is enabled.
Have a look at the class Mage_Eav_Model_Entity_Attribute_Source_Boolean for an example. You can probably copy over the methods with minimal adjustments into your custom source model from there. Otherwise, please ask a new question.

Magento – Admin Custom Label / Option for dropdown attributes

This maybe way out of date, but for anyone else having this problem then perhaps this can assist you. I hope it will save you from the hours of head banging against a wall like myself and my colleague experienced. For my purpose, I was trying to create an Image URL field for Magento version 1.9 to support a product migration from an older platform.

This answer has been partially answered here - https://stackoverflow.com/questions/21559681/creating-new-options-for-magento-attributesbut but there are some extra things I had to figure out:

1.) This answer assumes you have created your own module (if you do not know how then start here: http://www.smashingmagazine.com/2012/03/01/basics-creating-magento-module/)

2.) It also leaves you to create the extra fields in catalog/product/attribute/options.phtml yourself. But to save you time here are the amendments I made to to get it to appear in the admin. Create a new table head option on line 88:

<th><?php echo Mage::helper('catalog')->__('YOUR_ATTRIBUTE_NAME_HERE') ?></th>

Next create a new td on line 101:

<td class="a-left"><input class="input-text" type="text" name="option[YOUR_ATTRIBUTE_NAME_HERE][{{id}}]" value="{{TABLE_COLUMN_NAME_HERE}}" <?php if ($this->getReadOnly()):?> disabled="disabled"<?php endif;?>/></td>

And also, most of the logic is done in Javascript so we need to replicate the field here on line 126:

'<td><input class="input-text" type="text" name="option[YOUR_ATTRIBUTE_NAME_HERE][{{id}}]" value="{{TABLE_COLUMN_NAME_HERE}}" <?php if ($this->getReadOnly()):?> disabled="disabled"<?php endif;?>/><\/td>'+

3.) The longest part for me was creating the custom logic for _saveOption method. I overrode the parent class, but to save you the trouble here is my logic:

protected function _saveOption(Mage_Core_Model_Abstract $object)
{
$option = $object->getOption();
if (is_array($option)) {
    $adapter            = $this->_getWriteAdapter();
    $optionTable        = $this->getTable('eav/attribute_option');
    $optionValueTable   = $this->getTable('eav/attribute_option_value');

    $stores = Mage::app()->getStores(true);
    if (isset($option['value'])) {
        $attributeDefaultValue = array();
        if (!is_array($object->getDefault())) {
            $object->setDefault(array());
        }

        foreach ($option['value'] as $optionId => $values) {
            $intOptionId = (int) $optionId;
            if (!empty($option['delete'][$optionId])) {
                if ($intOptionId) {
                    $adapter->delete($optionTable, array('option_id = ?' => $intOptionId));
                }
                continue;
            }

            $sortOrder = !empty($option['order'][$optionId]) ? $option['order'][$optionId] : 0;
            $imgUrl = !empty($option['image_url'][$optionId]) ? $option['image_url'][$optionId] : 0;
            if (!$intOptionId) {
                $data = array(
                   'attribute_id'  => $object->getId(),
                   'sort_order'    => $sortOrder,
                   'image_url'     => $imgUrl
                );
                $adapter->insert($optionTable, $data);
                $intOptionId = $adapter->lastInsertId($optionTable);
            } else {
                $data  = array('sort_order' => $sortOrder, 'image_url' => $imgUrl);
                $where = array('option_id =?' => $intOptionId);
                $adapter->update($optionTable, $data, $where);
            }

            if (in_array($optionId, $object->getDefault())) {
                if ($object->getFrontendInput() == 'multiselect') {
                    $attributeDefaultValue[] = $intOptionId;
                } elseif ($object->getFrontendInput() == 'select') {
                    $attributeDefaultValue = array($intOptionId);
                }
            }

            // Default value
            if (!isset($values[0])) {
                Mage::throwException(Mage::helper('eav')->__('Default option value is not defined'));
            }

            $adapter->delete($optionValueTable, array('option_id =?' => $intOptionId));
            foreach ($stores as $store) {
                if (isset($values[$store->getId()])
                    && (!empty($values[$store->getId()])
                    || $values[$store->getId()] == "0")
                ) {
                    $data = array(
                        'option_id' => $intOptionId,
                        'store_id'  => $store->getId(),
                        'value'     => $values[$store->getId()]
                    );
                    $adapter->insert($optionValueTable, $data);
                }
            }
        }
        $bind  = array('default_value' => implode(',', $attributeDefaultValue));
        $where = array('attribute_id =?' => $object->getId());
        $adapter->update($this->getMainTable(), $bind, $where);
    }
}

return $this;
}

My custom field was named image_url so I added it to the $data variable to be inserted. This will insert values into the column "image_url" of the eav_attribute_option table, but you can manipulate it to store in eav_attribute_option_value in the same method.

4.) For some reason that stack overflow post stated that this _saveOption method would be fired on save but mine was not, therefore I also overrode the _afterSave method in the same class which looks like this:

protected function _afterSave(Mage_Core_Model_Abstract $object)
{
$this->_clearUselessAttributeValues($object);
$this->_saveStoreLabels($object)
     ->_saveAdditionalAttributeData($object)
     ->saveInSetIncluding($object)
     ->_saveOption($object);

return $this;
}

5.) Now it will attempt to save your new value. But it will cause an error since your custom table column most likely doesn't exist yet. You are welcome to create this manually if it is appropriate for you. Unfortunately I needed to create this programmatically for my situation, so for those of you in the same boat (this is a slightly unclean approach) but for speed I re-routed the app/code/core/Mage/Core/Model/Resource/Setup.php by creating the local revision here: app/code/local/Mage/Core/Model/Resource/Setup.php and add this to line 154 in the constructor class:

$installer = $this;
$installer->getConnection()->addColumn($installer->getTable('eav/attribute_option'), 'YOUR_COLUMN_NAME_HERE', 'VARCHAR(256) NULL');
$installer->endSetup();

6.) Okay, everything should now be saving to the database, but we still need to read the value into our - this had me stumped for a while, but figured out that the Javascript is responsible for replacing the {{id}} and {{sort_order}} tags in the HTML on line 230. Therefore we need to add our new column to this getOptionsValues() method. I added the following code in on line 70 of catalog/product/attribute/options.phtml:

<?php foreach ($this->getOptionValues() as &$val) {
$imgUrl = $this->getImageUrl($val->id);
if ($imgUrl != "0") {
    $val->_data["YOUR_TABLE_COLUMN_NAME_HERE"] = $imgUrl;
}
} ?>

Then, in your YOUR_MODULE_Block_Adminhtml_Options class add the method getImageUrl() that the above calls:

public function getImageUrl($option_id)
{
//Get the resource model
$resource = Mage::getSingleton('core/resource');

//Retrieve the read connection
$readConnection = $resource->getConnection('core_read');

//Retrieve our table name
$table = $resource->getTableName('eav/attribute_option');
$query = 'SELECT ' . $this->custom_col . ' FROM ' . $table . ' WHERE option_id = '
. (int)$option_id . ' LIMIT 1';

//Execute the query and store the result
$imgUrl = $readConnection->fetchOne($query);
return $imgUrl;
}

And there you have it. I really hope that this helps anyone in a similar situation.

Best Answer

Related Solutions

Magento – Create a sortable and filterable custom attribute to stand-alone entity

Magento – Admin Custom Label / Option for dropdown attributes

Related Topic