Magento – How to add a custom block to admin sales order shipment

blocksmoduleoverrides

i've been trying to include a block in the sales_order_shipment form.

I already got the block to appear at the bottom of the page, but everytime i press the ship button the information related to my block isn't sent (because it's not part of the original form).

This is what I've done so far:

In my module config.xml i added:

<global>
....
<blocks>
        <modulename>
            <class>Companyname_Modulename_Block</class>
        </modulename>
</blocks>
.....
</global>
<adminhtml>
    <layout>
        <updates>
            <Companyname_Modulename>
                <file>modulename.xml</file>
            </Companyname_Modulename>
        </updates>
    </layout>
</adminhtml>

Added modulename.xml to layout in (app/design/adminhtml/default/defaul/layout):

<layout>
<adminhtml_sales_order_shipment_new>
    <reference name="content">
            <block type="modulename/sales_order_shipment_create_atinfo" name="atinfo" template="modulename/sales/order/shipment/create/atinfo.phtml"></block>
    </reference>
</adminhtml_sales_order_shipment_new>

Added my template, named atinfo.phtml to (app/design/adminhtml/default/default/template/modulename/sales/order/shipment/create) with some simple html.

The problem seems to be that, by adding my block this way, it doesn't go into:

<form id="edit_form" method="post" action="<?php echo $this->getSaveUrl() ?>">

That is defined in form.phtml.

Is it possible, on my modulename.xml, to insert the block (name=atinfo) inside the block (name=form) that is defined on sales.xml (located at /app/design/adminhtml/default/default/layout)?

Right now, if we insert the block (name=form) inside modulename.xml, it gets duplicated on the order new shipment page.

Any help would be appreciated, as i said before, my block appears in the page, but when i press the Ship button, my block information isn't sent.

Best Answer

I recommend that you take the form.phtml, copy it, then customize it inside your module.

Put customForm.phtml in design/adminhtml/default/default/template/modulename/. Next, you will need to enter the new customForm.phtml into your xml layout file. Copy over the Mage/core/adminhtml/etc/config.xml entry for

<adminhtml_sales_order_shipment_new>

Copy that whole node. You're going to need all the block entries to do a succesful override. Then, change the specific form call to your custom form. The ... in the code below denotes all the other xml you will have copied over.

<layout>
    <adminhtml_sales_order_shipment_new>
        ...
        <reference name="content">
            ...
            <block type="adminhtml/sales_order_shipment_create_form" template="modulename/customForm.phtml">    
            </block>
            ...
        </reference>
    </adminhtml_sales_order_shipment_new>
</layout>

This way, you can customize the form to your hearts content, and the post action will include your variables.

Notice that I did not change the type. You do not need to change this specific block to do what you're doing. If you look at Mage_Adminhtml_Sales_Order_Shipment_Create_Form, you'll see all it does is execute layout calls, assign urls, child html, etc. You can probably leave it alone.

Related Solutions

Magento Admin – Append Block to Admin Login Form

So the answer is that it should not be an observed event. Here is how I got it to work, in the config.xml I needed to update the adminhtml node.

<?xml version="1.0" encoding="utf-8"?>
<config>
  <modules>
    <Wsu_NewtworkSecurities>
      <version>0.1.0</version>
    </Wsu_NewtworkSecurities>
  </modules>
  <adminhtml>
    <layout>
      <updates>
        <wsu_newtworksecurities>
          <file>newtworksecurities.xml</file>
        </wsu_newtworksecurities>
      </updates>
    </layout>
  </adminhtml>
</config>

and in

app\design\adminhtml\default\default\layout\wsu\newtworksecurities.xml

<?xml version="1.0"?>
<layout version="0.1.0">
    <feildset>
        <reference name="head">
            <action method="addJs">
                <script>wsu/newtworksecurities/newtworksecurities.js</script>
            </action>
        </reference>
    </feildset>

    <adminhtml_index_login>
        <update handle="feildset" />
        <reference name="form.additional.info">
            <block type="wsu_newtworksecurities/feildset" name="newtworksecurities.feildset"
                   template="wsu/newtworksecurities/feildset.phtml" />
        </reference>
    </adminhtml_index_login>

    <wsu_newtworksecurities_error_index>
        <reference name="content">
            <block type="core/template" name="newtworksecurities.error" template="wsu/newtworksecurities/error.phtml"/>
        </reference>
    </wsu_newtworksecurities_error_index>

</layout>

Magento 1.8 Custom Block Module – How to Create

I find the whole XML thing difficult so I am sympathetic to your cause here.

It looks to me like there is a discrepancy with your class name and your block XML

class Crusader_CLHomePage_Block_Qwerty extends Mage_Core_Block_Template

and

    <block type="core/template" name="homepage" template="crusader/home.phtml">
        <block type="crusaderhome/qwerty" name="homeads" as="homeads" template="crusader/homeads.phtml" />
    </block>

Let's start with the block type and work backward. I think here I would expect to see something like

<block type="crusader_home/qwerty" ...

and that type would refer Magento to the class

Crusader_Home_Block_Qwerty extends Mage_Core_Block_Template

Continuing to work backward on this tack, the file app\code\local\Crusader\CLHomePage\etc\config.xml would need to be modified to something like

<global>
    <blocks>
        <crusader_home>
            <class>Crusader_Home_Block</class>
        </crusader_home>
    </blocks>
</global>

It points Magento to all classes starting 'Crusader_Home_Block_*'. And now I think you need to rename your module Crusader_Home instead of Crusader_CLHomePage and change the folder names accordingly...

AND / BUT I strongly recommend you change your module name. Only ever use one capital letter at the start of the module name not three and don't put capital letters in the middle of the name either.

You may want to look into some of the tools available for generating modules. I find them very useful for avoiding typing errors. I use this one by the very clever people at MGT Commerce (it has simplicity on its side) and this one is all-encompassing and an astonishing piece of coding by Silk Software.

***EDIT following comments below

Additionally based on the error log I think the problem is that Magento can't find your class file. So double-check the caches are refreshed or off, particularly XML cache, and that the compiler is off or re-enabled.

Best Answer

Related Solutions

Magento Admin – Append Block to Admin Login Form

Magento 1.8 Custom Block Module – How to Create

Related Topic