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=http://www.frei-diplom1.ru]http://www.frei-diplom1.ru[/url] .
Diplomi_goOi
15 Oct 25 at 1:45 pm
диплом техникума купить в казахстане [url=www.frei-diplom12.ru/]диплом техникума купить в казахстане[/url] .
Diplomi_niPt
15 Oct 25 at 1:47 pm
growyourpresenceonline – Very encouraging tone, feels like someone believes in your growth
Arica Vecino
15 Oct 25 at 1:48 pm
купить диплом в петропавловске-камчатском [url=http://rudik-diplom9.ru/]купить диплом в петропавловске-камчатском[/url] .
Diplomi_jbei
15 Oct 25 at 1:48 pm
купить диплом колледжа спб в калуге [url=https://frei-diplom8.ru]https://frei-diplom8.ru[/url] .
Diplomi_zusr
15 Oct 25 at 1:49 pm
купить диплом украина с занесением в реестр [url=www.frei-diplom5.ru/]www.frei-diplom5.ru/[/url] .
Diplomi_efPa
15 Oct 25 at 1:49 pm
Организм, подвергшийся воздействию наркотических веществ, нуждается в очищении от токсинов. Детоксикация проводится под медицинским контролем с применением препаратов, поддерживающих работу внутренних органов и минимизирующих неприятные симптомы.
Подробнее – [url=https://lechenie-narkomanii-novosibirsk0.ru/]лечение больных наркоманией в новосибирске[/url]
JosephVek
15 Oct 25 at 1:50 pm
купить диплом в нальчике [url=https://rudik-diplom2.ru]купить диплом в нальчике[/url] .
Diplomi_dvpi
15 Oct 25 at 1:50 pm
После поступления вызова наш нарколог выезжает к пациенту в кратчайшие сроки, прибывая по адресу в пределах 30–60 минут. Специалист начинает процедуру с подробного осмотра и диагностики, измеряя ключевые показатели организма: артериальное давление, частоту пульса, насыщенность кислородом и собирая подробный анамнез.
Выяснить больше – [url=https://narcolog-na-dom-novosibirsk00.ru/]vyzov-narkologa-na-dom novosibirsk[/url]
EnriqueBum
15 Oct 25 at 1:53 pm
диплом о среднем образовании купить легально [url=www.frei-diplom1.ru]www.frei-diplom1.ru[/url] .
Diplomi_rfOi
15 Oct 25 at 1:54 pm
1win promo kodu necə daxil etməli [url=https://www.1win5005.com]https://www.1win5005.com[/url]
1win_sbml
15 Oct 25 at 1:54 pm
купить диплом в ачинске [url=https://www.rudik-diplom6.ru]купить диплом в ачинске[/url] .
Diplomi_bzKr
15 Oct 25 at 1:55 pm
купить диплом об окончании техникума в москве [url=www.frei-diplom12.ru]купить диплом об окончании техникума в москве[/url] .
Diplomi_luPt
15 Oct 25 at 1:55 pm
The Minotaurus ICO referral system is paying off big; got extra tokens from invites. $MTAUR’s utility in power-ups makes it more than hype. This project’s got legs.
minotaurus coin
WilliamPargy
15 Oct 25 at 1:56 pm
https://briansk.ru/video/
Nathanhip
15 Oct 25 at 1:57 pm
Такой подход делает лечение предсказуемым: вы понимаете, что происходит сейчас, чего ждать завтра и как закрепить результат на горизонте недель и месяцев.
Ознакомиться с деталями – http://narkologicheskaya-klinika-podolsk0.ru/
Jasonmes
15 Oct 25 at 1:58 pm
как купить диплом техникума в воронеже [url=https://frei-diplom8.ru]как купить диплом техникума в воронеже[/url] .
Diplomi_sesr
15 Oct 25 at 1:59 pm
Minotaurus token’s audits top-tier. Presale accessible. Power-ups game-changing.
minotaurus coin
WilliamPargy
15 Oct 25 at 2:00 pm
купить диплом в белогорске [url=http://www.rudik-diplom8.ru]http://www.rudik-diplom8.ru[/url] .
Diplomi_hxMt
15 Oct 25 at 2:00 pm
For those seeking an effective erythropoietin analogue, [url=https://epo-hgh.com/erythropoietin-eralfon-2000iu/]buy eralfon[/url] to improve endurance and accelerate recovery. Eralfon supports red blood cell growth, restores vitality, and enhances oxygen flow to muscles. It’s a reliable option for athletes, patients, and anyone aiming to maintain optimal performance and faster recovery after intense physical effort or stress.
LloydOpesK
15 Oct 25 at 2:01 pm
натяжные потолки в нижнем новгороде [url=http://stretch-ceilings-nizhniy-novgorod-1.ru]натяжные потолки в нижнем новгороде[/url] .
natyajnie potolki nijnii novgorod_jlOn
15 Oct 25 at 2:01 pm
сайт натяжной потолок [url=https://www.natyazhnye-potolki-nizhniy-novgorod.ru]https://www.natyazhnye-potolki-nizhniy-novgorod.ru[/url] .
natyajnie potolki nijnii novgorod_gfOt
15 Oct 25 at 2:01 pm
Just want to say your article is as astonishing. The clarity in your post is just cool and i can assume you are an expert on this subject.
Well with your permission allow me to grab your RSS feed to keep up to date with forthcoming post.
Thanks a million and please continue the gratifying work.
FundFoundry
15 Oct 25 at 2:02 pm
profi sportwetten tipps
My homepage :: Wettanbieter Im Vergleich (https://Panecof.Com/)
Https://Panecof.Com/
15 Oct 25 at 2:03 pm
mexican pharmacy: mexico pharmacy – mexican pharmacy online
AndrewPal
15 Oct 25 at 2:04 pm
купить диплом слесаря [url=rudik-diplom6.ru]купить диплом слесаря[/url] .
Diplomi_ijKr
15 Oct 25 at 2:04 pm
купить диплом в усолье-сибирском [url=https://www.rudik-diplom13.ru]купить диплом в усолье-сибирском[/url] .
Diplomi_vhon
15 Oct 25 at 2:04 pm
Следующий этап — согласование индивидуального плана. Состав капельницы и схема симптоматической терапии подбираются с учётом возраста, веса, сопутствующих болезней и текущих жалоб. Мы подробно объясняем, зачем назначается каждый препарат, как он действует и чего ожидать в ближайшие часы.
Получить дополнительную информацию – https://narkolog-na-dom-krasnogorsk6.ru/narkolog-na-dom-srochno-v-krasnogorske
JosephVem
15 Oct 25 at 2:06 pm
Мы — частная наркологическая служба в Химках, где каждый шаг лечения объясняется простым языком и запускается без задержек. С первого контакта дежурный врач уточняет жалобы, длительность запоя, хронические диагнозы и принимаемые лекарства, после чего предлагает безопасный старт: выезд на дом, дневной формат или госпитализацию в стационар 24/7. Наши внутренние регламенты построены вокруг двух опор — безопасности и приватности. Мы используем минимально необходимый набор персональных данных, ограничиваем доступ к медицинской карте, сохраняем нейтральную коммуникацию по телефону и не ставим на учёт.
Подробнее тут – http://narkologicheskaya-klinika-himki0.ru/kruglosutochnaya-narkologicheskaya-klinika-v-himkah/
JosephNex
15 Oct 25 at 2:06 pm
http://medicosur.com/# MedicoSur
MervinWoorE
15 Oct 25 at 2:07 pm
Получить диплом о высшем образовании поможем. Купить диплом в Чите – [url=http://diplomybox.com/kupit-diplom-chita/]diplomybox.com/kupit-diplom-chita[/url]
Cazrqil
15 Oct 25 at 2:08 pm
где купить диплом техникума в томске [url=frei-diplom12.ru]где купить диплом техникума в томске[/url] .
Diplomi_yxPt
15 Oct 25 at 2:08 pm
Для эффективного приёма рекомендуется заранее:
Получить больше информации – [url=https://lechenie-alkogolizma-ekaterinburg00.ru/]лечение наркомании и алкоголизма екатеринбург[/url]
MichaelTom
15 Oct 25 at 2:09 pm
где купить диплом техникума хорошую [url=www.frei-diplom8.ru]где купить диплом техникума хорошую[/url] .
Diplomi_prsr
15 Oct 25 at 2:10 pm
После поступления звонка нарколог оперативно выезжает по указанному адресу и прибывает в течение 30–60 минут. Врач незамедлительно приступает к оказанию помощи по четко отработанному алгоритму, состоящему из следующих этапов:
Изучить вопрос глубже – [url=https://narcolog-na-dom-voronezh00.ru/]запой нарколог на дом воронеж[/url]
AnthonyCow
15 Oct 25 at 2:10 pm
купить диплом в волгограде [url=www.rudik-diplom2.ru]купить диплом в волгограде[/url] .
Diplomi_xcpi
15 Oct 25 at 2:13 pm
https://telegra.ph/Kupit-binokl-komz-s-zavoda-izgotovitelya-10-13
DennisNeene
15 Oct 25 at 2:13 pm
купить диплом в сызрани [url=https://rudik-diplom5.ru]купить диплом в сызрани[/url] .
Diplomi_bhma
15 Oct 25 at 2:17 pm
В клинике «РеабилитейшнПро» применяется комплексный и современный подход к оказанию наркологической помощи. Команда опытных врачей-наркологов, психотерапевтов и медицинских сестёр работает круглосуточно, чтобы оперативно реагировать на обращения пациентов, независимо от времени суток и сложности состояния. Каждый случай рассматривается индивидуально, что позволяет подобрать максимально эффективную схему терапии с учётом особенностей организма, стадии зависимости и сопутствующих заболеваний.
Углубиться в тему – https://narkologicheskaya-pomoshch-domodedovo6.ru/
Briangen
15 Oct 25 at 2:19 pm
купить диплом в горно-алтайске [url=http://rudik-diplom13.ru/]http://rudik-diplom13.ru/[/url] .
Diplomi_xron
15 Oct 25 at 2:20 pm
Сразу после поступления вызова нарколог прибывает на дом для проведения детального первичного осмотра. Врач собирает краткий анамнез, измеряет жизненно важные показатели, такие как пульс, артериальное давление и температура, и оценивает степень интоксикации. Эта информация является фундаментом для разработки индивидуального плана терапии, который учитывает особенности состояния пациента.
Получить больше информации – [url=https://vyvod-iz-zapoya-tula000.ru/]vyvod-iz-zapoya-na-domu tula[/url]
JohnnieHot
15 Oct 25 at 2:20 pm
В зависимости от состояния пациента, помощь может быть оказана в домашних условиях или в стационаре. Вызов нарколога на дом особенно актуален при абстинентном синдроме или тяжелом алкогольном опьянении. Как отмечается в материалах НМИЦ психиатрии и наркологии, в таких ситуациях крайне важно избежать самолечения и довериться врачам, способным правильно подобрать препараты и дозировки.
Подробнее тут – [url=https://narkologicheskaya-pomoshh-arkhangelsk0.ru/]вызов наркологической помощи[/url]
MiquelCavop
15 Oct 25 at 2:22 pm
На этом этапе специалист уточняет, сколько времени продолжается запой, какие основные симптомы наблюдаются, и если имеются, то какие хронические заболевания могут влиять на течение терапии. Точный анализ этих данных позволяет сформировать персонализированную стратегию лечения, которая будет максимально адаптирована к состоянию пациента и его потребностям.
Выяснить больше – [url=https://vyvod-iz-zapoya-yaroslavl0.ru/]вывод из запоя на дому круглосуточно ярославль[/url]
Walterionib
15 Oct 25 at 2:23 pm
Hey There. I found your blog using msn. This is an extremely well written article.
I will make sure to bookmark it and return to read more of your useful information. Thanks
for the post. I will certainly comeback.
turkey visa for australians
15 Oct 25 at 2:23 pm
Этап процедуры
Узнать больше – https://vyvod-iz-zapoya-odincovo6.ru/vyvod-iz-zapoya-kruglosutochno-v-odincovo
DamonTip
15 Oct 25 at 2:25 pm
После первичной диагностики начинается активная фаза детоксикации, во время которой современные препараты вводятся капельничным методом. Этот этап помогает быстро снизить концентрацию токсинов в крови, восстановить нормальные обменные процессы и нормализовать работу внутренних органов, таких как печень, почки и сердце.
Выяснить больше – https://vyvod-iz-zapoya-tula0.ru/
JeffreyBoync
15 Oct 25 at 2:25 pm
Выбор клиники — задача не только медицинская, но и стратегическая. Учитывать нужно не только наличие лицензии, но и содержание программ, их гибкость, участие родственников в процессе, а также прозрачность взаимодействия с пациентом. Именно эти аспекты позволяют отличить профессиональное учреждение от формального.
Подробнее тут – [url=https://narkologicheskaya-klinika-yaroslavl0.ru/]наркологическая клиника цены ярославль[/url]
ChrisWeall
15 Oct 25 at 2:26 pm
Для пациентов, требующих круглосуточного наблюдения, клиника «Полярис» предлагает стационар VIP-класса. Здесь созданы все условия для быстрого восстановления: удобные палаты, индивидуальное меню, зоны отдыха и консультации профильных специалистов.
Исследовать вопрос подробнее – [url=https://narkologicheskaya-klinika-arkhangelsk0.ru/]наркологическая клиника[/url]
Craigfek
15 Oct 25 at 2:27 pm
https://zencaremeds.com/# top online pharmacy
MervinWoorE
15 Oct 25 at 2:27 pm
Very quickly this website will be famous among all blogging and site-building viewers, due to
it’s nice posts
Yupoo Celine
15 Oct 25 at 2:28 pm