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-diplom23.ru]arus-diplom23.ru[/url] .
Diplomi_wxol
22 Jul 25 at 12:56 pm
вывод из запоя круглосуточно
vivod-iz-zapoya-omsk003.ru
вывод из запоя круглосуточно
izzapoyaomskNeT
22 Jul 25 at 12:57 pm
Яхта в аренду в Сочи — это сочетание комфорта, роскоши и невероятных эмоций, которые подарит вам морская прогулка с друзьями или любимым человеком: рыбалка на яхте в сочи
RobertGet
22 Jul 25 at 12:59 pm
https://remontkomand.kz/ Полный комплекс услуг для ремонта надежность и ответственность специалисты с высокое качество и под ключ.
DarrylEpifs
22 Jul 25 at 1:10 pm
generic sertraline: cheap Zoloft – generic sertraline
Leroymex
22 Jul 25 at 1:12 pm
https://remontkomand.kz/ Мастера с опытом делают ремонт без предоплаты недорого с индивидуальный подход и прозрачные условия.
DarrylEpifs
22 Jul 25 at 1:12 pm
Spot on with this write-up, I really think this site needs much
more attention. I’ll probably be returning to read through more, thanks for the information!
igtoto login
22 Jul 25 at 1:18 pm
купить аттестаты за 11 классов в екатеринбурге [url=www.arus-diplom23.ru]купить аттестаты за 11 классов в екатеринбурге[/url] .
Diplomi_viol
22 Jul 25 at 1:19 pm
где можно ставить ставки без верификации [url=https://1win3070.ru]https://1win3070.ru[/url]
1win_ixen
22 Jul 25 at 1:26 pm
На этом этапе врач детально выясняет, как долго продолжается запой, какие симптомы наблюдаются, и имеются ли сопутствующие заболевания. Точный анализ информации помогает оперативно определить степень интоксикации и подобрать оптимальные методы детоксикации, что является ключом к предотвращению дальнейших осложнений.
Получить больше информации – [url=https://narcolog-na-dom-ryazan00.ru/]запой нарколог на дом в рязани[/url]
Williedicky
22 Jul 25 at 1:28 pm
где купить диплом с реестром [url=arus-diplom31.ru]где купить диплом с реестром[/url] .
Diplomi_kepl
22 Jul 25 at 1:28 pm
После процедуры пациент и его близкие получают развернутые рекомендации по дальнейшему восстановлению, советы по профилактике рецидивов и возможности прохождения кодирования при желании пациента.
Получить дополнительные сведения – [url=https://narcolog-na-dom-sankt-peterburg000.ru/]вызов нарколога на дом санкт-петербург[/url]
DouglasBus
22 Jul 25 at 1:31 pm
generic sertraline [url=https://zoloft.company/#]generic sertraline[/url] buy Zoloft online without prescription USA
BurtonCix
22 Jul 25 at 1:31 pm
Highly energetic post, I loved that a lot. Will there be a
part 2?
cheap adult webcams
22 Jul 25 at 1:31 pm
AME Capitals Отзывы Отличная платформа для начинающих инвесторов. AME Capitals предоставляет все необходимые инструменты и обучение.
DavidLex
22 Jul 25 at 1:33 pm
http://finasteridefromcanada.com/# Propecia for hair loss online
TheronSnipt
22 Jul 25 at 1:38 pm
скачать приложение 1win на андроид [url=https://1win3069.ru/]https://1win3069.ru/[/url]
1win_wakn
22 Jul 25 at 1:39 pm
Выезд на дом включает: первичный осмотр, необходимые анализы на месте, подготовку и введение инфузионных смесей, мониторинг динамики, а также рекомендации по дальнейшему лечению.
Подробнее – [url=https://narkologicheskaya-klinika-sochi00.ru/]наркологическая клиника на дом[/url]
TimothyBoche
22 Jul 25 at 1:39 pm
Метод лечения
Изучить вопрос глубже – https://narkologicheskaya-klinika-krasnodar00.ru/platnaya-narkologicheskaya-klinika-krasnodar/
AubreySkise
22 Jul 25 at 1:44 pm
https://remontkomand.kz/ Соблюдение сроков и качество при ремонте высокое качество мастера недорого и полный комплекс услуг.
DarrylEpifs
22 Jul 25 at 1:45 pm
купить диплом в архангельске с занесением в реестр [url=www.arus-diplom31.ru/]купить диплом в архангельске с занесением в реестр[/url] .
Diplomi_qfpl
22 Jul 25 at 1:50 pm
https://lexapro.pro/# lexapro drug
TommyNex
22 Jul 25 at 1:50 pm
Когда речь идет о лечении зависимостей, многие пациенты испытывают стресс от визита в медицинские учреждения, особенно если это касается такой деликатной темы, как алкоголизм. Лечение на дому помогает избежать всех этих трудностей и обеспечивает комфорт для пациента. Привычная домашняя обстановка снижает тревожность, что позитивно влияет на процесс выздоровления.
Узнать больше – [url=https://narcolog-na-dom-ektb55.ru/]нарколог на дом круглосуточно в екатеринбурге[/url]
DonnieSnoli
22 Jul 25 at 1:52 pm
изготовление стендов в москве Стенд для выставки: Создание уникального пространства для взаимодействия Стенд для выставки – это специально организованное пространство, предназначенное для представления компании и ее продукции целевой аудитории. Он должен быть функциональным, удобным и привлекательным, обеспечивая комфортное взаимодействие с посетителями и эффективную демонстрацию преимуществ предлагаемых товаров и услуг. Дизайн стенда должен соответствовать фирменному стилю компании и отражать ее ценности.
DanielNip
22 Jul 25 at 1:57 pm
купил аттестат за 11 класс [url=http://arus-diplom23.ru/]купил аттестат за 11 класс[/url] .
Diplomi_sool
22 Jul 25 at 1:58 pm
Клиническая помощь на дому охватывает не только острые состояния, но и плановые мероприятия по выводу из запоя, устранению абстиненции и восстановлению водно-электролитного баланса. Используются только сертифицированные препараты, рекомендованные Минздравом России.
Подробнее тут – [url=https://narcolog-na-dom-ekaterinburg55.ru/]нарколог на дом срочно[/url]
Davidlah
22 Jul 25 at 1:58 pm
На первом этапе проводится осмотр: врач измеряет давление, пульс, уровень кислорода, температуру тела, оценивает общее состояние, собирает анамнез и анализирует возможные сопутствующие заболевания. При необходимости пациент проходит экспресс-диагностику, включая лабораторные анализы, ЭКГ и консультации других специалистов (кардиолога, невролога).
Подробнее можно узнать тут – [url=https://vyvod-iz-zapoya-balashiha5.ru/]вывод из запоя с выездом балашиха[/url]
Edwintut
22 Jul 25 at 2:01 pm
generic Cialis from India: generic Cialis from India – Tadalafil From India
Leroymex
22 Jul 25 at 2:02 pm
1win պաշտոնական կայք [url=https://1win3074.ru/]https://1win3074.ru/[/url]
1win_gpet
22 Jul 25 at 2:03 pm
Таким образом, мы создаём систему поддержки, позволяющую каждому пациенту успешно справляться с зависимостью и вернуться к полноценной жизни.
Разобраться лучше – http://alko-lechebnica.ru/vivod-iz-zapoya-anonimno-v-Sankt-Peterburge/
CharlesPat
22 Jul 25 at 2:05 pm
купить аттестат за 10 11 класс отзывы [url=arus-diplom21.ru]arus-diplom21.ru[/url] .
Priobresti diplom ob obrazovanii!_vxpn
22 Jul 25 at 2:08 pm
I juѕt couldn’t dеpart your web site priօr to suggesting that I really enjoyed tһe standard info
an individual provide fօr your guests? Iѕ going to be back
steadily to cheск up ⲟn new posts
Also visit my homepage – Bed Covering
Bed Covering
22 Jul 25 at 2:10 pm
http://xn--80aafabrjladsicc1amg1o4cf1dg.top/
Carlosweect
22 Jul 25 at 2:11 pm
вывод из запоя
vivod-iz-zapoya-omsk003.ru
экстренный вывод из запоя
narkologiyaomskNeT
22 Jul 25 at 2:14 pm
Medicines information for patients. Drug Class.
get cipro price
Best what you want to know about drugs. Read information now.
get cipro price
22 Jul 25 at 2:17 pm
я купил диплом с проводкой [url=https://arus-diplom31.ru/]я купил диплом с проводкой[/url] .
Diplomi_zupl
22 Jul 25 at 2:22 pm
Основу капельницы составляют инфузионные растворы, которые помогают устранить обезвоживание. Дополнительно вводятся витамины для улучшения обменных процессов, препараты для защиты печени, а также успокоительные средства для стабилизации нервной системы. Компоненты подбираются индивидуально с учетом состояния пациента, чтобы обеспечить максимальную эффективность и безопасность.
Разобраться лучше – [url=https://kapelnica-ot-zapoya-krasnoyarsk55.ru/]капельница от запоя выезд[/url]
MartinPep
22 Jul 25 at 2:25 pm
аттестат за 11 класс купить в томске [url=https://www.arus-diplom21.ru]аттестат за 11 класс купить в томске[/url] .
Priobresti diplom lubogo yniversiteta!_wzpn
22 Jul 25 at 2:30 pm
создание выставочных стендов Изготовление выставочных стендов Москва: лучшие предложения Изготовление выставочных стендов в Москве предлагает широкий выбор вариантов. Множество компаний предлагают услуги по проектированию и изготовлению стендов различной сложности и конфигурации. Важно тщательно изучить предложения различных компаний и выбрать ту, которая соответствует вашим требованиям и бюджету.
DanielNip
22 Jul 25 at 2:31 pm
where buy dipyridamole without rx
buying dipyridamole pills
22 Jul 25 at 2:45 pm
Все больше людей в Екатеринбурге выбирают капельницу на дому, и это не случайно. Данная услуга имеет несколько важных преимуществ. Во-первых, это анонимность — пациент может получить помощь без необходимости посещать медицинское учреждение. Во-вторых, лечение на дому позволяет избежать лишнего стресса, который может возникнуть при пребывании в больнице. Пациент чувствует себя в своей обстановке, что способствует лучшему восстановлению.
Разобраться лучше – [url=https://kapelnica-ot-zapoya-ektb55.ru/]капельница от запоя выезд екатеринбург[/url]
Josephexall
22 Jul 25 at 2:46 pm
Каждый пациент получает персонализированную программу, учитывающую стадию заболевания, сопутствующие патологии и социальный статус. На основании анализа состояния назначается оптимальная терапия, что значительно повышает эффективность лечения. Врач-нарколог подбирает препараты с учетом индивидуальной переносимости, а психотерапевт разрабатывает план психологической поддержки.
Получить больше информации – http://lechenie-alkogolizma-sochi00.ru
Jeffreybok
22 Jul 25 at 2:50 pm
mental health support chatbot [url=www.mental-health23.com]www.mental-health23.com[/url] .
Mental Health_hoMr
22 Jul 25 at 2:51 pm
mental health chatbot [url=http://www.mental-health23.com]http://www.mental-health23.com[/url] .
Mental Health_ovMr
22 Jul 25 at 2:52 pm
Процедура детоксикации занимает от 40 минут до 2 часов. После её завершения врач консультирует пациента и родственников, даёт рекомендации по дальнейшему лечению и профилактике повторных запоев.
Выяснить больше – [url=https://narcolog-na-dom-sankt-peterburg00.ru/]врач нарколог на дом санкт-петербург[/url]
DavidHaw
22 Jul 25 at 2:53 pm
Propecia for hair loss online [url=https://finasteridefromcanada.com/#]generic Finasteride without prescription[/url] Propecia for hair loss online
BurtonCix
22 Jul 25 at 2:54 pm
Основными направлениями работы являются:
Изучить вопрос глубже – [url=https://narkologicheskaya-klinika-sochi0.ru/]частная наркологическая клиника сочи.[/url]
RichardPow
22 Jul 25 at 2:57 pm
где купить аттестат 11 класса [url=https://arus-diplom21.ru/]где купить аттестат 11 класса[/url] .
Bistro i prosto priobresti diplom ob obrazovanii!_gopn
22 Jul 25 at 2:59 pm
Совместные занятия с другими пациентами создают атмосферу поддержки и понимания. Под руководством психотерапевта участники группы делятся опытом, обсуждают сложные ситуации и находят оптимальные способы удержаться от срыва.
Выяснить больше – [url=https://lechenie-alkogolizma-sochi0.ru/]klinika lecheniya alkogolizma sochi[/url]
Jerryquien
22 Jul 25 at 3:01 pm
https://www.glicol.ru/
Ismaelzek
22 Jul 25 at 3:01 pm