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!
обзор спортивных событий [url=https://novosti-sporta-16.ru/]novosti-sporta-16.ru[/url] .
novosti sporta_xxsi
3 Oct 25 at 3:01 am
ставки на футбол сегодня 100 процентный [url=http://www.prognozy-na-futbol-9.ru]http://www.prognozy-na-futbol-9.ru[/url] .
prognozi na fytbol_pfea
3 Oct 25 at 3:02 am
เข้าร่วม JEETA และสัมผัสโลกใหม่ของเกมออนไลน์
JEETA Official | เว็บพนันสดและคาสิโนที่ดีที่สุดในบังคลาเทศ
3 Oct 25 at 3:03 am
Приобрести MEF GASH SHIHSKI ALFA – ОТЗЫВЫ, ГАРАНТРР, КАЧЕСТВО
Jeromeliz
3 Oct 25 at 3:04 am
СтройСинтез построил для нас кирпичный дом с просторной мансардой. Работы были выполнены на высоком уровне, а качество материалов приятно удивило. Теперь у нас уютный и красивый дом. Все подробности можно посмотреть по ссылке, https://stroysyntez.com/
Brianvop
3 Oct 25 at 3:07 am
прогноз ставок на сегодня [url=www.stavka-10.ru]www.stavka-10.ru[/url] .
stavka_yvSi
3 Oct 25 at 3:10 am
лига ставок прогнозы [url=https://stavka-10.ru]https://stavka-10.ru[/url] .
stavka_ufSi
3 Oct 25 at 3:18 am
прогноз футбол [url=prognozy-na-futbol-9.ru]прогноз футбол[/url] .
prognozi na fytbol_poea
3 Oct 25 at 3:19 am
LuckyMax Casino NL https://server-test.momilash.com/online-casino-nederlan-u-lieve-va-lucky-max-casino-nu//
LuckyMax Casino
3 Oct 25 at 3:20 am
прогнозы на сегодня футбол [url=http://prognozy-na-futbol-9.ru]http://prognozy-na-futbol-9.ru[/url] .
prognozi na fytbol_opea
3 Oct 25 at 3:25 am
DragonMoney – лицензированное казино с щедрыми бонусами, топовыми играми, быстрыми выплатами и круглосуточной поддержкой
dragon money
EdgarPak
3 Oct 25 at 3:28 am
momoanmashop – Overall, I enjoyed the browsing experience, cheerful and straightforward.
Lucius Halo
3 Oct 25 at 3:28 am
купить диплом электромонтажника [url=https://www.rudik-diplom14.ru]купить диплом электромонтажника[/url] .
Diplomi_imea
3 Oct 25 at 3:28 am
ставки на футбол сегодня 100 процентный [url=prognozy-na-futbol-9.ru]prognozy-na-futbol-9.ru[/url] .
prognozi na fytbol_mtea
3 Oct 25 at 3:29 am
lotsofonlinepeople – I like the vibe, navigation is intuitive and visuals catch attention.
Alonso Sznejkowski
3 Oct 25 at 3:29 am
brahmanshome – Browsing here feels natural, calm, and very easygoing.
Eden Breaud
3 Oct 25 at 3:29 am
stavkiprognozy [url=www.stavka-10.ru/]www.stavka-10.ru/[/url] .
stavka_cnSi
3 Oct 25 at 3:29 am
Закладки тут – купить гашиш, мефедрон, альфа-РїРІРї
Jeromeliz
3 Oct 25 at 3:31 am
haskdhaskdjaslkds – I see images but context is missing, feels like a placeholder site.
Monte Walterson
3 Oct 25 at 3:32 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 token
WilliamPargy
3 Oct 25 at 3:32 am
прогнозы ру [url=http://stavka-10.ru/]http://stavka-10.ru/[/url] .
stavka_ldSi
3 Oct 25 at 3:33 am
goestotown – I like the simple navigation, makes browsing quick and enjoyable.
Lionel Spaniel
3 Oct 25 at 3:38 am
прогнозы на футбол сегодня [url=www.prognozy-na-futbol-9.ru]прогнозы на футбол сегодня[/url] .
prognozi na fytbol_hcea
3 Oct 25 at 3:42 am
сайт прогнозов [url=www.stavka-12.ru/]www.stavka-12.ru/[/url] .
stavka_rfSi
3 Oct 25 at 3:45 am
I like the helpful info you provide in your articles. I will bookmark your blog and
check again here regularly. I’m quite certain I’ll learn a lot of new stuff right here!
Best of luck for the next!
hair transplant istanbul
3 Oct 25 at 3:46 am
спорт 24 часа [url=http://novosti-sporta-16.ru/]http://novosti-sporta-16.ru/[/url] .
novosti sporta_uvsi
3 Oct 25 at 3:51 am
прогнозист ру [url=http://www.stavka-12.ru]http://www.stavka-12.ru[/url] .
stavka_jaSi
3 Oct 25 at 3:52 am
cnsbiodesk – I like the straightforward presentation, nothing feels cluttered at all.
Henry Houchin
3 Oct 25 at 3:52 am
Do you have a spam problem on this blog;
I also am a blogger, and I was wondering your situation; we have developed some nice methods
and we are looking to exchange strategies with others, be sure to shoot me an e-mail
if interested.
roobet casino
3 Oct 25 at 3:53 am
лига ставок прогнозы [url=http://stavka-10.ru]http://stavka-10.ru[/url] .
stavka_sjSi
3 Oct 25 at 3:53 am
https://www.wildberries.ru/catalog/514992745/detail.aspx
Kevinsaush
3 Oct 25 at 3:55 am
ставки и прогнозы на спорт [url=http://stavka-12.ru]http://stavka-12.ru[/url] .
stavka_mhSi
3 Oct 25 at 3:55 am
geomatique237 – I found the design unusual, navigation is adventurous yet somewhat rough.
Judi Mcniel
3 Oct 25 at 3:57 am
Great post. I used to be checking constantly this weblog and
I am impressed! Extremely useful information specially the ultimate part 🙂 I maintain such info a lot.
I used to be looking for this particular info for a very lengthy time.
Thanks and good luck.
Kudos
3 Oct 25 at 3:57 am
Приобрести онлайн кокаин, мефедрон, гашиш, бошки
Jeromeliz
3 Oct 25 at 3:59 am
купить диплом в иркутске [url=http://www.rudik-diplom14.ru]купить диплом в иркутске[/url] .
Diplomi_auea
3 Oct 25 at 4:00 am
http://medicexpressmx.com/# MedicExpress MX
Williamjib
3 Oct 25 at 4:00 am
лига ставок прогнозы [url=http://stavka-10.ru/]http://stavka-10.ru/[/url] .
stavka_baSi
3 Oct 25 at 4:00 am
новости чемпионатов [url=https://novosti-sporta-16.ru/]https://novosti-sporta-16.ru/[/url] .
novosti sporta_zlsi
3 Oct 25 at 4:01 am
где купить дипломы медсестры [url=http://frei-diplom15.ru]где купить дипломы медсестры[/url] .
Diplomi_meoi
3 Oct 25 at 4:01 am
haskdhaskdjaslkds – I’m not sure what this does, yet the design tries to be bold.
Bo Newberry
3 Oct 25 at 4:02 am
1win demo aviator o‘ynash [url=http://1win5507.ru/]http://1win5507.ru/[/url]
1win_lakr
3 Oct 25 at 4:03 am
Admiring the hard work you put into your website and in depth information you offer.
It’s good to come across a blog every once in a while that isn’t
the same outdated rehashed information. Excellent read!
I’ve bookmarked your site and I’m including your RSS
feeds to my Google account.
казино для новичков
3 Oct 25 at 4:05 am
Generic tadalafil 20mg price: tadalafil – Generic tadalafil 20mg price
MartinJaive
3 Oct 25 at 4:05 am
DragonMoney – лицензированное казино с щедрыми бонусами, топовыми играми, быстрыми выплатами и круглосуточной поддержкой https://cream-soda-kafe.ru/
EdgarPak
3 Oct 25 at 4:05 am
Tһｅ upcoming brand-new physical area at OMT promises immersive math experiences, stimulating ⅼong-lasting love for the subject and inspiration fоr examination achievements.
Dive іnto ѕelf-paced math mastery ᴡith OMT’s 12-mօnth e-learning courses, сomplete wіth practice
worksheets and recorded sessions fօr thoгough revision.
In Singapore’s extensive education ѕystem,
where mathematics іs obligatory ɑnd consumes аroսnd 1600 hⲟurs of curriculum time in primary and secondary
schools, math tuition еnds up bеing neϲessary to heⅼp trainees construct a strong
foundation f᧐r lifelong success.
Math tuition іn primary school bridges gaps іn class learning, ensuring students grasp complex topics ѕuch аs geometry and data analysis befoгe the PSLE.
Witһ O Levels emphasizing geometry evidence аnd theorems, math tuition օffers
specialized drills tо guarantee students can take on thesе wіth accuracy and ѕelf-confidence.
Structure confidence νia regular assistance іn junior college math tuition minimizes
exam anxiety, leading tο mսch better end reѕults
in A Levels.
OMT’s exclusive syllabus enhances MOE standards ƅy giving scaffolded learning paths tһat gradually
raise іn intricacy, constructing trainee ѕelf-confidence.
OMT’ѕ on-line tuition saves cash onn transport lah, enabling mοre focus
оn studies and improved math outcomes.
For Singapore students dealing ԝith extreme competitors, math tuition еnsures they rеmain ahead Ьy enhancing foundational skills eɑrly on.
Ꮋere iѕ my h᧐mepage :: ib math hl ia tutor
ib math hl ia tutor
3 Oct 25 at 4:06 am
Aesthetic help in OMT’s educational program mɑke abstract concepts concrete, cultivating а deep
appreciation fоr mathematics and inspiration tо dominate exams.
Broaden your horizons witһ OMT’s upcoming new physical аrea ⲟpening in Seρtember 2025, providing а lot moгe chances fօr hands-on math
expedition.
The holistic Singapore Math technique, ᴡhich develops multilayered
analytical abilities, highlights ᴡhy math tuition is imⲣortant
for mastering thе curriculum ɑnd preparing for future careers.
primary school math tuition enhances logical reasoning, іmportant for translating PSLE questions including
sequences аnd rational deductions.
Secondary marh tuition conquers tһе restrictions of big classroom
sizes, providing concentrated attention tһat improves understanding for O Level preparation.
Junior college tuition ɡives access tο extra sources like worksheets and video explanations, reinforcing А Level curriculum
coverage.
Distnct fгom othеrs, OMT’s curriculum complements MOE’ѕ throᥙgh a concentrate on resilience-building exercises, assisting
students tackle challenging troubles.
Ꮤith 24/7 accessibility to video lessons, you ⅽan capture
up on challenging subjects anytime leh, assisting үⲟu score much bｅtter
in examinations witһout tension.
In Singapore’s affordable education ɑnd learning landscape,
math tuition provides the extra side neeԁeԁ for pupils tο master high-stakes exams
lіke the PSLE, O-Levels, аnd A-Levels.
Review my site; sec 2 math tuition singapore
sec 2 math tuition singapore
3 Oct 25 at 4:06 am
прогноз ставки [url=www.stavka-10.ru]www.stavka-10.ru[/url] .
stavka_qtSi
3 Oct 25 at 4:06 am
купить диплом в первоуральске [url=rudik-diplom8.ru]rudik-diplom8.ru[/url] .
Diplomi_bwMt
3 Oct 25 at 4:06 am
momoanmashop – Everything looks well organized, and easy to find what’s needed.
Britteny Hilovsky
3 Oct 25 at 4:08 am