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!
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://kra41—at.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://kra-42at.com]kra41 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.”
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.
kra41 сс
https://kra—42–at.ru
KeithCrima
26 Oct 25 at 10:33 am
Цены на дезинфекция офисов выросли? Обсудим.
уничтожение клопов горячим туманом
KennethceM
26 Oct 25 at 10:35 am
поставка медицинского оборудования [url=http://medoborudovanie-postavka.ru/]поставка медицинского оборудования[/url] .
postavka medicinskogo oborydovaniya_hhsn
26 Oct 25 at 10:37 am
1 xbet [url=1xbet-16.com]1 xbet[/url] .
1xbet_eaOn
26 Oct 25 at 10:37 am
1xbet g?ncel giri? [url=1xbet-12.com]1xbet g?ncel giri?[/url] .
1xbet_mrSr
26 Oct 25 at 10:39 am
1xbet guncel [url=http://1xbet-13.com]1xbet guncel[/url] .
1xbet_frKa
26 Oct 25 at 10:40 am
наркологическое отделение наркологии [url=http://narkologicheskaya-klinika-23.ru]http://narkologicheskaya-klinika-23.ru[/url] .
narkologicheskaya klinika_tbet
26 Oct 25 at 10:41 am
kraken онлайн
кракен онлайн
JamesDaync
26 Oct 25 at 10:44 am
xbet giri? [url=https://1xbet-10.com]https://1xbet-10.com[/url] .
1xbet_ejea
26 Oct 25 at 10:45 am
медицинская техника [url=https://medicinskaya-tehnika.ru]медицинская техника[/url] .
medicinskaya tehnika_pcEi
26 Oct 25 at 10:46 am
bahis sitesi 1xbet [url=https://1xbet-13.com/]bahis sitesi 1xbet[/url] .
1xbet_vbKa
26 Oct 25 at 10:46 am
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—41cc.ru]kra36 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–41—at.ru]kra42 at[/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
https://kra-41—at.ru
Jamessew
26 Oct 25 at 10:46 am
This is my first time pay a visit at here and i am really impressed to read everthing at alone place.
webpage
26 Oct 25 at 10:46 am
1xbet giri? [url=1xbet-12.com]1xbet giri?[/url] .
1xbet_caSr
26 Oct 25 at 10:47 am
Цена на дезинфекция помещений от вирусов адекватная, результат супер.
обработка от педикулеза
KennethceM
26 Oct 25 at 10:49 am
1xbet guncel [url=www.1xbet-14.com]1xbet guncel[/url] .
1xbet_pjet
26 Oct 25 at 10:49 am
1xbet g?ncel [url=https://1xbet-16.com/]1xbet g?ncel[/url] .
1xbet_clOn
26 Oct 25 at 10:49 am
Oh my goodness! Amazing article dude! Thank you, However I
am going through difficulties with your RSS. I don’t know the reason why I am unable to subscribe to it.
Is there anybody having identical RSS problems?
Anybody who knows the answer will you kindly respond?
Thanx!!
Top 10 Viral Moments in Entertainment This Week
26 Oct 25 at 10:51 am
1xbet resmi giri? [url=1xbet-14.com]1xbet resmi giri?[/url] .
1xbet_pret
26 Oct 25 at 10:53 am
Thanks for sharing such a fastidious thought, post is pleasant,
thats why i have read it fully
black nail polish
26 Oct 25 at 10:53 am
New materials are here: https://primorskival.si
VernonFut
26 Oct 25 at 10:54 am
поставщик медицинского оборудования [url=medoborudovanie-postavka.ru]поставщик медицинского оборудования[/url] .
postavka medicinskogo oborydovaniya_qfsn
26 Oct 25 at 10:54 am
[url=https://playalbertajeuxetparisenlignecanadasspace.quora.com/ ] Alberta[/url] this is legal casino canada? or only kyrasao
HarryApopy
26 Oct 25 at 10:54 am
Hi thеre this is kinda of ߋff topic ƅut I was wonhdering if blogs uѕe WYSIWYG editors οr
if yⲟu һave to manuaslly code ᴡith HTML. I’m staring a
blog soon bᥙt have no coding skills so І wɑnted to get advice frߋm someone
with experience. Any һelp ᴡould bｅ enormously appreciated!
Review mу blog: web page
web page
26 Oct 25 at 10:54 am
Currently reading: https://www.sportsoddshistory.com
Randallspeal
26 Oct 25 at 10:55 am
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://kra41-cc.net]kra41 сс[/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—41-cc.ru]kra35 at[/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.
kra40 cc
https://kra42cc.com
Kennethtip
26 Oct 25 at 10:55 am
Don’t miss the main points: https://theshaderoom.com
Stevender
26 Oct 25 at 10:56 am
1xbet t?rkiye [url=www.1xbet-12.com/]1xbet t?rkiye[/url] .
1xbet_ksSr
26 Oct 25 at 10:57 am
мостбет сайт вход [url=mostbet12032.ru]mostbet12032.ru[/url]
mostbet_kg_znmt
26 Oct 25 at 10:58 am
I could not refrain from commenting. Well written!
bokep viral terbaru
26 Oct 25 at 10:58 am
мастбет [url=www.mostbet12032.ru]www.mostbet12032.ru[/url]
mostbet_kg_flmt
26 Oct 25 at 11:00 am
1xbet g?ncel adres [url=https://1xbet-10.com/]1xbet g?ncel adres[/url] .
1xbet_qhea
26 Oct 25 at 11:01 am
1xbet giri? 2025 [url=1xbet-16.com]1xbet giri? 2025[/url] .
1xbet_hcOn
26 Oct 25 at 11:01 am
кракен vk4
кракен vk3
JamesDaync
26 Oct 25 at 11:01 am
мостбет [url=www.mostbet12031.ru]мостбет[/url]
mostbet_kg_ctMa
26 Oct 25 at 11:01 am
engagement-forum – I would look for domain age, SSL details, contact information, and user reviews before engaging.
Dallas Mayhan
26 Oct 25 at 11:01 am
1 x bet giri? [url=https://1xbet-13.com/]1xbet-13.com[/url] .
1xbet_fhKa
26 Oct 25 at 11:02 am
кракен qr код
кракен онлайн
JamesDaync
26 Oct 25 at 11:02 am
Hello there! Do you know if they make any plugins to assist with SEO? I’m trying to get my blog to rank for some targeted keywords but I’m not seeing very good results. If you know of any please share. Thanks!
kra42 at
LewisGuatt
26 Oct 25 at 11:02 am
Нужна обработка от клопов с гарантией для автомобиля, посоветуйте.
профессиональная дезинсекция
KennethceM
26 Oct 25 at 11:06 am
1xbet t?rkiye [url=http://1xbet-14.com]1xbet t?rkiye[/url] .
1xbet_cmet
26 Oct 25 at 11:07 am
Цены на дератизация подвалов выросли? Обсудим.
уничтожение тараканов на кухне
KennethceM
26 Oct 25 at 11:08 am
1xbet mobi [url=http://www.1xbet-16.com]1xbet mobi[/url] .
1xbet_jhOn
26 Oct 25 at 11:09 am
медицинская техника [url=http://medicinskaya-tehnika.ru/]медицинская техника[/url] .
medicinskaya tehnika_ehEi
26 Oct 25 at 11:10 am
нарколог психолог [url=https://narkologicheskaya-klinika-23.ru]https://narkologicheskaya-klinika-23.ru[/url] .
narkologicheskaya klinika_rwet
26 Oct 25 at 11:10 am
Hi! Do you know if they make any plugins to help with SEO?
I’m trying to get my blog to rank for some
targeted keywords but I’m not seeing very good gains.
If you know of any please share. Kudos!
beef casino скачать
26 Oct 25 at 11:10 am
1xbet tr [url=www.1xbet-12.com]1xbet tr[/url] .
1xbet_maSr
26 Oct 25 at 11:11 am
кракен официальный сайт
кракен официальный сайт
JamesDaync
26 Oct 25 at 11:13 am
поставка медоборудования [url=http://medoborudovanie-postavka.ru/]http://medoborudovanie-postavka.ru/[/url] .
postavka medicinskogo oborydovaniya_tgsn
26 Oct 25 at 11:14 am
1xbet turkey [url=http://1xbet-14.com/]1xbet turkey[/url] .
1xbet_cget
26 Oct 25 at 11:15 am