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!
Je trouve absolument legendaire Casinia Casino, est une epopee de divertissement qui enchante. L’assortiment de jeux du casino est un rempart de delices. proposant des slots de casino a theme medieval. est un virtuose de la noblesse. proposant un appui qui enchante. arrivent comme un tournoi. neanmoins des offres qui vibrent comme une cadence royale. Au final, Casinia Casino est un casino en ligne qui s’eleve comme un chateau enchante pour ceux qui cherchent l’adrenaline royale du casino! Par ailleurs le site du casino est une merveille graphique noble. facilite une experience de casino royale.
casinia casino ГЁ sicuro|
shadowwhirllynx2zef
14 Oct 25 at 3:38 pm
Caninet IQ
15030 N Tatum Blvd #150, Phoenix,
AZ 85032, United Ѕtates
(480) 424-4866
Materials
Materials
14 Oct 25 at 3:39 pm
купить диплом экономиста [url=rudik-diplom6.ru]купить диплом экономиста[/url] .
Diplomi_onKr
14 Oct 25 at 3:39 pm
электрокарниз двухрядный цена [url=https://www.karniz-shtor-elektroprivodom.ru]https://www.karniz-shtor-elektroprivodom.ru[/url] .
karniz dlya shtor s elektroprivodom_fmer
14 Oct 25 at 3:39 pm
алюминиевые электрожалюзи [url=http://www.zhalyuzi-s-elektroprivodom77.ru]http://www.zhalyuzi-s-elektroprivodom77.ru[/url] .
jaluzi na okna s elektroprivodom_pbpa
14 Oct 25 at 3:40 pm
купить диплом железнодорожника [url=https://www.rudik-diplom3.ru]купить диплом железнодорожника[/url] .
Diplomi_prei
14 Oct 25 at 3:40 pm
потолочников натяжные потолки [url=https://stretch-ceilings-samara.ru/]stretch-ceilings-samara.ru[/url] .
natyajnie potolki samara_mzkl
14 Oct 25 at 3:41 pm
согласование перепланировки нежилого помещения [url=https://pereplanirovka-nezhilogo-pomeshcheniya10.ru]согласование перепланировки нежилого помещения[/url] .
pereplanirovka nejilogo pomesheniya_mqSr
14 Oct 25 at 3:41 pm
аренда мини экскаватора в москве цена [url=https://www.arenda-mini-ekskavatora-v-moskve-2.ru]аренда мини экскаватора в москве цена[/url] .
arenda mini ekskavatora v moskve_krKt
14 Oct 25 at 3:42 pm
купить диплом в саранске [url=http://www.rudik-diplom11.ru]купить диплом в саранске[/url] .
Diplomi_vjMi
14 Oct 25 at 3:43 pm
натяжные потолки официальный [url=https://stretch-ceilings-samara.ru]https://stretch-ceilings-samara.ru[/url] .
natyajnie potolki samara_mekl
14 Oct 25 at 3:44 pm
проект перепланировки нежилого помещения [url=https://www.pereplanirovka-nezhilogo-pomeshcheniya9.ru]https://www.pereplanirovka-nezhilogo-pomeshcheniya9.ru[/url] .
pereplanirovka nejilogo pomesheniya_qrKl
14 Oct 25 at 3:45 pm
Highly descriptive post, I loved that bit. Will there be a part 2?
Zlaté retiazky - vipgold.sk
14 Oct 25 at 3:47 pm
J’ai une passion debordante pour Locowin Casino, ca offre un thrill incomparable. Les options sont incroyablement vastes, proposant des jeux de table immersifs. Doublement des depots jusqu’a 200 €. Le suivi est impeccable, garantissant un support de qualite. Les transactions sont fiables et rapides, mais des bonus plus varies seraient apprecies. Pour conclure, Locowin Casino est indispensable pour les joueurs pour les amateurs de sensations fortes ! De plus la plateforme est visuellement impressionnante, amplifie le plaisir de jouer. Egalement appreciable les tournois reguliers pour la competition, propose des avantages personnalises.
Parcourir le site|
DestinyVoiceH6zef
14 Oct 25 at 3:47 pm
регистрация перепланировки нежилого помещения [url=https://pereplanirovka-nezhilogo-pomeshcheniya10.ru]https://pereplanirovka-nezhilogo-pomeshcheniya10.ru[/url] .
pereplanirovka nejilogo pomesheniya_msSr
14 Oct 25 at 3:48 pm
купить диплом в буйнакске [url=https://www.rudik-diplom3.ru]https://www.rudik-diplom3.ru[/url] .
Diplomi_yxei
14 Oct 25 at 3:48 pm
фитнес клуб цены фитнес клуб цены
fitnes-klub-899
14 Oct 25 at 3:48 pm
аренда мини спецтехники [url=https://arenda-mini-ekskavatora-v-moskve-2.ru/]аренда мини спецтехники[/url] .
arenda mini ekskavatora v moskve_scKt
14 Oct 25 at 3:49 pm
потолочник отзывы [url=http://www.natyazhnye-potolki-samara-1.ru]http://www.natyazhnye-potolki-samara-1.ru[/url] .
natyajnie potolki samara_enor
14 Oct 25 at 3:49 pm
автоматический карниз для штор [url=http://karniz-shtor-elektroprivodom.ru/]http://karniz-shtor-elektroprivodom.ru/[/url] .
karniz dlya shtor s elektroprivodom_bber
14 Oct 25 at 3:49 pm
жалюзи для пластиковых окон с электроприводом [url=http://zhalyuzi-s-elektroprivodom77.ru/]http://zhalyuzi-s-elektroprivodom77.ru/[/url] .
jaluzi na okna s elektroprivodom_dupa
14 Oct 25 at 3:50 pm
Je suis captive par Locowin Casino, il delivre une experience unique. La diversite des titres est epoustouflante, comprenant des jeux adaptes aux cryptos. Le bonus d’accueil est attractif. Le service est operationnel 24/7, accessible a tout instant. Les retraits sont realises promptement, mais des offres plus liberales ajouteraient de la valeur. Globalement, Locowin Casino merite une exploration approfondie pour les enthousiastes de casino en ligne ! A mentionner le site est veloce et seduisant, ajoute un confort notable. Un autre avantage cle les tournois periodiques pour la rivalite, qui stimule l’engagement.
Commencer Г apprendre|
ChaosReelV7zef
14 Oct 25 at 3:50 pm
потолки самара [url=http://www.natyazhnye-potolki-samara-1.ru]http://www.natyazhnye-potolki-samara-1.ru[/url] .
natyajnie potolki samara_jtor
14 Oct 25 at 3:52 pm
тканевый натяжной потолок самара [url=http://www.stretch-ceilings-samara.ru]http://www.stretch-ceilings-samara.ru[/url] .
natyajnie potolki samara_xhkl
14 Oct 25 at 3:54 pm
автоматический карниз для штор [url=https://elektrokarnizy797.ru]https://elektrokarnizy797.ru[/url] .
elektrokarnizi_wcMl
14 Oct 25 at 3:57 pm
Содержание процедуры
Углубиться в тему – https://vyvod-iz-zapoya-shchelkovo6.ru/skoryj-vyvod-iz-zapoya-v-shchelkovo
Davidlut
14 Oct 25 at 3:58 pm
согласование перепланировки нежилого помещения в жилом доме [url=http://pereplanirovka-nezhilogo-pomeshcheniya10.ru]http://pereplanirovka-nezhilogo-pomeshcheniya10.ru[/url] .
pereplanirovka nejilogo pomesheniya_srSr
14 Oct 25 at 3:58 pm
Hi, I do think this is an excellent blog. I stumbledupon it ;
) I’m going to come back yet again since I book-marked it.
Money and freedom is the greatest way to change, may
you be rich and continue to help others.
reported
14 Oct 25 at 3:58 pm
Seth Gamble
Brentsek
14 Oct 25 at 3:59 pm
мини экскаватор в аренду [url=https://arenda-mini-ekskavatora-v-moskve-2.ru/]мини экскаватор в аренду[/url] .
arenda mini ekskavatora v moskve_sdKt
14 Oct 25 at 3:59 pm
купить диплом в хабаровске [url=https://rudik-diplom3.ru/]https://rudik-diplom3.ru/[/url] .
Diplomi_dvei
14 Oct 25 at 3:59 pm
бамбуковые электрожалюзи [url=https://zhalyuzi-s-elektroprivodom77.ru/]zhalyuzi-s-elektroprivodom77.ru[/url] .
jaluzi na okna s elektroprivodom_lwpa
14 Oct 25 at 3:59 pm
электрокранизы [url=https://karniz-shtor-elektroprivodom.ru/]karniz-shtor-elektroprivodom.ru[/url] .
karniz dlya shtor s elektroprivodom_nher
14 Oct 25 at 4:01 pm
Экстренная выездная помощь клиники «Ренессанс Здоровья» — это быстрый и безопасный способ стабилизировать состояние без поездок в стационар и без огласки. Мы работаем круглосуточно по Серпухову и Серпуховскому городскому округу, приезжаем с укомплектованной сумкой врача, проводим осмотр, подбираем индивидуальную инфузионную терапию, купируем абстинентные симптомы и интоксикацию, помогаем восстановить сон и снизить тревожность. Все обращения — анонимно, без постановки на учет; при необходимости специалист приедет в гражданской одежде, чтобы визит остался незаметным для соседей и посторонних.
Выяснить больше – [url=https://narkolog-na-dom-serpuhov6.ru/]вызов врача нарколога на дом[/url]
SamuelClosy
14 Oct 25 at 4:02 pm
согласовать перепланировку нежилого помещения [url=https://www.pereplanirovka-nezhilogo-pomeshcheniya9.ru]https://www.pereplanirovka-nezhilogo-pomeshcheniya9.ru[/url] .
pereplanirovka nejilogo pomesheniya_fpKl
14 Oct 25 at 4:02 pm
Bullish on Minotaurus ICO’s viral referrals. $MTAUR utility strong. Sector expansion aids.
minotaurus coin
WilliamPargy
14 Oct 25 at 4:02 pm
потол [url=https://natyazhnye-potolki-samara-1.ru/]https://natyazhnye-potolki-samara-1.ru/[/url] .
natyajnie potolki samara_fuor
14 Oct 25 at 4:02 pm
потолочник натяжные потолки [url=http://stretch-ceilings-samara.ru/]http://stretch-ceilings-samara.ru/[/url] .
natyajnie potolki samara_agkl
14 Oct 25 at 4:03 pm
Медикаментозное пролонгированное
Узнать больше – [url=https://kodirovanie-ot-alkogolizma-vidnoe7.ru/]kodirovanie-ot-alkogolizma-vidnoe[/url]
Georgepat
14 Oct 25 at 4:03 pm
Далее проводится сама процедура: при медикаментозном варианте препарат может вводиться внутривенно, внутримышечно или имплантироваться под кожу; при психотерапевтическом — работа проходит в специально оборудованном кабинете, в спокойной атмосфере. После кодирования пациент находится под наблюдением, чтобы исключить осложнения и закрепить эффект. Важно помнить, что соблюдение рекомендаций и поддержка семьи играют решающую роль в сохранении трезвости.
Узнать больше – http://kodirovanie-ot-alkogolizma-kolomna6.ru/kodirovanie-ot-alkogolizma-na-domu-v-kolomne/
Rodneybeany
14 Oct 25 at 4:03 pm
В «АльтерМед» используются самые актуальные технологии, прошедшие проверку временем и доказавшие эффективность в тысячах клинических случаев. Выбор методики зависит от тяжести зависимости, состояния здоровья, наличия хронических заболеваний, прошлых попыток лечения и психологической мотивации пациента.
Детальнее – [url=https://kodirovanie-ot-alkogolizma-dolgoprudnyj6.ru/]кодирование от алкоголизма на дому[/url]
ArthurKalse
14 Oct 25 at 4:05 pm
горизонтальные жалюзи с электроприводом [url=http://www.zhalyuzi-s-elektroprivodom77.ru]горизонтальные жалюзи с электроприводом[/url] .
jaluzi na okna s elektroprivodom_hcpa
14 Oct 25 at 4:05 pm
Organic Dent у метро Тульская — клиника европейского уровня с экспертами по ортодонтии, имплантации и эстетике, где ставят брекеты и элайнеры, лечат ВНЧС и делают отбеливание за один приём. На https://organicdent.ru/ расписаны цены и акции: комплексная гигиена по немецкой технологии, имплантация опытными хирургами, протезирование с прицельной точностью. Сертифицированные врачи, современная диагностика и бережные методики — от планирования до контрольных визитов. Лёгкая запись через WhatsApp и удобное расположение в центре.
holosonlycle
14 Oct 25 at 4:07 pm
согласовать перепланировку нежилого помещения [url=https://pereplanirovka-nezhilogo-pomeshcheniya10.ru/]pereplanirovka-nezhilogo-pomeshcheniya10.ru[/url] .
pereplanirovka nejilogo pomesheniya_upSr
14 Oct 25 at 4:07 pm
аренда мини-экскаватора [url=http://arenda-mini-ekskavatora-v-moskve-2.ru]http://arenda-mini-ekskavatora-v-moskve-2.ru[/url] .
arenda mini ekskavatora v moskve_vkKt
14 Oct 25 at 4:08 pm
потолочник потолки [url=http://natyazhnye-potolki-samara-1.ru/]http://natyazhnye-potolki-samara-1.ru/[/url] .
natyajnie potolki samara_hxor
14 Oct 25 at 4:09 pm
потолочкин натяжные потолки самара отзывы [url=www.stretch-ceilings-samara-1.ru]www.stretch-ceilings-samara-1.ru[/url] .
natyajnie potolki samara_ossl
14 Oct 25 at 4:11 pm
Вызов нарколога на дом в Калининграде дает возможность начать лечение без очередей, сохранить конфиденциальность и провести процедуры в комфортных для пациента условиях.
Подробнее можно узнать тут – [url=https://narcolog-na-dom-kaliningrad00.ru/]нарколог на дом вывод из запоя в калининграде[/url]
Henryfed
14 Oct 25 at 4:12 pm
горизонтальные жалюзи с электроприводом [url=http://zhalyuzi-s-elektroprivodom77.ru]горизонтальные жалюзи с электроприводом[/url] .
jaluzi na okna s elektroprivodom_dhpa
14 Oct 25 at 4:12 pm
При критических симптомах (потеря сознания, сильная одышка, подозрение на инсульт/инфаркт) необходимо звонить 103/112. Мы подключимся к маршрутизации и организуем перевод в стационар.
Углубиться в тему – http://vyvod-iz-zapoya-noginsk7.ru/
WaynekiX
14 Oct 25 at 4:12 pm