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!
Appreciate the recommendation. Let me try it
out.
Yesterday, while I was at work, my cousin stole my apple ipad
and tested to see if it can survive a 30 foot drop,
just so she can be a youtube sensation. My iPad is now destroyed and she has 83 views.
I know this is entirely off topic but I had to share it with someone!
It’s great that you are getting ideas from this paragraph as well as from
our argument made here.
Мы можем предложить дипломы любой профессии по невысоким тарифам. Мы можем предложить документы ВУЗов, которые расположены в любом регионе РФ. Дипломы и аттестаты печатаются на “правильной” бумаге высшего качества. Это позволяет делать настоящие дипломы, которые не отличить от оригинала. orikdok-5v-gorode-perm-59.online
mostbey http://mostbet11023.ru/
заказать металлические значки значки металлические купить
Заказать вок
доставка суши в челябинске
доставка роллов в челябинске
Spot on with this write-up, I absolutely think this web site needs much more attention. I’ll probably be returning to read more, thanks for the information!
Мы можем предложить дипломы психологов, юристов, экономистов и других профессий по выгодным тарифам. Мы готовы предложить документы техникумов, расположенных в любом регионе Российской Федерации. Дипломы и аттестаты выпускаются на бумаге самого высшего качества. Это дает возможности делать государственные дипломы, не отличимые от оригинала. orikdok-v-gorode-groznyy-20.ru
доставка роллов
mostbet kg отзывы https://mostbet11023.ru
Суши на дом Челябинск
I know this web site gives quality depending articles or reviews and extra data, is there any other website which presents these stuff
in quality?
устранение запаха в посудомойке алматы Адрес сервиса холодильников Алматы: Адрес сервисного центра.
Мы готовы предложить дипломы любой профессии по доступным ценам. Мы предлагаем документы техникумов, которые расположены на территории всей России. Дипломы и аттестаты делаются на “правильной” бумаге высшего качества. Это позволяет делать государственные дипломы, не отличимые от оригиналов. [url=http://orikdok-3v-gorode-tula-71.online/]orikdok-3v-gorode-tula-71.online[/url]
Wow, wonderful weblog format! How long have you been running a blog for?
you made blogging glance easy. The total look of your site
is fantastic, as smartly as the content!
Everyone loves what you guys are usually up too.
This type of clever work and exposure! Keep up the superb works
guys I’ve incorporated you guys to our blogroll.
mostbet бетгеймс http://mostbet11030.ru
металлические пины значки металлические значки москва
artemzhvakin телег Дети ветра кайт школа Хургада: обучение в комфортных условиях Кайт школа “Дети ветра” в Хургаде предлагает обучение кайтсерфингу в комфортных условиях с опытными инструкторами.
Whether you prefer cryptocurrency for complete anonymity or traditional payment methods with minimal verification, our country-specific guides will point you in the right direction.
Reliable online casinos without identity confirmation 2025
Yo forum friends, I’m Marko from Serbia. I wanna tell you about my insane experience with this
new online casino I stumbled on a few weeks ago.
To be honest, I was barely affording rent, and now I can’t believe it myself —
I crushed it and made $712,000 playing mostly crazy time!
Now I’m thinking of getting a new car here in Belgrade, and investing a serious chunk of my winnings
into Cardano.
Later I’ll probably move to a better neighborhood and support my family.
Now I’m going by Tomasz from Poland because I honestly feel like a new person. My life is flipping upside
down in the best way.
No cap, what would you guys do if you had this kinda luck?
Are you feeling curious right now?
For real, I never thought I’d be living this dream. It’s all happening so fast!
Ask me anything!
Мы предлагаем оформление дипломов ВУЗов в Москве — с печатями, подписями, приложением и возможностью архивной записи (по запросу).
Документ максимально приближен к оригиналу и проходит визуальную проверку.
Мы даем гарантию, что в случае проверки документа, подозрений не возникнет.
– Конфиденциально
– Доставка 3–7 дней
– Любая специальность
Уже более 1493 клиентов воспользовались услугой — теперь ваша очередь.
Открыть — ответим быстро, без лишних формальностей.
скачать мостбет на телефон [url=www.mostbet11022.ru]www.mostbet11022.ru[/url]
Select your region below to find Bitcoin Casinos No Verification and Crypto Casinos No KYC available in your area. Get straight to the games without jumping through identity verification hoops.
Casino with instant withdrawal without verification
Wonderful blog! I found it while searching on Yahoo News.
Do you have any suggestions on how to get listed in Yahoo
News? I’ve been trying for a while but I never seem to get there!
Appreciate it
Оформиление дипломов ВУЗов в Москве — с печатями, подписями, приложением и возможностью архивной записи (по запросу).
Документ максимально приближен к оригиналу и проходит визуальную проверку.
Мы даем гарантию, что в случае проверки документа, подозрений не возникнет.
– Конфиденциально
– Доставка 3–7 дней
– Любая специальность
Уже более 4475 клиентов воспользовались услугой — теперь ваша очередь.
Узнать подробнее — ответим быстро, без лишних формальностей.
Greetings, I’m Alex from Romania. I wanna tell you about my
insane experience with this crazy popular online casino I stumbled on last month.
To be honest, I was totally broke, and now I can’t believe it myself
— I won $712,000 playing mostly crazy time!
Now I’m thinking of getting a new car here in Belgrade, and investing a serious chunk of
my winnings into Toncoin.
Later I’ll probably move to a better neighborhood and travel the world.
Now I’m going by Luka from Croatia because I honestly
feel like a new person. My life is flipping upside down in the best way.
Be real, what would you guys do if you had this kinda luck?
Are you feeling curious right now?
For real, I never thought I’d see this kinda money.
It’s all happening so fast!
Drop your thoughts below!
Мы предлагаем оформление дипломов ВУЗов в Москве — с печатями, подписями, приложением и возможностью архивной записи (по запросу).
Документ максимально приближен к оригиналу и проходит визуальную проверку.
Мы гарантируем, что в случае проверки документа, подозрений не возникнет.
– Конфиденциально
– Доставка 3–7 дней
– Любая специальность
Уже более 2266 клиентов воспользовались услугой — теперь ваша очередь.
[url=http://inforepetitor10.ru/]Купить диплом нового образца[/url] — ответим быстро, без лишних формальностей.
металлические значки на заказ изготовление металлических значков
I visit everyday some web sites and information sites to read articles or reviews, but this webpage offers feature based writing.
Yo forum friends, I’m Piotr from Poland. I wanna tell you about
my insane experience with this trending online casino I stumbled on last month.
To be honest, I was living paycheck to paycheck, and now I can’t believe it myself
— I won €384,000 playing mostly blackjack!
Now I’m thinking of finally owning an apartment here in Split, and investing a
serious chunk of my winnings into Bitcoin.
Later I’ll probably move to a better neighborhood and build my own startup.
Now I’m going by Luka from Croatia because I honestly feel like a new person. My life
is flipping upside down in the best way.
I gotta ask, what would you guys do if you had this kinda luck?
Are you feeling curious right now?
For real, I never thought I’d be living this dream.
It’s all happening so fast!
Drop your thoughts below!
Hi there, I wish for to subscribe for this blog to get newest updates,
therefore where can i do it please assist.
мостбет официальное приложение http://mostbet11029.ru/
кредит под птс машины
zaimpod-pts92.ru
займ под залог авто москва
monsbet monsbet
you are in point of fact a good webmaster.
The web site loading speed is incredible. It kind of feels that
you are doing any unique trick. Furthermore, The contents are masterpiece.
you’ve done a wonderful process in this subject!
Бездепозитные бонусы Бездепозитный бонус – это не просто бесплатные деньги, а ценный инструмент для обучения и тестирования. Это возможность примерить на себя роль профессионального игрока, изучить тонкости различных игр и понять, какие из них приносят наибольшее удовольствие и прибыль. Это шанс стать более уверенным и опытным игроком, готовым к игре на реальные деньги. Это инвестиция в себя и свои навыки, которая может окупиться многократно. Бездепозитный бонус в казино
mostbet букмекерская контора сайт http://mostbet11029.ru/
What’s Taking place i’m new to this, I stumbled upon this I’ve found It absolutely helpful
and it has aided me out loads. I’m hoping to give a contribution & assist different customers like its
aided me. Good job.
производство металлических значков металлические значки на заказ
Highly descriptive article, I liked that a lot.
Will there be a part 2?
I know this web page presents quality depending articles and extra data, is
there any other website which provides such stuff in quality?
Amazing issues here. I am very glad to look your post.
Thanks a lot and I am having a look ahead to touch you.
Will you kindly drop me a mail?
mostbet скачать на телефон http://www.mostbet11022.ru
производство металлических значков производство металлических значков
Выгодно приобрести диплом о высшем образовании!
Мы изготавливаем дипломы психологов, юристов, экономистов и прочих профессий по выгодным ценам— ekbpages.ru
Pretty section of content. I just stumbled upon your blog and in accession capital to
assert that I acquire actually enjoyed account your
blog posts. Anyway I will be subscribing to your feeds and even I achievement you access
consistently quickly.