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!
1win գրանցում [url=https://1win3072.ru/]https://1win3072.ru/[/url]
1win_fbkr
22 Jul 25 at 5:21 am
purchase generic Accutane online discreetly [url=https://isotretinoinfromcanada.com/#]buy Accutane online[/url] Isotretinoin From Canada
BurtonCix
22 Jul 25 at 5:22 am
Нужен дом? строительство дома ключ цена — от проекта до отделки. Каркасные, кирпичные, брусовые, из газобетона. Гарантия качества, соблюдение сроков, индивидуальный подход.
stroitelstvo-domov-209
22 Jul 25 at 5:22 am
lexapro prescription: lexapro 20mg pill – Lexapro for depression online
Leroymex
22 Jul 25 at 5:22 am
Нужен дом? https://stroitelstvo-domov-kazan1.ru — от проекта до отделки. Каркасные, кирпичные, брусовые, из газобетона. Гарантия качества, соблюдение сроков, индивидуальный подход.
stroitelstvo-domov-459
22 Jul 25 at 5:27 am
Hi Dear, are you really visiting this web site daily, if so afterward you will definitely obtain good knowledge.
https://alanews24.com/kazaxstanskij-virtualnyj-nomer-dlya-sms-sovremennoe-reshenie-dlya-soxraneniya-konfidencialnosti.html
IsmaelNek
22 Jul 25 at 5:32 am
Клиника «ВолгаМед» в Волгограде обеспечивает круглосуточную анонимную помощь людям, столкнувшимся с алкогольной или наркотической зависимостью. Мы предлагаем как стационарное лечение в комфортных условиях, так и выезд врача на дом в любое время суток. Конфиденциальность, профессионализм и индивидуальный подход — ключевые принципы нашей работы. В этой статье подробно рассмотрим преимущества клиники, спектр услуг, порядок организации домашнего выезда специалистов и дополнительные возможности поддержки в период реабилитации.
Исследовать вопрос подробнее – https://narkologicheskaya-klinika-volgograd13.ru/
DustinTon
22 Jul 25 at 5:37 am
Кодирование — это не просто медицинская манипуляция, а серьёзный шаг к восстановлению контроля над собственной жизнью и формированию устойчивой ремиссии.
Ознакомиться с деталями – https://kodirovanie-ot-alkogolizma-mytishchi5.ru
Kennethblirl
22 Jul 25 at 5:39 am
Howdy! This is kind of off topic but I need some help from an established blog. Is it difficult to set up your own blog? I’m not very techincal but I can figure things out pretty fast. I’m thinking about creating my own but I’m not sure where to begin. Do you have any tips or suggestions? Cheers
https://fasttelegraph.ru/chto-takoe-virtualnyj-nomer-i-zachem-on-nuzhen/
StephenGlona
22 Jul 25 at 5:44 am
mostbet uz aviator [url=https://mostbet4074.ru]mostbet uz aviator[/url]
mostbet_idKn
22 Jul 25 at 5:47 am
провайдеры по адресу дома
domashij-internet-samara004.ru
интернет по адресу дома
inernetsamaraelini
22 Jul 25 at 5:51 am
Кроме того, клиника “Ресурс здоровья” делает акцент на профилактике рецидивов. Мы обучаем пациентов навыкам управления стрессом, эмоциональному регулированию и формированию здорового образа жизни. Наша цель — обеспечить долгосрочное восстановление и снизить риск возвращения к пагубным привычкам.
Подробнее – https://narco-vivod.ru/
Michaeltob
22 Jul 25 at 5:54 am
blacksprut
блэкспрут
black sprut
блэк спрут
blacksprut вход
блэкспрут ссылка
blacksprut ссылка
blacksprut onion
блэкспрут сайт
блэкспрут вход
блэкспрут онион
блэкспрут дакрнет
blacksprut darknet
blacksprut сайт
блэкспрут зеркало
blacksprut зеркало
black sprout
blacksprut com зеркало
блэкспрут не работает
blacksprut зеркала
как зайти на blacksprut
blacksprut onion
RichardPep
22 Jul 25 at 5:56 am
В состав капельницы обычно входят растворы для гидратации, витаминно-минеральные комплексы, гепатопротекторы для защиты печени, а также седативные препараты для стабилизации нервной системы. Такой подход позволяет быстро справиться с признаками похмелья и предотвратить развитие более серьезных осложнений.
Углубиться в тему – https://kapelnica-ot-zapoya-ekb55.ru/kapelnicza-na-domu-ekaterinburg-ot-zapoya/
DavidNog
22 Jul 25 at 6:04 am
where can i buy ball bearings bearing manufacturer: Partner with a reputable bearing manufacturer to ensure consistent quality, reliable performance, and innovative solutions. Our commitment to excellence extends from design and engineering to manufacturing and testing. Benefit from our expertise and experience in developing custom bearing solutions for your unique needs.
RobertPhasp
22 Jul 25 at 6:07 am
Check web-site http://www.yicstone.com/cn/gbook.asp
Richardencuh
22 Jul 25 at 6:08 am
It’s in reality a great and useful piece of information. I am satisfied that you shared this useful information with us.
Please keep us informed like this. Thank you for sharing.
купить виагру
22 Jul 25 at 6:11 am
Lexapro for depression online: where can you buy lexapro – lexapro 5mg
Leroymex
22 Jul 25 at 6:12 am
Запой – это серьезная угроза для здоровья. Немедленно вызывайте нарколога на дом в Волгограде! Нарколог приедет к вам быстро, сохранит анонимность и подберет индивидуальное лечение. Мы быстро выведем токсины и вернем вам хорошее самочувствие. В любое время дня и ночи мы готовы приехать и начать лечение. Мы сочетаем медикаменты и психологическую поддержку для успешного лечения. Первый этап лечения – избавление от токсинов с помощью лекарств.
Получить дополнительную информацию – [url=https://vyvod-iz-zapoya-volgograd00.ru/]вывод из запоя на дому волгоград недорого[/url]
Charlesmew
22 Jul 25 at 6:22 am
https://lexapro.pro/# lexapro 20mg pill
TheronSnipt
22 Jul 25 at 6:22 am
как вывести бонусы с 1win на карту [url=http://1win3069.ru/]http://1win3069.ru/[/url]
1win_zjkn
22 Jul 25 at 6:26 am
mental health support chat [url=http://mental-health21.com/]http://mental-health21.com/[/url] .
Mental Health_xjPa
22 Jul 25 at 6:29 am
Врач-нарколог проводит комплексное обследование пациента, оценивая степень зависимости и общее состояние организма. В ходе первичного осмотра специалист не только определяет тяжесть алкогольной зависимости, но и выявляет сопутствующие патологии, которые могут повлиять на процесс лечения. Обследование включает лабораторные анализы, электрокардиограмму и другие необходимые диагностические процедуры. Врач тщательно изучает анамнез для выявления возможных противопоказаний к определенным методам терапии. Особое внимание уделяется психологическим аспектам, которые могли способствовать формированию зависимости, что помогает разработать эффективную программу лечения.
Получить дополнительные сведения – [url=https://vyvod-iz-zapoya-krasnoyarsk55.ru/]вывод из запоя в стационаре[/url]
Williamsok
22 Jul 25 at 6:30 am
ai mental health therapy [url=http://www.mental-health21.com]http://www.mental-health21.com[/url] .
Mental Health_yyPa
22 Jul 25 at 6:30 am
Вызов врача-нарколога на дом в Санкт-Петербурге начинается с детального осмотра и оценки состояния пациента. Врач измеряет давление, пульс, уровень кислорода в крови и определяет степень интоксикации.
Разобраться лучше – [url=https://narcolog-na-dom-sankt-peterburg00.ru/]вызвать нарколога на дом санкт-петербург[/url]
Tomaswak
22 Jul 25 at 6:32 am
вывод из запоя круглосуточно
vivod-iz-zapoya-kaluga006.ru
лечение запоя калуга
zapojkalugaNeT
22 Jul 25 at 6:33 am
сертификат на украшения Браслет из гематита Гематит – камень, известный своим металлическим блеском и способностью улучшать кровообращение. Браслет из гематита считается символом силы, мужества и защиты. Он помогает справиться с усталостью, повысить энергетический уровень и улучшить общее самочувствие.
Richardnox
22 Jul 25 at 6:34 am
бк 1 win [url=https://1win3066.ru]https://1win3066.ru[/url]
1win_fsEi
22 Jul 25 at 6:40 am
tadalafil online no rx [url=https://tadalafilfromindia.com/#]Cialis without prescription[/url] Tadalafil From India
BurtonCix
22 Jul 25 at 6:43 am
mental health chatbot [url=www.mental-health21.com]www.mental-health21.com[/url] .
Mental Health_ojPa
22 Jul 25 at 6:46 am
В нашем медицинском центре работают высококвалифицированные специалисты в области наркологии и психиатрии. Все врачи имеют профильное образование, а также опыт работы в клиниках и реабилитационных центрах. Основные преимущества нашей команды:
Получить больше информации – [url=https://alko-specialist.ru/]вывод из запоя на дому цена[/url]
IsmaelLox
22 Jul 25 at 7:04 am
Запой — состояние, при котором человек теряет контроль над количеством употребляемого алкоголя и уже не может самостоятельно прекратить пить. Подобные эпизоды представляют серьёзную угрозу для здоровья, а порой и для жизни. Особенно опасен резкий отказ от спиртного после длительных запоев — это может вызвать тяжёлые абстинентные расстройства, нарушение работы сердца, печени, нервной системы, галлюцинации и даже приступы судорог. В такой ситуации необходимо срочно обращаться к профессионалам. В наркологической клинике «Спасение Плюс» в Химках вывод из запоя осуществляется с выездом врача, гарантией безопасности и индивидуальным подходом.
Получить дополнительные сведения – http://vyvod-iz-zapoya-himki5.ru
BrandonRon
22 Jul 25 at 7:05 am
интернет по адресу дома
domashij-internet-samara004.ru
интернет провайдеры по адресу самара
inernetsamaraelini
22 Jul 25 at 7:12 am
generic isotretinoin: generic isotretinoin – Isotretinoin From Canada
KelvinHoosy
22 Jul 25 at 7:19 am
Попытка самостоятельно выйти из запоя или преодолеть тяжелое похмелье может привести к крайне негативным последствиям. Длительное употребление алкоголя или резкий отказ без врачебного контроля опасны развитием осложнений, таких как алкогольный психоз, инсульт, инфаркт, обезвоживание и острая сердечная недостаточность.
Изучить вопрос глубже – [url=https://narcolog-na-dom-sankt-peterburg000.ru/]нарколог на дом недорого[/url]
Charlesnob
22 Jul 25 at 7:22 am
СЕО оптимизация карточки товара создание карточек недорого: Качественное создание карточек по доступным ценам.
DarylHoamy
22 Jul 25 at 7:22 am
blacksprut
блэкспрут
black sprut
блэк спрут
blacksprut вход
блэкспрут ссылка
blacksprut ссылка
blacksprut onion
блэкспрут сайт
блэкспрут вход
блэкспрут онион
блэкспрут дакрнет
blacksprut darknet
blacksprut сайт
блэкспрут зеркало
blacksprut зеркало
black sprout
blacksprut com зеркало
блэкспрут не работает
blacksprut зеркала
как зайти на blacksprut
blacksprut сайт
RichardPep
22 Jul 25 at 7:25 am
Thanks for some other informative website. The place else may I am getting that kind of information written in such an ideal method? I have a venture that I am just now operating on, and I have been at the glance out for such info.
number
EarnestAbent
22 Jul 25 at 7:26 am
order isotretinoin from Canada to US: order isotretinoin from Canada to US – generic isotretinoin
KelvinHoosy
22 Jul 25 at 7:27 am
Эта публикация завернет вас в вихрь увлекательного контента, сбрасывая стереотипы и открывая двери к новым идеям. Каждый абзац станет для вас открытием, полным ярких примеров и впечатляющих достижений. Подготовьтесь быть вовлеченными и удивленными каждый раз, когда продолжите читать.
Секреты успеха внутри – https://digitisingmart.co.uk/blog/2020/04/30/lets-get-back-to-basics-embroidery-tension
DanielSok
22 Jul 25 at 7:34 am
I loved as much as you will receive carried out right here.
The sketch is tasteful, your authored material stylish.
nonetheless, you command get bought an shakiness over
that you wish be delivering the following. unwell unquestionably come further formerly again since
exactly the same nearly very often inside case you shield this hike.
https://ok9393.com/
22 Jul 25 at 7:37 am
экстренный вывод из запоя калуга
vivod-iz-zapoya-kaluga006.ru
экстренный вывод из запоя калуга
vivodkalugaNeT
22 Jul 25 at 7:48 am
Drugs information sheet. Generic Name.
can you get fexofenadine pills
All information about medicines. Get information now.
can you get fexofenadine pills
22 Jul 25 at 7:50 am
Бесплатные ставки в слотах
Jameskaf
22 Jul 25 at 7:58 am
п»їlexapro: Lexapro for depression online – Lexapro for depression online
KelvinHoosy
22 Jul 25 at 8:01 am
pillow block bearing manufacturer in Europe: Access a comprehensive network of leading bearing manufacturers across Europe, renowned for their innovation, quality, and reliability. Explore a diverse array of bearing types, materials, and sizes to meet your specific application needs. Forge a partnership with a trusted European manufacturer for unparalleled bearing performance and enduring value.
RobertPhasp
22 Jul 25 at 8:08 am
Промокод на бесплатную ставку
Miltonarguh
22 Jul 25 at 8:17 am
https://remontkomand.kz/ Доступный ремонт с гарантией специалисты без предоплаты, мастера, с использованием современных материалов.
DarrylEpifs
22 Jul 25 at 8:18 am
ai mental health app [url=mental-health22.com]mental-health22.com[/url] .
Mental Health_avOn
22 Jul 25 at 8:28 am
экстренный вывод из запоя
vivod-iz-zapoya-omsk002.ru
лечение запоя
lechenieomskNeT
22 Jul 25 at 8:30 am