PHP hook, building hooks in your application
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://vyvod-iz-zapoya-ekaterinburg.ru
Michaelalona
6 Aug 25 at 7:53 pm
Сайт о питании при беременности [url=https://edamam.ru/]https://edamam.ru/[/url] .
edamam.ru_jxKt
6 Aug 25 at 7:53 pm
cheap stromectol: is ivermectin safe – ivermectin ebv
Raymondheaps
6 Aug 25 at 7:54 pm
Мы предлагаем документы учебных заведений, которые расположены на территории всей России. Приобрести диплом о высшем образовании:
[url=http://censornet.ru/diplom-lyubogo-vuza-po-vashemu-zaprosu/]купить аттестат за 11 класс в казани[/url]
Diplomi_cyPn
6 Aug 25 at 7:54 pm
edamam.ru [url=edamam.ru]edamam.ru[/url] .
edamam.ru_lpKt
6 Aug 25 at 7:56 pm
Нарколог на дом в Новокузнецке – это возможность получить профессиональное медицинское лечение без госпитализации. Специалисты клиники «ЧистоЖизнь» приезжают в любое время суток, проводят детоксикацию, снимают абстинентный синдром и помогают пациенту стабилизировать состояние в комфортных домашних условиях.
Исследовать вопрос подробнее – [url=https://narcolog-na-dom-novokuznetsk00.ru/]выезд нарколога на дом[/url]
Duanelof
6 Aug 25 at 8:02 pm
ISTRIPPER MOBILE
ISTRIPPER MOBILE
6 Aug 25 at 8:03 pm
Уличные котлы
Blakemew
6 Aug 25 at 8:06 pm
proedy [url=www.proedy.online]www.proedy.online[/url] .
proedy.online_wami
6 Aug 25 at 8:08 pm
По окончании курса детоксикации нарколог дает пациенту и его близким подробные рекомендации, помогающие быстрее восстановить здоровье и предотвратить повторные случаи запоев.
Узнать больше – [url=https://vyvod-iz-zapoya-novosibirsk0.ru/]вывод из запоя круглосуточно[/url]
Williambax
6 Aug 25 at 8:09 pm
Hello, after reading this awesome article i am too happy to share my knowledge here with mates.
slip and fall lawyer in Peoria
6 Aug 25 at 8:09 pm
edamam.ru [url=http://www.edamam.ru]http://www.edamam.ru[/url] .
edamam.ru_epKt
6 Aug 25 at 8:13 pm
Я малышка [url=http://imalishka.ru/]http://imalishka.ru/[/url] .
imalishka.ru_mcmn
6 Aug 25 at 8:17 pm
https://soundcloud.com/malbet1
https://soundcloud.com/malbet1
6 Aug 25 at 8:17 pm
Мы можем предложить документы институтов, которые расположены в любом регионе России. Купить диплом любого ВУЗа:
[url=http://mamuli.club/forum/topic/36945/]купить аттестат 11 классов в братске[/url]
Diplomi_vzPn
6 Aug 25 at 8:18 pm
Yesterday, while I was at work, my sister stole
my iPad and tested to see if it can survive a 30 foot
drop, just so she can be a youtube sensation. My apple ipad is now broken and she has 83 views.
I know this is totally off topic but I had to share it with someone!
с для установкой заказать базы Владивосток xrumer
6 Aug 25 at 8:18 pm
hello!,I really like your writing very a lot! share we be in contact more about your article on AOL?
I need an expert on this house to resolve my problem. May
be that’s you! Taking a look ahead to look you.
Stop by my web site … bauturi care scad tensiunea arteriala
bauturi care scad tensiunea arteriala
6 Aug 25 at 8:19 pm
Самостоятельно выйти из запоя — почти невозможно. В Екатеринбурге врачи клиники проводят медикаментозный вывод из запоя с круглосуточным выездом. Доверяйте профессионалам.
Подробнее – [url=https://vyvod-iz-zapoya-ekaterinburg14.ru/]нарколог вывод из запоя в екатеринбурге[/url]
Arthurgycle
6 Aug 25 at 8:20 pm
Right now it seems like Drupal is the top blogging platform out there right now.
(from what I’ve read) Is that what you’re using on your blog?
AI Business Consulting
6 Aug 25 at 8:21 pm
помощь наркозависимым
FrankBiz
6 Aug 25 at 8:21 pm
edamam.ru [url=www.edamam.ru]www.edamam.ru[/url] .
edamam.ru_bkKt
6 Aug 25 at 8:23 pm
Самостоятельно выйти из запоя — почти невозможно. В Екатеринбурге врачи клиники проводят медикаментозный вывод из запоя с круглосуточным выездом. Доверяйте профессионалам.
Исследовать вопрос подробнее – [url=https://vyvod-iz-zapoya-ekaterinburg11.ru/]вывод из запоя на дому цена[/url]
RichardPoorm
6 Aug 25 at 8:26 pm
пансионат для престарелых людей
pansionat-tula006.ru
пансионат для лежачих тула
domprestarelihtulaNeT
6 Aug 25 at 8:31 pm
It’s great that you are getting ideas from this article
as well as from our discussion made here.
My web page; Flyttefolk
Flyttefolk
6 Aug 25 at 8:33 pm
Все об экстракорпоральном оплодотворении и лечении бесплодия [url=https://www.ekoclinic.ru]https://www.ekoclinic.ru[/url] .
ekoclinic.ru_puPt
6 Aug 25 at 8:34 pm
As the admin of this website is working, no doubt very
quickly it will be well-known, due to its
feature contents.
Brisomax App
6 Aug 25 at 8:38 pm
Проблемы с алкоголем и наркотиками — это не просто личные трудности, а серьёзное испытание для всей семьи и общества. Самостоятельные попытки справиться с зависимостью редко приводят к успеху и часто только усугубляют ситуацию. Оптимальное решение — обратиться за профессиональной помощью в специализированное учреждение. В наркологической клинике «ВитаРеабилит» в Подольске пациенты получают комплексное лечение под контролем опытных врачей, современные методики детоксикации и реабилитации, а также полную поддержку на всех этапах выздоровления.
Ознакомиться с деталями – [url=https://narkologicheskaya-klinika-podolsk5.ru/]narkologicheskaya-klinika-podolsk5.ru/[/url]
DouglasPap
6 Aug 25 at 8:44 pm
Все об экстракорпоральном оплодотворении и лечении бесплодия [url=http://ekoclinic.ru]http://ekoclinic.ru[/url] .
ekoclinic.ru_dsPt
6 Aug 25 at 8:45 pm
Asking questions are actually pleasant thing if you are not understanding
something entirely, but this article offers pleasant understanding even.
Australian female burlesque pe
6 Aug 25 at 8:46 pm
Pretty! This was an extremely wonderful post. Thanks for
supplying these details.
gay
6 Aug 25 at 8:46 pm
What’s up, the whole thing is going nicely here and ofcourse every one is sharing
facts, that’s truly good, keep up writing.
negative seo traffic
6 Aug 25 at 8:48 pm
На основе полученных диагностических данных врач подбирает оптимальные препараты и дозировки, разрабатывая персональный план лечебных мероприятий.
Изучить вопрос глубже – [url=https://narcolog-na-dom-voronezh00.ru/]нарколог на дом клиника[/url]
Robertcon
6 Aug 25 at 8:50 pm
Yes! Finally someone writes about tranh son dau.
san thi dau cong cong
6 Aug 25 at 8:52 pm
Мы готовы предложить документы университетов, которые находятся на территории всей РФ. Купить диплом университета:
[url=http://newsstatix.com/kupit-diplom-s-zaneseniem-v-reestr-193/]где купить аттестат 11 классов в москве[/url]
Diplomi_yiPn
6 Aug 25 at 8:53 pm
Hey there would you mind letting me know which web host you’re
working with? I’ve loaded your blog in 3 different
internet browsers and I must say this blog loads a lot faster then most.
Can you suggest a good internet hosting provider at a honest price?
Thanks, I appreciate it!
Sovamnex App
6 Aug 25 at 8:53 pm
Hi friends, its fantastic piece of writing on the topic of educationand entirely defined,
keep it up all the time.
X.AI Platform
6 Aug 25 at 8:54 pm
Greetings I am so delighted I found your web site, I really found you
by mistake, while I was looking on Bing for something else, Anyhow I am here now and would just like to
say thank you for a tremendous post and a all round exciting blog (I also love the theme/design), I don’t
have time to read it all at the moment but I have book-marked it and
also added your RSS feeds, so when I have time I will be back to read a
great deal more, Please do keep up the awesome b.
Sulong Tradex
6 Aug 25 at 8:55 pm
Все об экстракорпоральном оплодотворении и лечении бесплодия [url=http://ekoclinic.ru/]http://ekoclinic.ru/[/url] .
ekoclinic.ru_zsPt
6 Aug 25 at 8:58 pm
В период восстановления пациент получает психологическую поддержку, работает с психотерапевтом, осваивает навыки самоконтроля, учится противостоять стрессу без возвращения к прежним привычкам. После выписки возможно амбулаторное сопровождение, дистанционные консультации и поддержка для всей семьи.
Получить больше информации – [url=https://narkologicheskaya-klinika-balashiha5.ru/]narkologicheskaya-klinika-stacionar[/url]
WilliamaciGh
6 Aug 25 at 8:59 pm
интернет провайдеры по адресу краснодар
krasnodar-domashnij-internet006.ru
провайдеры интернета по адресу краснодар
inernetkrdelini
6 Aug 25 at 9:00 pm
FluidCare Pharmacy [url=https://fluidcarepharmacy.com/#]furosemida[/url] FluidCare Pharmacy
Harryinapy
6 Aug 25 at 9:03 pm
помощь наркозависимым
FrankBiz
6 Aug 25 at 9:05 pm
I really like what you guys are usually up too. Such
clever work and coverage! Keep up the very good works guys I’ve you guys to my personal blogroll.
پین باهیس
6 Aug 25 at 9:07 pm
Все об экстракорпоральном оплодотворении и лечении бесплодия [url=http://www.ekoclinic.ru]http://www.ekoclinic.ru[/url] .
ekoclinic.ru_vePt
6 Aug 25 at 9:10 pm
IverCare Pharmacy: IverCare Pharmacy – IverCare Pharmacy
Raymondheaps
6 Aug 25 at 9:10 pm
ekoclinic.ru [url=http://www.ekoclinic.ru]http://www.ekoclinic.ru[/url] .
ekoclinic.ru_xjPt
6 Aug 25 at 9:13 pm
интересные кашпо [url=www.dizaynerskie-kashpo-sochi.ru/]интересные кашпо[/url] .
dizainerskie kashpo_koOn
6 Aug 25 at 9:13 pm
malishi.online [url=http://malishi.online/]http://malishi.online/[/url] .
malishi.online_dpki
6 Aug 25 at 9:17 pm
купить проведенный диплом кого [url=arus-diplom34.ru]купить проведенный диплом кого[/url] .
Zakazat diplom o visshem obrazovanii!_wbkn
6 Aug 25 at 9:20 pm
Неотложная наркологическая помощь – это важный аспект в лечении зависимостей. Следует помнить, что при появлении признаков передозировки, таких как учащенное дыхание, обморок или судороги, необходимо незамедлительно вызывать экстренную медицинскую помощь. Наркоманы и их близкие могут обратиться в специальную наркологическую клинику, где окажут профессиональную помощь. Специальные кризисные службы предлагают консультацию нарколога, что позволяет обрести помощь как зависимым, так и их родным. Терапия зависимостей включает не только медикаментозную терапию, но и психотерапию для зависимых, что важно для восстановления после зависимости. Профилактика алкоголизма и адаптация в обществе также играют значительную роль в процессе восстановления наркоманов, обеспечивая успешное воссоединение с обычной жизнью. Помните‚ медицинская помощь при наркотической зависимости должна быть своевременной и комплексной. Поддержка и понимание близких помогают преодолеть сложности на пути к восстановлению. Для получения дополнительной информации посетите narkolog-tula014.ru.
vivodtulaNeT
6 Aug 25 at 9:25 pm