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!
аттестат о среднем образовании 9 классов купить [url=https://educ-ua20.ru/]аттестат о среднем образовании 9 классов купить[/url] .
Diplomi_cmEn
6 Sep 25 at 8:26 am
Кроме того, клиника «Новый шанс» уделяет особое внимание профилактике рецидивов. Мы обучаем пациентов навыкам управления стрессом, эмоциональной регуляции и прививаем навыки здорового образа жизни. Наша цель — обеспечить долгосрочное восстановление и снизить риск возврата к зависимости.
Получить дополнительные сведения – [url=https://tajno-vyvod-iz-zapoya.ru/vyvod-iz-zapoya-cena-v-rostove-na-donu.ru/]вывод из запоя на дому цена в ростове-на-дону[/url]
Kevinwef
6 Sep 25 at 8:28 am
The petition stated that the availability of information on electoral bonds is critical for voters to make informed
Electoral Bond Disclosure Controversy decisions, emphasizing the importance of transparency in the electoral process.
ssstwitter downloader
6 Sep 25 at 8:29 am
купить диплом института киев [url=http://educ-ua20.ru/]http://educ-ua20.ru/[/url] .
Diplomi_xjEn
6 Sep 25 at 8:32 am
nexus darknet market darknet market darknet drug links [url=https://darknetmarketsgate.com/ ]dark web market [/url]
Donaldfup
6 Sep 25 at 8:32 am
Every weekend i used to pay a quick visit this
web site, because i want enjoyment, since this this
web site conations truly good funny information too.
my webpage Chat Hub
Chat Hub
6 Sep 25 at 8:37 am
блог о рекламе и аналитике [url=https://statyi-o-marketinge.ru/]statyi-o-marketinge.ru[/url] .
stati o marketinge_aeSa
6 Sep 25 at 8:39 am
Приобрести диплом о высшем образовании!
Наша компания предлагаетвыгодно и быстро купить диплом, который выполнен на оригинальном бланке и заверен печатями, водяными знаками, подписями должностных лиц. Данный документ способен пройти лубую проверку, даже при помощи специальных приборов. Достигайте цели быстро и просто с нашей компанией- [url=http://forum-pravo.com.ua/member.php?u=10249/]forum-pravo.com.ua/member.php?u=10249[/url]
Jariorfix
6 Sep 25 at 8:42 am
https://ilm.iou.edu.gm/members/ambernortonamb/
Jeffreyzef
6 Sep 25 at 8:42 am
кракен ссылка kraken onion, kraken onion ссылка, kraken onion зеркала, kraken рабочая ссылка onion, сайт kraken onion, kraken darknet, kraken darknet market, kraken darknet ссылка, сайт kraken darknet, kraken актуальные ссылки, кракен ссылка kraken, kraken официальные ссылки, kraken ссылка тор, kraken ссылка зеркало, kraken ссылка на сайт, kraken онион, kraken онион тор, кракен онион, кракен онион тор, кракен онион зеркало, кракен даркнет маркет, кракен darknet, кракен onion, кракен ссылка onion, кракен onion сайт, kra ссылка, kraken сайт, kraken актуальные ссылки, kraken зеркало, kraken ссылка зеркало, kraken зеркало рабочее, актуальные зеркала kraken, kraken сайт зеркала, kraken маркетплейс зеркало, кракен ссылка, кракен даркнет
RichardPep
6 Sep 25 at 8:43 am
I think that is one of the so much significant info for me.
And i’m glad studying your article. But wanna statement on some normal things, The website style is great, the articles is in point of fact great
: D. Just right activity, cheers
memek becek
6 Sep 25 at 8:44 am
диплом высшего образования с занесением в реестр купить [url=http://arus-diplom34.ru]диплом высшего образования с занесением в реестр купить[/url] .
Diplomi_reer
6 Sep 25 at 8:51 am
купить диплом о среднем образовании в реестр [url=www.arus-diplom33.ru/]купить диплом о среднем образовании в реестр[/url] .
Diplomi_dbSa
6 Sep 25 at 8:53 am
I think the admin of this web site is genuinely working hard for
his site, because here every stuff is quality based material.
Here is my web page – best real estate agent in Oklahoma City OK
best real estate agent in Oklahoma City OK
6 Sep 25 at 8:53 am
Мы можем предложить документы институтов, которые находятся в любом регионе РФ. Приобрести диплом любого университета:
[url=http://countrysidetravels.com/forum/index.php?action=search2/]купить аттестат за 11 класс в архангельске[/url]
Diplomi_ksPn
6 Sep 25 at 8:53 am
В Химках найти надёжную наркологическую помощь можно на сайте клиники Stop Alko, где подробно описаны условия и этапы вывода из запоя.
Ознакомиться с деталями – https://vyvod-iz-zapoya-himki13.ru/
Joshuachisa
6 Sep 25 at 8:56 am
Since the admin of this web site is working, no hesitation very rapidly it will be well-known, due to its feature
contents.
roofing contractor
6 Sep 25 at 8:57 am
блог агентства интернет-маркетинга [url=http://statyi-o-marketinge.ru/]http://statyi-o-marketinge.ru/[/url] .
stati o marketinge_waSa
6 Sep 25 at 9:02 am
купить диплом техникума в реестре цена [url=awesome.5nx.ru/viewtopic.php?f=12&t=2693]купить диплом техникума в реестре цена[/url] .
Priobresti diplom VYZa!_ytkt
6 Sep 25 at 9:04 am
Идеален для пациентов со средней степенью интоксикации, не требующих круглосуточного мониторинга. Данная схема позволяет:
Ознакомиться с деталями – [url=https://nadezhnyj-vyvod-iz-zapoya.ru/]нарколог вывод из запоя[/url]
Davidhib
6 Sep 25 at 9:05 am
купить диплом о образовании недорого [url=educ-ua20.ru]купить диплом о образовании недорого[/url] .
Diplomi_tzEn
6 Sep 25 at 9:06 am
https://odysee.com/@huudieply29
Jeffreyzef
6 Sep 25 at 9:06 am
Hello, just wanted to say, I loved this article.
It was helpful. Keep on posting!
https://akademik-stroy.ru/product/314/
6 Sep 25 at 9:12 am
Looking for second-hand? thrift store We have collected the best stores with clothes, shoes and accessories. Large selection, unique finds, brands at low prices. Convenient catalog and up-to-date contacts.
second hand-844
6 Sep 25 at 9:12 am
dark market 2025 nexus site official link darknet drug links [url=https://darknetmarketsgate.com/ ]dark web sites [/url]
Donaldfup
6 Sep 25 at 9:13 am
Very energetic blog, I enjoyed that bit. Will there be a part 2?
Usa Private Proxy
6 Sep 25 at 9:16 am
подключить домашний интернет ростов
inernetvkvartiru-rostov004.ru
провайдеры интернета в ростове
internetrostovelini
6 Sep 25 at 9:16 am
hargatoto slot: toto slot hargatoto – hargatoto login
StevenFes
6 Sep 25 at 9:16 am
диплом купить с занесением в реестр [url=http://www.educ-ua12.ru]диплом купить с занесением в реестр[/url] .
Diplomi_tqMt
6 Sep 25 at 9:17 am
betawi77 [url=https://linkr.bio/betawi777#]betawi 777[/url] betawi 77
CharlesJam
6 Sep 25 at 9:18 am
seo статьи [url=http://statyi-o-marketinge.ru/]http://statyi-o-marketinge.ru/[/url] .
stati o marketinge_apSa
6 Sep 25 at 9:18 am
Hello there! This article could not be written any better!
Reading through this post reminds me of my previous roommate!
He constantly kept talking about this. I’ll send
this article to him. Pretty sure he’s going to have a good read.
Thank you for sharing!
atlantic fire arms shop
6 Sep 25 at 9:19 am
Now I am going to do my breakfast, afterward having my breakfast coming over again to read other news.
Review
6 Sep 25 at 9:20 am
Мы готовы предложить документы университетов, которые находятся на территории всей РФ. Купить диплом университета:
[url=http://ks4yumuo.listbb.ru/viewtopic.php?f=18&t=1799/]купить аттестат чита за 11[/url]
Diplomi_yaPn
6 Sep 25 at 9:23 am
betawi77 net: betawi77 net – betawi77 login
StevenFes
6 Sep 25 at 9:23 am
This text is worth everyone’s attention. Where can I find out
more?
soccer roulette
6 Sep 25 at 9:25 am
A fascinating discussion is worth comment. I do believe
that you need to publish more about this subject, it might
not be a taboo subject but typically folks don’t discuss such issues.
To the next! Cheers!!
memek tembem
6 Sep 25 at 9:26 am
купить диплом с занесением в реестр в спб [url=www.arus-diplom34.ru/]www.arus-diplom34.ru/[/url] .
Diplomi_acer
6 Sep 25 at 9:28 am
диплом медсестры с занесением в реестр купить [url=https://arus-diplom33.ru]диплом медсестры с занесением в реестр купить[/url] .
Diplomi_rmSa
6 Sep 25 at 9:28 am
Estou completamente louco por DiceBet Casino, da uma energia de cassino que e fora da curva. O catalogo de jogos do cassino e uma loucura total, incluindo jogos de mesa de cassino cheios de classe. O atendimento ao cliente do cassino e uma maravilha, com uma ajuda que e um arraso. Os saques no cassino sao velozes como um cometa, as vezes queria mais promocoes de cassino que mandam ver. Em resumo, DiceBet Casino e um cassino online que e uma pedrada para os cacadores de slots modernos de cassino! E mais o site do cassino e uma obra-prima de visual, da um toque de classe braba ao cassino.
dicebet Г© confiГЎvel|
zanycactus2zef
6 Sep 25 at 9:29 am
Je raffole de Circus, ca donne une vibe de jeu incroyable. La selection de jeux est spectaculaire, proposant des sessions live palpitantes. Les agents sont rapides et attentionnes, repondant en un rien de temps. Les paiements sont securises et efficaces, neanmoins j’aimerais plus de bonus reguliers. En resume, Circus garantit un divertissement de haut vol pour les joueurs en quete d’excitation ! De surcroit le site est style et bien pense, renforce l’envie de revenir.
circus casino arlon arlon|
thunderwave8zef
6 Sep 25 at 9:29 am
https://www.grepmed.com/yducadnyfgao
Jeffreyzef
6 Sep 25 at 9:29 am
hargatoto slot: hargatoto alternatif – toto slot hargatoto
StevenFes
6 Sep 25 at 9:31 am
купить диплом о высшем киев [url=http://www.educ-ua20.ru]http://www.educ-ua20.ru[/url] .
Diplomi_xeEn
6 Sep 25 at 9:32 am
https://mez.ink/batarabet# batarabet login
Thomaschied
6 Sep 25 at 9:32 am
раскрутка и продвижение сайта [url=https://internet-agentstvo-prodvizhenie-sajtov-seo.ru/]раскрутка и продвижение сайта[/url] .
internet agentstvo prodvijenie saitov seo_cbot
6 Sep 25 at 9:33 am
click through the next web site
PHP hook, building hooks in your application – Sjoerd Maessen blog at Sjoerd Maessen blog
click through the next web site
6 Sep 25 at 9:37 am
компании занимающиеся продвижением сайтов [url=internet-agentstvo-prodvizhenie-sajtov-seo.ru]компании занимающиеся продвижением сайтов[/url] .
internet agentstvo prodvijenie saitov seo_ksot
6 Sep 25 at 9:39 am
купить диплом ижевск с занесением в реестр [url=http://arus-diplom33.ru/]купить диплом ижевск с занесением в реестр[/url] .
Diplomi_wmSa
6 Sep 25 at 9:40 am
Hello there, just became aware of your blog through Google, and found that it’s really informative.
I am going to watch out for brussels. I’ll appreciate if
you continue this in future. A lot of people will be
benefited from your writing. Cheers!
نتایج کنکور فنی حرفه ای ۱۴۰۴
6 Sep 25 at 9:41 am