Magento – Adding a custom field to Order admin screen

magento-1.7orders

I'm trying to add a custom field to the order admin screen, specifically a dropdown box with the information appended to the order.

I have created a custom module, which has the structure:

etc -> with config.xml

    <?xml version="1.0"?>
<config>
    <modules>
        <Custom_Module>
            <version>0.4.0</version>
        </Custom_Module>
    </modules>

    <global>
     <resources>
         <Custom_Module>
              <setup>
                  <module>Custom_Module</module>
                  <class>Mage_Sales_Model_Mysql4_Setup</class>
              </setup>
               <connection>
                <use>core_setup</use>
              </connection>
         </Custom_Module>
     </resources>
 </global>
</config>

sql -> Custom_Module_Setup/mysql4-install-0.4.0.php

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

$options = array(
    'value' = array(
        'test' => array('test'),
        'test2' => array('test2'),
        )
    );

$installer->addAttribute('order', 'test_option', array(
    'label' => 'Test Option',
    'default' => '',
    'type' => 'varchar',
    'input' => 'select',
    'visible' => true,
    'required' => false,
    'position' => 1,
    'visible_on_front'  => false,
    'option' => $options,
    'default' => array('web'),
));

$installer->endSetup();

I also have in modules

<?xml version="1.0"?>
<config>
    <modules>
        <Custom_Module>
            <active>true</active>
            <codePool>local</codePool>
            <depends></depends>
        </Custom_Module>
    </modules>
</config>

From what I can tell, the module is activated, and config file is read but the install file is not?
The attribute is not appearing as a column in sales_flat_order (I have been flushing the cache while testing each time)

So question 1 what am I doing wrong?
Question 2 once I have it appearing in the column, how can I then display/save it in the order edit screen?

Best Answer

You have an error in your config.xml, change:

<global>
 <resources>
     <Custom_Module>
          <setup>
              <module>Custom_Module</module>
              <class>Mage_Sales_Model_Mysql4_Setup</class>
          </setup>
           <connection>
            <use>core_setup</use>
          </connection>
     </Custom_Module>
 </resources>

To:

<resources>
        <custom_module_setup>
            <setup>
                <module>Custom_Module</module>
        <class>Mage_Sales_Model_Mysql4_Setup</class>
            </setup>
        </custom_module_setup>
    </resources>

And then create the upgrade script in the directory: sql/custom_module_setup/, since 1.6 you can name them install-0.4.0.php (without the mysql4- prefix). Also check the core_resource tabel for custom_module_setup to check what version is installed, remove the record if you want your setup script to run again.

Related Solutions

Magento – Adding a custom entity value in Order table

You can do this easily with an Observer.

Firstly, I would add this to your config.xml:

<config>
...
  <global>
  ...
    <events>
      <sales_order_save_before>
        <observers>
          <module_order_save_before>
            <type>singleton</type>
            <class>module/observer</class>
            <method>orderSaveBefore</method>
          </module_order_save_before>
        </observers>
      </sales_order_save_before>
    </events>
  ...
  </global>
...
</config>

If you are calculating the values of these 2 columns, you can do the following in your Observer.

Observer.php:

public function orderSaveBefore($obs) {
  $event = $obs->getEvent();
  $order = $event->getOrder();

  $order->setPercentorder(value);
  $order->setCommission(value);
  return $this;
}

If however, you're relying on input from a form that you can attach to with an event, you can do something similar to this:

Observer.php

public function orderSaveBefore($obs) {
  $event = $obs->getEvent();
  $order = $event->getOrder();
  $request = Mage::app()->getFrontController()->getRequest();
  $percentorder = $request->getParam('percentorder');
  $commission = $request->getParam('commission');

  $order->setPercentorder(value);
  $order->setCommission(value);
  return $this;
}

If you hook into the models save_before event, you can set the values for the columns before the order actually gets saved, reducing the cost of having to use save() again.

Magento – Adding order comments to invoices

The last post used the getVisibleStatusHistory method of the order object, but the first comment entered on an order is never visible. There are several methods for grabbing the status history and setting it in the order object.

That being said we might want to list all of the comments that are marked as visible on front-ed and the first comment entered when the order is created. I've substitued your formatting with a "p" tag.

<?php $_history = $order->getAllStatusHistory(); ?>
<?php $_buffer = array(); ?>
<?php $_i=1; ?>

<?php foreach ($_history as $_historyItem): ?>
<?php // Ignore the visibility for the first comment ?>
<?php if ( $_historyItem->getData('is_visible_on_front') == 1 || $_i == count($_history) ): ?>
    <?php $_buffer[] = $_historyItem->getData('comment'); ?>
<?php endif; ?>
<?php $_i++; ?>
<?php endforeach; ?>

<?php if ( count($_buffer) > 0 ): ?>
   <p><?php echo implode( $_buffer, '</p><p>' ); ?></p>
<?php endif ?>

Best Answer

Related Solutions

Magento – Adding a custom entity value in Order table

Magento – Adding order comments to invoices

Related Topic