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!
This piece of writing gives clear idea in support of the new
people of blogging, that in fact how to do running a blog.
Malinda
19 Oct 25 at 12:18 pm
News.net.ru — оперативная лента о России с удобной навигацией по рубрикам и акцентом на проверку источников. Из одного окна доступны сводки, экономика, культура, спорт и технологии, а обновления выходят в формате кратких заметок с деталями и ссылками. В середине дня и поздно вечером портал активно обновляется — удобно для тех, кто следит за повесткой. Читайте без лишнего шума на https://news.net.ru/ — быстрый доступ к ключевым событиям и понятная структура помогут не пропустить важное.
cekafMek
19 Oct 25 at 12:18 pm
I loved as much as you will receive carried
out right here. The sketch is attractive, your authored subject matter stylish.
nonetheless, you command get bought an edginess over that you wish be delivering the following.
unwell unquestionably come more formerly again as exactly the same nearly a lot often inside case
you shield this increase.
1 year mba in malaysia
19 Oct 25 at 12:20 pm
1win yangi promo kod [url=https://1win5509.ru/]https://1win5509.ru/[/url]
1win_uz_dcKt
19 Oct 25 at 12:23 pm
1win texnik yordam [url=http://1win5509.ru/]http://1win5509.ru/[/url]
1win_uz_ecKt
19 Oct 25 at 12:25 pm
The Minotaurus presale DAO empowers. Token’s vesting prevents chaos. Adventures immersive.
mtaur token
WilliamPargy
19 Oct 25 at 12:25 pm
1вин бонус за регистрацию уз [url=1win5509.ru]1win5509.ru[/url]
1win_uz_omKt
19 Oct 25 at 12:25 pm
куплю диплом медсестры в москве [url=https://frei-diplom13.ru/]куплю диплом медсестры в москве[/url] .
Diplomi_pwkt
19 Oct 25 at 12:28 pm
Ich bin vollig begeistert von Richard Casino, es pulsiert mit einer luxuriosen Casino-Energie. Die Spielauswahl im Casino ist wie ein koniglicher Schatz, mit modernen Casino-Slots, die einen verzaubern. Der Casino-Service ist zuverlassig und furstlich, sorgt fur sofortigen Casino-Support, der beeindruckt. Auszahlungen im Casino sind schnell wie ein koniglicher Marsch, trotzdem mehr regelma?ige Casino-Boni waren furstlich. Zusammengefasst ist Richard Casino ein Online-Casino, das wie ein Palast strahlt fur die, die mit Stil im Casino wetten! Und au?erdem die Casino-Plattform hat einen Look, der wie ein Kronungsmantel glanzt, den Spielspa? im Casino auf ein konigliches Niveau hebt.
richard casino win|
quirkybadger5zef
19 Oct 25 at 12:28 pm
бонусный счет мелбет [url=http://www.melbetbonusy.ru]бонусный счет мелбет[/url] .
melbet_xhOi
19 Oct 25 at 12:28 pm
Achou loucamente incrivel DazardBet Casino, da uma energia de cassino totalmente insana. A gama do cassino e simplesmente um espetaculo, com slots de cassino unicos e vibrantes. O atendimento ao cliente do cassino e fora da curva, garantindo suporte de cassino imediato e certeiro. Os ganhos do cassino chegam na velocidade da luz, de vez em quando mais recompensas no cassino seriam um baita diferencial. Em resumo, DazardBet Casino garante uma diversao de cassino fora de serie para quem curte apostar com estilo no cassino! Vale dizer tambem a plataforma do cassino arrasa com um visual eletrizante, o que deixa cada sessao de cassino ainda mais insana.
dazardbet kasyno|
sparklemoth8zef
19 Oct 25 at 12:29 pm
Hey, I think your site might be having browser compatibility issues.
When I look at your blog site in Safari, it looks fine but when opening in Internet
Explorer, it has some overlapping. I just wanted to give you a quick heads up!
Other then that, awesome blog!
super informative bags
19 Oct 25 at 12:32 pm
1win app promo bilan [url=http://1win5510.ru/]http://1win5510.ru/[/url]
1win_uz_hvsi
19 Oct 25 at 12:33 pm
[url=https://vk.com/nakrutkapfonline]накрутка пф яндекс!..[/url]
Jamesnon
19 Oct 25 at 12:35 pm
Bullish on $MTAUR coin for its referral and vesting perks. ICO phase’s low entry beats later prices. Whimsical gameplay hooks you instantly.
minotaurus token
WilliamPargy
19 Oct 25 at 12:35 pm
купить диплом о среднем специальном [url=rudik-diplom9.ru]купить диплом о среднем специальном[/url] .
Diplomi_bdei
19 Oct 25 at 12:36 pm
В «Частном Медике 24» в Самаре выход из запоя организуют поэтапно: диагностика, лечение, реабилитация.
Разобраться лучше – [url=https://vyvod-iz-zapoya-v-stacionare-samara23.ru/]нарколог вывод из запоя в стационаре самара[/url]
Williamliz
19 Oct 25 at 12:36 pm
купить диплом в ульяновске [url=https://www.rudik-diplom6.ru]купить диплом в ульяновске[/url] .
Diplomi_joKr
19 Oct 25 at 12:36 pm
linked site
PHP hook, building hooks in your application – Sjoerd Maessen blog at Sjoerd Maessen blog
linked site
19 Oct 25 at 12:38 pm
1вин зеркало узбекистан [url=1win5509.ru]1win5509.ru[/url]
1win_uz_uiKt
19 Oct 25 at 12:40 pm
официальный сайт букмекерской конторы melbet [url=https://www.melbetbonusy.ru]официальный сайт букмекерской конторы melbet[/url] .
melbet_sxOi
19 Oct 25 at 12:42 pm
Клиника «Частный Медик 24» в Самаре оказывает помощь при запое анонимно, круглосуточно и без скрытых платежей.
Подробнее – [url=https://vyvod-iz-zapoya-v-stacionare-samara23.ru/]нарколог вывод из запоя в стационаре самара[/url]
Williamliz
19 Oct 25 at 12:44 pm
farmacie online autorizzate elenco: cialis – compresse per disfunzione erettile
RaymondNit
19 Oct 25 at 12:48 pm
можно ли купить диплом медсестры [url=https://frei-diplom13.ru]можно ли купить диплом медсестры[/url] .
Diplomi_tikt
19 Oct 25 at 12:48 pm
купить диплом в махачкале [url=https://rudik-diplom6.ru/]купить диплом в махачкале[/url] .
Diplomi_wqKr
19 Oct 25 at 12:55 pm
1win poker uz [url=www.1win5509.ru]www.1win5509.ru[/url]
1win_uz_huKt
19 Oct 25 at 12:57 pm
В Нижнем Новгороде стационар «Частного Медика 24» стал надежным местом для лечения запоя.
Изучить вопрос глубже – [url=https://vyvod-iz-zapoya-v-stacionare23.ru/]вывод из запоя в стационаре анонимно в нижний новгороде[/url]
Francisitedo
19 Oct 25 at 12:58 pm
melbet букмекерская контора официальный сайт регистрация [url=https://melbetbonusy.ru/]https://melbetbonusy.ru/[/url] .
melbet_uoOi
19 Oct 25 at 1:01 pm
Do you have a spam problem on this blog; I also am a blogger,
and I was wondering your situation; we have created some
nice practices and we are looking to exchange methods with other folks,
please shoot me an email if interested.
seo
19 Oct 25 at 1:02 pm
At this moment I am ready to do my breakfast, when having my breakfast coming over again to read other news.
ChinaTime，Super Clone Watches
19 Oct 25 at 1:03 pm
Estou completamente enfeiticado por SpellWin Casino, parece um portal mistico cheio de adrenalina. A gama do cassino e simplesmente um feitico de prazeres, oferecendo sessoes de cassino ao vivo que brilham como runas. O suporte do cassino ta sempre na ativa 24/7, dando solucoes na hora e com precisao. Os pagamentos do cassino sao lisos e blindados, mesmo assim as ofertas do cassino podiam ser mais generosas. No geral, SpellWin Casino garante uma diversao de cassino que e magica para os magos do cassino! E mais o design do cassino e um espetaculo visual encantado, eleva a imersao no cassino a um nivel magico.
george spellwin|
zestycandycrow6zef
19 Oct 25 at 1:03 pm
можно купить диплом медсестры [url=http://www.frei-diplom13.ru]можно купить диплом медсестры[/url] .
Diplomi_rkkt
19 Oct 25 at 1:04 pm
Kaizenaire.ϲom iѕ Singapore’s curated promotions powerhouse fⲟr deals and offｅrs.
In Singapore, promotions are king in thjs shopping
heaven, adored Ьү deal-loving Singaporeans.
Singaporeans typically unwind ԝith family members outings
at East Coast Park, ɑnd keep in mind to remain upgraded on Singapore’s mоst rеcеnt promotions and shopping deals.
Kydra concentrates ᧐n high-performance activewear,
ⅼiked by flashy Singaporeans fоr theіr cutting-edge fabrics ɑnd fit.
Samsung supplies electronics ⅼike smart devices
and TVs lah, loved Ƅy technology enthusiasts іn Singapore f᧐r their cutting-edge functions аnd sturdiness lor.
Delfi Limited sweetens ᴡith delicious chocolates ⅼike
Ⅴan Houten, valued ƅy youngsters for fun,
budget-friendly treats.
Мuch bеtter prepare leh, Kaizenaire.com updates supplies ᧐ne.
my web ρage – promotions singapore
promotions singapore
19 Oct 25 at 1:04 pm
Ich bin vollig hin und weg von King Billy Casino, es verstromt eine Spielstimmung, die wie ein Palast glanzt. Es gibt eine Flut an mitrei?enden Casino-Titeln, mit modernen Casino-Slots, die verzaubern. Der Casino-Support ist rund um die Uhr verfugbar, liefert klare und schnelle Losungen. Casino-Zahlungen sind sicher und reibungslos, aber mehr regelma?ige Casino-Boni waren koniglich. Kurz gesagt ist King Billy Casino ein Casino mit einem Spielspa?, der wie ein Kronungsfest funkelt fur Fans moderner Casino-Slots! Extra die Casino-Seite ist ein grafisches Meisterwerk, einen Hauch von Majestat ins Casino bringt.
king billy casino curacao bonuses|
goofybeetle9zef
19 Oct 25 at 1:05 pm
купить диплом в новороссийске [url=rudik-diplom9.ru]купить диплом в новороссийске[/url] .
Diplomi_msei
19 Oct 25 at 1:06 pm
Hello, I enjoy reading through your article post.
I like to write a little comment to support you.
buy Linode accounts
19 Oct 25 at 1:06 pm
В Краснодаре нарколог из клиники «Детокс» приедет на дом, чтобы вывести из запоя и оказать необходимую помощь.
Подробнее можно узнать тут – [url=https://narkolog-na-dom-krasnodar25.ru/]нарколог на дом круглосуточно цены краснодар[/url]
JamieOvedy
19 Oct 25 at 1:07 pm
The $MTAUR token utility in unlocking special zones is what sets it apart from generic play-to-earn. Presale stage 1 savings are massive, up to 5x value. Team’s experience from top crypto projects adds credibility.
minotaurus ico
WilliamPargy
19 Oct 25 at 1:08 pm
Do you have a spam problem on this blog; I also am a blogger, and I was wanting to know your situation; many of us have developed some nice methods and we are looking to swap solutions with others, why not shoot
me an email if interested.
Dog Hiking Equipment
19 Oct 25 at 1:10 pm
Hey there would you mind stating which blog platform
you’re working with? I’m planning to start my
own blog soon but I’m having a difficult time selecting between BlogEngine/Wordpress/B2evolution and Drupal.
The reason I ask is because your layout seems different then most blogs and
I’m looking for something completely unique.
P.S My apologies for getting off-topic but I had to ask!
mv88 com
19 Oct 25 at 1:11 pm
сколько стоит купить диплом медсестры [url=frei-diplom13.ru]сколько стоит купить диплом медсестры[/url] .
Diplomi_rfkt
19 Oct 25 at 1:12 pm
1win jonli yordam [url=https://1win5509.ru/]1win jonli yordam[/url]
1win_uz_wmKt
19 Oct 25 at 1:13 pm
1win uz [url=1win5509.ru]1win uz[/url]
1win_uz_waKt
19 Oct 25 at 1:17 pm
купить диплом в тольятти [url=https://rudik-diplom9.ru]купить диплом в тольятти[/url] .
Diplomi_cmei
19 Oct 25 at 1:19 pm
Hi there, I would like to subscribe for this webpage to obtain newest
updates, thus where can i do it please help out.
tv88.com
19 Oct 25 at 1:20 pm
https://hub.docker.com/u/hadefkeehnvx
Anthonycam
19 Oct 25 at 1:20 pm
Oh my goodness! Awesome article dude! Thank you,
However I am encountering troubles with your RSS. I don’t
understand why I can’t join it. Is there anybody else
getting identical RSS issues? Anyone who knows the solution will
you kindly respond? Thanks!!
88aa.com
19 Oct 25 at 1:21 pm
диплом медсестры с аккредитацией купить [url=http://www.frei-diplom13.ru]диплом медсестры с аккредитацией купить[/url] .
Diplomi_ickt
19 Oct 25 at 1:22 pm
Бонусы также различаются по виду. Часть бонусов предлагаются новичкам. При регистрации на 1xBet, введите промокод и оформите 100% бонус на первый депозит на сумму до 32500 рублей. Компания 1xBet предлагает своим клиентам участвовать в спортивных ставках и казино с использованием бонусных средств. Это увеличивает вовлечённость к ставкам и гарантирует надежность игры. Актуальный промокод можно найти по этой ссылке — http://www.vlaje.ru/obuv/pages/1xbet_promokod_pri_registracii_na_segodnya_besplatno.html.
Jamesslurn
19 Oct 25 at 1:22 pm
мелбет фрибет 500 [url=http://www.melbetbonusy.ru]мелбет фрибет 500[/url] .
melbet_bzOi
19 Oct 25 at 1:28 pm