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!
Актуальные тренды сегодня популярные тренды: фото, видео и медиа. Всё о том, что популярно сегодня — в России и в мире. Мода, визуальные стили, digital-направления и соцсети. Следите за трендами и оставайтесь в курсе главных новинок каждого дня.
jb5-490
18 Jul 25 at 12:22 am
ставки на спорт аналитика прогнозы [url=https://stavki-na-sport-prognozy2.ru/]stavki-na-sport-prognozy2.ru[/url] .
stavki na sport prognozi _iymi
18 Jul 25 at 12:31 am
Лечение зависимости требует не только физической детоксикации, но и работы с психоэмоциональным состоянием пациента. Психотерапевтическая поддержка помогает выявить глубинные причины зависимости, снизить уровень стресса и сформировать устойчивые навыки самоконтроля, что существенно снижает риск рецидивов.
Исследовать вопрос подробнее – [url=https://narcolog-na-dom-ufa000.ru/]врач нарколог на дом платный в уфе[/url]
Vincentdow
18 Jul 25 at 12:36 am
borax pulver apotek: magkatarr apotek – handkrГ¤m apotek
Altonjah
18 Jul 25 at 12:40 am
Миссия нашей клиники заключается в оказании высококачественной помощи людям, страдающим от зависимостей. Мы стремимся создать безопасное и поддерживающее пространство для лечения, где каждый пациент получает необходимую поддержку и понимание. Наша задача — не только помочь избавиться от зависимости, но и вернуть полноценную жизнедеятельность человека, восстановив его социальные связи и жизненные ориентиры.
Узнать больше – [url=https://kapelnica-ot-zapoya-irkutsk2.ru/]www.domen.ru[/url]
Richardincog
18 Jul 25 at 12:41 am
душевая перегородка из стекла Душевые кабины, выполненные из качественного стекла, обожаются многими за свою элегантность и функциональность. Они прекрасно вписываются в любой интерьер ванной комнаты, придавая ей модный вид. Дешевая перегородка
Dannyfaign
18 Jul 25 at 12:43 am
covid snabbtest apotek [url=http://snabbapoteket.com/#]Snabb Apoteket[/url] koffeintabletter apotek
ScottFup
18 Jul 25 at 12:46 am
Актуальные тренды сегодня тренды в музыке: фото, видео и медиа. Всё о том, что популярно сегодня — в России и в мире. Мода, визуальные стили, digital-направления и соцсети. Следите за трендами и оставайтесь в курсе главных новинок каждого дня.
jb5-650
18 Jul 25 at 12:47 am
Актуальные тренды сегодня подробнее: фото, видео и медиа. Всё о том, что популярно сегодня — в России и в мире. Мода, визуальные стили, digital-направления и соцсети. Следите за трендами и оставайтесь в курсе главных новинок каждого дня.
jb5-474
18 Jul 25 at 12:48 am
прогнозы на спорт от профессионалов точные бесплатно на сегодня [url=http://prognozy-na-sport-1.ru]http://prognozy-na-sport-1.ru[/url] .
prognozi na sport_bgol
18 Jul 25 at 12:49 am
Пациенту устанавливают катетер в вену на руке или предплечье, используя лёгкий местный анестетик для минимизации дискомфорта. Затем подключают автоматизированную помпу, обеспечивающую равномерную подачу раствора в течение 3–6 часов.
Ознакомиться с деталями – [url=https://kapelnica-ot-zapoya-voronezh2.ru/]posle-kapelniczy-ot-zapoya voronezh[/url]
Jamesgains
18 Jul 25 at 12:50 am
Когда запой превращается в острую угрозу здоровью, оперативное вмешательство становится необходимым условием для спасения жизни и предотвращения серьезных осложнений. В Уфе наркологи выезжают на дом для оказания качественной помощи при запое, предлагая детоксикацию, корректировку обменных процессов и психологическую поддержку. Такой формат лечения обеспечивает комфортную обстановку, индивидуальный подход и полную конфиденциальность для каждого пациента.
Выяснить больше – https://narcolog-na-dom-ufa0.ru/
KennethRem
18 Jul 25 at 12:51 am
Drug information leaflet. Brand names.
metformin bei ct untersuchung
Best news about meds. Get information here.
metformin bei ct untersuchung
18 Jul 25 at 12:54 am
Онлайн-психолог всегда рядом, даже дома. Детский психолог онлайн поможет ребенку преодолеть страхи.
женщина психолог онлайн
Ernestpoive
18 Jul 25 at 12:57 am
При запое организм отравляется, и нужна экстренная помощь нарколога в Волгограде. Получите квалифицированную помощь на дому, сохраняя конфиденциальность и удобство. Быстрая детоксикация и восстановление здоровья – наша задача. Мы приедем к вам как можно скорее и окажем всю необходимую помощь. Мы подберем лекарства и поможем вам справиться с психологическими проблемами. Начинаем с детоксикации, чтобы очистить организм от вредных веществ.
Разобраться лучше – [url=https://vyvod-iz-zapoya-volgograd00.ru/]вывести из запоя[/url]
Mathewdub
18 Jul 25 at 1:01 am
Когда организм на пределе, важна срочная помощь в Химках — это команда опытных наркологов, которые помогут быстро и мягко выйти из запоя без вреда для здоровья.
Получить дополнительную информацию – http://vyvod-iz-zapoya-himki12.ru
MariaGer
18 Jul 25 at 1:01 am
прогнозы от профессионалов [url=prognozy-na-sport-3.ru]prognozy-na-sport-3.ru[/url] .
prognozi na sport_mjen
18 Jul 25 at 1:03 am
HSA Dermal Clinic specializes inn advanced skincare, aesthetics, ɑnd
rejuvenation treatments.
dermal clinic
18 Jul 25 at 1:09 am
бланк аттестат за 11 класс купить в [url=www.arus-diplom22.ru/]бланк аттестат за 11 класс купить в[/url] .
Diplomi_jtsl
18 Jul 25 at 1:10 am
Прокапка после алкогольной зависимости — это важная медицинская процедура , предназначенная для очищения организма и восстановление здоровья человека. Во время обращения к наркологу для оказания помощи на дому проводится внутривенное введение препаратов для капельницы , что помогает очистить кровь от токсинов , которые накапливаются при злоупотреблении алкоголем. Нарколог на дом срочно Процедура обычно включает в себя солевые растворы, витамины и минералы, что способствует улучшению самочувствия и уменьшает проявления похмелья. Уход на дому дает возможность пациенту оставаться в знакомой среде, что играет важную роль в процессе реабилитации. Наркологическая помощь включает поддержку пациента , что значительно увеличивает вероятность успешного восстановления после алкогольной зависимости. Необходимо соблюдать рекомендации по лечению и регулярно проходить процедуру прокапки для достижения оптимальных результатов.
lechenietulaNeT
18 Jul 25 at 1:16 am
Вызов врача-нарколога на дом в Санкт-Петербурге начинается с детального осмотра и оценки состояния пациента. Врач измеряет давление, пульс, уровень кислорода в крови и определяет степень интоксикации.
Разобраться лучше – [url=https://narcolog-na-dom-sankt-peterburg00.ru/]нарколог на дом срочно[/url]
DerickDen
18 Jul 25 at 1:17 am
Howdy, i read your blog occasionally and i own a similar one and i was just curious if
you get a lot of spam comments? If so how do you stop it,
any plugin or anything you can advise? I get so much lately
it’s driving me crazy so any assistance is very much appreciated.
Read Full Report
18 Jul 25 at 1:20 am
прогнозы на спорт от профессионалов точные бесплатно на сегодня [url=www.prognozy-na-sport-3.ru/]www.prognozy-na-sport-3.ru/[/url] .
prognozi na sport_ypen
18 Jul 25 at 1:21 am
На этом этапе врач детально выясняет, как долго продолжается запой, какие симптомы наблюдаются, и имеются ли сопутствующие заболевания. Точный анализ информации помогает оперативно определить степень интоксикации и подобрать оптимальные методы детоксикации, что является ключом к предотвращению дальнейших осложнений.
Подробнее – [url=https://narcolog-na-dom-ryazan00.ru/]вызвать нарколога на дом рязань[/url]
Kennethseavy
18 Jul 25 at 1:21 am
Чем раньше проведена детоксикация, тем меньше риск развития серьезных последствий, таких как инфаркт, инсульт, алкогольный психоз, цирроз печени.
Получить дополнительную информацию – [url=https://kapelnica-ot-zapoya-moskva0.ru/]kapelnicza-ot-zapoya-czena moskva[/url]
Shawnsnala
18 Jul 25 at 1:25 am
Алкогольная и наркотическая зависимости требуют незамедлительного медицинского вмешательства. Длительные запои или острое отравление могут привести к тяжелым осложнениям и серьезным проблемам со здоровьем. Клиника «МедТрезвость» в Санкт-Петербурге предлагает квалифицированную наркологическую помощь прямо на дому, обеспечивая полную конфиденциальность и безопасность пациента. Наши специалисты оперативно выезжают по адресу, проводят все необходимые процедуры и помогают максимально быстро стабилизировать состояние пациента в комфортных домашних условиях.
Ознакомиться с деталями – https://narcolog-na-dom-sankt-peterburg0.ru/narkolog-na-dom-czena-spb/
CalvinSib
18 Jul 25 at 1:29 am
купить аттестат за 11 класс в чите [url=https://arus-diplom22.ru]https://arus-diplom22.ru[/url] .
Diplomi_ntsl
18 Jul 25 at 1:30 am
купить диплом в самаре [url=https://www.arus-diplom8.ru]купить диплом в самаре[/url] .
Kypit diplom ob obrazovanii!_qjol
18 Jul 25 at 1:45 am
Вся процедура проходит под полным контролем врача и занимает от 40 минут до 2 часов. Пациенту и его родственникам даются рекомендации по дальнейшему лечению и профилактике повторных запоев.
Изучить вопрос глубже – [url=https://kapelnica-ot-zapoya-moskva00.ru/]врач на дом капельница от запоя москва[/url]
RaymondBow
18 Jul 25 at 1:46 am
Психолог онлайн даст совет в сложный момент. Детский психолог онлайн разберется с детской тревогой.
психолог практик онлайн
Ernestpoive
18 Jul 25 at 1:51 am
Have you ever considered about including a little bit more than just your articles?
I mean, what you say is important and all. But imagine if you added some great pictures or video clips
to give your posts more, “pop”! Your content is excellent
but with images and videos, this site could undeniably be one of the best in its niche.
Terrific blog!
Adam
18 Jul 25 at 1:52 am
купить аттестаты для школы 11 класс [url=https://www.arus-diplom22.ru]купить аттестаты для школы 11 класс[/url] .
Diplomi_ohsl
18 Jul 25 at 1:55 am
Есть ситуации, когда вызов врача на дом становится не просто желателен, а жизненно необходим. Если зависимый человек не способен самостоятельно прекратить употребление алкоголя или наркотиков, а его самочувствие заметно ухудшается, необходимо незамедлительно обратиться за медицинской помощью. Поводом для вызова нарколога служат следующие опасные симптомы:
Подробнее – http://narcolog-na-dom-novosibirsk0.ru/
JerryJodia
18 Jul 25 at 1:58 am
Пациенты выбирают нашу клинику для срочного вызова врача-нарколога благодаря следующим важным преимуществам:
Получить дополнительные сведения – [url=https://narcolog-na-dom-novosibirsk00.ru/]narcolog-na-dom-novosibirsk00.ru/[/url]
ManuelLut
18 Jul 25 at 2:00 am
купить аттестат в новосибирске [url=https://arus-diplom8.ru]купить аттестат в новосибирске[/url] .
Priobresti diplom o visshem obrazovanii!_frol
18 Jul 25 at 2:06 am
Когда организм на пределе, важна срочная помощь в Люберцах — это команда опытных наркологов, которые помогут быстро и мягко выйти из запоя без вреда для здоровья.
[url=https://kapelnica-ot-zapoya-lyubercy12.ru/]врача капельницу от запоя в люберцах[/url] – [url=https://kapelnica-ot-zapoya-lyubercy12.ru/]капельница от запоя вызов люберцы[/url]
Lymanbot
18 Jul 25 at 2:08 am
certainly like your web-site however you have to
check the spelling on several of your posts.
Many of them are rife with spelling problems and I to find it very bothersome
to tell the truth then again I’ll surely come again again.
Latest Reviews
18 Jul 25 at 2:08 am
Онлайн-психолог — это забота о вашем душевном здоровье. Детский психолог онлайн поддержит в переходном возрасте.
детский психолог калуга
Ernestpoive
18 Jul 25 at 2:12 am
Good article! We are linking to this particularly great content on our website.
Keep up the great writing.
my link
18 Jul 25 at 2:13 am
Купить диплом возможно используя сайт компании. [url=http://psorum.ru/member.php?u=4348/]psorum.ru/member.php?u=4348[/url]
Sazrljz
18 Jul 25 at 2:16 am
Dragon money Графика и звуковое сопровождение создают атмосферу средневекового мира, полного приключений и опасностей. Регулярные обновления и новые функции делают игру интересной и захватывающей.
WoodrowNuare
18 Jul 25 at 2:18 am
1win blackjack [url=http://1win3043.com/]1win blackjack[/url]
1win_olEt
18 Jul 25 at 2:18 am
Нужен буст в игре? купить оружие dune awakening легендарная броня, костюмы, скины и уникальные предметы. Всё для выживания на Арракисе!
duneshop-558
18 Jul 25 at 2:21 am
Близкий человек в запое? Не ждите ухудшения. Обратитесь в клинику — здесь проведут профессиональный вывод из запоя с последующим восстановлением организма.
http://kapelnica-ot-zapoya-lyubercy13.ru/http://kapelnica-ot-zapoya-lyubercy13.ru – [url=https://kapelnica-ot-zapoya-lyubercy13.ru/]поставить капельницу от запоя в люберцах[/url]
BenitoPet
18 Jul 25 at 2:26 am
После поступления вызова нарколог клиники «АльфаНаркология» оперативно выезжает по указанному адресу. На месте врач проводит первичную диагностику, оценивая степень интоксикации, физическое и психологическое состояние пациента. По результатам осмотра врач подбирает индивидуальный комплекс лечебных процедур, в который входит постановка капельницы с растворами для детоксикации, препараты для стабилизации работы органов и нормализации психического состояния.
Выяснить больше – http://narcolog-na-dom-sankt-peterburg000.ru/narkolog-na-dom-czena-spb/
NormanIncib
18 Jul 25 at 2:26 am
Нужен буст в игре? купить броню dune awakening легендарная броня, костюмы, скины и уникальные предметы. Всё для выживания на Арракисе!
duneshop-520
18 Jul 25 at 2:28 am
Нашёл данные о bet boom скачать, рекомендую. Смотрите: [url=https://platie4you.ru/kak-skachat-prilozhenie-betbum-dlya-android-prostoj-put-k-miru-stavok-i-razvlechenij/]bet boom скачать[/url].
LucylGaunk
18 Jul 25 at 2:29 am
Онлайн-консультация с психологом — это просто. Детский психолог онлайн научит ребенка выражать чувства.
психолог калуга
Ernestpoive
18 Jul 25 at 2:30 am
pГҐskeГҐpent apotek [url=https://tryggmed.shop/#]Trygg Med[/url] poppers apotek
ScottFup
18 Jul 25 at 2:34 am
Купить диплом возможно через сайт компании. [url=http://wakeuptaylor.boardhost.com/post.php?action=post&fid=4/]wakeuptaylor.boardhost.com/post.php?action=post&fid=4[/url]
Sazrdqc
18 Jul 25 at 2:37 am