Magento – How to include the checkout progress on the Paypal express review page

blockscheckoutlayoutonepage-checkoutpaypal-express

Okay I've broken this down into steps and you can see where I am stuck:

Step 1 – change column number

The PayPal express review page (our page that PayPal sends the buyer back to in order to review and finally submit their order) is a one column page. Of course we can change the number of columns by overriding the layout in a custom module xml file:

<paypal_express_review>
   <!-- maybe other references here -->
   <reference name="root">
      <action method="setTemplate"><template>page/2columns-right.phtml</template></action>
   </reference>
   <!-- maybe other references here -->
</paypal_express_review>

Step 2 – remove code restricting right-hand column content

Now the right hand column will be present but will be blank – this is because of the following line in app/design/frontend/base/default/layout/paypal.xml – which we remove:

<remove name="right"/>

Step 3 – add content in xml file

Clearing the cache and refreshing the page will show the default right-hand column content. So if from there we add the following lines (borrowed from app/design/frontend/base/default/layout/checkout.xml) into the custom module xml file we once again come up with a blank.

<reference name="right">
    <action method="unsetChildren"></action>
    <block type="page/html_wrapper" name="checkout.progress.wrapper" translate="label">
        <label>Checkout Progress Wrapper</label>
        <action method="setElementId"><value>checkout-progress-wrapper</value></action>
        <block type="checkout/onepage_progress" name="checkout.progress" before="-" template="checkout/onepage/progress.phtml"/>
    </block>
</reference>

I know that this is the right method to get the content in that column as I can do it with a custom template, e.g.

<reference name="right">
    <action method="unsetChildren"></action>
    <block type="page/html" name="custom" template="custom_module/custom.phtml" />
</reference>

Little unsure about the block type there. Also I am aware that there is the following block in app/design/frontend/base/default/layout/checkout.xml that isn't being used:

<block type="checkout/onepage_progress" name="root" output="toHtml" template="checkout/onepage/progress.phtml">
    <block type="checkout/onepage_payment_info" name="payment_info">
        <action method="setInfoTemplate"><method></method><template></template></action>
    </block>
</block>

As you can see my knowledge on this is pretty restricted – due more to a lack of documentation than desire (this site was interesting though).

I must stress that this is by no means unachievable so if anyone has suggestions or alas the sought after solution or any insight at all your post is worthy and most welcome. Many thanks

Best Answer

Yes it is possible.

This is what you will need to achieve it.

In your module.xml remove all references <remove name="right" /> from the paypal_express_review handle and update the template the same as you have done in step 1 and 2.

Next you can add the checkout.progress wrapper block into the right reference. This block can be found in app/design/frontend/base/default/layout/checkout.xml

<reference name="right">
            <action method="unsetChildren"></action>
            <block type="page/html_wrapper" name="checkout.progress.wrapper" translate="label">
                <label>Checkout Progress Wrapper</label>
                <action method="setElementId"><value>checkout-progress-wrapper</value></action>
                <block type="checkout/onepage_progress" name="checkout.progress" before="-" template="checkout/onepage/progress.phtml">
                    <block type="checkout/onepage_progress" name="billing.progress" template="checkout/onepage/progress/billing.phtml"></block>
                    <block type="checkout/onepage_progress" name="shipping.progress" template="checkout/onepage/progress/shipping.phtml"></block>
                    <block type="checkout/onepage_progress" name="shippingmethod.progress" template="checkout/onepage/progress/shipping_method.phtml"></block>
                    <block type="checkout/onepage_progress" name="payment.progress" template="checkout/onepage/progress/payment.phtml"></block>
                </block>
            </block>
        </reference>

Once you get to the paypal/express/review/ page you should see that there is a blank column? Why isn't you block showing up? If you inspect the page in the right column you should see opactity: 0;. Update your styles to be opacity:1; and the block should be there.

The only issue you may have is getting the change links to work as they are expecting the container to be there already. If not you could look at creating your own template for progress and removing the links. Hope this helps :D

Related Solutions

Magento – How to Add Page in Checkout

You are trying to define an invalid handler and block in checkout.xml.

You are using a handler that magento do not understand. i e.

<checkout_onepage_pay />

What you have done here is you are used an invalid handler instead of actual handler <checkout_onepage_failure />. Magento looks for this handler when onepage checkout fails. When magento enquires handler, its not present in your layout file. Hence it throws an error.

Also your block is also invalid (Most probly). i e

<block type="checkout/onepage_pay" name="checkout.pay" template="checkout/onepage/pay.phtml"/>

This block tells magento that, whenever a onepage checkout failure occurs (Assumes your handler is <checkout_onepage_failure />), you have to look for a block Mage_Checkout/Block/Onepage/Pay.php . Hence Magento fails to load this block type, since it is not defined. In default case the block that magento looking for will be Mage/Checkout/Block/Onepage/Failure.php and it DOES exist.

From your question, its difficult to understand what you are looking for. There may be two cases

You are trying to create a custom checkout onepage failure template

If that is the case you have to do this handler.

 <checkout_onepage_failure translate="label">
       <label>One Page Checkout Failure</label>
       <reference name="root">
            <action method="setTemplate"><template>page/2columns-right.phtml</template></action>
        </reference>
        <reference name="content">
            <block type="checkout/onepage_failure" name="checkout.failure" template="path/to/your/custom/template.php"/>
        </reference>
   </checkout_onepage_failure>

You just need to alter the template part of default block.

You may trying to set a payment method page

If that is the case, then you need to use this handler

<checkout_onepage_paymentmethod>
    <remove name="right"/>
    <remove name="left"/>

    <block type="checkout/onepage_payment_methods" name="root" output="toHtml" template="checkout/onepage/payment/methods.phtml">
        <action method="setMethodFormTemplate"><method>purchaseorder</method><template>payment/form/purchaseorder.phtml</template></action>
    </block>
</checkout_onepage_paymentmethod>

This code snippet is from app/design/frontend/base/default/layout/checkout.xml. Make changes to content of this handler.

Note: Whatever be the reason, it is not a good practice to change the the files that resides in the location app/design/frontend/base/default. Set a new package and theme and make changes to the directory app/design/frontend/<your_package>/<your_theme>/

Magento – Include .phtml File in One Page Checkout

try the following:

<layout version="0.1.0">
 <checkout_onepage_index translate="label">
  <reference name="checkout.onepage.billing">
   <block type="core/template" name="checkout.onepage.dealer" template="checkoutfields/search.phtml" as="checkout_dealer_search" />
  </reference>
 </checkout_onepage_index>
</layout>

and use echo $this->getChildHtml('checkout_dealer_search'); in the billing.phtml.

UPDATE:

if the checkoutfields.xml is not part of any module, you can create local.xml in the respected layout folder and move the code in it.

Best Answer

Related Solutions

Magento – How to Add Page in Checkout

Magento – Include .phtml File in One Page Checkout

Related Topic