Using Observer/Notifier System in order class

[yesaul]

Hello,

I'd like to change information, which is being prepared for sending by E-mail while placing the order.

(In another words: I'd like to replace $email_order string and $html_msg array, which are being built in send_order_email method of order class)

It seem's I should use one notifiers, provided in send_order_email method (v 1.5.5a), for example:

$this->notify('NOTIFY_ORDER_EMAIL_BEFORE_PRODUCTS', array(), $email_order, $html_msg); 

(line ~1018 in includes/classes/order.php file)

I know, how to build additional observer class, but I cannot understand, how to transfer back the updated $email_order and $html_msg from this observer back to send_order_email method (as $email_order and $html_msg aren't declared as global in send_order_email method)

Could somebody please give me any advise?

I have a strong feeling, I can not comprehend something and the solution should be very simply, otherwise I don't understand, for which purpose the mentioned notifer could be used.

Many thanks in advance.


BR, AR

[lat9]

An observer-class solution is the way to go.

You'll use the basic observer elements:

class my_class extends base
{
    public __construct ()
    {
        $this->attach ('NOTIFY_ORDER_EMAIL_BEFORE_PRODUCTS');
    }

    public update (&$class, $event, $roParm1, &$rwParm2, &$rwParm3, &$rwParm4)  // Up to &$rwParm9, depending on the notifier
    {
         <insert your processing here>
    }
}

For the notifier you're interested in, when your update function receives control:
$class ....... contains a reference to the $order object, so you've got full R/W access to the order's elements
$event ...... contains 'NOTIFY_ORDER_EMAIL_BEFORE_PRODUCTS', in case your observer handles multiple events
$roParm1 ... contains an empty array
$rwParm2 ... contains a reference to the order-class' $email_order variable
$rwParm3 ... contains a reference to the order-class' $html_msg variable

That said, upon receipt of that "notification" you have r/w access to the entire $order object (some information might not be all there, depending on the point at which the notification was raised) and to $rwParm2 and $rwParm3 (up to $rwParm9). Making a change to $rwParm2 results in a change to $email_order, for example.

[yesaul]

Hello,

Many thanks for your reply!

I was exactly writing an additional message displaying the observer's code, which I've used for tests, when I got your reply.

It seems, my code is very similar to yours:

<?php // class.ordersTokenHandling.php

class ordersTokenHandling extends base {

  public function __construct() {
    $this->attach($this, array('NOTIFY_ORDER_EMAIL_BEFORE_PRODUCTS'));
  }

  public function update(&$class, $eventID, $paramsArray = array(), $param1, $param2 = array())
  {
	  // echo "Old msg:" . $param2['ORDER_COMMENTS'] . "<br />";
	  
      $param2['ORDER_COMMENTS'] = 'Modified in observer'; 	
	
  }
}
// EOF

...But $html_msg['ORDER_COMMENTS'] is remains unchanged in send_order_email method... Where is my mistake?

I'd be very thankful for your advice.

BR, AR

PS I checked - my observer class is being called from mentioned method
PPS I have implemented my test on 'straight-from-the-box' Zen_cart v.1.5.5a...

[lat9]

You're missing the "reference" designation on your observer's update function (and you really don't want those default values, either):

<?php // class.ordersTokenHandling.php

class ordersTokenHandling extends base {

  public function __construct() {
    $this->attach($this, array('NOTIFY_ORDER_EMAIL_BEFORE_PRODUCTS'));
  }

  public function update(&$class, $eventID, $paramsArray, &$param1, &$param2)
  {
	  // echo "Old msg:" . $param2['ORDER_COMMENTS'] . "<br />";
	  
      $param2['ORDER_COMMENTS'] = 'Modified in observer'; 	
	
  }
}
// EOF

[yesaul]

Hello,

Many thanks for your advice! Everything is running smooth now!

(Anyway there was one thing I correctly assumedy: the solution is really simply :-) )

Thank you again and best regards,

AR

[lat9]

Woo-hoo! I'm happy to have helped.