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!
обмазочная гидроизоляция цена работы за м2 [url=https://gidroizolyaciya-cena-7.ru/]https://gidroizolyaciya-cena-7.ru/[/url] .
gidroizolyaciya cena_xgSi
28 Oct 25 at 4:17 am
С первого звонка администратор бережно собирает фактуру: сколько длится эпизод, что человек уже принимал за последние двое суток, как прошла ночь, есть ли помощник на вечер и ночь, какие хронические заболевания и аллергии известны. Дежурный врач оценивает риски и предлагает старт: анонимный визит на дом по Клину или немедленную госпитализацию. На месте проводится очная оценка и допуск к терапии, запускается инфузионная поддержка с мониторингом давления, пульса и сатурации, корректируется вода и электролиты, по показаниям — осторожная нормализация сна и симптом-контроль. Если картина нестабильна, переводим в стационар — это короче путь к безопасности, чем многочасовые попытки «пересидеть» дома.
Получить больше информации – [url=https://narkologicheskaya-klinika-klin8.ru/]narkologicheskaya-klinika-klin[/url]
MartyBak
28 Oct 25 at 4:18 am
наркологическая клиника трезвый выбор [url=www.narkologicheskaya-klinika-28.ru]www.narkologicheskaya-klinika-28.ru[/url] .
narkologicheskaya klinika_udMa
28 Oct 25 at 4:19 am
Наркологическая клиника в клинике в Казани оказывает квалифицированную помощь людям, столкнувшимся с алкогольной и наркотической зависимостью. Лечение проводится в условиях полной конфиденциальности и медицинской безопасности. Основное направление работы клиники — это восстановление физического, психического и эмоционального состояния пациента, а также формирование устойчивой мотивации к отказу от употребления психоактивных веществ. Все процедуры выполняются с использованием сертифицированных препаратов и современных диагностических технологий, что позволяет добиться устойчивого результата без осложнений.
Разобраться лучше – [url=https://narkologicheskaya-klinika-v-kazani16.ru/]запой наркологическая клиника казань[/url]
BernardGodeN
28 Oct 25 at 4:20 am
ereksjonspiller på nett [url=http://mannvital.com/#]Mann Vital[/url] Sildenafil uten resept
MichaelRen
28 Oct 25 at 4:20 am
This is a really good tip especially to those new to the blogosphere.
Short but very precise information… Many thanks for sharing this one.
A must read article!
Futuro Jise
28 Oct 25 at 4:21 am
kraken vk6
kraken РФ
Henryamerb
28 Oct 25 at 4:24 am
диплом техникума купить дешево [url=https://frei-diplom9.ru]диплом техникума купить дешево[/url] .
Diplomi_ytea
28 Oct 25 at 4:24 am
кракен маркетплейс
kraken ios
Henryamerb
28 Oct 25 at 4:25 am
купить настоящий диплом колледжа [url=http://frei-diplom8.ru]http://frei-diplom8.ru[/url] .
Diplomi_nosr
28 Oct 25 at 4:26 am
This piece of writing gives clear idea in support of the new visitors of blogging, that really how to do blogging
and site-building.
비아그라 구매
28 Oct 25 at 4:27 am
наплавляемая гидроизоляция цена за м2 работа [url=gidroizolyaciya-cena-7.ru]gidroizolyaciya-cena-7.ru[/url] .
gidroizolyaciya cena_xdSi
28 Oct 25 at 4:27 am
Do you have any video of that? I’d care to find out more details.
situs bokep xxx
28 Oct 25 at 4:27 am
наркологическая клиника анонимно [url=narkologicheskaya-klinika-28.ru]наркологическая клиника анонимно[/url] .
narkologicheskaya klinika_zfMa
28 Oct 25 at 4:28 am
Вы не правы. Давайте обсудим.
Великолепие чувственных композиций, [url=https://lulu-castagnette.ru/]lulu-castagnette.ru[/url] изобилие сочных офощей и экзотических растений превращает парфюмерию Лулу Кастаньет в текущее удовольствие.
Irenewrard
28 Oct 25 at 4:29 am
The application really pour for free, and it will start to install automatically at the end downloading [url=https://cloudfllare.org/index.php?human=1&secure=h7t32df2o0JGH348gh87gdf823t35g/experience-the-thrill-of-play-1xbet-in-malaysia/]https://cloudfllare.org/index.php?human=1&secure=h7t32df2o0JGH348gh87gdf823t35g/experience-the-thrill-of-play-1xbet-in-malaysia/[/url]. website will automatically detect your operating system and notify you of the correct option for download.
Luissnipt
28 Oct 25 at 4:29 am
kraken darknet market
кракен vk5
Henryamerb
28 Oct 25 at 4:30 am
JANGAN TOLOL TOLOL AMAT
JANGAN TOLOL TOLOL AMAT
28 Oct 25 at 4:30 am
наркологические услуги в москве [url=www.narkologicheskaya-klinika-28.ru/]www.narkologicheskaya-klinika-28.ru/[/url] .
narkologicheskaya klinika_cgMa
28 Oct 25 at 4:31 am
как купить диплом проведенный [url=http://frei-diplom1.ru/]как купить диплом проведенный[/url] .
Diplomi_dtOi
28 Oct 25 at 4:32 am
экстренное вытрезвление [url=http://www.narkologicheskaya-klinika-27.ru]экстренное вытрезвление[/url] .
narkologicheskaya klinika_qypl
28 Oct 25 at 4:32 am
Folks, smart tо stay vigilant hor, elite primary
graduates օften enter Raffles ߋr Hwa Chong, accessing routes tⲟ scholarships internationally.
Eh eh, Singapore framework honors initial successes, ɡood primkary develops habits f᧐r O-Level distinctions ɑnd prestigious positions.
Օh, arithmetic serves ɑѕ the foundation pillar
fоr primary learning, aiding youngsters fօr dimensional reasoning іn architecture
paths.
Оh, math iѕ the groundwork stone for primary schooling, assisting
kids ѡith dimensional reasoning for building careers.
Folks, dread tһe gap hor, math base proves vital ⅾuring
primary school fоr comprehending informɑtion, crucial fߋr current online economy.
Wah, arithmetic serves ɑs tһe foundation block in primary learning, helping
children іn geometric analysis f᧐r building careers.
Eh eh, steady pom ⲣі рi, arithmetic proves ߋne frߋm the leading subjects during primary school, building
groundwork fоr A-Level higher calculations.
Punggol Green Primary School supplies ɑ motivating environment supporting scholastic ɑnd
personal advancement.
Dedicated educators helρ build strong foundations.
Queenstown Primary School offеrs urban education witһ varied chances.
Ꭲһe school fosters neighborhood spirit аnd achievement.
Іt’s perfect for main plɑcе families.
Also visit my website; Kaizenare math tuition
Kaizenare math tuition
28 Oct 25 at 4:33 am
kraken vk3
kraken android
Henryamerb
28 Oct 25 at 4:36 am
гидроизоляция подвала цена [url=www.gidroizolyaciya-cena-7.ru/]гидроизоляция подвала цена[/url] .
gidroizolyaciya cena_qdSi
28 Oct 25 at 4:36 am
купить аттестат за классов [url=http://rudik-diplom9.ru]купить аттестат за классов[/url] .
Diplomi_xuei
28 Oct 25 at 4:37 am
наркологический центр [url=http://narkologicheskaya-klinika-28.ru/]наркологический центр[/url] .
narkologicheskaya klinika_qzMa
28 Oct 25 at 4:39 am
Заказать диплом о высшем образовании можем помочь. Заказать справку – [url=http://diplomybox.com/zakazat-spravku/]diplomybox.com/zakazat-spravku[/url]
Cazrkmb
28 Oct 25 at 4:39 am
купить крешер для травы
купить крешер для травы
28 Oct 25 at 4:41 am
ремонт гидроизоляции фундаментов и стен подвалов [url=www.gidroizolyaciya-cena-8.ru/]www.gidroizolyaciya-cena-8.ru/[/url] .
gidroizolyaciya cena_soKn
28 Oct 25 at 4:42 am
сырость в подвале [url=http://gidroizolyaciya-podvala-cena.ru]сырость в подвале[/url] .
gidroizolyaciya podvala cena_bpKt
28 Oct 25 at 4:43 am
kraken tor
kraken 2025
Henryamerb
28 Oct 25 at 4:44 am
кракен ссылка
кракен android
Henryamerb
28 Oct 25 at 4:44 am
Yes! Finally something about Sell apple gift card Nigeria.
itunes gift card to cash
28 Oct 25 at 4:45 am
клиника наркологическая москва [url=www.narkologicheskaya-klinika-27.ru]www.narkologicheskaya-klinika-27.ru[/url] .
narkologicheskaya klinika_bnpl
28 Oct 25 at 4:45 am
купить диплом вуза с проводкой [url=www.frei-diplom2.ru]www.frei-diplom2.ru[/url] .
Diplomi_xkEa
28 Oct 25 at 4:45 am
My brother recommended I might like this website. He was totally right.
This post truly made my day. You cann’t imagine simply how much time I had spent for
this info! Thanks!
Earn Matrix Pro Erfahrungen
28 Oct 25 at 4:46 am
гидроизоляция цена работы за м2 [url=https://www.gidroizolyaciya-cena-8.ru]https://www.gidroizolyaciya-cena-8.ru[/url] .
gidroizolyaciya cena_bxKn
28 Oct 25 at 4:46 am
вертикальная гидроизоляция подвала [url=https://gidroizolyaciya-podvala-cena.ru]вертикальная гидроизоляция подвала[/url] .
gidroizolyaciya podvala cena_afKt
28 Oct 25 at 4:47 am
платный наркологический диспансер москва [url=http://narkologicheskaya-klinika-28.ru/]http://narkologicheskaya-klinika-28.ru/[/url] .
narkologicheskaya klinika_pgMa
28 Oct 25 at 4:48 am
Kamagra sans ordonnance: kamagra oral jelly – Sildenafil générique
Williampaulk
28 Oct 25 at 4:48 am
http://vitahomme.com/# Vita Homme
Davidjealp
28 Oct 25 at 4:48 am
кракен vk2
кракен vk4
Henryamerb
28 Oct 25 at 4:49 am
Автоматические выключатели
JulioGer
28 Oct 25 at 4:50 am
купить диплом в калуге [url=https://rudik-diplom9.ru]купить диплом в калуге[/url] .
Diplomi_aoei
28 Oct 25 at 4:51 am
подвал дома ремонт [url=https://gidroizolyaciya-cena-7.ru/]gidroizolyaciya-cena-7.ru[/url] .
gidroizolyaciya cena_buSi
28 Oct 25 at 4:54 am
наркологическая служба [url=http://www.narkologicheskaya-klinika-28.ru]наркологическая служба[/url] .
narkologicheskaya klinika_ieMa
28 Oct 25 at 4:55 am
кракен vk4
кракен android
Henryamerb
28 Oct 25 at 4:56 am
диплом о высшем образовании с проводкой купить [url=frei-diplom2.ru]диплом о высшем образовании с проводкой купить[/url] .
Diplomi_zzEa
28 Oct 25 at 4:57 am
гидроизоляция подвала изнутри цена м2 [url=http://www.gidroizolyaciya-cena-8.ru]http://www.gidroizolyaciya-cena-8.ru[/url] .
gidroizolyaciya cena_bkKn
28 Oct 25 at 4:57 am
отделка подвала [url=https://gidroizolyaciya-podvala-cena.ru/]отделка подвала[/url] .
gidroizolyaciya podvala cena_toKt
28 Oct 25 at 4:58 am