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!
If you are going for most excellent contents like myself, simply visit this web site every day because it offers quality contents, thanks
turkey visa for australian
13 Oct 25 at 8:04 am
metal chat
Keithwebra
13 Oct 25 at 8:05 am
Just swapped some ETH for $MTAUR in the presale; the process was seamless on multiple chains. The in-game currency conversion gives real edge in play. This could rival Subway Surfers with crypto flair.
minotaurus presale
WilliamPargy
13 Oct 25 at 8:05 am
В этом интересном тексте собраны обширные сведения, которые помогут вам понять различные аспекты обсуждаемой темы. Мы разбираем детали и факты, делая акцент на важности каждого элемента. Не упустите возможность расширить свои знания и взглянуть на мир по-новому!
Информация доступна здесь – https://burgre.sk/bigstock-157829123_upr
Michaelled
13 Oct 25 at 8:06 am
Acho simplesmente fenomenal BR4Bet Casino, oferece uma aventura que brilha como um candelabro em chamas. As opcoes sao ricas e reluzem como luzes. com jogos adaptados para criptomoedas. Os agentes sao rapidos como um raio de farol. com solucoes precisas e instantaneas. Os pagamentos sao seguros e fluidos. entretanto queria promocoes que acendem como chamas. No geral, BR4Bet Casino garante um jogo que reluz como um farol para os faroleiros do cassino! E mais o visual e uma explosao de claroes. dando vontade de voltar como uma chama eterna.
como usar o bonus da br4bet|
quirkyblazepenguin3zef
13 Oct 25 at 8:06 am
1win az virtual oyunlar [url=https://1win5004.com/]https://1win5004.com/[/url]
1win_usoi
13 Oct 25 at 8:06 am
What’s up it’s me, I am also visiting this website on a regular basis, this web site is genuinely
pleasant and the users are in fact sharing good thoughts.
Immediate Elevation
13 Oct 25 at 8:07 am
Sou totalmente viciado em BETesporte Casino, leva a um universo de apostas dinamico. Ha uma explosao de jogos emocionantes, suportando jogos compativeis com criptomoedas. Fortalece seu saldo inicial. O suporte ao cliente e excepcional, acessivel a qualquer momento. Os ganhos chegam sem atraso, embora recompensas extras seriam um hat-trick. Em sintese, BETesporte Casino e uma plataforma que domina o campo para amantes de apostas esportivas ! Alem disso o design e moderno e vibrante, instiga a prolongar o jogo. Muito atrativo os pagamentos seguros em cripto, fortalece o senso de comunidade.
Consultar os detalhes|
ThunderKickV9zef
13 Oct 25 at 8:07 am
Sou viciado em PlayPIX Casino, leva a um universo de pura adrenalina. A selecao de jogos e fenomenal, com slots de design inovador. 100% ate €500 + rodadas gratis. O suporte ao cliente e excepcional, sempre pronto para resolver. Os saques sao rapidos como um raio, no entanto promocoes mais frequentes dariam um toque extra. Em sintese, PlayPIX Casino e uma plataforma que brilha para quem aposta com cripto ! Alem disso o design e moderno e vibrante, aumenta o prazer de jogar. Um diferencial significativo as opcoes variadas de apostas esportivas, oferece recompensas continuas.
Clique agora|
RioFlareZ3zef
13 Oct 25 at 8:09 am
куплю диплом младшей медсестры [url=frei-diplom14.ru]frei-diplom14.ru[/url] .
Diplomi_czoi
13 Oct 25 at 8:10 am
Sou viciado na pista de F12.Bet Casino, tem um ritmo de jogo que derrapa como um drift. Os jogos formam uma curva de diversao. incluindo mesas com charme de pit lane. O suporte e um engenheiro de pit stop. com ajuda que ronca como um motor. As transacoes sao faceis como um drift. mas mais giros gratis seriam uma loucura de pista. Ao final, F12.Bet Casino promete uma diversao que e uma ultrapassagem para os exploradores de jogos online! Por sinal o layout e vibrante como um velocimetro. dando vontade de voltar como um carro de corrida.
f12 bet aviator da f12|
twistyflameotter7zef
13 Oct 25 at 8:10 am
Me encantei pelo drible de MarjoSports Casino, tem uma energia de jogo tao vibrante quanto uma torcida em delirio. Os jogos formam uma quadra de diversao. com caca-niqueis que aceleram como contra-ataques. O suporte e um arbitro de eficiencia. disponivel por chat ou e-mail. Os saques sao velozes como um sprint final. mesmo assim mais giros gratis seriam uma loucura de torcida. Em resumo, MarjoSports Casino e uma rede de adrenalina para os craques do cassino! Alem disso a interface e fluida e vibra como um estadio. criando uma experiencia de cassino de torcida.
www marjosports|
twistyneonemu2zef
13 Oct 25 at 8:10 am
Slot-Spiele in Online-Casinos bieten Unterhaltung und Gewinnchancen. Setzen Sie sich ein Budget, um Verluste zu begrenzen.
metoprolol
ThomasInvag
13 Oct 25 at 8:11 am
Je suis captive par Simsinos Casino, on dirait un scenario plein de bulles de fun. La selection du casino est une planche de plaisirs. avec des slots qui rebondissent comme des bulles. Le service client du casino est un realisateur fidele. assurant un support de casino immediat et anime. Le processus du casino est transparent et sans fondu. par moments des bonus de casino plus frequents seraient animes. Au final, Simsinos Casino resonne comme un storyboard de plaisir pour les fans de symphonies colorees! Ajoutons l’interface du casino est fluide et vibre comme une planche animee. facilite une experience de casino dessinee.
simsinos online casino|
whirlneonflamingo2zef
13 Oct 25 at 8:11 am
Simply desire to say your article is as surprising.
The clarity on your put up is just cool and that i could assume you’re a professional on this subject.
Fine along with your permission allow me to take hold
of your RSS feed to stay updated with coming near near post.
Thank you 1,000,000 and please keep up the rewarding work.
dog gps
13 Oct 25 at 8:11 am
аренда погрузчиков в москве и московской области [url=https://arenda-ekskavatora-pogruzchika-cena-2.ru/]https://arenda-ekskavatora-pogruzchika-cena-2.ru/[/url] .
arenda ekskavatora pogryzchika cena_gqst
13 Oct 25 at 8:13 am
Эта публикация дает возможность задействовать различные источники информации и представить их в удобной форме. Читатели смогут быстро найти нужные данные и получить ответы на интересующие их вопросы. Мы стремимся к четкости и доступности материала для всех!
Слушай внимательно — тут важно – https://blog.bdp.cn/?attachment_id=37
Edwarddug
13 Oct 25 at 8:15 am
Je suis totalement seduit par Locowin Casino, ca fournit un plaisir intense. Les alternatives sont incroyablement etendues, avec des slots au style innovant. Le bonus d’accueil est attractif. Le suivi est exemplaire, accessible a tout instant. Les operations sont solides et veloces, mais quelques tours gratuits supplementaires seraient apprecies. En fin de compte, Locowin Casino merite une exploration approfondie pour les aficionados de jeux contemporains ! Ajoutons que l’interface est intuitive et raffinee, facilite une immersion complete. A souligner aussi les tournois periodiques pour la rivalite, offre des privileges sur mesure.
Ouvrir maintenant|
EnigmaReelD5zef
13 Oct 25 at 8:15 am
Snagged more $MTAUR; referrals pay. Presale’s value jumps. Minotaur customizable.
minotaurus presale
WilliamPargy
13 Oct 25 at 8:17 am
Very nice post. I just stumbled upon your weblog and wanted to say that I have really enjoyed browsing your blog
posts. In any case I’ll be subscribing to your feed and
I hope you write again soon!
seriöse Entrümpelung Berlin
13 Oct 25 at 8:17 am
1win crypto ödənişlər [url=https://1win5005.com/]https://1win5005.com/[/url]
1win_tvml
13 Oct 25 at 8:18 am
купить диплом в москве [url=http://www.rudik-diplom2.ru]купить диплом в москве[/url] .
Diplomi_yopi
13 Oct 25 at 8:18 am
можно ли купить диплом медсестры [url=http://www.frei-diplom14.ru]можно ли купить диплом медсестры[/url] .
Diplomi_eroi
13 Oct 25 at 8:19 am
Howdy! I know this is kinda off topic nevertheless I’d figured I’d
ask. Would you be interested in trading links or maybe guest writing a blog article or vice-versa?
My site addresses a lot of the same topics as yours
and I feel we could greatly benefit from each other.
If you might be interested feel free to send me an email.
I look forward to hearing from you! Excellent blog by the way!
xem ngay truyện người lớn
13 Oct 25 at 8:20 am
Hey there, I think your site might be having browser compatibility issues.
When I look at your website in Ie, 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, amazing blog!
Redefined Restoration - Franklin Park Water Damage Service
13 Oct 25 at 8:20 am
brand levitra online
brand levitra online
13 Oct 25 at 8:21 am
1win promo kod [url=https://1win5004.com]https://1win5004.com[/url]
1win_zroi
13 Oct 25 at 8:21 am
buy viagra online: Viagra online UK – order ED pills online UK
Brettesofe
13 Oct 25 at 8:22 am
аренда навесного оборудования на экскаватор [url=http://arenda-ekskavatora-pogruzchika-cena-2.ru]аренда навесного оборудования на экскаватор[/url] .
arenda ekskavatora pogryzchika cena_jcst
13 Oct 25 at 8:24 am
https://killjack.ru
RandyEluse
13 Oct 25 at 8:25 am
I have been surfing online more than 2 hours today, yet I never
found any interesting article like yours.
It is pretty worth enough for me. Personally, if all web owners and bloggers
made good content as you did, the net will be a lot more useful than ever
before.
fuck
13 Oct 25 at 8:26 am
Je suis entierement obsede par Locowin Casino, ca transporte dans un univers envoutant. La diversite des titres est epoustouflante, avec des slots au style innovant. Associe a des tours gratuits sans wager. L’equipe d’assistance est remarquable, assurant un support premium. Les paiements sont proteges et lisses, de temps a autre des incitations additionnelles seraient un benefice. Tout compte fait, Locowin Casino garantit du divertissement constant pour les joueurs a la recherche d’aventure ! A mentionner le site est veloce et seduisant, ajoute un confort notable. Un autre avantage cle les evenements communautaires captivants, qui stimule l’engagement.
Voir par vous-mГЄme|
NeonPulseG5zef
13 Oct 25 at 8:29 am
I was able to find good info from your blog posts.
smut short stories
13 Oct 25 at 8:30 am
1win şikayətlər [url=https://1win5005.com]https://1win5005.com[/url]
1win_fxml
13 Oct 25 at 8:35 am
аренда экскаватора погрузчика в москве [url=https://arenda-ekskavatora-pogruzchika-cena-2.ru/]аренда экскаватора погрузчика в москве[/url] .
arenda ekskavatora pogryzchika cena_hsst
13 Oct 25 at 8:36 am
Этот обзор предлагает структурированное изложение информации по актуальным вопросам. Материал подан так, чтобы даже новичок мог быстро освоиться в теме и начать использовать полученные знания в практике.
Не упусти шанс – https://www.orquestraarabdebarcelona.com/nurturing-the-bond-between-humans-and-nature
DavidquAbs
13 Oct 25 at 8:36 am
Этот обзор дает возможность взглянуть на историю и науку под новым углом. Мы представляем редкие факты, неожиданные связи и значимые события, которые помогут вам глубже понять развитие цивилизации и роль человека в ней.
Получить исчерпывающие сведения – https://myqmd.com/98symptoms
MarvinBog
13 Oct 25 at 8:38 am
Публикация предлагает читателю не просто информацию, а инструменты для анализа и саморазвития. Мы стимулируем критическое мышление, предлагая различные точки зрения и призывая к самостоятельному поиску решений.
Что скрывают от вас? – https://finance-navi.info/idea
Nolanwet
13 Oct 25 at 8:38 am
Today, while I was at work, my cousin stole my iphone and tested to see if it
can survive a 30 foot drop, just so she can be a youtube sensation. My iPad is now destroyed and she has
83 views. I know this is entirely off topic but I had to share it
with someone!
Buy Crystal Meth Online
13 Oct 25 at 8:38 am
аренда экскаватора погрузчика в москве срочно [url=http://arenda-ekskavatora-pogruzchika-cena-2.ru/]http://arenda-ekskavatora-pogruzchika-cena-2.ru/[/url] .
arenda ekskavatora pogryzchika cena_hgst
13 Oct 25 at 8:40 am
В этом информативном тексте представлены захватывающие события и факты, которые заставят вас задуматься. Мы обращаем внимание на важные моменты, которые часто остаются незамеченными, и предлагаем новые перспективы на привычные вещи. Подготовьтесь к тому, чтобы быть поглощенным увлекательными рассказами!
Обратиться к источнику – https://suavisfv.se/hello-world
CharlesVak
13 Oct 25 at 8:43 am
brand levitra online
brand levitra online
13 Oct 25 at 8:43 am
It’s actually very complicated in this active life to listen news on TV, therefore
I only use web for that purpose, and take
the most recent information.
Rikdom Bitrad
13 Oct 25 at 8:44 am
music stream
Keithwebra
13 Oct 25 at 8:47 am
Эта публикация дает возможность задействовать различные источники информации и представить их в удобной форме. Читатели смогут быстро найти нужные данные и получить ответы на интересующие их вопросы. Мы стремимся к четкости и доступности материала для всех!
Заходи — там интересно – https://a1bakers.com/index.php/2023/02/18/hello-world
ErichLesty
13 Oct 25 at 8:47 am
1win aviator qeydiyyat [url=www.1win5005.com]www.1win5005.com[/url]
1win_gtml
13 Oct 25 at 8:48 am
forzest without prescription
forzest without prescription
13 Oct 25 at 8:49 am
I’ve been following the Minotaurus presale closely, and it’s impressive how they’ve structured the tokenomics for long-term sustainability. The vesting bonuses are a smart incentive that could really reward patient holders. Excited to see $MTAUR launch and disrupt the blockchain gaming space. minotaurus token
WilliamPargy
13 Oct 25 at 8:50 am
https://infiniti32.ru
RandyEluse
13 Oct 25 at 8:51 am
купить диплом в белогорске [url=https://rudik-diplom1.ru/]https://rudik-diplom1.ru/[/url] .
Diplomi_tqer
13 Oct 25 at 8:51 am