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!
Hello there! This article could not be written any better!
Looking through this article reminds me of my previous roommate!
He constantly kept preaching about this. I will send this information to him.
Pretty sure he will have a great read. Thanks for sharing!
https://28bet88.com/
26 Oct 25 at 12:52 pm
1xbet ?yelik [url=http://1xbet-10.com]http://1xbet-10.com[/url] .
1xbet_ffea
26 Oct 25 at 12:53 pm
certainly like your web site however you have to check the spelling on several
of your posts. Several of them are rife with spelling problems and I find it very troublesome to inform the truth however I will definitely come again again.
m bs2web at
26 Oct 25 at 12:53 pm
кракен онлайн
kraken СПб
JamesDaync
26 Oct 25 at 12:57 pm
xbet [url=www.1xbet-13.com]xbet[/url] .
1xbet_pcKa
26 Oct 25 at 12:57 pm
скачать мостбет на телефон [url=https://mostbet12032.ru/]https://mostbet12032.ru/[/url]
mostbet_kg_vwmt
26 Oct 25 at 12:58 pm
This is really attention-grabbing, You’re a very skilled blogger.
I have joined your feed and look ahead to in search of
more of your wonderful post. Additionally, I have
shared your website in my social networks
88i link
26 Oct 25 at 12:59 pm
Crow Pose In Yoga
PHP hook, building hooks in your application – Sjoerd Maessen blog at Sjoerd Maessen blog
Crow Pose In Yoga
26 Oct 25 at 12:59 pm
My family every time say that I am wasting my time here at web, but I know
I am getting knowledge all the time by reading thes good posts.
buôn bán nội tạng
26 Oct 25 at 12:59 pm
медтехника [url=https://medicinskaya-tehnika.ru/]https://medicinskaya-tehnika.ru/[/url] .
medicinskaya tehnika_zwEi
26 Oct 25 at 1:01 pm
1xbet t?rkiye [url=http://www.1xbet-14.com]1xbet t?rkiye[/url] .
1xbet_zjet
26 Oct 25 at 1:01 pm
аппараты медицинские [url=http://medicinskoe–oborudovanie.ru]http://medicinskoe–oborudovanie.ru[/url] .
medicinskoe oborydovanie_cgei
26 Oct 25 at 1:01 pm
1 x bet giri? [url=http://1xbet-10.com/]http://1xbet-10.com/[/url] .
1xbet_dlea
26 Oct 25 at 1:02 pm
промокод мостбет [url=https://mostbet12031.ru/]промокод мостбет[/url]
mostbet_kg_shMa
26 Oct 25 at 1:02 pm
войти в мостбет [url=www.mostbet12031.ru]www.mostbet12031.ru[/url]
mostbet_kg_lrMa
26 Oct 25 at 1:04 pm
Today, I went to the beachfront with my kids.
I found a sea shell and gave it to my 4 year old daughter and said “You can hear the ocean if you put this to your ear.” She put
the shell to her ear and screamed. There was a hermit crab inside and
it pinched her ear. She never wants to go back!
LoL I know this is totally off topic but I had to tell someone!
Wow
26 Oct 25 at 1:04 pm
Do you have any video of that? I’d like to find out more details.
تعمیر ماکروفر کنوود
26 Oct 25 at 1:04 pm
Mystake is also one of the best Bitcoin betting sites for horse racing.
site
26 Oct 25 at 1:04 pm
медсестра которая купила диплом врача [url=http://frei-diplom15.ru]медсестра которая купила диплом врача[/url] .
Diplomi_tqoi
26 Oct 25 at 1:05 pm
1xbwt giri? [url=1xbet-17.com]1xbet-17.com[/url] .
1xbet_fqpl
26 Oct 25 at 1:05 pm
mostbet casino [url=www.mostbet12032.ru]www.mostbet12032.ru[/url]
mostbet_kg_lkmt
26 Oct 25 at 1:06 pm
https://mediuomo.shop/# Viagra generico online Italia
Hermanereli
26 Oct 25 at 1:06 pm
Remarkable! Its truly amazing paragraph, I have got much clear
idea concerning from this post.
Check This Out
26 Oct 25 at 1:06 pm
Плесень ушла после обработка от тараканов стоимость, спасибо!
дезинфекция
KennethceM
26 Oct 25 at 1:07 pm
мост бет [url=mostbet12032.ru]mostbet12032.ru[/url]
mostbet_kg_blmt
26 Oct 25 at 1:08 pm
I do not even know how I ended up here, but I thought this post was
good. I do not know who you are but certainly you
are going to a famous blogger if you aren’t already 😉 Cheers!
Feel free to surf to my web-site – slg game updates
slg game updates
26 Oct 25 at 1:12 pm
1x lite [url=https://www.1xbet-10.com]https://www.1xbet-10.com[/url] .
1xbet_tsea
26 Oct 25 at 1:12 pm
Ukrainian President Volodymyr Zelensky condemned Russian attacks on the Ukrainian regions of Kharkiv, Zaporizhzhia and Sumy on Monday, saying that the Kremlin intends to “humiliate diplomatic efforts” just hours before European leaders visit the White House.
[url=https://kra-42cc.com]kra40 cc[/url]
“The Russian war machine continues to destroy lives despite everything,” Zelensky said in a statement, hours before he’s due to meet US President Donald Trump in the Oval Office. “That is precisely why we are seeking assistance to put an end to the killings. That is why reliable security guarantees are required. That is why Russia should not be rewarded for its participation in this war.”
[url=https://kra41at.com]kra35[/url]
“Everyone seeks dignified peace and true security,” the Ukrainian president said. “And at this very moment, the Russians are attacking Kharkiv, Zaporizhzhia, the Sumy region, and Odesa, destroying residential buildings and our civilian infrastructure.”
At least seven people were killed in Russia’s attack? on Kharkiv and a further three killed in the ballistic missile strike on the city of Zaporizhzhia, with scores more injured, according to Ukrainian authorities.
“This was a demonstrative and cynical Russian strike,” Zelensky added.
kra37 сс
https://kra—42cc.ru
KeithCrima
26 Oct 25 at 1:14 pm
1xbet ?ye ol [url=https://1xbet-17.com/]1xbet ?ye ol[/url] .
1xbet_iepl
26 Oct 25 at 1:15 pm
кракен зеркало
кракен вход
JamesDaync
26 Oct 25 at 1:16 pm
конспирация достойная, товар оказался отличным, кроли заценили. будем еще работать купить скорость, кокаин, мефедрон, гашиш неужели ркс такая шляпа?
Georgeidots
26 Oct 25 at 1:18 pm
Ukrainian President Volodymyr Zelensky condemned Russian attacks on the Ukrainian regions of Kharkiv, Zaporizhzhia and Sumy on Monday, saying that the Kremlin intends to “humiliate diplomatic efforts” just hours before European leaders visit the White House.
[url=https://kra–41.cc]kra35 cc[/url]
“The Russian war machine continues to destroy lives despite everything,” Zelensky said in a statement, hours before he’s due to meet US President Donald Trump in the Oval Office. “That is precisely why we are seeking assistance to put an end to the killings. That is why reliable security guarantees are required. That is why Russia should not be rewarded for its participation in this war.”
[url=https://kra-42—cc.ru]kra39[/url]
“Everyone seeks dignified peace and true security,” the Ukrainian president said. “And at this very moment, the Russians are attacking Kharkiv, Zaporizhzhia, the Sumy region, and Odesa, destroying residential buildings and our civilian infrastructure.”
At least seven people were killed in Russia’s attack? on Kharkiv and a further three killed in the ballistic missile strike on the city of Zaporizhzhia, with scores more injured, according to Ukrainian authorities.
“This was a demonstrative and cynical Russian strike,” Zelensky added.
kra38 at
https://kra-42-at.net
KeithCrima
26 Oct 25 at 1:19 pm
1xbet giri? g?ncel [url=http://1xbet-10.com]http://1xbet-10.com[/url] .
1xbet_xyea
26 Oct 25 at 1:20 pm
мостбеь [url=http://mostbet12031.ru/]http://mostbet12031.ru/[/url]
mostbet_kg_wvMa
26 Oct 25 at 1:21 pm
Таким образом, бесплатная юридическая помощь в Москве —
это необходимый ресурс для
жителей столицы. Консультации помогают людям лучше понимать свои права и обязанности.
https://www.schoolgear.co.nz/user/profile/16396
26 Oct 25 at 1:21 pm
Thanks for sharing your thoughts. I really appreciate your efforts
and I will be waiting for your next write ups thank you once again.
au888
26 Oct 25 at 1:21 pm
1x bet [url=https://www.1xbet-13.com]1x bet[/url] .
1xbet_kmKa
26 Oct 25 at 1:23 pm
click the up coming site
PHP hook, building hooks in your application – Sjoerd Maessen blog at Sjoerd Maessen blog
click the up coming site
26 Oct 25 at 1:25 pm
1xbet tr giri? [url=https://www.1xbet-17.com]https://www.1xbet-17.com[/url] .
1xbet_hupl
26 Oct 25 at 1:25 pm
Hello, I enjoy reading all of your article post.
I like to write a little comment to support you.
material
26 Oct 25 at 1:26 pm
Благодарю за дезинфекция после умерших! Проблема решена быстро.
обработка от клопов в отеле
KennethceM
26 Oct 25 at 1:26 pm
bahis sitesi 1xbet [url=https://1xbet-13.com]bahis sitesi 1xbet[/url] .
1xbet_maKa
26 Oct 25 at 1:26 pm
медтехника [url=http://www.medicinskaya-tehnika.ru]http://www.medicinskaya-tehnika.ru[/url] .
medicinskaya tehnika_hrEi
26 Oct 25 at 1:26 pm
https://moneylead.gg/
MoneyLead
26 Oct 25 at 1:27 pm
Цены на обработка от тараканов выросли? Обсудим.
уничтожение клопов
KennethceM
26 Oct 25 at 1:27 pm
1xbet g?ncel adres [url=https://www.1xbet-10.com]1xbet g?ncel adres[/url] .
1xbet_fsea
26 Oct 25 at 1:28 pm
TeknoTrend — официальный поставщик финских материалов TEKNOS для защиты древесины и фасадов. У нас Teknos Nordica Eko, Aqua Primer, Aquatop, герметики и антисептики для промышленных и частных проектов. Поможем подобрать систему, вышлем техкарты, организуем опт и доставку по РФ. Цены, наличие и консультации смотрите на https://teknotrend.ru — заказывайте краски и лаки TEKNOS с гарантией качества и поддержкой технологов. Контакты: +7 (915) 024 33 88.
bucyzgimmut
26 Oct 25 at 1:28 pm
kraken обмен
кракен онион
JamesDaync
26 Oct 25 at 1:28 pm
Ukrainian President Volodymyr Zelensky condemned Russian attacks on the Ukrainian regions of Kharkiv, Zaporizhzhia and Sumy on Monday, saying that the Kremlin intends to “humiliate diplomatic efforts” just hours before European leaders visit the White House.
[url=https://kra–41—cc.ru]kra39 at[/url]
“The Russian war machine continues to destroy lives despite everything,” Zelensky said in a statement, hours before he’s due to meet US President Donald Trump in the Oval Office. “That is precisely why we are seeking assistance to put an end to the killings. That is why reliable security guarantees are required. That is why Russia should not be rewarded for its participation in this war.”
[url=https://kra42-at.com]kra39 cc[/url]
“Everyone seeks dignified peace and true security,” the Ukrainian president said. “And at this very moment, the Russians are attacking Kharkiv, Zaporizhzhia, the Sumy region, and Odesa, destroying residential buildings and our civilian infrastructure.”
[url=https://kra—41–at.ru]kra37 сс[/url]
At least seven people were killed in Russia’s attack? on Kharkiv and a further three killed in the ballistic missile strike on the city of Zaporizhzhia, with scores more injured, according to Ukrainian authorities.
[url=https://kra42-at.net]kra41 сс[/url]
“This was a demonstrative and cynical Russian strike,” Zelensky added.
kra41 at
https://kra-41-cc.net
Ronniefluem
26 Oct 25 at 1:28 pm
1xbet turkiye [url=https://1xbet-17.com/]1xbet turkiye[/url] .
1xbet_ampl
26 Oct 25 at 1:29 pm