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!
Календарь огородника https://istoriamashin.ru/ .
Лунные день сегодня istoriamashin.ru .
скачать официальный сайт мостбет mostbet11025.ru
Магнитные бури istoriamashin.ru .
мостбет оригинал скачать mostbet11026.ru
Hey There. I discovered your weblog the usage of msn. That is a really well written article.
I’ll be sure to bookmark it and come back to learn more of your useful info.
Thanks for the post. I’ll certainly return.
Very good blog! Do you have any tips for aspiring writers?
I’m hoping to start my own website soon but I’m a little lost
on everything. Would you recommend starting with a free platform like WordPress or
go for a paid option? There are so many choices out there that
I’m completely overwhelmed .. Any ideas? Thank you!
мостбет мобильная версия скачать мостбет мобильная версия скачать
букмекеры кыргызстана https://mostbet11024.ru
Hi there I am so glad I found your webpage, I really found you by mistake, while I was
browsing on Digg for something else, Anyways I am here now
and would just like to say thanks a lot for a marvelous
post and a all round enjoyable blog (I also love the theme/design), I don’t have time to go through it all at the moment but I have bookmarked it and also added your RSS feeds,
so when I have time I will be back to read a lot more, Please do
keep up the awesome work.
заказать металлические значки заказать металлические значки
Hi there to all, the contents existing at this web site are in fact amazing for people experience, well, keep up the
nice work fellows.
букмекерские конторы в кыргызстане букмекерские конторы в кыргызстане
We are a bunch of volunteers and opening a new scheme in our community.
Your site provided us with helpful info
to work on. You’ve done an impressive task and our entire neighborhood
shall be thankful to you.
Hey There. I found your blog using msn. This is an extremely
well written article. I will be sure to bookmark it and come back to read more of your useful info.
Thanks for the post. I will certainly return. queboi https://queboi.com
зайти в мостбет https://www.mostbet11027.ru
My relatives every time say that I am wasting my time here at web, but
I know I am getting experience everyday by reading thes good posts.
температура красного моря Кайтинг в Египте в июле: жара и ветер Кайтинг в Египте в июле – это жара и ветер, создающие отличные условия для катания, но требующие соблюдения мер предосторожности от перегрева и солнечных ожогов.
Good blog you have here.. It’s hard to find high quality writing like yours nowadays.
I seriously appreciate people like you! Take care!!
мостбет официальный сайт вход https://www.mostbet11026.ru
займ под птс
zaimpod-pts92.ru/kazan.html
машина под залог
I’ve been exploring for a little for any high quality articles or
blog posts in this kind of space . Exploring in Yahoo
I at last stumbled upon this website. Reading this information So i am satisfied to exhibit that
I’ve a very excellent uncanny feeling I found out just what
I needed. I so much certainly will make sure to don?t fail to remember this website and provides it a glance regularly.
мостбет сайт вход [url=mostbet11026.ru]mostbet11026.ru[/url]
Купить диплом университета по выгодной цене возможно, обращаясь к надежной специализированной компании. Купить документ о получении высшего образования можно в нашем сервисе. orikdok-3v-gorode-kazan-16.ru
Оформиление дипломов ВУЗов в Москве — с печатями, подписями, приложением и возможностью архивной записи (по запросу).
Документ максимально приближен к оригиналу и проходит визуальную проверку.
Мы гарантируем, что в случае проверки документа, подозрений не возникнет.
– Конфиденциально
– Доставка 3–7 дней
– Любая специальность
Уже более 3006 клиентов воспользовались услугой — теперь ваша очередь.
Купить диплом о среднем образовании — ответим быстро, без лишних формальностей.
почему не работает посудомойка алматы Холодильник не морозит Алматы: Устранение причины, почему холодильник не морозит. Быстрый выезд мастера.
Купить диплом института по доступной цене можно, обратившись к проверенной специализированной компании. Заказать документ университета можно у нас. orikdok-3v-gorode-sankt-peterburg-78.ru
Оформиление дипломов ВУЗов в Москве — с печатями, подписями, приложением и возможностью архивной записи (по запросу).
Документ максимально приближен к оригиналу и проходит визуальную проверку.
Мы гарантируем, что в случае проверки документа, подозрений не возникнет.
– Конфиденциально
– Доставка 3–7 дней
– Любая специальность
Уже более 2395 клиентов воспользовались услугой — теперь ваша очередь.
Посмотреть информацию — ответим быстро, без лишних формальностей.
Оформиление дипломов ВУЗов по всей России и СНГ — с печатями, подписями, приложением и возможностью архивной записи (по запросу).
Документ максимально приближен к оригиналу и проходит визуальную проверку.
Мы гарантируем, что в случае проверки документа, подозрений не возникнет.
– Конфиденциально
– Доставка 3–7 дней
– Любая специальность
Уже более 1359 клиентов воспользовались услугой — теперь ваша очередь.
[url=http://inforepetitor10.ru/]Посмотреть информацию[/url] — ответим быстро, без лишних формальностей.
кайт спорт Египет кайтсерфинг: рай для любителей ветра и волн Египет – настоящий рай для кайтсерферов. Стабильный ветер, теплое море и множество кайт-спотов делают его идеальным местом для катания круглый год. Здесь каждый найдет себе место по душе, от спокойных лагун для новичков до открытых морских просторов для продвинутых райдеров.
Купить диплом университета по доступной цене можно, обращаясь к надежной специализированной компании. Купить документ института можно в нашей компании в столице. [url=http://orikdok-3v-gorode-cheboksary-21.ru/]orikdok-3v-gorode-cheboksary-21.ru[/url]
1000 рублей за регистрацию вывод сразу без вложений в казино Получить 1000 рублей за регистрацию с моментальным выводом, не требующим каких-либо вложений, – это мечта любого новичка онлайн-казино. Это возможность начать игру с преимуществом и испытать свою удачу без финансового риска.
Yo forum friends, I’m Piotr from Poland. I wanna tell you about my insane experience with this crazy popular online casino I stumbled
on this spring.
To be honest, I was struggling badly, and now I can’t believe it myself — I hit €1,200,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 Solana.
Later I’ll probably move to a better neighborhood and retire early.
Now I’m going by Andrei from Romania 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 a bit envious right now?
For real, I never thought I’d have a shot at investing. It’s all happening so fast!
Drop your thoughts below!
Stunning story there. What occurred after? Good luck!
скачать бк осталось именно выбрать подходящее [url=http://mostbet11024.ru/]http://mostbet11024.ru/[/url]
mostbet apk скачать https://mostbet11024.ru/
Hello there I am so grateful I found your blog page, I really found you by error, while I
was browsing on Askjeeve for something else, Regardless I am
here now and would just like to say thank you for a marvelous
post and a all round entertaining blog (I also love the theme/design), I
don’t have time to read it all at the minute but I have saved it
and also added in your RSS feeds, so when I have time I
will be back to read a lot more, Please do keep up the awesome jo.
Гороскоп novorjev.ru .
Магнитные бури http://pechory-online.ru .
кайтсёрфинг инструктор Кайт обучение Египет: Эффективные программы обучения Кайт обучение Египет – это эффективные программы обучения для всех уровней подготовки.
Thanks for finally writing about > PHP hook, building hooks in your application –
Sjoerd Maessen blog < Loved it!
mostbet скачать бесплатно https://mostbet11024.ru
Какой сегодня праздник http://www.novorjev.ru/ .
Запреты дня pechory-online.ru .
мостбет скачать бесплатно мостбет скачать бесплатно
mostbet sitio oficial https://www.mostbet11024.ru
кайт спорт IKO что означает: International Kiteboarding Organization IKO означает International Kiteboarding Organization – международная организация кайтбординга, устанавливающая стандарты обучения и сертификации.
motbet [url=https://mostbet11023.ru]https://mostbet11023.ru[/url]
автомобиль под залог
zaimpod-pts92.ru/kemerovo.html
займ залог птс
Суши роллы