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!
где купить аттестат 11 класс [url=arus-diplom21.ru]где купить аттестат 11 класс[/url] .
Zakazat diplom lubogo VYZa!_fcpn
19 Jul 25 at 2:24 am
Having read this I thought it was rather informative.
I appreciate you finding the time and effort to put this
content together. I once again find myself personally spending
a lot of time both reading and commenting. But so
what, it was still worthwhile!
sauna forum
19 Jul 25 at 2:25 am
Выезд нарколога на дом включает несколько ключевых этапов: первичный дистанционный сбор анамнеза, оперативный приезд специалиста, проведение обследования — измерение пульса, давления, сатурации, уровня глюкозы и электролитов крови — и последующее назначение инфузионной терапии. В зависимости от состояния пациента подбирается индивидуальный состав растворов, направленных на восстановление водно-электролитного баланса, поддержку функций печени и нормализацию работы центральной нервной системы. Все процедуры выполняются с учётом противопоказаний и сопутствующих заболеваний.
Разобраться лучше – https://kapelnica-ot-zapoya-voronezh3.ru/kapelnicza-ot-zapoya-na-domu-v-voronezhe/
RobertThons
19 Jul 25 at 2:28 am
mostbet install [url=https://mostbet1.app/]mostbet install[/url] .
mostbet apk_vlPi
19 Jul 25 at 2:30 am
В клинике в Сочи реализованы современные протоколы мониторинга состояния пациентов, включая лабораторные исследования и консультации профильных специалистов. Это позволяет своевременно корректировать лечение и минимизировать возможные осложнения. Более подробно о диагностике можно узнать на портале Российского общества наркологов.
Выяснить больше – [url=https://narkologicheskaya-klinika-sochi0.ru/]наркологические клиники алкоголизм[/url]
DarwinGeada
19 Jul 25 at 2:33 am
kraken vk5
DavidFoogs
19 Jul 25 at 2:36 am
хоккей прогноз на сегодня [url=prognozy-na-khokkej-segodnya1.ru]prognozy-na-khokkej-segodnya1.ru[/url] .
prognozi na hokkei segodnya_pwml
19 Jul 25 at 2:40 am
Check site https://jp-dream.or.jp/47576458_284449715755807_1403343489810300928_n/
JasonNeony
19 Jul 25 at 2:41 am
Специалист выясняет, как долго продолжается запой, какие симптомы наблюдаются, а также наличие сопутствующих заболеваний. Эти данные позволяют сформировать индивидуальный план лечения и выбрать оптимальные методы детоксикации.
Ознакомиться с деталями – https://vyvod-iz-zapoya-vladimir0.ru/srochnyj-vyvod-iz-zapoya-vladimir/
TerryAcith
19 Jul 25 at 2:41 am
https://expresscarerx.online/# ExpressCareRx
RobertEmard
19 Jul 25 at 2:41 am
диплом высшего образования с занесением в реестр купить [url=https://arus-diplom31.ru]диплом высшего образования с занесением в реестр купить[/url] .
Diplomi_xlpl
19 Jul 25 at 2:43 am
Мы понимаем, что лечение от алкогольной зависимости — это только первый шаг на пути к восстановлению. Профилактика рецидивов — важная часть нашего подхода. Мы проводим тренинги и курсы, направленные на развитие навыков борьбы с соблазнами и стрессом. Психотерапевтическая поддержка помогает пациентам справиться с эмоциональными трудностями, а также укрепляет мотивацию для сохранения трезвости.
Подробнее тут – http://kapelnica-ot-zapoya-irkutsk3.ru/
PatrickCrymn
19 Jul 25 at 2:43 am
Перед оформлением вызова проводится предварительная телефонная консультация, позволяющая оценить тяжесть состояния и заранее подготовить необходимые препараты.
Получить дополнительные сведения – https://kapelnica-ot-zapoya-voronezh.ru
Patricktip
19 Jul 25 at 2:45 am
mostbet aviator yutish [url=http://mostbet4073.ru]http://mostbet4073.ru[/url]
mostbet_nmot
19 Jul 25 at 2:45 am
Drug information leaflet. Drug Class.
how can i get generic sinemet without prescription
Everything what you want to know about drug. Get here.
how can i get generic sinemet without prescription
19 Jul 25 at 2:52 am
imiquimod pharmacy [url=http://expresscarerx.org/#]ExpressCareRx[/url] ez online pharmacy viagra
DavidRhinc
19 Jul 25 at 2:53 am
Заказать дипломную работу http://diplomikon.ru недорого и без стресса. Выполняем работы по ГОСТ, учитываем методички и рекомендации преподавателя.
diplomikon-u
19 Jul 25 at 3:01 am
Мегаполис после заката бодрствует, и мы аналогично: эксклюзивная центр лечения алкоголизма и наркомании клиника https://mcnl.ru ждёт 24/7. Без записей и документов — вызов врача по адресу за 39 минут, безопасный детокс под контролем, сверхскоростная капельница, психологическая поддержка на месте, долговечное сопровождение. Тихо, конфиденциально, эффективно — вернем вам трезвость без страха.
StephenGlona
19 Jul 25 at 3:02 am
онлайн ломбард часов [url=http://ocenka-chasov-onlajn8.ru/]http://ocenka-chasov-onlajn8.ru/[/url] .
ocenka chasov onlain_nvKt
19 Jul 25 at 3:04 am
Great blog here! Also your website loads up
fast! What web host are you using? Can I get your affiliate link to
your host? I wish my site loaded up as quickly as yours lol
Turbo Forteo Hex
19 Jul 25 at 3:05 am
оценка элитных часов [url=http://ocenka-chasov-onlajn8.ru]http://ocenka-chasov-onlajn8.ru[/url] .
ocenka chasov onlain_xjKt
19 Jul 25 at 3:05 am
bomber sms
GerardobaR
19 Jul 25 at 3:06 am
Психолог онлайн поможет справиться с паникой. Детский психолог онлайн разберется с детскими фобиями.
психолог практик онлайн
Ernestpoive
19 Jul 25 at 3:08 am
На основе полученных диагностических данных врач подбирает оптимальные препараты и дозировки, разрабатывая персональный план лечебных мероприятий.
Получить больше информации – https://narcolog-na-dom-voronezh00.ru/narkolog-na-dom-anonimno-voronezh/
StevenDag
19 Jul 25 at 3:12 am
оценка часов цена [url=https://ocenka-chasov-onlajn8.ru]https://ocenka-chasov-onlajn8.ru[/url] .
ocenka chasov onlain_vgKt
19 Jul 25 at 3:21 am
indian pharmacies safe: top 10 online pharmacy in india – IndiaMedsHub
BobbyAcany
19 Jul 25 at 3:21 am
экстренный вывод из запоя иркутск
vivod-iz-zapoya-irkutsk002.ru
вывод из запоя иркутск
narkologiyairkutskNeT
19 Jul 25 at 3:22 am
Now I am going away to do my breakfast, once having my breakfast coming oover again to
read additional news.
https://www.vapediy.de/horizontech-falcon-ii-sector-mesh-coils-3er-pack-014-ohm
19 Jul 25 at 3:23 am
лечебное голодание Подготовка к голоданию: Шаги для безопасного начала
BrianBaw
19 Jul 25 at 3:28 am
Дополнительную информацию о методах социальной реабилитации можно найти в публикациях Фонда борьбы с наркоманией и алкоголизмом.
Подробнее – http://narkologicheskaya-klinika-krasnodar0.ru/platnaya-narkologicheskaya-klinika-krasnodar/
ThomasIdeaf
19 Jul 25 at 3:32 am
Наркологическая клиника в Екатеринбурге уделяет большое внимание психотерапевтическим методам. Индивидуальный подход к пациенту позволяет выявить причины и особенности зависимости, сформировать устойчивую мотивацию на лечение и отказ от вредных привычек.
Исследовать вопрос подробнее – [url=https://narcologicheskaya-klinika-ekaterinburg00.ru/]narcologicheskaya-klinika-ekaterinburg00.ru/[/url]
Robertosheal
19 Jul 25 at 3:38 am
Алкогольная зависимость — это комплексное заболевание, требующее не только медикаментозного воздействия, но и серьёзной психологической поддержки. В Сочи клиника «ЮгМед» предлагает выезд нарколога на дом, что позволяет начать лечение без стресса, связанного с госпитализацией. Такой подход особенно важен для тех, кто ценит конфиденциальность и предпочитает комфорт привычной обстановки. Мы обеспечиваем полную анонимность, а опытные специалисты разрабатывают индивидуальную программу, учитывающую длительность запоя, сопутствующие заболевания и психологические факторы зависимости.
Получить больше информации – [url=https://lechenie-alkogolizma-sochi0.ru/]анонимное лечение алкоголизма[/url]
WilliamToort
19 Jul 25 at 3:41 am
промокод на melbet [url=https://www.melbet3007.com]https://www.melbet3007.com[/url]
melbet_piOn
19 Jul 25 at 3:45 am
Когда запой становится критическим, оперативное вмешательство имеет решающее значение для спасения здоровья и предотвращения необратимых последствий. Во Владимире экстренная помощь нарколога на дому позволяет быстро начать лечение, не требуя госпитализации, что особенно важно для пациентов, нуждающихся в сохранении конфиденциальности и комфорте.
Подробнее – [url=https://vyvod-iz-zapoya-vladimir000.ru/]вывод из запоя[/url]
MichaelBrees
19 Jul 25 at 3:47 am
«НаркоМед» основана группой узкопрофильных специалистов, чей опыт насчитывает более 15 лет в лечении зависимости. Клиника работает круглосуточно — вы можете рассчитывать на оперативное реагирование в любой час дня и ночи. Анонимность пациентов сохраняется на уровне медицинской тайны: персональные данные и диагноз не разглашаются.
Изучить вопрос глубже – [url=https://narkologicheskaya-klinika-ekaterinburg0.ru/]chastnaya narkologicheskaya klinika ekaterinburg[/url]
RaymondHal
19 Jul 25 at 3:47 am
kraken vk6
DavidFoogs
19 Jul 25 at 3:48 am
Во-первых, мы фокусируемся на медицинской детоксикации, которая является первоочередной задачей при лечении зависимостей. Этот процесс позволяет удалить токсические вещества из организма и улучшить общее состояние пациента. Мы применяем современные методики, которые помогают минимизировать симптомы абстиненции и обеспечить комфортное пребывание в клинике.
Разобраться лучше – [url=https://kapelnica-ot-zapoya-irkutsk.ru/]капельница от запоя выезд в иркутске[/url]
Josephshoow
19 Jul 25 at 3:49 am
как купить легально диплом о высшем образовании [url=https://arus-diplom31.ru]как купить легально диплом о высшем образовании[/url] .
Bistro zakazat diplom o visshem obrazovanii!_dqOl
19 Jul 25 at 3:53 am
Игроки часто ищут vavada официальный сайт, и не зря — именно такие платформы обеспечивают честную игру и качественный сервис. Если вас интересует vavada официальный сайт, рекомендуем заглянуть сюда: vavada официальный сайт. Вы узнаете о бонусах, мобильной версии, рабочих зеркалах и многом другом. Проверяйте сами — vavada официальный сайт может приятно удивить!
Matthewrhica
19 Jul 25 at 3:53 am
Москва в ночь не спит, и мы аналогично: частная центр лечения алкоголизма клиника https://mcnl.ru работает 24/7. Без записей и бумаг — приезд врача по адресу за 40 минут, мягкий детокс под контролем, сверхскоростная капельница, психотерапия на дому, пожизненное сопровождение. Тихо, скрытно, результативно — вернем вам трезвость без боли.
Dichaelwaw
19 Jul 25 at 3:55 am
melbet friday bonus [url=https://melbet3007.com]https://melbet3007.com[/url]
melbet_mpOn
19 Jul 25 at 3:59 am
legit mexican pharmacy for hair loss pills [url=https://medimexicorx.com/#]best mexican pharmacy online[/url] buy from mexico pharmacy
DavidRhinc
19 Jul 25 at 4:02 am
Greate article. Keep writing such kind of information on your site.
Im really impressed by your site.
Hi there, You’ve performed an excellent job. I’ll
certainly digg it and individually recommend to my friends.
I’m sure they will be benefited from this site.
chicken road
19 Jul 25 at 4:11 am
Мегаполис ночью не спит, и мы аналогично: частная центр лечения алкоголизма клиника https://mcnl.ru/ открыта 24/7. Без записей и документов — вызов врача по адресу за менее 45 минут, мягкий детокс в сне, сверхскоростная капельница, нейрокоррекция у вас, пожизненное сопровождение. Без шума, анонимно, эффективно — вернем вам трезвость без страха.
EarnestAbent
19 Jul 25 at 4:13 am
mostbet aviator qeydiyyat [url=www.mostbet4055.ru]www.mostbet4055.ru[/url]
mostbet_dqKi
19 Jul 25 at 4:18 am
купить аттестат за 11 класс москва [url=https://arus-diplom23.ru/]купить аттестат за 11 класс москва[/url] .
Diplomi_smol
19 Jul 25 at 4:21 am
оценка швейцарских часов [url=https://ocenka-chasov-onlajn9.ru]оценка швейцарских часов[/url] .
ocenka chasov onlain_ibMn
19 Jul 25 at 4:28 am
Наркологическая клиника в Краснодаре представляет собой специализированное медицинское учреждение, где оказывается профессиональная помощь пациентам с различными формами зависимости. Современные подходы к лечению позволяют обеспечить эффективную и безопасную терапию, направленную на восстановление физического и психического здоровья.
Подробнее тут – http://narkologicheskaya-klinika-krasnodar00.ru
Andreslah
19 Jul 25 at 4:33 am
buy antibiotics over the counter in mexico: zithromax mexican pharmacy – best mexican pharmacy online
BobbyAcany
19 Jul 25 at 4:37 am
code bonus 1win [url=https://www.1win3044.com]code bonus 1win[/url]
1win_brea
19 Jul 25 at 4:39 am