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!
кайт школа Кайт лагерь: развлечения, общение и обмен опытом
Kennethvut
1 Aug 25 at 1:38 am
Комплексное лечение на дому организовано по четкой схеме, состоящей из последовательных этапов. Каждый из них направлен на быстрое восстановление нормального функционирования организма.
Подробнее – [url=https://vyvod-iz-zapoya-vladimir0.ru/]вывод из запоя недорого владимир[/url]
RichardUnsef
1 Aug 25 at 1:46 am
7 slots [url=http://candy-casino-10.com/]7 slots[/url] .
candy casino_rgol
1 Aug 25 at 1:46 am
легально купить диплом о высшем образовании [url=https://www.arus-diplom34.ru]легально купить диплом о высшем образовании[/url] .
Diplomi_sger
1 Aug 25 at 1:47 am
Комплексное лечение на дому организовано по строго отлаженной схеме, позволяющей оперативно стабилизировать состояние пациента и провести качественную детоксикацию.
Ознакомиться с деталями – https://vyvod-iz-zapoya-vladimir00.ru/vyvod-iz-zapoya-na-domu-vladimir/
Billyprola
1 Aug 25 at 1:51 am
slot giri? [url=www.candy-casino-7.com/]www.candy-casino-7.com/[/url] .
candy casino_wzKl
1 Aug 25 at 1:56 am
comics смотреть онлайн free digital comics reader
batcave-652
1 Aug 25 at 1:58 am
кайт лагерь Кайт лагерь: Сообщество единомышленников, объединенных страстью к ветру и волнам. Возможность не только научиться кайтсёрфингу, но и завести новых друзей.
Kennethvut
1 Aug 25 at 2:00 am
canadian pharmacies comparison: canadian pharmacy victoza – pharmacy rx world canada
Richardbog
1 Aug 25 at 2:05 am
услуги транспортировки автомобилей [url=https://avtovoz-av8.ru/]https://avtovoz-av8.ru/[/url] .
avtovoz_euKt
1 Aug 25 at 2:05 am
кайт лагерь “Зимний кайт”: Кайтсерфинг зимой: выбор экипировки и особенности катания
Kennethvut
1 Aug 25 at 2:06 am
casino bahis [url=https://www.candy-casino-7.com]https://www.candy-casino-7.com[/url] .
candy casino_utKl
1 Aug 25 at 2:09 am
https://indigenixpharm.shop/# top 10 pharmacies in india
Jessegap
1 Aug 25 at 2:14 am
перевозки автовозом по россии [url=www.avtovoz-av8.ru/]www.avtovoz-av8.ru/[/url] .
avtovoz_zdKt
1 Aug 25 at 2:19 am
Затяжной запой опасен для жизни. Врачи наркологической клиники в Ростове-На-Дону проводят срочный вывод из запоя — на дому или в стационаре. Анонимно, безопасно, круглосуточно.
Раскрыть тему полностью – https://vyvod-iz-zapoya-rostov11.ru/
Eugenevef
1 Aug 25 at 2:24 am
MexiCare Rx Hub [url=https://mexicarerxhub.com/#]real mexican pharmacy USA shipping[/url] MexiCare Rx Hub
JamesCoaby
1 Aug 25 at 2:24 am
Капельница от запоя на дому — это эффективным методом детоксикации организма при лечении алкоголизма . Нарколог на дом анонимно в городе Красноярск предлагает услуги по введению капельниц , что позволяет быстро восстановить здоровье пациентов . Состав капельницы включает в себя лекарственных средств, которые помогают устранению симптомов запойного алкоголизма , таких как обезвоживание и интоксикация . Нарколог на дом анонимно Красноярск. Ключевые компоненты капельницы: солевой раствор для восполнения жидкости, глюкоза для энергетической поддержки , витамины группы B для нормализации обмена веществ и препараты для облегчения абстиненции; лекарства для капельницы подбираются индивидуально , в зависимости от состояния пациента. Домашняя терапия под контролем нарколога обеспечивает анонимное лечение , что существенно для многих людей, страдающих от алкогольной зависимости . Семейная поддержка во время запоя имеет решающее значение для успешного выздоровления. Консультация нарколога поможет определить следующие шаги, включая реабилитацию алкоголиков и восстановление после запоя .
alkogolizmkrasnoyarskNeT
1 Aug 25 at 2:26 am
melbet promo code [url=www.melbet1037.ru]www.melbet1037.ru[/url]
melbet_eksr
1 Aug 25 at 2:27 am
зеркало melbet [url=www.melbet1037.ru]www.melbet1037.ru[/url]
melbet_yysr
1 Aug 25 at 2:35 am
mexico drug stores pharmacies: MexiCare Rx Hub – MexiCare Rx Hub
Richardquaxy
1 Aug 25 at 2:37 am
Чрезмерное употребление алкоголя приводит к отравлению организма, негативно сказываясь на работе внутренних органов, уровне жидкости и общем самочувствии. Длительные запои сопровождаются тяжёлыми последствиями, включая нарушения сердечной деятельности, сбои в работе печени, скачки давления и психоэмоциональные расстройства.
Ознакомиться с деталями – http://kapelnica-ot-zapoya-krasnoyarsk6.ru/
Eugeneelupe
1 Aug 25 at 2:39 am
Мега сайт
RichardPep
1 Aug 25 at 2:39 am
melbet регистрация [url=https://melbet1031.ru]https://melbet1031.ru[/url]
melbet_tpPi
1 Aug 25 at 2:40 am
читать манхву онлайн манхва с переводом
com-x-258
1 Aug 25 at 2:45 am
manga reader no ads manga for mobile devices
manga-214
1 Aug 25 at 2:46 am
download melbet app [url=www.melbet1038.ru]www.melbet1038.ru[/url]
melbet_faKl
1 Aug 25 at 2:50 am
1win скачать приложение на айфон [url=https://www.1win40001.ru]https://www.1win40001.ru[/url]
1win_icOa
1 Aug 25 at 2:52 am
купить диплом занесением реестр украины [url=forum.ixbt.com/users.cgi?id=info:iliaanisimov]купить диплом занесением реестр украины[/url] .
Kypit diplom ob obrazovanii!_npkt
1 Aug 25 at 2:53 am
Hey I know this is off topic but I was wondering if you knew of any widgets
I could add to my blog that automatically tweet my newest twitter updates.
I’ve been looking for a plug-in like this for quite some time
and was hoping maybe you would have some experience with something like this.
Please let me know if you run into anything.
I truly enjoy reading your blog and I look forward to
your new updates.
تعمیرگاه ام وی ام غرب تهران
1 Aug 25 at 2:54 am
Thanks for any other informative web site.
Where else could I get that kind of information written in such an ideal method?
I’ve a undertaking that I am simply now running on, and I’ve been at the
glance out for such information.
kruzty live wallpaper
1 Aug 25 at 2:55 am
Затяжной запой опасен для жизни. Врачи наркологической клиники в Ростове-На-Дону проводят срочный вывод из запоя — на дому или в стационаре. Анонимно, безопасно, круглосуточно.
Изучите внимательнее – https://vyvod-iz-zapoya-rostov12.ru
GregoryCorry
1 Aug 25 at 2:56 am
Основные методы, используемые в клинике, включают медикаментозную детоксикацию, психотерапевтические программы и реабилитационные мероприятия. Медикаментозное выведение токсинов из организма проводится с применением сертифицированных препаратов под строгим контролем врачей. Подробности о методах медикаментозной детоксикации представлены на сайте Министерства здравоохранения РФ.
Разобраться лучше – http://narkologicheskaya-klinika-rostov-na-donu13.ru
DevinImpub
1 Aug 25 at 2:57 am
купить чистый аттестат за 11 класс [url=arus-diplom23.ru]купить чистый аттестат за 11 класс[/url] .
Diplomi_ieSr
1 Aug 25 at 2:57 am
https://indigenixpharm.shop/# top 10 pharmacies in india
Jessegap
1 Aug 25 at 3:08 am
кайт “Полет души”: кайт для продвинутых, когда трюки – не просто движения, а выражение внутренней свободы
Kennethvut
1 Aug 25 at 3:09 am
Процесс вывода из запоя капельничным методом организован по строгой схеме, позволяющей обеспечить максимальную эффективность терапии. Каждая стадия направлена на комплексное восстановление организма и минимизацию риска осложнений.
Получить больше информации – https://kapelnica-ot-zapoya-tyumen0.ru/postavit-kapelniczu-ot-zapoya-tyumen/
Richardbluen
1 Aug 25 at 3:09 am
comics in Russian free graphic novels online
batcave-824
1 Aug 25 at 3:14 am
melbet казахстан [url=https://melbet1038.ru/]melbet казахстан[/url]
melbet_myKl
1 Aug 25 at 3:14 am
Мы готовы предложить дипломы любых профессий по доступным тарифам. Купить диплом в Санкт-Петербурге (СПБ) — [url=http://kyc-diplom.com/geography/spb.html/]kyc-diplom.com/geography/spb.html[/url]
Cazryry
1 Aug 25 at 3:20 am
Алкогольный запой — это не просто следствие длительного употребления спиртного, а критическое состояние, которое, если оставить его без своевременного квалифицированного медицинского вмешательства, может привести к крайне серьезным и даже необратимым последствиям для здоровья и жизни человека, затрагивая практически все системы организма
Получить дополнительную информацию – [url=https://vyvod-iz-zapoya-arkhangelsk6.ru/]вывод из запоя[/url]
NancyWhiRl
1 Aug 25 at 3:23 am
кайт Кайт
Kennethvut
1 Aug 25 at 3:23 am
Découvrez pocket option application, l’application de trading intuitive utilisée par des millions de traders dans le monde. Accédez à plus de 100 actifs : forex, actions, crypto-monnaies et matières premières. Exécutions rapides, interface claire et retraits instantanés. Parfait pour débutants comme pour traders expérimentés – tradez où que vous soyez, à tout moment.
Larryuneve
1 Aug 25 at 3:27 am
continuously i used to read smaller articles or reviews which also clear
their motive, and that is also happening with this piece of
writing which I am reading now.
Vista Social AI
1 Aug 25 at 3:40 am
В городе Красноярск доступно широкий спектр услуг для вывода из запоя. Наркологические клиники предлагают профессиональную помощь, включая детоксикацию и стационарную терапию. Профессиональные наркологи проводят кодирование, а также предоставляют психотерапевтическую помощь и реабилитацию. Важно помнить о важности консультаций для близких, чтобы поддержать семью; Лечение с гарантией анонимности гарантирует конфиденциальность, а реабилитационные программы помогают зависимым возвратиться к полноценной жизни. Получите дополнительную информацию на сайте vivod-iz-zapoya-krasnoyarsk006.ru.
zapojkrasnoyarskNeT
1 Aug 25 at 3:42 am
comics 3d free digital comics reader
batcave-902
1 Aug 25 at 3:44 am
If you want to improve your experience only keep visiting this site and be updated with the newest news posted here.
link alternatif calon4d
1 Aug 25 at 3:44 am
the world of comics latest superhero comics
batcave-651
1 Aug 25 at 3:45 am
скачать мелбет казино [url=https://melbet1033.ru/]https://melbet1033.ru/[/url]
melbet_kuPn
1 Aug 25 at 3:49 am
Когда запой становится критическим, оперативное вмешательство имеет решающее значение для спасения здоровья и предотвращения необратимых последствий. Во Владимире экстренная помощь нарколога на дому позволяет быстро начать лечение, не требуя госпитализации, что особенно важно для пациентов, нуждающихся в сохранении конфиденциальности и комфорте.
Углубиться в тему – [url=https://vyvod-iz-zapoya-vladimir000.ru/]нарколог на дом вывод из запоя на дому[/url]
DavidJem
1 Aug 25 at 3:52 am
https://dipris-studio.ru/news/kanefron-vash-nadezhnyj-pomoshhnik-v-borbe-s-zabolevaniyami-mochevyvodyashhej-sistemy/
AndrepitlE
1 Aug 25 at 3:56 am