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!
Лечение наркомании в клинике начинается с диагностики, позволяющей определить степень зависимости, выявить сопутствующие заболевания и выбрать оптимальную тактику терапии. Важным этапом является детоксикация — очищение организма от токсинов и продуктов распада наркотических веществ, что снижает риск осложнений и облегчает последующее восстановление.
Выяснить больше – [url=https://lechenie-narkomanii-tver0.ru/]лечение наркомании наркология[/url]
MatthewNoG
14 Oct 25 at 3:09 pm
купить диплом в набережных челнах [url=http://www.rudik-diplom11.ru]купить диплом в набережных челнах[/url] .
Diplomi_zwMi
14 Oct 25 at 3:09 pm
Minotaurus token’s multi-chain support key. Presale raise impressive. Unlocks thrilling.
mtaur coin
WilliamPargy
14 Oct 25 at 3:09 pm
горизонтальные жалюзи с электроприводом [url=https://zhalyuzi-s-elektroprivodom77.ru]горизонтальные жалюзи с электроприводом[/url] .
jaluzi na okna s elektroprivodom_ewpa
14 Oct 25 at 3:09 pm
Диагностика в клинике «КузбассМед» проводится комплексно: используются лабораторные, инструментальные и психологические методы. Благодаря применению цифровых систем и алгоритмов обработки данных, результаты анализов доступны уже в течение первого часа. Оценка проводится по нескольким направлениям: токсикологический статус, состояние печени и почек, электролитный баланс, нейровегетативное состояние, когнитивные функции и уровень стресса. Это позволяет врачам составлять максимально точную картину заболевания и подбирать индивидуальные методы терапии.
Изучить вопрос глубже – [url=https://narkologicheskaya-klinika-novokuzneczk0.ru/]наркологическая клиника стационар новокузнецк[/url]
BrandonScoto
14 Oct 25 at 3:10 pm
согласование перепланировки в нежилом помещении [url=https://pereplanirovka-nezhilogo-pomeshcheniya9.ru/]pereplanirovka-nezhilogo-pomeshcheniya9.ru[/url] .
pereplanirovka nejilogo pomesheniya_zlKl
14 Oct 25 at 3:10 pm
купить диплом в первоуральске [url=rudik-diplom8.ru]rudik-diplom8.ru[/url] .
Diplomi_hvMt
14 Oct 25 at 3:11 pm
В клинике используются современные методы лечения, которые включают:
Исследовать вопрос подробнее – http://narkologicheskaya-klinika-tver0.ru/
Briangaw
14 Oct 25 at 3:11 pm
потолочкин ру натяжные потолки отзывы [url=stretch-ceilings-samara-1.ru]stretch-ceilings-samara-1.ru[/url] .
natyajnie potolki samara_ejsl
14 Oct 25 at 3:11 pm
В «СамарМед» пациент рассматривается не как носитель диагноза, а как личность с уникальной историей, эмоциональным фоном, социальным окружением и индивидуальными триггерами зависимости. Именно поэтому с первого обращения к лечению подключаются сразу несколько специалистов. Стартовый консилиум позволяет сформировать целостную картину состояния, определить точки риска и создать персонализированную стратегию терапии, включающую медицинскую, психотерапевтическую и социальную составляющие.
Подробнее тут – [url=https://narkologicheskaya-klinika-samara0.ru/]наркологическая клиника стационар в самаре[/url]
WilliamDer
14 Oct 25 at 3:12 pm
купить диплом в ставрополе [url=http://rudik-diplom4.ru]купить диплом в ставрополе[/url] .
Diplomi_joOr
14 Oct 25 at 3:12 pm
жалюзи на окна с электроприводом [url=https://zhalyuzi-s-elektroprivodom77.ru/]жалюзи на окна с электроприводом[/url] .
jaluzi na okna s elektroprivodom_lrpa
14 Oct 25 at 3:12 pm
Наркологическая помощь в Самаре представляет собой комплекс медицинских мероприятий, направленных на лечение алкогольной и наркотической зависимости, а также восстановление физического и психического здоровья пациентов. В наркологической клинике «Согласие» применяются современные методики диагностики, детоксикации и комплексной терапии, учитывающие индивидуальные особенности каждого пациента, тяжесть зависимости и наличие сопутствующих заболеваний. Основная цель — восстановление здоровья, предупреждение осложнений и снижение риска рецидивов.
Узнать больше – [url=https://narkologicheskaya-pomoshh-samara0.ru/]скорая наркологическая помощь в самаре[/url]
ShawnTup
14 Oct 25 at 3:12 pm
The Minotaurus ICO referral system is paying off big; got extra tokens from invites. $MTAUR’s utility in power-ups makes it more than hype. This project’s got legs.
minotaurus coin
WilliamPargy
14 Oct 25 at 3:13 pm
Для понимания ключевых компонентов лечения ниже представлена таблица, в которой систематизированы основные методы и их назначение.
Ознакомиться с деталями – [url=https://narkologicheskaya-pomoshh-novokuzneczk0.ru/]платная наркологическая скорая помощь новокузнецк[/url]
Henrymiply
14 Oct 25 at 3:13 pm
как узаконить перепланировку нежилого помещения [url=www.pereplanirovka-nezhilogo-pomeshcheniya10.ru]как узаконить перепланировку нежилого помещения[/url] .
pereplanirovka nejilogo pomesheniya_yvSr
14 Oct 25 at 3:13 pm
карниз электро [url=https://www.karniz-shtor-elektroprivodom.ru]https://www.karniz-shtor-elektroprivodom.ru[/url] .
karniz dlya shtor s elektroprivodom_euer
14 Oct 25 at 3:14 pm
Психотерапевтические сеансы направлены на осознание проблемы зависимости, развитие навыков сопротивления срывам и формирование новых моделей поведения. Особое внимание уделяется мотивационному консультированию и работе с эмоциональным состоянием.
Разобраться лучше – [url=https://narkologicheskaya-klinika-vladimir0.ru/]наркологические клиники алкоголизм в владимире[/url]
Jaimenef
14 Oct 25 at 3:14 pm
аренда мини экскаватора без оператора [url=www.arenda-mini-ekskavatora-v-moskve-2.ru/]www.arenda-mini-ekskavatora-v-moskve-2.ru/[/url] .
arenda mini ekskavatora v moskve_ufKt
14 Oct 25 at 3:14 pm
карниз с приводом [url=http://elektrokarnizy797.ru]http://elektrokarnizy797.ru[/url] .
elektrokarnizi_pqMl
14 Oct 25 at 3:14 pm
купить диплом в димитровграде [url=https://rudik-diplom13.ru]купить диплом в димитровграде[/url] .
Diplomi_coon
14 Oct 25 at 3:15 pm
«ТверьМед» — частная лицензированная клиника, специализирующаяся на наркологической помощи любой степени сложности. Здесь работают неравнодушные врачи-наркологи, психиатры, терапевты и психологи с многолетним стажем. Медицинская команда настроена на оперативную диагностику и проведение первичных мероприятий в течение первого часа после обращения. Упор сделан на доступность: клиника открыта 24/7, приём возможен как на территории медучреждения, так и на выезде — дома, в офисе, гостинице, санатории или любом удобном месте.
Подробнее тут – [url=https://narkologicheskaya-pomoshh-tver0.ru/]оказание наркологической помощи[/url]
DavidTop
14 Oct 25 at 3:15 pm
https://news.sarbc.ru/polit/
Nathanhip
14 Oct 25 at 3:17 pm
согласование перепланировок нежилых помещений [url=https://www.pereplanirovka-nezhilogo-pomeshcheniya10.ru]https://www.pereplanirovka-nezhilogo-pomeshcheniya10.ru[/url] .
pereplanirovka nejilogo pomesheniya_dpSr
14 Oct 25 at 3:19 pm
https://medreliefuk.com/# UK chemist Prednisolone delivery
Raymondspemn
14 Oct 25 at 3:20 pm
жалюзи автоматические цена [url=https://zhalyuzi-s-elektroprivodom77.ru/]жалюзи автоматические цена[/url] .
jaluzi na okna s elektroprivodom_slpa
14 Oct 25 at 3:20 pm
обслуживание мини экскаватора [url=http://arenda-mini-ekskavatora-v-moskve-2.ru/]http://arenda-mini-ekskavatora-v-moskve-2.ru/[/url] .
arenda mini ekskavatora v moskve_htKt
14 Oct 25 at 3:20 pm
купить диплом менеджера по туризму [url=http://rudik-diplom8.ru]купить диплом менеджера по туризму[/url] .
Diplomi_lxMt
14 Oct 25 at 3:21 pm
можно купить диплом медсестры [url=http://frei-diplom15.ru]можно купить диплом медсестры[/url] .
Diplomi_gdoi
14 Oct 25 at 3:23 pm
фитнес клуб женский фитнес клуб
fitnes-klub-484
14 Oct 25 at 3:24 pm
тканевые электрожалюзи [url=https://zhalyuzi-s-elektroprivodom77.ru/]https://zhalyuzi-s-elektroprivodom77.ru/[/url] .
jaluzi na okna s elektroprivodom_kopa
14 Oct 25 at 3:24 pm
купить диплом в дербенте [url=http://rudik-diplom11.ru/]купить диплом в дербенте[/url] .
Diplomi_dhMi
14 Oct 25 at 3:24 pm
купить диплом в архангельске [url=rudik-diplom3.ru]купить диплом в архангельске[/url] .
Diplomi_bjei
14 Oct 25 at 3:25 pm
потол [url=https://stretch-ceilings-samara-1.ru]https://stretch-ceilings-samara-1.ru[/url] .
natyajnie potolki samara_nmsl
14 Oct 25 at 3:25 pm
купить диплом в ачинске [url=https://rudik-diplom13.ru/]купить диплом в ачинске[/url] .
Diplomi_pron
14 Oct 25 at 3:25 pm
разрешение на перепланировку нежилого помещения не требуется [url=http://pereplanirovka-nezhilogo-pomeshcheniya10.ru/]http://pereplanirovka-nezhilogo-pomeshcheniya10.ru/[/url] .
pereplanirovka nejilogo pomesheniya_eoSr
14 Oct 25 at 3:26 pm
карнизы с электроприводом купить [url=karniz-shtor-elektroprivodom.ru]карнизы с электроприводом купить[/url] .
karniz dlya shtor s elektroprivodom_wier
14 Oct 25 at 3:27 pm
стоимость. экскаватора. на. час. [url=http://arenda-mini-ekskavatora-v-moskve-2.ru]http://arenda-mini-ekskavatora-v-moskve-2.ru[/url] .
arenda mini ekskavatora v moskve_thKt
14 Oct 25 at 3:27 pm
перепланировка нежилого помещения в многоквартирном доме [url=http://www.pereplanirovka-nezhilogo-pomeshcheniya9.ru]перепланировка нежилого помещения в многоквартирном доме[/url] .
pereplanirovka nejilogo pomesheniya_jyKl
14 Oct 25 at 3:27 pm
halbzeit endergebnis wetten
My blog :: die besten sportwetten anbieter
die besten sportwetten anbieter
14 Oct 25 at 3:29 pm
электрокарниз москва [url=https://elektrokarnizy797.ru]https://elektrokarnizy797.ru[/url] .
elektrokarnizi_lnMl
14 Oct 25 at 3:30 pm
жалюзи с электроприводом купить [url=https://www.zhalyuzi-s-elektroprivodom77.ru]жалюзи с электроприводом купить[/url] .
jaluzi na okna s elektroprivodom_gupa
14 Oct 25 at 3:31 pm
купить диплом в шадринске [url=www.rudik-diplom11.ru/]купить диплом в шадринске[/url] .
Diplomi_hfMi
14 Oct 25 at 3:32 pm
Hi! Do you use Twitter? I’d like to follow you if that would be
ok. I’m absolutely enjoying your blog and look forward to new
updates.
Bitnex Crestfort
14 Oct 25 at 3:35 pm
потолочник натяжные потолки самара [url=natyazhnye-potolki-samara-2.ru]natyazhnye-potolki-samara-2.ru[/url] .
natyajnie potolki samara_gqPi
14 Oct 25 at 3:35 pm
Начнем путешествие по магическим уголкам российских заповедников.
Для тех, кто ищет информацию по теме “Изучение ООПТ России: парки, заповедники, водоемы”, нашел много полезного.
Ссылка ниже:
[url=https://alloopt.ru]https://alloopt.ru[/url]
Рад был поделиться с вами этой информацией. До новых встреч!
fixRow
14 Oct 25 at 3:35 pm
согласование перепланировки в нежилом здании [url=www.pereplanirovka-nezhilogo-pomeshcheniya10.ru/]www.pereplanirovka-nezhilogo-pomeshcheniya10.ru/[/url] .
pereplanirovka nejilogo pomesheniya_rlSr
14 Oct 25 at 3:35 pm
Je suis totalement envoute par Casombie, ca transporte dans un monde de chaos ludique. La gamme est un veritable apocalypse de fun, offrant des sessions live dignes d’un film d’horreur. Le suivi est aussi fiable qu’un sortilege, repondant en un battement d’ailes. Les transactions sont fluides et fiables, neanmoins plus de promos macabres seraient un plus. Pour resumer, Casombie vaut chaque frisson qu’il procure pour ceux qui aiment l’adrenaline sombre ! De plus le site est visuellement un chef-d’?uvre macabre, ajoute une touche de magie noire.
casombie kasino -kokemuksia|
ShadowGlimmerZ3zef
14 Oct 25 at 3:36 pm
работа экскаватора цена за час [url=https://www.arenda-mini-ekskavatora-v-moskve-2.ru]работа экскаватора цена за час[/url] .
arenda mini ekskavatora v moskve_dyKt
14 Oct 25 at 3:36 pm
кожаные жалюзи с электроприводом [url=https://zhalyuzi-s-elektroprivodom77.ru]https://zhalyuzi-s-elektroprivodom77.ru[/url] .
jaluzi na okna s elektroprivodom_mtpa
14 Oct 25 at 3:38 pm