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!
My brother suggested I may like this website.
He was entirely right. This publish actually made my day.
You can not imagine just how so much time I had spent for this information! Thank you!
1 win букмекерская контора 1 win букмекерская контора
1вин промокод 1вин промокод
Как забронировать и забронировать отель на Букинге из России, все способы оплаты отелей на Букинге для россиян, доступные в 2025 году смотрите в этом материале
For newest information you have to pay a quick visit web and on web I found
this site as a best website for most up-to-date updates.
Your style is so unique compared to other people I’ve read stuff
from. Many thanks for posting when you’ve got the opportunity,
Guess I will just bookmark this page.
What’s up to every one, because I am really keen of
reading this webpage’s post to be updated regularly.
It contains nice data.
aviator игра на деньги скачать http://www.1win1109.ru
https://2-bs2best.art/blaksprut_ssylka.html
вавада казино официальный сайт рабочее зеркало на сегодня Vavada Casino славится своей щедрой бонусной политикой. От приветственных бонусов для новичков до регулярных акций и промокодов для постоянных игроков – каждый пользователь найдет для себя выгодное предложение, увеличивающее шансы на выигрыш. Vavada Casino Скачать Бесплатно на Телефон
pokies.net http://pokies106.com .
Hi there, the whole thing is going nicely here and ofcourse every one is sharing facts,
that’s actually fine, keep up writing.
Heya i’m for the primary time here. I came across this board and I in finding It
really helpful & it helped me out much. I am hoping to offer one thing again and aid
others like you aided me.
бк 1win официальный [url=http://1win1114.ru/]бк 1win официальный[/url]
1 win вход 1 win вход
Как забронировать и отели на Букинг с бесплатной отменой из России, все способы оплаты отелей на Букинге для россиян, доступные в 2025 году смотрите в этом материале
The other day, while I was at work, my sister stole my iphone and tested to
see if it can survive a 40 foot drop, just so she can be a youtube sensation. My iPad is now broken and she has 83 views.
I know this is entirely off topic but I had to share it with someone!
Мы изготавливаем дипломы любой профессии по приятным тарифам. Купить академическую справку недорого — kyc-diplom.com/akadem-spravka.html
как вывести бонусы с 1win http://www.1win1113.ru
букмекерская контора 1win [url=www.1win1112.ru]www.1win1112.ru[/url]
1win как заработать https://www.1win1114.ru
1win ставки на спорт официальный сайт [url=https://1win1111.ru/]https://1win1111.ru/[/url]
Hello! This is kind of off topic but I need some help from an established blog.
Is it tough to set up your own blog? I’m not very techincal but I can figure things out pretty fast.
I’m thinking about setting up my own but I’m not sure where to begin. Do you have any ideas or suggestions?
Many thanks
I got this site from my pal who shared with me regarding this web site and now this time I am browsing this web page and reading very informative posts at this time.
https://510.com.ua/chomu-suchasni-avto-obirayut-linzy-zamist-zvychaynyh-far
проститутки донецк Секс ДНР – этот запрос указывает на то, что тема секса актуальна и в этом регионе. Важно, чтобы люди имели доступ к информации о безопасном сексе и контрацепции.
Hello, always i used to check weblog posts here early in the
dawn, for the reason that i love to gain knowledge of more and more.
I do trust all of the ideas you’ve presented to your
post. They are very convincing and will certainly work.
Nonetheless, the posts are very quick for novices.
May just you please extend them a little from next time?
Thanks for the post.
Получить диплом университета мы поможем. Купить диплом архитектора – перемены к лучшему – diplomybox.com/diplom-arkhitektora
mostbet apk download mostbet apk download .
скачать мостбет казино на андроид http://www.mostbet-download-app-apk.com .
mostbet app [url=http://mostbet-download-app-apk.com]mostbet app[/url] .
Hello There. I found your blog using msn. This is a really well written article.
I will make sure to bookmark it and return to read
more of your useful info. Thanks for the post. I will definitely return.
We stumbled over here different website and thought I should check things out.
I like what I see so now i’m following you.
Look forward to going over your web page again.
Кто в теме мототехники — может быть полезно: нашёл компанию HOTOMOTOS, у них неплохой выбор квадроциклов, питбайков и снегоходов, есть и техника, и запчасти. Вот информация по ним: https://russia24.pro/spb/404432299/
https://2bs-2best.at/blacksprut_bs2best.html
1000 рублей за регистрацию вывод сразу без вложений в казино с выводом без депозита Казино “Адмирал” заманивает новичков щедрым предложением: 1000 рублей за регистрацию с моментальным выводом, не требующим каких-либо вложений. Это словно безвозмездный подарок, позволяющий сразу же окунуться в атмосферу азарта и, возможно, сорвать куш. 1000 рублей за регистрацию вывод сразу без вложений в казино
Can I just say what a relief to find someone that truly understands what they are discussing online. You definitely understand how to bring a problem to light and make it important. A lot more people ought to look at this and understand this side of your story. I can’t believe you aren’t more popular because you most certainly possess the gift.
http://bagstore.com.ua/bezpechne-znyattya-skla-bez-poshkodzhen.html
секс Донецк Знакомства Донецк: Поиск любви и дружбы Помимо секса, в Донецке люди ищут любви, дружбы и долгосрочных отношений. Сайты знакомств и социальные сети помогают им найти единомышленников и построить прочные связи.
aviator 1win aviator 1win
1win xyz почта вход http://www.1win1109.ru
промокоды 1вин промокоды 1вин
1win deposit https://1win11005.com/
kaszino jatekok
Appreciate this post. Let me try it out.
Amazing, I could not resist commenting. Expertly written — quantum ai is underrated for sure!
ai quantum
секс знакомства макеевка Секс знакомства Горловка: Любовь во время войны В Горловке, где жизнь подвержена постоянной опасности, люди ищут утешение и близость друг в друге. Онлайн-знакомства помогают им найти партнеров для интимных встреч.
I am really loving the theme/design of your site. Do you ever run into any
internet browser compatibility issues? A couple of my blog visitors have complained about my site not
working correctly in Explorer but looks great in Chrome.
Do you have any suggestions to help fix this problem?
It is appropriate time to make some plans for the future and it’s
time to be happy. I have read this post and if I could I desire to suggest you few interesting things or
suggestions. Perhaps you can write next articles referring to this article.
I wish to read more things about it!
Бездепозитный бонус Перед тем, как воспользоваться бездепозитным бонусом, стоит внимательно изучить условия его получения и отыгрыша. Важно понимать, какие игры доступны для игры на бонусные средства, какой вейджер необходимо выполнить, чтобы вывести выигрыш, и какие сроки установлены для отыгрыша бонуса. Тщательное изучение правил поможет избежать разочарований и получить максимальную выгоду от использования бонуса.
Hello there, just became aware of your blog through Google, and found that it’s truly informative.
I am going to watch out for brussels. I will be grateful
if you continue this in future. Lots of people will be benefited from
your writing. Cheers!