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://narkolog-na-dom-krasnodar26.ru/]вызвать нарколога на дом краснодар[/url]
DanielCaupe
18 Oct 25 at 1:45 pm
проект перепланировки квартиры для согласования цена [url=proekt-pereplanirovki-kvartiry16.ru]proekt-pereplanirovki-kvartiry16.ru[/url] .
proekt pereplanirovki kvartiri_pbMl
18 Oct 25 at 1:46 pm
заказать проект перепланировки квартиры [url=https://proekt-pereplanirovki-kvartiry17.ru]заказать проект перепланировки квартиры[/url] .
proekt pereplanirovki kvartiri_nmml
18 Oct 25 at 1:49 pm
согласование перепланировки квартиры [url=https://soglasovanie-pereplanirovki-kvartiry14.ru/]soglasovanie-pereplanirovki-kvartiry14.ru[/url] .
soglasovanie pereplanirovki kvartiri _fhEl
18 Oct 25 at 1:49 pm
мелбет приветственный бонус [url=http://melbetbonusy.ru/]мелбет приветственный бонус[/url] .
melbet_shOi
18 Oct 25 at 1:50 pm
https://t.me/s/Official_1xbet_1xbet/1629
Josephadvem
18 Oct 25 at 1:53 pm
перепланировка москва [url=www.soglasovanie-pereplanirovki-kvartiry11.ru/]www.soglasovanie-pereplanirovki-kvartiry11.ru/[/url] .
soglasovanie pereplanirovki kvartiri _jwMi
18 Oct 25 at 1:55 pm
Hi everybody, here every person is sharing these know-how, so it’s nice to read this website, and
I used to pay a visit this webpage all the time.
https://ch.search.yahoo.com/mobile/s?ei=UTF-8&fl=35&p=site:www.telegramoom.com
18 Oct 25 at 1:55 pm
live casinos: This category resources casinos that are not included in gamstop, provides different games in rhythm present time, [url=https://www.mattchedit.com/exploring-slots-and-casinos-not-on-gamstop-21/]https://www.mattchedit.com/exploring-slots-and-casinos-not-on-gamstop-21/[/url] including variants of classic table games.
DeniseErrop
18 Oct 25 at 1:56 pm
перепланировка под ключ москва стоимость [url=www.stoimost-soglasovaniya-pereplanirovki-kvartiry.ru/]www.stoimost-soglasovaniya-pereplanirovki-kvartiry.ru/[/url] .
stoimost soglasovaniya pereplanirovki kvartiri_dqPt
18 Oct 25 at 1:56 pm
Discover curated savings аt Kaizenaire.com, Singapore’ѕ elite systеm for promotions аnd occasion deals.
Ԝith its glittering malls ɑnd dynamic markets, Singapore іs a true shopping heaven, sustaining
tһe intеrest of deal-loving Singaporeans fօr promotions galore.
Accumulating vinyl records іs a retro interest for music-collecting Singaporeans, аnd bear in mind tօ stay
upgraded օn Singapore’ѕ most recent promotions and shopping deals.
Amazon pгovides on tһe internet purchasing publications, devices, ɑnd much mօгe, appreciated by Singaporeans for thеir
quick shipment аnd hսgе choice.
A Kind Studio focuses оn sustainable precious jewelry аnd accessories leh, valued by eco-friendly
Singaporeans fоr tһeir honest workmanship
оne.
Prima Taste packs Singaporean faves likе laksa paste,
enjoyed fߋr simple, restaurant-quality dishes аt home.
Wah lao, power lah, Kaizenaire.ϲom has fresh ⲣrice cuts waiting sia.
Also visit my website – Kaizenaire.com business loans
Kaizenaire.com business loans
18 Oct 25 at 1:57 pm
проект на перепланировку квартиры заказать [url=http://www.proekt-pereplanirovki-kvartiry16.ru]http://www.proekt-pereplanirovki-kvartiry16.ru[/url] .
proekt pereplanirovki kvartiri_gcMl
18 Oct 25 at 1:57 pm
мелбет фрибет за регистрацию условия [url=https://www.melbetbonusy.ru]мелбет фрибет за регистрацию условия[/url] .
melbet_noOi
18 Oct 25 at 1:59 pm
I all the time emailed this webpage post page to all my associates, since if like to
read it after that my links will too.
tk88
18 Oct 25 at 1:59 pm
http://pilloleverdi.com/# pillole verdi
MickeySum
18 Oct 25 at 1:59 pm
https://t.me/s/Official_1xbet_1xbet/1756
Josephadvem
18 Oct 25 at 2:00 pm
wettbüro us wahl
Also visit my web page; wett tips heute (Ruth)
Ruth
18 Oct 25 at 2:00 pm
Вызов нарколога на дом в Краснодаре — услуга клиники «Детокс». Специалисты оказывают квалифицированную помощь прямо у вас дома.
Ознакомиться с деталями – [url=https://narkolog-na-dom-krasnodar29.ru/]вызов врача нарколога на дом в краснодаре[/url]
StevenPrabY
18 Oct 25 at 2:00 pm
компании занимащиеся офицально перепланировками квартир [url=https://www.soglasovanie-pereplanirovki-kvartiry14.ru]https://www.soglasovanie-pereplanirovki-kvartiry14.ru[/url] .
soglasovanie pereplanirovki kvartiri _kyEl
18 Oct 25 at 2:01 pm
сколько стоит перепланировка квартиры в москве [url=https://zakazat-proekt-pereplanirovki-kvartiry11.ru/]zakazat-proekt-pereplanirovki-kvartiry11.ru[/url] .
zakazat proekt pereplanirovki kvartiri_abet
18 Oct 25 at 2:01 pm
Thanks for finally talking about > PHP hook, building hooks in your application – Sjoerd Maessen blog at Sjoerd Maessen blog < Liked it!
tải 13win com
18 Oct 25 at 2:03 pm
bs2web at Заинтригован, что вызывает резонанс в тёмных закоулках сети? Blacksprut — это не просто наименование, это воплощение идеала анонимности, стремительной работы и непоколебимой уверенности. Отправляйся на bs2best.at — в обитель, где раскрывают секреты, о которых предпочитают молчать. Здесь тебе станет доступно сокровенное знание, охраняемое от непосвященных. Исключительно для тех, кто понимает суть. Никаких улик. Никаких соглашений. Только Blacksprut. Не упусти драгоценную возможность стать пионером — bs2best.at распахнул врата для тех, кто ищет истину. Хватит ли тебе отваги заглянуть правде в лицо?
HermanRhype
18 Oct 25 at 2:03 pm
сделать проект перепланировки [url=www.proekt-pereplanirovki-kvartiry16.ru]www.proekt-pereplanirovki-kvartiry16.ru[/url] .
proekt pereplanirovki kvartiri_esMl
18 Oct 25 at 2:05 pm
mostbet uz yuklab olish skachat [url=http://mostbet4185.ru/]http://mostbet4185.ru/[/url]
mostbet_uz_haer
18 Oct 25 at 2:05 pm
Hi! Would you mind if I share your blog with my facebook group?
There’s a lot of people that I think would really appreciate your content.
Please let me know. Thanks
website mua bán ma túy
18 Oct 25 at 2:06 pm
It’s actually a great and helpful piece of info.
I’m happy that you simply shared this useful information with us.
Please keep us up to date like this. Thank you for sharing.
https://cz.search.yahoo.com/mobile/s?ei=UTF-8&fl=8&p=site:www.telehao.com
18 Oct 25 at 2:06 pm
Каждая инновация начинается с кода kraken ссылка зеркало кракен онион тор кракен онион зеркало кракен даркнет маркет
RichardPep
18 Oct 25 at 2:07 pm
cjukfcjdfybt [url=http://www.soglasovanie-pereplanirovki-kvartiry11.ru]http://www.soglasovanie-pereplanirovki-kvartiry11.ru[/url] .
soglasovanie pereplanirovki kvartiri _bwMi
18 Oct 25 at 2:07 pm
В Самаре в «Частном Медике 24» пациент получает детоксикацию, восстановительное лечение и круглосуточное наблюдение врачей.
Подробнее – [url=https://vyvod-iz-zapoya-v-stacionare-samara23.ru/]вывод из запоя в стационаре в самаре[/url]
Williamliz
18 Oct 25 at 2:07 pm
сколько стоит разрешение на перепланировку квартиры [url=https://stoimost-soglasovaniya-pereplanirovki-kvartiry.ru]https://stoimost-soglasovaniya-pereplanirovki-kvartiry.ru[/url] .
stoimost soglasovaniya pereplanirovki kvartiri_oaPt
18 Oct 25 at 2:08 pm
sportwetten prognosen heute
Also visit my site … Wollen Wir Wetten Gewinner – http://Www.Byc.Cl,
Www.Byc.Cl
18 Oct 25 at 2:08 pm
мосбет [url=http://mostbet4182.ru]мосбет[/url]
mostbet_uz_ibkt
18 Oct 25 at 2:09 pm
сколько стоит оформить перепланировку квартиры в бти [url=www.zakazat-proekt-pereplanirovki-kvartiry11.ru/]www.zakazat-proekt-pereplanirovki-kvartiry11.ru/[/url] .
zakazat proekt pereplanirovki kvartiri_ctet
18 Oct 25 at 2:11 pm
Just extended $MTAUR vesting for extras. ICO’s tokenomics balanced. Play-to-earn future here.
mtaur coin
WilliamPargy
18 Oct 25 at 2:14 pm
мел бет [url=www.melbetbonusy.ru/]мел бет[/url] .
melbet_yyOi
18 Oct 25 at 2:14 pm
перепланировка и согласование [url=https://soglasovanie-pereplanirovki-kvartiry14.ru/]https://soglasovanie-pereplanirovki-kvartiry14.ru/[/url] .
soglasovanie pereplanirovki kvartiri _jfEl
18 Oct 25 at 2:14 pm
It’s awesome to pay a visit this website and reading the views of all mates
on the topic of this article, while I am also eager of getting
familiarity.
888new
18 Oct 25 at 2:20 pm
сколько стоит оформление перепланировки квартиры [url=https://stoimost-soglasovaniya-pereplanirovki-kvartiry.ru]https://stoimost-soglasovaniya-pereplanirovki-kvartiry.ru[/url] .
stoimost soglasovaniya pereplanirovki kvartiri_zdPt
18 Oct 25 at 2:20 pm
I really like your blog.. very nice colors & theme.
Did you make this website yourself or did you hire someone to do it for you?
Plz answer back as I’m looking to design my own blog and would like to
know where u got this from. thanks a lot
hargatoto
18 Oct 25 at 2:21 pm
где можно купить диплом медсестры [url=https://frei-diplom14.ru/]где можно купить диплом медсестры[/url] .
Diplomi_guoi
18 Oct 25 at 2:21 pm
Hello i am kavin, its my first time to commenting anywhere,
when i read this paragraph i thought i could also make comment due to this sensible article.
imp source
18 Oct 25 at 2:22 pm
изготовление проекта перепланировки квартиры [url=proekt-pereplanirovki-kvartiry16.ru]proekt-pereplanirovki-kvartiry16.ru[/url] .
proekt pereplanirovki kvartiri_pmMl
18 Oct 25 at 2:22 pm
https://t.me/s/Official_1xbet_1xbet/1664
Josephadvem
18 Oct 25 at 2:23 pm
купить диплом в биробиджане [url=https://www.rudik-diplom10.ru]купить диплом в биробиджане[/url] .
Diplomi_hqSa
18 Oct 25 at 2:25 pm
linebet ????? ?????
????? ????? ??????? linebet
18 Oct 25 at 2:27 pm
стоимость согласования перепланировки квартиры в москве [url=https://zakazat-proekt-pereplanirovki-kvartiry11.ru/]https://zakazat-proekt-pereplanirovki-kvartiry11.ru/[/url] .
zakazat proekt pereplanirovki kvartiri_tdet
18 Oct 25 at 2:27 pm
melbet фрибет при регистрации [url=https://melbetbonusy.ru]melbet фрибет при регистрации[/url] .
melbet_tuOi
18 Oct 25 at 2:27 pm
перепланировка помещения [url=https://soglasovanie-pereplanirovki-kvartiry11.ru/]soglasovanie-pereplanirovki-kvartiry11.ru[/url] .
soglasovanie pereplanirovki kvartiri _dqMi
18 Oct 25 at 2:28 pm
Если пациент не может приехать в клинику, в Краснодаре нарколог приедет к нему домой. Помощь оказывает «Детокс» круглосуточно.
Детальнее – [url=https://narkolog-na-dom-krasnodar27.ru/]вызвать нарколога на дом краснодар[/url]
DanielNus
18 Oct 25 at 2:34 pm
sportwetten bonus
my homepage :: Esc deutschland buchmacher
Esc deutschland buchmacher
18 Oct 25 at 2:35 pm