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!
DRINKIO стал постоянным выбором для заказов. Всё работает стабильно, быстро и удобно. Курьеры пунктуальные, упаковка целая. Ассортимент широкий, сайт простой. Радует круглосуточная доступность сервиса. Доставка алкоголя 24 часа Москва: https://drinkio105.ru/
Arthurtok
22 Oct 25 at 1:37 am
Hello my family member! I want to say that this article is amazing,
great written and include almost all important infos.
I’d like to see more posts like this .
SolanixPeak 2.7 Ai Opiniones
22 Oct 25 at 1:39 am
Если вы строите дом, баню или террасу, на этом складе вы найдете весь перечень пиломатериалов — от обрезной и строганной доски до профилированного бруса, фанеры и террасной доски. С 2004 года компания поддерживает большие складские остатки в Мытищах и быстро возит заказы собственными машинами по Москве и Подмосковью. Подробные цены от производителя, акции и калькулятор доступны на сайте — https://pilomaterialy-msk.ru Менеджеры рассчитают кубатуру, подскажут оптимальные сорта и быстро соберут заказ под ваш проект.
juyazDrecy
22 Oct 25 at 1:39 am
The Minotaurus presale vesting program is a game-changer for early birds. Extend for bonuses and avoid FOMO on post-TGE pumps. $MTAUR could be the dark horse in blockchain games.
mtaur token
WilliamPargy
22 Oct 25 at 1:39 am
seo продвижение сайта россия [url=reiting-seo-agentstv.ru]seo продвижение сайта россия[/url] .
reiting seo agentstv_xpsa
22 Oct 25 at 1:40 am
агентства контекстная реклама продвижение сайтов [url=https://www.reiting-kompanii-po-prodvizheniyu-sajtov.ru]https://www.reiting-kompanii-po-prodvizheniyu-sajtov.ru[/url] .
agentstvo poiskovogo prodvijeniya_tpKt
22 Oct 25 at 1:40 am
интернет маркетинг агентство [url=https://luchshie-digital-agencstva.ru/]интернет маркетинг агентство[/url] .
lychshie digital agentstva_jroi
22 Oct 25 at 1:40 am
раскрутка сайтов в москве в топ 10 [url=https://reiting-seo-agentstv-moskvy.ru/]reiting-seo-agentstv-moskvy.ru[/url] .
reiting seo agentstv moskvi_dtMl
22 Oct 25 at 1:42 am
кракен vk6
кракен vk2
JamesDaync
22 Oct 25 at 1:43 am
Attractive section of content. I just stumbled upon your weblog and in accession capital to assert that
I acquire in fact loved account your weblog posts.
Any way I will be subscribing in your augment or even I success you get admission to persistently
rapidly.
comments
22 Oct 25 at 1:43 am
Добрый день!
чуть что телефон iphone
Полная информация по ссылке – https://www.gada.su/
языковедение — наука, изучающая язык, [url=https://www.gada.su/2025/09/blog-post_20.html]Грамматика[/url], температура процессора
Удачи и успехов в жизни и саморазвитии!
JamesTipsy
22 Oct 25 at 1:43 am
купить диплом в комсомольске-на-амуре [url=https://www.rudik-diplom12.ru]купить диплом в комсомольске-на-амуре[/url] .
Diplomi_ezPi
22 Oct 25 at 1:44 am
сайтов продвижение в топ [url=https://top-10-seo-prodvizhenie.ru/]сайтов продвижение в топ[/url] .
top 10 seo prodvijenie_hjKa
22 Oct 25 at 1:44 am
рейтинг агентств digital маркетинга [url=www.luchshie-digital-agencstva.ru/]www.luchshie-digital-agencstva.ru/[/url] .
lychshie digital agentstva_kdoi
22 Oct 25 at 1:47 am
услуги по раскрутке сайта [url=www.reiting-runeta-seo.ru]www.reiting-runeta-seo.ru[/url] .
reiting ryneta seo_jbma
22 Oct 25 at 1:48 am
seo продвижение россия [url=http://reiting-seo-agentstv.ru/]seo продвижение россия[/url] .
reiting seo agentstv_gcsa
22 Oct 25 at 1:48 am
seo agency nj [url=www.reiting-seo-kompanii.ru/]seo agency nj[/url] .
reiting seo kompanii_sqsn
22 Oct 25 at 1:49 am
Клиника «Похмельная служба» в Нижнем Новгороде предлагает комплексное лечение запоя с использованием капельницы. Наши специалисты проводят диагностику и назначают индивидуальный план лечения.
Узнать больше – [url=https://vyvod-iz-zapoya-nizhnij-novgorod12.ru/]вывод из запоя дешево в нижний новгороде[/url]
AllanCauck
22 Oct 25 at 1:49 am
заказать сео продвижение сайта москва [url=http://www.reiting-seo-agentstv-moskvy.ru]заказать сео продвижение сайта москва[/url] .
reiting seo agentstv moskvi_qwMl
22 Oct 25 at 1:50 am
сео оптимизация заказать [url=reiting-runeta-seo.ru]сео оптимизация заказать[/url] .
reiting ryneta seo_dfma
22 Oct 25 at 1:50 am
сео москва [url=www.seo-prodvizhenie-reiting-kompanij.ru]сео москва[/url] .
seo prodvijenie reiting kompanii_nost
22 Oct 25 at 1:50 am
заказ дошел до нас)))
https://dokuchaevskpj.ru
Врубим поскорей музончик:
Donaldmoire
22 Oct 25 at 1:51 am
кто купил диплом с занесением в реестр [url=www.frei-diplom1.ru]кто купил диплом с занесением в реестр[/url] .
Diplomi_ifOi
22 Oct 25 at 1:51 am
top digital agency [url=https://www.luchshie-digital-agencstva.ru]top digital agency[/url] .
lychshie digital agentstva_veoi
22 Oct 25 at 1:51 am
заказать продвижение сайта москва топ [url=http://reiting-seo-agentstv-moskvy.ru]заказать продвижение сайта москва топ[/url] .
reiting seo agentstv moskvi_fdMl
22 Oct 25 at 1:52 am
сео компания [url=http://reiting-seo-agentstv.ru]сео компания[/url] .
reiting seo agentstv_cssa
22 Oct 25 at 1:55 am
kraken qr code
кракен ios
JamesDaync
22 Oct 25 at 1:55 am
profesionales seo [url=https://top-10-seo-prodvizhenie.ru]profesionales seo[/url] .
top 10 seo prodvijenie_lqKa
22 Oct 25 at 1:56 am
рейтинг агентств digital услуг [url=luchshie-digital-agencstva.ru]luchshie-digital-agencstva.ru[/url] .
lychshie digital agentstva_ejoi
22 Oct 25 at 1:57 am
сео продвижение компания [url=https://www.seo-prodvizhenie-reiting-kompanij.ru]сео продвижение компания[/url] .
seo prodvijenie reiting kompanii_npst
22 Oct 25 at 1:58 am
What’s up i am kavin, its my first time to commenting anywhere, when i read this article i thought i could also make comment due to this brilliant piece of writing.
https://easystaffingmd.com/
Timsothydet
22 Oct 25 at 1:58 am
Очистка холодильника включает размораживание (если требуется), мытьё
полок, ящиков и внутренних стенок моющим средством с
дезинфицирующим эффектом.
уборка квартир под ключ
22 Oct 25 at 1:58 am
технический перевод ошибки [url=https://www.dzen.ru/a/aPFFa3ZMdGVq1wVQ]https://www.dzen.ru/a/aPFFa3ZMdGVq1wVQ[/url] .
Tehnicheskii perevod_gmml
22 Oct 25 at 2:00 am
It’s perfect time to make some plans for the longer term and it’s
time to be happy. I have learn this put up and
if I could I wish to counsel you few fascinating things or tips.
Perhaps you can write next articles regarding this article.
I desire to learn even more issues about it!
sodo 66
22 Oct 25 at 2:00 am
Клиника «Похмельная служба» в Нижнем Новгороде предлагает капельницу от запоя с выездом на дом. Наши специалисты обеспечат вам комфортное и безопасное лечение в привычной обстановке.
Подробнее тут – [url=https://vyvod-iz-zapoya-nizhnij-novgorod11.ru/]врач вывод из запоя[/url]
Norbertavoig
22 Oct 25 at 2:01 am
сео продвижение сайтов 10 [url=https://www.reiting-runeta-seo.ru]https://www.reiting-runeta-seo.ru[/url] .
reiting ryneta seo_abma
22 Oct 25 at 2:02 am
агентство продвижения сайтов [url=http://reiting-kompanii-po-prodvizheniyu-sajtov.ru/]агентство продвижения сайтов[/url] .
agentstvo poiskovogo prodvijeniya_wpKt
22 Oct 25 at 2:02 am
kraken client
kraken сайт
JamesDaync
22 Oct 25 at 2:04 am
рейтинг агентств digital [url=https://luchshie-digital-agencstva.ru]рейтинг агентств digital[/url] .
lychshie digital agentstva_yaoi
22 Oct 25 at 2:04 am
seo продвижение сайтов москва [url=reiting-seo-agentstv-moskvy.ru]reiting-seo-agentstv-moskvy.ru[/url] .
reiting seo agentstv moskvi_dpMl
22 Oct 25 at 2:05 am
Excited for $MTAUR coin’s role in personalizing characters—fancy outfits via tokens? Yes please. Presale’s low barrier ($10 min) opens it to everyone. Community events sound epic.
minotaurus presale
WilliamPargy
22 Oct 25 at 2:06 am
В Сочи клиника «Детокс» предлагает полный курс вывода из запоя в стационаре. Круглосуточный медицинский контроль гарантирует безопасность и эффективность лечения.
Ознакомиться с деталями – [url=https://vyvod-iz-zapoya-sochi24.ru/]вывод из запоя на дому круглосуточно[/url]
DavidExarl
22 Oct 25 at 2:08 am
I enjoy looking through an article that will
make men and women think. Also, many thanks for permitting me to comment!
Finxor Gpt
22 Oct 25 at 2:08 am
топ интернет агентств [url=http://www.luchshie-digital-agencstva.ru]топ интернет агентств[/url] .
lychshie digital agentstva_bdoi
22 Oct 25 at 2:09 am
кто такой сео в компании [url=reiting-seo-agentstv.ru]кто такой сео в компании[/url] .
reiting seo agentstv_upsa
22 Oct 25 at 2:10 am
Капельница от запоя на дому в Нижнем Новгороде — удобное решение для тех, кто не может посетить клинику. Наши специалисты приедут к вам домой и проведут необходимую процедуру.
Углубиться в тему – [url=https://vyvod-iz-zapoya-nizhnij-novgorod13.ru/]вывод из запоя вызов в нижний новгороде[/url]
StevenLat
22 Oct 25 at 2:11 am
вопросы юридического перевода [url=https://www.teletype.in/@alexd78/HN462R01hzy]https://www.teletype.in/@alexd78/HN462R01hzy[/url] .
Vidi perevodov v buro Perevod i Pravo_hhst
22 Oct 25 at 2:12 am
Где купить МДМА в Камень-на-Обие?Здравствуйте, ищу проверенный магазин – нашел https://vkusnoivkusno.ru
. Цены вменяемые, доставка работает. Кто-нибудь пользовался их услугами? Насколько хороший товар?
Stevenref
22 Oct 25 at 2:12 am
купить диплом техникума в новокузнецке [url=https://frei-diplom10.ru/]купить диплом техникума в новокузнецке[/url] .
Diplomi_xfEa
22 Oct 25 at 2:13 am
kraken vk4
kraken вход
JamesDaync
22 Oct 25 at 2:13 am