Introduction
One of the real challenges in building any type of framework, core or application is making it possible for the developers to hook into the business logic at specific points. Since PHP is not event based, nor it works with interrupts you have to come up an alternative.
The test case
Lets assume we are the main developers of a webshop framework. Programmers can use our framework to build complete webshops. Programmers can manage the orders that are placed on the webshop with the order class. The order class is part of our framework and we don’t want it to be extended by any programmer. However we don’t want to limit to programmers in their possibilities to hook into the orders process.
For example programmers should be able to send an email to the webshopowner if an order changes from one specific delivery status to another. This functionality is not part of the default behavior in our framework and is custom for the progammers webshop implementation.
Like said before, PHP doesn’t provide interrupts or real events so we need to come up with another way to implement hooks into our application. Lets take a look at the observer pattern.
Implementing the Observer pattern
The observer pattern is a design-pattern that describes a way for objects to be notified to specific state-changes in objects of the application.
For the first implementation we can use SPL. The SPL provides in two simple objects:
SPLSubject
- attach (new observer to attach)
- detach (existing observer to detach)
- notify (notify all observers)
SPLObserver
- update (Called from the subject (i.e. when it’s value has changed).
iOrderRef = $iOrderRef;
// Get order information from the database or an other resources
$this->iStatus = Order::STATUS_SHIPPED;
}
/**
* Attach an observer
*
* @param SplObserver $oObserver
* @return void
*/
public function attach(SplObserver $oObserver)
{
$sHash = spl_object_hash($oObserver);
if (isset($this->aObservers[$sHash])) {
throw new Exception('Observer is already attached');
}
$this->aObservers[$sHash] = $oObserver;
}
/**
* Detach observer
*
* @param SplObserver $oObserver
* @return void
*/
public function detach(SplObserver $oObserver)
{
$sHash = spl_object_hash($oObserver);
if (!isset($this->aObservers[$sHash])) {
throw new Exception('Observer not attached');
}
unset($this->aObservers[$sHash]);
}
/**
* Notify the attached observers
*
* @param string $sEvent, name of the event
* @param mixed $mData, optional data that is not directly available for the observers
* @return void
*/
public function notify()
{
foreach ($this->aObservers as $oObserver) {
try {
$oObserver->update($this);
} catch(Exception $e) {
}
}
}
/**
* Add an order
*
* @param array $aOrder
* @return void
*/
public function delete()
{
$this->notify();
}
/**
* Return the order reference number
*
* @return int
*/
public function getRef()
{
return $this->iOrderRef;
}
/**
* Return the current order status
*
* @return int
*/
public function getStatus()
{
return $this->iStatus;
}
/**
* Update the order status
*/
public function updateStatus($iStatus)
{
$this->notify();
// ...
$this->iStatus = $iStatus;
// ...
$this->notify();
}
}
/**
* Order status handler, observer that sends an email to secretary
* if the status of an order changes from shipped to delivered, so the
* secratary can make a phone call to our customer to ask for his opinion about the service
*
* @package Shop
*/
class OrderStatusHandler implements SplObserver
{
/**
* Previous orderstatus
* @var int
*/
protected $iPreviousOrderStatus;
/**
* Current orderstatus
* @var int
*/
protected $iCurrentOrderStatus;
/**
* Update, called by the observable object order
*
* @param Observable_Interface $oSubject
* @param string $sEvent
* @param mixed $mData
* @return void
*/
public function update(SplSubject $oSubject)
{
if(!$oSubject instanceof Order) {
return;
}
if(is_null($this->iPreviousOrderStatus)) {
$this->iPreviousOrderStatus = $oSubject->getStatus();
} else {
$this->iCurrentOrderStatus = $oSubject->getStatus();
if($this->iPreviousOrderStatus === Order::STATUS_SHIPPED && $this->iCurrentOrderStatus === Order::STATUS_DELIVERED) {
$sSubject = sprintf('Order number %d is shipped', $oSubject->getRef());
//mail('secratary@example.com', 'Order number %d is shipped', 'Text');
echo 'Mail sended to the secratary to help her remember to call our customer for a survey.';
}
}
}
}
$oOrder = new Order(26012011);
$oOrder->attach(new OrderStatusHandler());
$oOrder->updateStatus(Order::STATUS_DELIVERED);
$oOrder->delete();
?>
There are several problems with the implementation above. To most important disadvantage is that we have only one update method in our observer. In this update method we don’t know when and why we are getting notified, just that something happened. We should keep track of everything that happens in the subject. (Or use debug_backtrace… just joking, don’t even think about using it that way ever!).
Taking it a step further, events
Lets take a look at the next example, we will extend the Observer implementation with some an additional parameter for the eventname that occured.
Finishing up, optional data
iOrderRef = $iOrderRef;
// Get order information from the database or something else...
$this->iStatus = Order::STATUS_SHIPPED;
}
/**
* Attach an observer
*
* @param Observer_Interface $oObserver
* @return void
*/
public function attachObserver(Observer_Interface $oObserver)
{
$sHash = spl_object_hash($oObserver);
if (isset($this->aObservers[$sHash])) {
throw new Exception('Observer is already attached');
}
$this->aObservers[$sHash] = $oObserver;
}
/**
* Detach observer
*
* @param Observer_Interface $oObserver
* @return void
*/
public function detachObserver(Observer_Interface $oObserver)
{
$sHash = spl_object_hash($oObserver);
if (!isset($this->aObservers[$sHash])) {
throw new Exception('Observer not attached');
}
unset($this->aObservers[$sHash]);
}
/**
* Notify the attached observers
*
* @param string $sEvent, name of the event
* @param mixed $mData, optional data that is not directly available for the observers
* @return void
*/
public function notifyObserver($sEvent, $mData=null)
{
foreach ($this->aObservers as $oObserver) {
try {
$oObserver->update($this, $sEvent, $mData);
} catch(Exception $e) {
}
}
}
/**
* Add an order
*
* @param array $aOrder
* @return void
*/
public function add($aOrder = array())
{
$this->notifyObserver('onAdd');
}
/**
* Return the order reference number
*
* @return int
*/
public function getRef()
{
return $this->iOrderRef;
}
/**
* Return the current order status
*
* @return int
*/
public function getStatus()
{
return $this->iStatus;
}
/**
* Update the order status
*/
public function updateStatus($iStatus)
{
$this->notifyObserver('onBeforeUpdateStatus');
// ...
$this->iStatus = $iStatus;
// ...
$this->notifyObserver('onAfterUpdateStatus');
}
}
/**
* Order status handler, observer that sends an email to secretary
* if the status of an order changes from shipped to delivered, so the
* secratary can make a phone call to our customer to ask for his opinion about the service
*
* @package Shop
*/
class OrderStatusHandler implements Observer_Interface
{
protected $iPreviousOrderStatus;
protected $iCurrentOrderStatus;
/**
* Update, called by the observable object order
*
* @param Observable_Interface $oObservable
* @param string $sEvent
* @param mixed $mData
* @return void
*/
public function update(Observable_Interface $oObservable, $sEvent, $mData=null)
{
if(!$oObservable instanceof Order) {
return;
}
switch($sEvent) {
case 'onBeforeUpdateStatus':
$this->iPreviousOrderStatus = $oObservable->getStatus();
return;
case 'onAfterUpdateStatus':
$this->iCurrentOrderStatus = $oObservable->getStatus();
if($this->iPreviousOrderStatus === Order::STATUS_SHIPPED && $this->iCurrentOrderStatus === Order::STATUS_DELIVERED) {
$sSubject = sprintf('Order number %d is shipped', $oObservable->getRef());
//mail('secratary@example.com', 'Order number %d is shipped', 'Text');
echo 'Mail sended to the secratary to help her remember to call our customer for a survey.';
}
}
}
}
$oOrder = new Order(26012011);
$oOrder->attachObserver(new OrderStatusHandler());
$oOrder->updateStatus(Order::STATUS_DELIVERED);
$oOrder->add();
?>
Now we are able to take action on different events that occur.
Disadvantages
Although this implementation works quite well there are some drawbacks. One of those drawbacks is that we need to dispatch an event in our framework, if we don’t programmers can’t hook into our application. Triggering events everywhere give us a small performance penalty however I do think this way of working gives the programmers a nice way to hook into your application on those spots that you want them to hook in.
Just for the record
Notice that this code is just an example and can still use some improvements, for example: each observer is initialized even it will maybe never be notified, therefore I suggest to make use of lazy in some cases for loading the objects. There are other systems to hook into an application, more to follow!
машина под залог
zaimpod-pts91.ru/kemerovo.html
займ под залог птс
История дня [url=https://allizmalkovo.ru]https://allizmalkovo.ru[/url] .
скачать мостбет на телефон https://mostbet11015.ru
Wow, amazing blog structure! How long have you ever been running a blog
for? you make blogging glance easy. The total look of your website is magnificent, let alone the content material!
Гороскоп congress-st.ru .
Какой сегодня праздник http://www.congress-st.ru .
скачать игры с облака mail Наслаждайтесь удобством и безопасностью современных способов загрузки игр. Выбирайте прямые ссылки, облачные хранилища и забудьте о проблемах с торрентами, наслаждаясь мгновенным доступом к миру гейминга.
I go to see each day some web pages and websites to read content, except this webpage presents quality based articles.
Hi there, I discovered your web site by the use of Google while
looking for a similar topic, your web site got here up, it appears to be like great.
I’ve bookmarked it in my google bookmarks.
Hi there, simply become aware of your blog through Google, and found that it’s
really informative. I am gonna watch out for brussels.
I’ll appreciate in the event you continue this in future.
A lot of folks might be benefited out of your writing.
Cheers!
Запреты дня [url=https://congress-st.ru]https://congress-st.ru[/url] .
https://dettka.com/piony-s-dostavkoj-po-moskve-krasota-i-udobstvo-v-vashem-dome/ Букет пионов с доставкой в Москве: Идеальный подарок для особых случаев. Букет пионов – это не просто цветы, это символ любви, нежности и восхищения. Мы создаем уникальные композиции, сочетая различные сорта и оттенки пионов, чтобы каждый букет был настоящим произведением искусства. Наши флористы – настоящие профессионалы своего дела, которые с любовью и вниманием подходят к каждому заказу. Доставка букета пионов в Москве – это идеальный способ выразить свои чувства и подарить незабываемые эмоции близкому человеку. Мы гарантируем, что ваш подарок будет оценен по достоинству и оставит самые теплые воспоминания.
мелбет кыргызстан http://mostbet11014.ru
I’m not that much of a internet reader to be honest but your sites really nice, keep it up!
I’ll go ahead and bookmark your site to come
back later on. All the best
I have read several good stuff here. Definitely worth bookmarking for revisiting.
I surprise how a lot attempt you put to make such a fantastic informative web site.
наркологическая клиника телефон анонимная наркологическая клиника
лучший пансионат для пожилых https://pansionat-dlya-pozhilyh1.ru
Wow, superb weblog format! How lengthy have you ever been blogging for?
you made blogging glance easy. The entire glance of your website is fantastic, as well as the content!
Мы изготавливаем дипломы любой профессии по приятным ценам. Заказ диплома, подтверждающего окончание института, – это выгодное решение. Купить диплом университета: nec.phorum.pl/posting.php?mode=newtopic&f=27&sid=ecd0ccf9ba00a1656680ad2915c9d0a0
It’s perfect time to make some plans for the future and it is
time to be happy. I have read this post and if I could I wish to suggest you some interesting things or tips.
Maybe you could write next articles referring to this article.
I desire to read even more things about it!
1win android 1win android
Мы готовы предложить дипломы любых профессий по приятным ценам. Заказ диплома, который подтверждает окончание ВУЗа, – это разумное решение. Заказать диплом ВУЗа: yaharaho.com/profile/sheritarodway2
скачать игры с облака mail Скачать игры по прямой ссылке: Прямой путь к развлечениям без преград. Прямые ссылки – это ваш персональный скоростной коридор в мир гейминга. Никаких дополнительных программ, никаких сложных процедур. Только вы, игра и молниеносная загрузка, позволяющая максимально быстро погрузиться в игровой процесс.
наркологическая клиника сайт анонимная наркологическая клиника
как использовать бонусы 1win казино как использовать бонусы 1win казино
мостбет вход, регистрация mostbet11014.ru
взять займ под залог авто
zaimpod-pts91.ru
займ под залог птс авто
Hi there! This post could not be written any better! Reading through this post reminds me of my old room mate!
He always kept chatting about this. I will forward this article to him.
Fairly certain he will have a good read. Thanks for sharing!
I am sure this post has touched all the internet visitors, its really really fastidious article on building up new web site.
Hey there, I think your blog might be having browser compatibility issues.
When I look at your blog in Ie, it looks fine but when opening in Internet Explorer, it has some overlapping.
I just wanted to give you a quick heads up!
Other then that, great blog!
Мы изготавливаем дипломы психологов, юристов, экономистов и прочих профессий по приятным тарифам. Заказ диплома, подтверждающего обучение в университете, – это грамотное решение. Приобрести диплом о высшем образовании: [url=http://mosmol.flybb.ru/viewtopic.php?f=2&t=993/]mosmol.flybb.ru/viewtopic.php?f=2&t=993[/url]
Thank you for the auspicious writeup. It if truth be told was once a entertainment account it.
Glance complicated to far delivered agreeable from you!
However, how can we keep up a correspondence?
займ под птс автомобиля москва
zaimpod-pts90.ru
займ под птс без автомобиля
дом пансионат для пожилых пансионат для пожилых людей
1win codigo promocional http://www.1win3002.com
Wow, this piece of writing is nice, my sister is analyzing these things, so Iam going to let know her.
скачать бесплатно мостбет mostbet11008.ru
Hi there this is kinda of off topic but I
was wondering if blogs use WYSIWYG editors or if you have to manually code with HTML.
I’m starting a blog soon but have no coding knowledge so I wanted to get guidance from someone with experience.
Any help would be enormously appreciated!
E2Bet
Blog Comment: If you’re a cricket fan in Pakistan, E2Bet is the platform for you.
They cover all major tournaments with detailed betting options.
My go-to website for cricket betting!
центр наркологии частная наркологическая клиника
I am regular reader, how are you everybody?
This post posted at this web page is truly fastidious.
I love what you guys tend to be up too. This kind of clever work and reporting!
Keep up the very good works guys I’ve included you guys to my blogroll.
Hi, i think that i saw you visited my blog so i got here to return the
desire?.I am attempting to find things to enhance my site!I suppose its good
enough to make use of some of your ideas!!
диплом в оренбурге купить диплом в оренбурге купить .
сеть пансионатов для пожилых пансионат для пожилых
скачать мостбет казино http://www.mostbet11015.ru
купить диплом в краснодаре http://www.arus-diplom3.ru/ .
мостбет скачать приложение на андроид бесплатно https://mostbet11001.ru
мостбет уз скачать http://mostbet11008.ru/
In fact when someone doesn’t be aware of afterward its up to
other visitors that they will assist, so here it occurs.
диплом купить в челябинске [url=https://arus-diplom3.ru/]диплом купить в челябинске[/url] .