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!
online pharmacy india: india pharmacy mail order – IndiaMedsHub
BobbyAcany
18 Jul 25 at 11:52 pm
Критерий
Узнать больше – [url=https://narkologicheskaya-klinika-nizhnij-tagil11.ru/]наркологическая клиника на дом[/url]
Keithgek
18 Jul 25 at 11:54 pm
Психолог онлайн — ваш надежный спутник в жизни. Детский психолог онлайн найдет подход к каждому ребенку.
психолог запись онлайн
Ernestpoive
19 Jul 25 at 12:00 am
https://www.speedrun.com/users/Fanfara/about
vjdqtayqn
19 Jul 25 at 12:13 am
мелбет горячая линия [url=https://melbet3007.com]мелбет горячая линия[/url]
melbet_avOn
19 Jul 25 at 12:14 am
Сайты подшипниковых заводов, Цилиндрический подшипник – это тип подшипника качения, в котором тела качения имеют форму цилиндров. Он отличается высокой грузоподъемностью и способен воспринимать радиальные нагрузки.
Davidpaics
19 Jul 25 at 12:15 am
Bonjour, passionnes de jeux en ligne !
Je viens de trouver un article avec des details tout frais sur le jeu Plinko en France.
Si tu es fan de ce jeu, cette lecture est incontournable.
Lis tout cela via le lien place en bas :
https://www.readthecloud.store/plinko/plinko-le-jeu-captivant-des-chanceux/
Amuse-toi avec les infos !
TimothysuTty
19 Jul 25 at 12:16 am
kraken onion
DavidFoogs
19 Jul 25 at 12:18 am
В клинике применяются инновационные методы диагностики, включая лабораторные анализы и аппаратные исследования, которые позволяют выявить степень зависимости и сопутствующие патологии. Важным этапом является комплексный подход к лечению, включающий детоксикацию организма, психотерапию и медикаментозную поддержку.
Детальнее – [url=https://narkologicheskaya-klinika-krasnodar00.ru/]бесплатная наркологическая клиника в краснодаре[/url]
Andreslah
19 Jul 25 at 12:20 am
В таких случаях своевременное обращение за помощью позволяет быстро стабилизировать состояние и предотвратить развитие серьезных осложнений.
Получить больше информации – [url=https://narcolog-na-dom-voronezh0.ru/]нарколог на дом клиника[/url]
Lancenep
19 Jul 25 at 12:20 am
отзывы о melbet [url=melbet3005.com]melbet3005.com[/url]
melbet_jbPl
19 Jul 25 at 12:30 am
Наркологическая клиника «СочиМед» предлагает полный спектр услуг по лечению алкогольной и наркотической зависимости, сочетая современные медицинские технологии с уютной атмосферой. Размещение в стационаре организовано по принципу гостиничного сервиса: отдельные палаты с кондиционером, круглосуточное питание по диетам, а внимательный персонал поддерживает пациентов на каждом этапе восстановления.
Исследовать вопрос подробнее – https://narkologicheskaya-klinika-sochi00.ru/chastnaya-narkologicheskaya-klinika-sochi/
MichaelCrumn
19 Jul 25 at 12:32 am
скачать мелбет на андроид украина [url=melbet3007.com]melbet3007.com[/url]
melbet_cjOn
19 Jul 25 at 12:34 am
Столица ночью бодрствует, и мы вдобавок: закрытая центр лечения алкоголизма клиника https://mcnl.ru/ ждёт 24/7. Без записей и формальностей — вызов специалиста на дом за 39 минут, щадящий детокс под седацией, сверхскоростная капельница, психотерапия у вас, долговечное сопровождение. Без шума, конфиденциально, эффективно — вернем трезвость без страха.
ShaneDrync
19 Jul 25 at 12:34 am
It’s not my first time to visit this web page,
i am browsing this site dailly and obtain pleasant facts from here all the time.
66man.com
19 Jul 25 at 12:36 am
Заказать дипломную работу https://diplomikon.ru недорого и без стресса. Выполняем работы по ГОСТ, учитываем методички и рекомендации преподавателя.
diplomikon-r
19 Jul 25 at 12:46 am
После первичного осмотра начинается активная фаза детоксикации. Современные препараты вводятся капельничным методом для быстрого снижения уровня токсинов в крови и восстановления обменных процессов. Этот этап критически важен для нормализации работы печени, почек и сердечно-сосудистой системы.
Изучить вопрос глубже – https://vyvod-iz-zapoya-vladimir000.ru/vyvod-iz-zapoya-na-domu-vladimir
MichaelBrees
19 Jul 25 at 12:47 am
buy kamagra oral jelly mexico: trusted mexican pharmacy – buy antibiotics from mexico
LewisSoump
19 Jul 25 at 12:51 am
пансионат для лежачих пожилых
pansionat-msk002.ru
пансионат с медицинским уходом
alkogolizmkrasnodarNeT
19 Jul 25 at 12:57 am
Психолог онлайн поможет наладить отношения. Детский психолог онлайн поддержит в период адаптации.
хороший психолог онлайн отзывы
Ernestpoive
19 Jul 25 at 1:02 am
можно купить легальный диплом [url=www.arus-diplom31.ru]www.arus-diplom31.ru[/url] .
Kypit diplom o visshem obrazovanii!_saOl
19 Jul 25 at 1:07 am
При вызовах в ночное время или в случаях с тяжелой интоксикацией стоимость может увеличиваться до 3000–4500 рублей. Окончательная сумма определяется после первичного осмотра и обсуждения индивидуальной схемы лечения с пациентом.
Получить дополнительные сведения – https://vyvod-iz-zapoya-vladimir00.ru/vyvod-iz-zapoya-anonimno-vladimir/
TimothyEvema
19 Jul 25 at 1:11 am
I know this site provides quality depending articles and other information, is there any other web page which gives such stuff in quality?
333bet
19 Jul 25 at 1:13 am
Детская стоматология Kids Dent – это мир заботы и профессионализма для маленьких пациентов!
Наша стоматология предлагает широкий спектр услуг
по уходу за зубами и полостью рта для детей всех возрастов.
От профилактических осмотров до сложных стоматологических процедур, наши опытные специалисты всегда находят подход к каждому маленькому пациенту.
Мы понимаем, что первый визит к стоматологу может быть для ребенка стрессом, поэтому наши врачи делают
все возможное, чтобы создать комфортную и дружелюбную
атмосферу во время приема. С нами ваши дети научатся ухаживать за своими
зубами с самого раннего возраста,
что поможет сохранить их здоровье на долгие годы.
В нашей стоматологии используются только
современные материалы и технологии,
прошедшие строгий контроль качества.
Мы заботимся о здоровье
наших маленьких пациентов и гарантируем высокое
качество оказываемых услуг – детская стоматология казани
Кроме того, мы предлагаем различные акции и скидки для постоянных
клиентов, а также возможность оплаты в рассрочку.
Запишитесь на прием прямо сейчас и убедитесь в качестве наших услуг!
Подарите своему ребенку здоровую улыбку вместе с детской стоматологией “Кидс Дент”!
керамические виниры
19 Jul 25 at 1:13 am
Подшипники от производителей Подшипники для сельхозтехники Мы предлагаем широкий выбор подшипников, специально разработанных для использования в сельхозтехнике.
Davidpaics
19 Jul 25 at 1:15 am
Во-вторых, реабилитация является неотъемлемой частью нашего подхода. Мы понимаем, что избавление от физической зависимости — это только первый шаг. Важной задачей является восстановление социального статуса, создание новых привычек и умение управлять своей жизнью без наркотиков или алкоголя. Наша клиника предлагает групповые и индивидуальные занятия, направленные на изменение поведения и мышления.
Подробнее можно узнать тут – [url=https://kapelnica-ot-zapoya-irkutsk.ru/]врача капельницу от запоя[/url]
Josephshoow
19 Jul 25 at 1:21 am
Применение современных средств медикаментозного лечения обеспечивает безопасность процедуры и минимизирует риски осложнений.
Выяснить больше – https://lechenie-alkogolizma-sochi00.ru/lechenie-alkogolizma-gipnozom-v-sochi
MichaelTum
19 Jul 25 at 1:24 am
kraken обмен
DavidFoogs
19 Jul 25 at 1:27 am
mostbet skachat app [url=https://www.mostbet4072.ru]mostbet skachat app[/url]
mostbet_enot
19 Jul 25 at 1:27 am
Игроки часто ищут vavada вход, и не зря — именно такие платформы обеспечивают честную игру и качественный сервис. Если вас интересует vavada вход, рекомендуем заглянуть сюда: vavada вход. Вы узнаете о бонусах, мобильной версии, рабочих зеркалах и многом другом. Проверяйте сами — vavada вход может приятно удивить!
Matthewrhica
19 Jul 25 at 1:33 am
купить аттестат 11 класс екатеринбург [url=arus-diplom21.ru]купить аттестат 11 класс екатеринбург[/url] .
Zakazat diplom lubogo instityta!_qypn
19 Jul 25 at 1:36 am
download mostbet apk [url=http://island-hvar.info]download mostbet apk[/url] .
mostbet apk_ytPi
19 Jul 25 at 1:39 am
Лечение алкоголизма в Краснодаре представляет собой комплекс мероприятий, направленных на полное восстановление физического и психологического состояния пациента. Этот процесс требует профессионального подхода, включающего диагностику, детоксикацию, терапию зависимости и реабилитацию. Информация о современных методах терапии доступна на официальном портале Минздрава РФ.
Узнать больше – https://lechenie-alkogolizma-krasnodar00.ru
Virgilcic
19 Jul 25 at 1:43 am
прогнозы ставок на спорт [url=https://www.prognozy-na-sport-2.ru]https://www.prognozy-na-sport-2.ru[/url] .
prognozi na sport_bgSn
19 Jul 25 at 1:46 am
ставки футбол [url=https://www.prognozy-na-futbol-2.ru]https://www.prognozy-na-futbol-2.ru[/url] .
prognozi na fytbol_fjmi
19 Jul 25 at 1:47 am
Купить промышленный подшипник Виброустойчивые подшипники – это подшипники, разработанные для работы в условиях повышенной вибрации. Они отличаются повышенной прочностью и износостойкостью, обеспечивая надежную работу оборудования.
Davidpaics
19 Jul 25 at 1:47 am
subutex online pharmacy [url=https://expresscarerx.org/#]zoloft indian pharmacy[/url] ExpressCareRx
DavidRhinc
19 Jul 25 at 1:50 am
слоты мелбет [url=www.melbet3004.com]слоты мелбет[/url]
melbet_zrMt
19 Jul 25 at 1:50 am
Мы стремимся обеспечить пациентам максимальный уровень доверия и результативности лечения, сочетая передовые технологии и многолетний опыт специалистов:
Подробнее можно узнать тут – [url=https://lechenie-alkogolizma-krasnodar0.ru/]лечение алкоголизма цена[/url]
DonaldWrava
19 Jul 25 at 1:51 am
купить диплом с регистрацией [url=www.arus-diplom31.ru]купить диплом с регистрацией[/url] .
Diplomi_yxpl
19 Jul 25 at 1:56 am
где можно купить аттестат 11 классов в екатеринбурге [url=www.arus-diplom21.ru/]где можно купить аттестат 11 классов в екатеринбурге[/url] .
Zakazat diplom o visshem obrazovanii!_wvpn
19 Jul 25 at 1:57 am
Thanks for the auspicious writeup. It if truth be told was once a leisure
account it. Look complex to more brought agreeable from you!
By the way, how can we keep in touch?
xổ số trực tuyến
19 Jul 25 at 1:59 am
Психолог онлайн всегда готов помочь. Детский психолог онлайн научит ребенка справляться с гневом.
запись к психологу калуга
Ernestpoive
19 Jul 25 at 2:04 am
melbet регистрация [url=www.melbet3007.com]www.melbet3007.com[/url]
melbet_xwOn
19 Jul 25 at 2:06 am
вывод из запоя круглосуточно иркутск
vivod-iz-zapoya-irkutsk002.ru
экстренный вывод из запоя
narkologiyairkutskNeT
19 Jul 25 at 2:10 am
Проблема зависимости от алкоголя, наркотиков и азартных игр остается одной из наиболее острых в современном обществе. Эти состояния оказывают значительное воздействие не только на здоровье самого человека, но и на его семью, друзей и общественные связи. Наркологическая клиника “Восстановление души” предлагает широкий спектр услуг для тех, кто борется с различными формами зависимости, такими как алкоголизм, наркомания и игромания. Наша цель — предоставить комплексный подход к лечению, что обеспечивает высокие показатели успешности среди наших пациентов.
Подробнее тут – http://kapelnica-ot-zapoya-irkutsk2.ru/
GarlandVop
19 Jul 25 at 2:11 am
where can i get cheap adalat without prescription
where buy adalat tablets
19 Jul 25 at 2:11 am
flood sms
GerardobaR
19 Jul 25 at 2:11 am
https://indiamedshub.shop/# indianpharmacy com
RobertEmard
19 Jul 25 at 2:13 am
купить легальный диплом техникума [url=https://arus-diplom31.ru/]купить легальный диплом техникума[/url] .
Diplomi_ntpl
19 Jul 25 at 2:15 am