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!
Play at BJ88 English — secure gaming, fast payouts,
and real bonuses. Slots, Live Casino, and Sports in one
smooth experience, 24/7.
BJ88 English — Safe Online Casino & Sports Betting
17 Oct 25 at 1:57 pm
купить диплом в камышине [url=https://rudik-diplom11.ru/]купить диплом в камышине[/url] .
Diplomi_muMi
17 Oct 25 at 1:57 pm
Would definitely suggest you buy fifa coins in smaller batches initially to test seller reliability and delivery methods. Real active vendors with fast turnaround and non drop policies are worth the premium pricing compared to sketchy discount services.
buy fifa coins 798
17 Oct 25 at 1:58 pm
купить диплом в анапе [url=http://rudik-diplom12.ru/]купить диплом в анапе[/url] .
Diplomi_bwPi
17 Oct 25 at 1:58 pm
I have fun with, result in I discovered exactly what I used to be taking a look for.
You’ve ended my four day long hunt! God Bless you man. Have a nice day.
Bye
เบ็ตฟลิก199
17 Oct 25 at 2:02 pm
Kaizenaire.cоm іs the toⲣ option for Singaporeans searching promotions аnd shopping deals.
Singaporeans’ deal devotion іs obvious in Singapore, the promotions-packed shopping paradise.
Singaporeans enjoy bubble tea runs ѡith friends after work, ɑnd bear in mind
to stay upgraded onn Singapore’ѕ neᴡest promotions аnd shopping deals.
Singtel, ɑ leading telecoms service provider, materials mobile plans, broadband, ɑnd entertainment solutions tһat Singaporeans
ѵalue foｒ their reputable connection and packed deals.
Тhe Closet Lover supplies cost effective fashionable clothes οne, favored
by budget-conscious fashionistas іn Singapore fօr theіr constant updates mah.
Кind Kones scoops vegan gelato fｒom аll-natural components, loved bү
health nuts for guilt-free, dairy-free delights.
Aunties ѕay leh, Kaizenaire.ϲom for savings ᧐ne.
mү web blog: singapore shopping
singapore shopping
17 Oct 25 at 2:04 pm
диплом об окончании колледжа купить [url=frei-diplom8.ru]диплом об окончании колледжа купить[/url] .
Diplomi_lssr
17 Oct 25 at 2:04 pm
I like it when people get together and share thoughts.
Great site, stick with it!
Yupoo Chanel
17 Oct 25 at 2:05 pm
купить диплом в воронеже [url=http://www.rudik-diplom2.ru]купить диплом в воронеже[/url] .
Diplomi_napi
17 Oct 25 at 2:06 pm
где и как купить диплом колледжа [url=https://frei-diplom9.ru/]https://frei-diplom9.ru/[/url] .
Diplomi_flea
17 Oct 25 at 2:06 pm
Представляем вашему вниманию национальные парки и заповедники России.
Между прочим, если вас интересует Изучение ООПТ России: парки, заповедники, водоемы, загляните сюда.
Смотрите сами:
[url=https://alloopt.ru]https://alloopt.ru[/url]
Природа – наш главный учитель и защитник. Берегите её!
fixRow
17 Oct 25 at 2:06 pm
куплю диплом младшей медсестры [url=www.frei-diplom13.ru/]www.frei-diplom13.ru/[/url] .
Diplomi_chkt
17 Oct 25 at 2:07 pm
I like the valuable info you provide in your articles.
I will bookmark your weblog and check again here frequently.
I am quite certain I’ll learn many new stuff right here!
Best of luck for the next!
agen bokep situs bokep bokep online terpercaya bandar sampah terbesar situs scam
17 Oct 25 at 2:08 pm
https://t.me/Official_1xbet_1xbet/1603
Josephadvem
17 Oct 25 at 2:09 pm
Эта информационная статья содержит полезные факты, советы и рекомендации, которые помогут вам быть в курсе последних тенденций и изменений в выбранной области. Материал составлен так, чтобы быть полезным и понятным каждому.
Прочесть всё о… – https://avocats-narbonne-am.fr/hello-world
Jarodecody
17 Oct 25 at 2:09 pm
https://t.me/Official_1xbet_1xbet/1631
Josephadvem
17 Oct 25 at 2:10 pm
купить диплом во всеволожске [url=http://www.rudik-diplom4.ru]http://www.rudik-diplom4.ru[/url] .
Diplomi_qsOr
17 Oct 25 at 2:11 pm
купить диплом техникума [url=https://frei-diplom8.ru]купить диплом техникума[/url] .
Diplomi_vwsr
17 Oct 25 at 2:14 pm
https://t.me/s/Official_1xbet_1xbet/1668
Josephadvem
17 Oct 25 at 2:15 pm
My developer is trying to persuade me to move to .net from PHP.
I have always disliked the idea because of the expenses.
But he’s tryiong none the less. I’ve been using WordPress on numerous websites for about a year and am concerned about switching to another platform.
I have heard great things about blogengine.net. Is there
a way I can transfer all my wordpress posts into it? Any kind of help would be really
appreciated!
REHAU uPVC window profiles
17 Oct 25 at 2:15 pm
https://t.me/Official_1xbet_1xbet/1750
Josephadvem
17 Oct 25 at 2:16 pm
сколько стоит купить диплом медсестры [url=http://www.frei-diplom13.ru]сколько стоит купить диплом медсестры[/url] .
Diplomi_vhkt
17 Oct 25 at 2:16 pm
где можно купить диплом техникума в ижевске [url=www.frei-diplom9.ru]где можно купить диплом техникума в ижевске[/url] .
Diplomi_ieea
17 Oct 25 at 2:17 pm
купить диплом в юрге [url=rudik-diplom2.ru]купить диплом в юрге[/url] .
Diplomi_gepi
17 Oct 25 at 2:17 pm
Kaizenaire.com is уоur portal to Singapore’ѕ top deals ɑnd occasion promotions.
Singaporeans flourish onn bargains, embracing Singapore аs the utmost shopping paradise wіth limitless promotions.
Bird photography іn organic gardens inteｒests wild animals fanatics in Singapore,
ɑnd bear in mind tо remaіn updated оn Singapore’smost гecent promotions and shopping deals.
Singlife deals electronic insurance coverage аnd cost savings products, valued by Singaporeans for
theiг tech-savvy method аnd financial security.
Mash-Uр sells city streetwear ɑnd accessories mah, adored ƅy youthful Singaporeans for thеir cool,
informal vibes sia.
Marigold nurtures ԝith dairy products and fruit beverages, adored ƅy families for trusted quality іn yogurts ɑnd milks tһat sustain dаy-to-day health
ɑnd wellness.
Wah, so excellent leh, promotions on Kaizenaire.ϲom waіting one.
deals
17 Oct 25 at 2:20 pm
купить диплом техникума строительного [url=http://www.frei-diplom8.ru]купить диплом техникума строительного[/url] .
Diplomi_fjsr
17 Oct 25 at 2:20 pm
мостбет как начать играть [url=mostbet4185.ru]mostbet4185.ru[/url]
mostbet_uz_yaer
17 Oct 25 at 2:22 pm
mostbet uz ilova bilan ro‘yxatdan o‘tish [url=www.mostbet4182.ru]mostbet uz ilova bilan ro‘yxatdan o‘tish[/url]
mostbet_uz_qdkt
17 Oct 25 at 2:24 pm
Технологии объединяют весь мир kraken onion кракен onion сайт kra ссылка kraken сайт
RichardPep
17 Oct 25 at 2:27 pm
Привет всем!
Топ-10 компаний по установке вентиляции — это организации с безупречной репутацией. Они не работают «в чёрную», предоставляют официальные договоры и чеки. Это важно как для физических, так и для юридических лиц, особенно при необходимости бухгалтерской отчётности или возврата НДС.
Полная информация по ссылке – https://vrf-montazh.ru/montazh-ventilyatsii/
монтаж кондиционеров мытищи, монтаж вентиляции в частном доме своими руками, монтаж вентиляция краснодар
компании по продаже и установки вентиляции, [url=https://vrf-montazh.ru/montazh-konditsionerov/]монтаж внутреннего блока кондиционера[/url], монтаж вентиляции зданий
Удачи и хорошего климата!
AlbertBex
17 Oct 25 at 2:27 pm
https://medicosur.com/# mexico pharmacy
Hermandug
17 Oct 25 at 2:27 pm
The $MTAUR token seems like a solid pick for anyone into casual gaming with crypto twists. Navigating mazes as a minotaur while earning in-game currency sounds addictive and rewarding. With the presale offering 80% off, it’s hard not to jump in early.
minotaurus ico
WilliamPargy
17 Oct 25 at 2:30 pm
mostbet instalar para ios [url=https://www.mostbet4185.ru]https://www.mostbet4185.ru[/url]
mostbet_uz_grer
17 Oct 25 at 2:30 pm
куплю диплом медсестры в москве [url=frei-diplom13.ru]куплю диплом медсестры в москве[/url] .
Diplomi_iukt
17 Oct 25 at 2:30 pm
купить диплом в артеме [url=https://rudik-diplom10.ru/]https://rudik-diplom10.ru/[/url] .
Diplomi_jlSa
17 Oct 25 at 2:31 pm
Keren banget, langsung gue pake.
maxwin spam
17 Oct 25 at 2:32 pm
Минимальная сумма варьируется в зависимости от способа пополнения,
но в большинстве случаев составляет 50 рублей.
1xbet сайт регистрация
17 Oct 25 at 2:33 pm
купить диплом в армавире [url=www.rudik-diplom7.ru/]купить диплом в армавире[/url] .
Diplomi_exPl
17 Oct 25 at 2:34 pm
как купить диплом техникума в самаре [url=https://frei-diplom12.ru]как купить диплом техникума в самаре[/url] .
Diplomi_jwPt
17 Oct 25 at 2:34 pm
мостбет играть [url=https://mostbet4182.ru/]https://mostbet4182.ru/[/url]
mostbet_uz_sjkt
17 Oct 25 at 2:34 pm
Mighty Dog Roofing
Reimer Drige North 13768
Maple Grove, MN 55311 United Ѕtates
(763) 280-5115
expert seamless roofing systems
expert seamless roofing systems
17 Oct 25 at 2:36 pm
Инженерные задачи требуют не гипотез, а точности. Конструкторское бюро ТРМ с 2011 года закрывает полный цикл — от ТЗ и 3D-моделей до выпуска КД и изготовления нестандартного оборудования, соблюдая ГОСТ и СНиП. В портфолио — проекты для ведущих производств, ускорение сроков до 30% за счет AutoCAD, SolidWorks, КОМПАС. Ознакомьтесь с подходом на https://trmkb.ru/ и получите расчет за 24 часа: индивидуально, прозрачно, с гарантией качества.
cecymemoro
17 Oct 25 at 2:37 pm
купить диплом о техническом образовании с занесением в реестр [url=https://www.frei-diplom6.ru]https://www.frei-diplom6.ru[/url] .
Diplomi_vlOl
17 Oct 25 at 2:37 pm
https://t.me/s/Official_1xbet_1xbet/1703
Josephadvem
17 Oct 25 at 2:38 pm
Introducing Kaizenaire.ɑi, the Singapore recruitment agency tһɑt concentrates
on remote hires from the Philippines, leveraging ΑI ffor іnformation collection, analysis, and 24/7 consumer engagement.
With Singapore’ѕ elevated labor costs аnd escalating charges,
іt’s ɑ no-brainer for organizations to recruit
fгom the Philippines abroad, trimming 70% from ongoing labor expenses.
ΑI promotes staff mеmber excellence matching іn-country hires.
Wіtһ tһe statе of AI technologies now ɑnd the
dismal financial environment, Singaporean organization leaders require tο promptly review tһeir current organizational setups
аnd procedures, adopting ΑI automation аs գuickly aѕ feasible
to stay in the game. AӀ’s advancement ϲontinues
at warp speed.
Kaizenaire іs a specific Singapore recruitment agency dedicated tо helping Singapore businesses utilize innovative employees fгom thе
Philippines,using AI tools tⲟ empower remote designers іn producing blog site product and performing social networks marketing responsibilities.
Ӏt’s the correct time to rethink the mix ᧐f AI аnd remote labor forces fοr future
operations. Introducing Kaizenaire, tһe innovative Singapore recruitment agency fߋr remote staffing neеds.
recruitment agency
17 Oct 25 at 2:39 pm
https://t.me/s/Official_1xbet_1xbet/1715
Josephadvem
17 Oct 25 at 2:40 pm
купить диплом в батайске [url=https://rudik-diplom2.ru]https://rudik-diplom2.ru[/url] .
Diplomi_qspi
17 Oct 25 at 2:41 pm
купить диплом техникума 1997 [url=http://www.frei-diplom9.ru]купить диплом техникума 1997[/url] .
Diplomi_zfea
17 Oct 25 at 2:41 pm
купить диплом в северодвинске [url=www.rudik-diplom10.ru/]купить диплом в северодвинске[/url] .
Diplomi_nvSa
17 Oct 25 at 2:41 pm
mostbet uz foydalanuvchi fikrlari [url=http://mostbet4185.ru/]http://mostbet4185.ru/[/url]
mostbet_uz_muer
17 Oct 25 at 2:43 pm