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=http://frei-diplom5.ru/]купить диплом с занесением в реестр новосибирск[/url] .
Diplomi_zzPa
14 Oct 25 at 12:01 pm
Je suis captive par Grandz Casino, est une symphonie de divertissement qui effleure. Les options de jeu au casino sont riches et ephemeres. proposant des slots de casino a theme theatral. repond comme un fantome gracieux. repondant en un souffle spectral. fluisent comme une sonate spectrale. tout de meme des offres qui vibrent comme une cadence spectrale. En fin de compte, Grandz Casino promet un divertissement de casino spectral pour les passionnes de casinos en ligne! En plus l’interface du casino est fluide et danse comme une ombre. cadence l’aventure avec une rhapsodie spectrale.
grandz|
twirlshadowlynx6zef
14 Oct 25 at 12:01 pm
потолочкин натяжные [url=www.natyazhnye-potolki-samara-1.ru]www.natyazhnye-potolki-samara-1.ru[/url] .
natyajnie potolki samara_kbor
14 Oct 25 at 12:01 pm
Откройте для себя прекрасные и загадочные места, которые находятся под охраной в нашей стране.
Кстати, если вас интересует Изучение ООПТ России: парки, заповедники, водоемы, загляните сюда.
Вот, делюсь ссылкой:
[url=https://alloopt.ru]https://alloopt.ru[/url]
Жду ваших отзывов и вопросов по теме.
fixRow
14 Oct 25 at 12:02 pm
mebel jati jepara
PHP hook, building hooks in your application – Sjoerd Maessen blog at Sjoerd Maessen blog
mebel jati jepara
14 Oct 25 at 12:03 pm
купить диплом в спб с занесением в реестр [url=https://frei-diplom4.ru/]https://frei-diplom4.ru/[/url] .
Diplomi_euOl
14 Oct 25 at 12:05 pm
купить диплом электрика [url=http://www.rudik-diplom3.ru]купить диплом электрика[/url] .
Diplomi_plei
14 Oct 25 at 12:06 pm
перепланировка и согласование [url=https://pereplanirovka-nezhilogo-pomeshcheniya8.ru/]https://pereplanirovka-nezhilogo-pomeshcheniya8.ru/[/url] .
pereplanirovka nejilogo pomesheniya_ueki
14 Oct 25 at 12:07 pm
жалюзи для пластиковых окон с электроприводом [url=https://zhalyuzi-s-elektroprivodom77.ru/]zhalyuzi-s-elektroprivodom77.ru[/url] .
jaluzi na okna s elektroprivodom_mdpa
14 Oct 25 at 12:07 pm
купить диплом университета [url=http://rudik-diplom8.ru/]купить диплом университета[/url] .
Diplomi_ukMt
14 Oct 25 at 12:07 pm
My partner and I stumbled over here coming from a different web page and thought I might as well check things out.
I like what I see so i am just following you.
Look forward to finding out about your web page for a second time.
dentist lebanon
14 Oct 25 at 12:08 pm
Way cool! Some very valid points! I appreciate you penning this write-up plus
the rest of the site is extremely good.
Somers plumbers phoenix az
14 Oct 25 at 12:08 pm
диплом занесен в реестр купить [url=http://frei-diplom5.ru]диплом занесен в реестр купить[/url] .
Diplomi_quPa
14 Oct 25 at 12:09 pm
электрокарниз купить в москве [url=https://elektrokarnizy797.ru]электрокарниз купить в москве[/url] .
elektrokarnizi_kuMl
14 Oct 25 at 12:09 pm
карниз с электроприводом [url=karniz-shtor-elektroprivodom.ru]карниз с электроприводом[/url] .
karniz dlya shtor s elektroprivodom_qier
14 Oct 25 at 12:10 pm
перепланировка в нежилом здании [url=http://pereplanirovka-nezhilogo-pomeshcheniya9.ru]перепланировка в нежилом здании[/url] .
pereplanirovka nejilogo pomesheniya_tfKl
14 Oct 25 at 12:10 pm
самара натяжные потолки [url=http://natyazhnye-potolki-samara-1.ru/]http://natyazhnye-potolki-samara-1.ru/[/url] .
natyajnie potolki samara_deor
14 Oct 25 at 12:12 pm
купить диплом автомеханика [url=http://rudik-diplom8.ru]купить диплом автомеханика[/url] .
Diplomi_ogMt
14 Oct 25 at 12:13 pm
купить диплом провизора [url=https://rudik-diplom13.ru]купить диплом провизора[/url] .
Diplomi_flon
14 Oct 25 at 12:14 pm
купить проведенный диплом вуза [url=https://frei-diplom5.ru]https://frei-diplom5.ru[/url] .
Diplomi_maPa
14 Oct 25 at 12:14 pm
переустройство и перепланировка нежилого помещения [url=https://pereplanirovka-nezhilogo-pomeshcheniya10.ru]https://pereplanirovka-nezhilogo-pomeshcheniya10.ru[/url] .
pereplanirovka nejilogo pomesheniya_jgSr
14 Oct 25 at 12:15 pm
https://drupal.stackexchange.com/users/120406/free-spins-no-deposit-india?tab=profile
jigcjfy
14 Oct 25 at 12:15 pm
натяжные потолки самара [url=https://natyazhnye-potolki-samara-2.ru]натяжные потолки самара[/url] .
natyajnie potolki samara_ovPi
14 Oct 25 at 12:15 pm
аренда мини экскаватора с гидромолотом [url=https://arenda-mini-ekskavatora-v-moskve-2.ru/]аренда мини экскаватора с гидромолотом[/url] .
arenda mini ekskavatora v moskve_rcKt
14 Oct 25 at 12:16 pm
bs market В курсе ли ты, что сотрясает самые глубины тёмной сети? Blacksprut — это не просто название. Это новый уровень в обеспечении анонимности, оперативности и безопасности сделок. Посети bs2best.at — там тебе откроются двери в мир, о котором другие предпочитают умалчивать. Получи доступ к информации, которую тщательно скрывают от общего внимания. Только для тех, кто понимает и разбирается. Без возможности обнаружения. Без каких-либо уступок. Только Blacksprut. Не упусти свой шанс стать одним из первых — bs2best.at уже готов принять тебя в свои ряды. Готов ли ты к тому, что узнаешь?
Armandnum
14 Oct 25 at 12:16 pm
купить диплом преподавателя [url=https://rudik-diplom11.ru]купить диплом преподавателя[/url] .
Diplomi_xiMi
14 Oct 25 at 12:16 pm
жалюзи на окна с электроприводом [url=http://www.zhalyuzi-s-elektroprivodom77.ru]жалюзи на окна с электроприводом[/url] .
jaluzi na okna s elektroprivodom_alpa
14 Oct 25 at 12:17 pm
перепланировка в нежилом помещении [url=http://pereplanirovka-nezhilogo-pomeshcheniya8.ru]http://pereplanirovka-nezhilogo-pomeshcheniya8.ru[/url] .
pereplanirovka nejilogo pomesheniya_fbki
14 Oct 25 at 12:19 pm
Hello There. I discovered your weblog using msn.
This is an extremely neatly written article. I’ll be sure
to bookmark it and return to read extra of
your helpful info. Thank you for the post. I’ll definitely return.
useful content
14 Oct 25 at 12:20 pm
сайт натяжной потолок [url=stretch-ceilings-samara-1.ru]stretch-ceilings-samara-1.ru[/url] .
natyajnie potolki samara_wlsl
14 Oct 25 at 12:20 pm
you are in reality a excellent webmaster. The site loading speed is amazing.
It sort of feels that you’re doing any distinctive trick.
Furthermore, The contents are masterwork. you have done a excellent process on this matter!
تعمیر ماکروفر سامسونگ
14 Oct 25 at 12:20 pm
потолочник отзывы [url=https://stretch-ceilings-samara.ru]https://stretch-ceilings-samara.ru[/url] .
natyajnie potolki samara_srkl
14 Oct 25 at 12:21 pm
Thematic systems іn OMT’s syllabus attach math tօ
passions ⅼike technology, stiring ᥙp curiosity аnd drive for leading test scores.
Dive іnto self-paced mathematics mastery ԝith OMT’s 12-mօnth e-learning courses,
ϲomplete with practice worksheets ɑnd taped sessions for thoгough modification.
Тhe holistic Singapore Math approach, ѡhich builds multilayered ⲣroblem-solving abilities, highlights ѡhy math
tuition is imp᧐rtant for mastering tһe curriculum annd preparing f᧐r future careers.
primary school tuition іs necessary for PSLE as it οffers therapeutic assistance fߋr
topics like entіre numberѕ and measurements, making sure no
foundational weak ρoints persist.
Senior һigh school math tuition іs vital for O
Levels as it strengthens mastery оf algebraic control,
а core part tht frequently ѕhows uρ in exam questions.
With A Levels requiring proficiency іn vectors and intricate numbеrs,
math tuition рrovides targeted practice tⲟ handle thеse abstract
principles efficiently.
OMT’s special math program matches tһе MOE educational program Ьy consisting of proprietary situation гesearch studies
tһat սse mathematics tߋ actual Singaporean contexts.
Individualized development monitoring іn OMT’s system reveals yߋur
vulnerable ⲣoints ѕia,enabling targeted practice fοr
quality enhancement.
Ιn a hectic Singapore class, math tuition ߋffers thｅ slower, tһorough descriptions required to build self-confidence
for examinations.
Feel free tߋ surf to my web paɡe math tuition secondary
math tuition secondary
14 Oct 25 at 12:24 pm
согласование перепланировки нежилого помещения в нежилом здании [url=www.pereplanirovka-nezhilogo-pomeshcheniya8.ru]www.pereplanirovka-nezhilogo-pomeshcheniya8.ru[/url] .
pereplanirovka nejilogo pomesheniya_gaki
14 Oct 25 at 12:25 pm
купить диплом инженера по охране труда [url=https://rudik-diplom11.ru/]купить диплом инженера по охране труда[/url] .
Diplomi_kyMi
14 Oct 25 at 12:25 pm
купить диплом в кстово [url=http://rudik-diplom4.ru/]http://rudik-diplom4.ru/[/url] .
Diplomi_qxOr
14 Oct 25 at 12:26 pm
https://italian.stackexchange.com/users/17188/free-spins-no-deposit-india?tab=profile
ffepjdv
14 Oct 25 at 12:27 pm
wetten ist unser sport
My homepage … sportwetten quoten vergleich
sportwetten quoten vergleich
14 Oct 25 at 12:27 pm
Undeniably imagine that that you said. Your favourite justification appeared to be on the
internet the easiest factor to keep in mind of.
I say to you, I definitely get annoyed while other folks consider issues
that they plainly do not recognize about. You controlled to hit the
nail upon the top and defined out the entire thing without having side
effect , people could take a signal. Will probably be back to get more.
Thanks
tenda membrane bali
14 Oct 25 at 12:27 pm
согласование перепланировки нежилых помещений [url=http://pereplanirovka-nezhilogo-pomeshcheniya10.ru]http://pereplanirovka-nezhilogo-pomeshcheniya10.ru[/url] .
pereplanirovka nejilogo pomesheniya_qzSr
14 Oct 25 at 12:28 pm
аренда мини экскаватора в московской области цены [url=https://arenda-mini-ekskavatora-v-moskve-2.ru/]arenda-mini-ekskavatora-v-moskve-2.ru[/url] .
arenda mini ekskavatora v moskve_naKt
14 Oct 25 at 12:28 pm
Good day! I could have sworn I’ve been to this website before but after browsing through some of the post I
realized it’s new to me. Anyhow, I’m definitely delighted I found it and
I’ll be book-marking and checking back often!
Jasa Pembuatan Website
14 Oct 25 at 12:29 pm
I just like the helpful information you supply for your articles.
I will bookmark your blog and check once more right here frequently.
I am quite sure I will be told many new stuff proper right here!
Best of luck for the next!
Seriously
14 Oct 25 at 12:30 pm
фитнес клуб с бассейном занятия в фитнес клубе
fitnes-klub-msk-167
14 Oct 25 at 12:31 pm
карниз электро [url=http://karniz-shtor-elektroprivodom.ru]http://karniz-shtor-elektroprivodom.ru[/url] .
karniz dlya shtor s elektroprivodom_ijer
14 Oct 25 at 12:31 pm
как узаконить перепланировку нежилого помещения [url=http://pereplanirovka-nezhilogo-pomeshcheniya8.ru/]http://pereplanirovka-nezhilogo-pomeshcheniya8.ru/[/url] .
pereplanirovka nejilogo pomesheniya_egki
14 Oct 25 at 12:32 pm
купить диплом в ачинске [url=rudik-diplom11.ru]купить диплом в ачинске[/url] .
Diplomi_evMi
14 Oct 25 at 12:32 pm
Minotaurus ICO is targeting $6.4M, and with current traction, it’ll smash it. $MTAUR’s DeFi access empowers users without complexity. Referral rewards have me spreading the word. minotaurus token
WilliamPargy
14 Oct 25 at 12:32 pm
натяжные потолки самара [url=http://stretch-ceilings-samara-1.ru/]натяжные потолки самара[/url] .
natyajnie potolki samara_ypsl
14 Oct 25 at 12:32 pm
сайт натяжной потолок [url=www.natyazhnye-potolki-samara-1.ru/]www.natyazhnye-potolki-samara-1.ru/[/url] .
natyajnie potolki samara_xkor
14 Oct 25 at 12:32 pm