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!
rankforge.click – The navigation is intuitive, I found what I needed in just a few clicks.
Jonas Tavares
18 Oct 25 at 8:09 am
keywordorbit.click – Already bookmarked this — I think I’ll keep checking back here.
Ezequiel Hansard
18 Oct 25 at 8:10 am
перепланировка под ключ стоимость [url=https://www.zakazat-proekt-pereplanirovki-kvartiry11.ru]https://www.zakazat-proekt-pereplanirovki-kvartiry11.ru[/url] .
zakazat proekt pereplanirovki kvartiri_ryet
18 Oct 25 at 8:10 am
https://t.me/s/Official_1xbet_1xbet/1824
Josephadvem
18 Oct 25 at 8:10 am
Сливы курсов по подготовке к ЕГЭ 2026 https://courses-ege.ru
courses-ege-938
18 Oct 25 at 8:12 am
мелбет условия бонуса на депозит [url=https://melbetbonusy.ru/]мелбет условия бонуса на депозит[/url] .
melbet_bgOi
18 Oct 25 at 8:12 am
trafficpulse.click – I just visited and the site feels sleek with a very modern clean layout.
Hoyt Corredor
18 Oct 25 at 8:12 am
Онлайн СМС сервис
Ricardopam
18 Oct 25 at 8:12 am
Своевременный вызов нарколога позволяет снизить риски осложнений, таких как судорожный синдром, панкреатит или сердечная недостаточность, часто сопровождающие тяжелое алкогольное или наркотическое отравление. По данным исследований, раннее вмешательство сокращает сроки госпитализации и улучшает прогнозы выздоровления.
Углубиться в тему – [url=https://narkolog-na-dom-chelyabinsk13.ru/]нарколог на дом круглосуточно цены в челябинске[/url]
Charlesnak
18 Oct 25 at 8:14 am
Стационарное лечение запоя в Воронеже — гарантированная анонимность и комфортные условия. Мы предлагаем индивидуальный подход к каждому пациенту, обеспечивая полное восстановление организма и предотвращение рецидивов.
Разобраться лучше – [url=https://vyvod-iz-zapoya-v-stacionare-voronezh24.ru/]стационар вывод из запоя в воронеже[/url]
Stuartbooms
18 Oct 25 at 8:14 am
Very nice blog post. I absolutely love this website.
Thanks!
Kaynak
18 Oct 25 at 8:14 am
cialis: PilloleVerdi – cialis prezzo
JosephPseus
18 Oct 25 at 8:15 am
https://t.me/Official_1xbet_1xbet/1661
Josephadvem
18 Oct 25 at 8:15 am
перепланировка офиса [url=https://soglasovanie-pereplanirovki-kvartiry4.ru/]перепланировка офиса[/url] .
soglasovanie pereplanirovki kvartiri _cvOr
18 Oct 25 at 8:16 am
https://t.me/Official_1xbet_1xbet/1671
Josephadvem
18 Oct 25 at 8:16 am
заказ перепланировки квартиры [url=soglasovanie-pereplanirovki-kvartiry3.ru]soglasovanie-pereplanirovki-kvartiry3.ru[/url] .
soglasovanie pereplanirovki kvartiri _kiPi
18 Oct 25 at 8:19 am
согласование [url=http://soglasovanie-pereplanirovki-kvartiry11.ru/]http://soglasovanie-pereplanirovki-kvartiry11.ru/[/url] .
soglasovanie pereplanirovki kvartiri _msMi
18 Oct 25 at 8:19 am
экспертиза перепланировки квартиры [url=http://soglasovanie-pereplanirovki-kvartiry14.ru]http://soglasovanie-pereplanirovki-kvartiry14.ru[/url] .
soglasovanie pereplanirovki kvartiri _qcEl
18 Oct 25 at 8:21 am
http://potenzvital.com/# potenzmittel cialis
LarryArrix
18 Oct 25 at 8:22 am
Quality content is the main to interest the users to go to see the site, that’s what this website is providing.
Locksmith company
18 Oct 25 at 8:23 am
Your style is so unique compared to other people I’ve read
stuff from. Many thanks for posting when you’ve got the opportunity,
Guess I will just bookmark this blog.
Meteor Profit Scam
18 Oct 25 at 8:24 am
сколько стоит оформить перепланировку квартиры [url=https://stoimost-soglasovaniya-pereplanirovki-kvartiry.ru]https://stoimost-soglasovaniya-pereplanirovki-kvartiry.ru[/url] .
stoimost soglasovaniya pereplanirovki kvartiri_jwPt
18 Oct 25 at 8:25 am
программы https://softprogram-free.ru/
Maximodaf
18 Oct 25 at 8:27 am
Just swapped some ETH for $MTAUR in the presale; the process was seamless on multiple chains. The in-game currency conversion gives real edge in play. This could rival Subway Surfers with crypto flair.
minotaurus coin
WilliamPargy
18 Oct 25 at 8:31 am
сколько стоит проект перепланировки [url=http://proekt-pereplanirovki-kvartiry16.ru]http://proekt-pereplanirovki-kvartiry16.ru[/url] .
proekt pereplanirovki kvartiri_hsMl
18 Oct 25 at 8:31 am
Курсы ЕГЭ биология https://courses-ege.ru
courses-ege-995
18 Oct 25 at 8:32 am
Thematic systems іn OMT’s curriculum link mathematics to raqte οf interеsts ⅼike modern technology,
sparking іnterest and drive fоr leading test scores.
Established іn 2013 ƅy Mr. Justin Tan, OMT Math Tuition һas helped numerous students ace exams ⅼike PSLE, O-Levels, and Ꭺ-Levels
with tested proƅlem-solving techniques.
Αѕ mathematics underpins Singapore’ѕ reputation for quality in international standards ⅼike PISA, math tuition іs
key tօ opｅning а kid’s рossible and securing academic advantages іn thiѕ core subject.
Math tuition in primary school bridges gaps іn classroom learning, mɑking sure students grasp complex subjects sucһ
as geometry and data analysis Ьefore the PSLE.
Ꮐiven thе high risks of O Levels for high school progression іn Singapore,
math tuition maximizes opportunities fⲟr leading grades аnd wantｅd placements.
Customized junior college tuition helps bridge tһe void from Օ Level to A Level math, makіng
suгe trainees adapt to tthe enhanced rigor ɑnd depth neеded.
OMT attracts attention ѡith іts curriculum made to support MOE’ѕ by including mindfulness strategies
t᧐ decrease math anxiety durіng researches.
Expert ideas іn videos gіve shortcuts lah, aiding ｙou fix
inquiries quicker ɑnd rack սp extra in examinations.
Bｙ highlighting conceptual understanding οver rote understanding, math tuition gears
ᥙp Singapore students fоr tһе advancing examination formats.
Ꮇʏ web blog … jc 1 exam papers
jc 1 exam papers
18 Oct 25 at 8:32 am
проект перепланировки квартиры цена [url=http://proekt-pereplanirovki-kvartiry17.ru/]проект перепланировки квартиры цена[/url] .
proekt pereplanirovki kvartiri_dsml
18 Oct 25 at 8:33 am
мелбет бонусы как ими пользоваться [url=https://melbetbonusy.ru]мелбет бонусы как ими пользоваться[/url] .
melbet_qqOi
18 Oct 25 at 8:34 am
проект перепланировки [url=proekt-pereplanirovki-kvartiry16.ru]proekt-pereplanirovki-kvartiry16.ru[/url] .
proekt pereplanirovki kvartiri_nhMl
18 Oct 25 at 8:34 am
obviously like your website however you need to take a look
at the spelling on quite a few of your posts. Many of them are rife with spelling
problems and I to find it very troublesome to inform the reality then again I
will surely come back again.
Window tinting
18 Oct 25 at 8:35 am
Подробности можно найти на официальном сайте Министерства здравоохранения РФ, где описаны стандарты оказания наркологической помощи и рекомендации по лечению зависимости Минздрав РФ — наркологическая помощь.
Разобраться лучше – [url=https://narkolog-na-dom-chelyabinsk13.ru/]вызов врача нарколога на дом[/url]
Charlesnak
18 Oct 25 at 8:36 am
заказ перепланировки квартиры [url=https://soglasovanie-pereplanirovki-kvartiry3.ru/]https://soglasovanie-pereplanirovki-kvartiry3.ru/[/url] .
soglasovanie pereplanirovki kvartiri _dePi
18 Oct 25 at 8:37 am
кто нибудь работает медсестрой по купленному диплому [url=www.frei-diplom14.ru]www.frei-diplom14.ru[/url] .
Diplomi_keoi
18 Oct 25 at 8:38 am
https://t.me/s/Official_1xbet_1xbet/1600
Josephadvem
18 Oct 25 at 8:38 am
сколько стоит согласование перепланировки [url=www.zakazat-proekt-pereplanirovki-kvartiry11.ru/]www.zakazat-proekt-pereplanirovki-kvartiry11.ru/[/url] .
zakazat proekt pereplanirovki kvartiri_cset
18 Oct 25 at 8:38 am
https://t.me/Official_1xbet_1xbet/1598
Josephadvem
18 Oct 25 at 8:39 am
Tình cờ thấy KING7BET — nền tảng live casino 24/7 với dealer HD,
bàn VIP, giao dịch an toàn và rút siêu nhanh.
Có bonus thành viên mới rất ổn. Hỗ
trợ 24/7 phản hồi rất nhanh. Rất hợp với ai thích slot RTP cao và
cá cược thể thao. Giao diện dễ dùng,
đáng để thử luôn.
king7bet
18 Oct 25 at 8:40 am
официальный сайт melbet [url=http://www.melbetbonusy.ru]http://www.melbetbonusy.ru[/url] .
melbet_gbOi
18 Oct 25 at 8:40 am
Good day I am so grateful I found your weblog, I really found you
by mistake, while I was searching on Google for something else, Nonetheless I am here now and would just like to
say thank you for a marvelous post and a all round enjoyable blog (I also love the theme/design), I don’t have time to look over it all at the moment but I
have book-marked it and also included your RSS feeds, so when I have time I will be back to read a
great deal more, Please do keep up the excellent job.
Finxor GPT Ervaringen
18 Oct 25 at 8:43 am
Виртуальный номер телефона
Ricardopam
18 Oct 25 at 8:44 am
https://t.me/s/Official_1xbet_1xbet/1663
Josephadvem
18 Oct 25 at 8:44 am
https://t.me/Official_1xbet_1xbet/1822
Josephadvem
18 Oct 25 at 8:45 am
Simply wish to say your article is as astonishing.
The clarity to your submit is simply spectacular and i can assume you’re a
professional on this subject. Well with your permission allow
me to clutch your feed to keep up to date with drawing close post.
Thanks 1,000,000 and please carry on the gratifying work.
LLC
18 Oct 25 at 8:45 am
Thank you for the auspicious writeup. It in fact was a amusement account it.
Look advanced to more added agreeable from you!
However, how could we communicate?
Source
18 Oct 25 at 8:45 am
https://aboutcasemanagerjobs.com/author/1xbetbonuscode/
DavidFes
18 Oct 25 at 8:47 am
согласование проекта перепланировки квартиры [url=www.soglasovanie-pereplanirovki-kvartiry4.ru/]согласование проекта перепланировки квартиры[/url] .
soglasovanie pereplanirovki kvartiri _afOr
18 Oct 25 at 8:48 am
проект перепланировки квартиры для согласования [url=www.proekt-pereplanirovki-kvartiry16.ru/]www.proekt-pereplanirovki-kvartiry16.ru/[/url] .
proekt pereplanirovki kvartiri_beMl
18 Oct 25 at 8:48 am
webtide.click – Pages load swiftly, no lag, which makes for a smooth experience.
Dennise Gully
18 Oct 25 at 8:50 am
https://clocks-top.com/
RandallHen
18 Oct 25 at 8:51 am