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!
Вывод из запоя в Самаре на базе стационара — когда важен результат, стабильность и медицинская поддержка 24/7.
Детальнее – [url=https://vyvod-iz-zapoya-v-stacionare-samara23.ru/]вывод из запоя в стационаре[/url]
Carlosquold
8 Oct 25 at 12:19 am
купить диплом медсестры [url=frei-diplom13.ru]купить диплом медсестры[/url] .
Diplomi_pvkt
8 Oct 25 at 12:20 am
Клиника «Детокс» в Сочи предлагает услугу вывода из запоя в стационаре. Под наблюдением профессиональных врачей пациент получит необходимую медицинскую помощь и поддержку. Услуга доступна круглосуточно, анонимно и начинается от 2000 ?.
Ознакомиться с деталями – [url=https://vyvod-iz-zapoya-sochi23.ru/]вывод из запоя в сочи[/url]
Jeffreymet
8 Oct 25 at 12:21 am
https://kiteschoolhurghada.ru/
WarrenHet
8 Oct 25 at 12:22 am
Prednisone without prescription USA: PredniWell Online – PredniWell Online
WillieRuivy
8 Oct 25 at 12:24 am
купить диплом в сыктывкаре [url=rudik-diplom10.ru]купить диплом в сыктывкаре[/url] .
Diplomi_xqSa
8 Oct 25 at 12:25 am
новости киберспорта [url=https://www.sportivnye-novosti-2.ru]новости киберспорта[/url] .
sportivnie novosti_xoma
8 Oct 25 at 12:26 am
новости киберспорта [url=https://sport-novosti-2.ru/]https://sport-novosti-2.ru/[/url] .
sport novosti_izmn
8 Oct 25 at 12:27 am
свежие новости спорта [url=sport-novosti-1.ru]sport-novosti-1.ru[/url] .
sport novosti_ebpa
8 Oct 25 at 12:30 am
play roulette online canada free, usa casino opening dates and real money online games in casino pride (Alta)
canada app, or casino united states stock
Alta
8 Oct 25 at 12:31 am
купить диплом техникума ссср в ставрополе [url=www.frei-diplom12.ru/]купить диплом техникума ссср в ставрополе[/url] .
Diplomi_ibPt
8 Oct 25 at 12:31 am
May I just say what a comfort to discover a person that truly understands what they’re talking about online.
You actually realize how to bring a problem to light and make it important.
More and more people need to look at this and understand this side of the story.
I can’t believe you aren’t more popular since you definitely possess the
gift.
Thanks
8 Oct 25 at 12:31 am
последние новости спорта [url=http://www.sportivnye-novosti-2.ru]последние новости спорта[/url] .
sportivnie novosti_vfma
8 Oct 25 at 12:31 am
купить диплом в первоуральске [url=www.rudik-diplom10.ru/]www.rudik-diplom10.ru/[/url] .
Diplomi_exSa
8 Oct 25 at 12:34 am
последние новости спорта [url=sportivnye-novosti-2.ru]последние новости спорта[/url] .
sportivnie novosti_cyma
8 Oct 25 at 12:35 am
куплю диплом медсестры в москве [url=http://www.frei-diplom13.ru]куплю диплом медсестры в москве[/url] .
Diplomi_owkt
8 Oct 25 at 12:35 am
Если нужен профессиональный вывод из запоя, обращайтесь в стационар клиники «Детокс» в Сочи. Все процедуры проводятся анонимно и под наблюдением специалистов.
Получить дополнительные сведения – [url=https://vyvod-iz-zapoya-sochi24.ru/]вывод из запоя на дому недорого в сочи[/url]
RobertoToott
8 Oct 25 at 12:36 am
Мы как производитель — федеральный производитель, которая с 2010-х годов занимается [url=https://18ps.ru/about/stati/9095/]отчетность по роп[/url] и изготовлением оборудования полного цикла. Разрабатываем и собираем линии, дробилки, смесители и пресс-формы, которые перерабатывают пластик в новые полезные материалы. Работаем по всей России, помогаем клиентам открывать собственные экологичные производства и выходить на рынок переработки с разумным бюджетом.
Вся техника создаётся на собственных мощностях, проходит испытания и запускается без длительной настройки. Мы контролируем процесс от начала до запуска: рассчитываем оптимальные параметры, обучаем операторов и консультируем по технологии. При необходимости можно [url=https://18ps.ru/about/stati/9099/]российский экологический оператор[/url] в индивидуальной комплектации — под любой объём производства.
Мы ориентируемся на долговечность и доверие, открытые принципы работы и долгосрочные отношения. Поэтому клиенты получают не просто оборудование, а систему, включающую сервис, обучение и гарантию во время всего производственного цикла.
Leronzacop
8 Oct 25 at 12:36 am
купить диплом техникума 1996 года [url=www.frei-diplom12.ru/]купить диплом техникума 1996 года[/url] .
Diplomi_scPt
8 Oct 25 at 12:39 am
купить диплом дизайнера [url=rudik-diplom10.ru]купить диплом дизайнера[/url] .
Diplomi_yxSa
8 Oct 25 at 12:40 am
Excellent article. Keep writing such kind of info on your site.
Im really impressed by it.
Hi there, You have done a great job. I’ll certainly digg it and in my view suggest to my friends.
I am confident they’ll be benefited from this website.
https://blog.aryes.fr/
8 Oct 25 at 12:42 am
cheap prednisone online [url=https://predniwellonline.com/#]Prednisone tablets online USA[/url] how to get Prednisone legally online
Michaelriz
8 Oct 25 at 12:43 am
сколько стоит купить диплом медсестры [url=www.frei-diplom13.ru]сколько стоит купить диплом медсестры[/url] .
Diplomi_shkt
8 Oct 25 at 12:43 am
В Краснодаре клиника «Детокс» проводит выезд нарколога на дом для безопасного вывода из запоя.
Подробнее – http://narkolog-na-dom-krasnodar25.ru
LelandLax
8 Oct 25 at 12:43 am
Great site, I recommend it to everyone.[url=https://anyswap.cc]anyswap[/url]
AnyswapCcNic
8 Oct 25 at 12:44 am
купить диплом техникума образец в спб [url=frei-diplom12.ru]купить диплом техникума образец в спб[/url] .
Diplomi_nsPt
8 Oct 25 at 12:45 am
https://palpalych.bandcamp.com/merch/palpalych
Thomasbip
8 Oct 25 at 12:46 am
новости тенниса [url=http://www.sportivnye-novosti-2.ru]новости тенниса[/url] .
sportivnie novosti_odma
8 Oct 25 at 12:50 am
диплом медсестры с аккредитацией купить [url=https://frei-diplom13.ru]диплом медсестры с аккредитацией купить[/url] .
Diplomi_tskt
8 Oct 25 at 12:54 am
Refresh Renovation Southwewst Charlotte
1251 Arrow Pine Ɗr c121,
Charlotte, NC 28273, United States
+19803517882
Makes your refresh renovating easy home
Makes your refresh renovating easy home
8 Oct 25 at 12:54 am
My partner and I absolutely love your blog and find nearly all of your post’s to be exactly I’m
looking for. Would you offer guest writers to write
content for you? I wouldn’t mind creating a post
or elaborating on most of the subjects you write
related to here. Again, awesome blog!
Xibet
8 Oct 25 at 12:56 am
новости хоккея [url=https://sport-novosti-2.ru/]новости хоккея[/url] .
sport novosti_epmn
8 Oct 25 at 12:59 am
download linebet apk
download linebet
8 Oct 25 at 1:00 am
В Краснодаре нарколог из клиники «Детокс» приедет на дом, чтобы вывести из запоя и оказать необходимую помощь.
Разобраться лучше – [url=https://narkolog-na-dom-krasnodar29.ru/]вызвать нарколога на дом срочно[/url]
Bradleycoova
8 Oct 25 at 1:00 am
В Сочи клиника «Детокс» предоставляет услугу вывода из запоя в стационаре. Профессиональные врачи обеспечат комфортное и безопасное лечение. Минимальная стоимость услуги — 2000 ?.
Изучить вопрос глубже – [url=https://vyvod-iz-zapoya-sochi22.ru/]вывод из запоя цена в сочи[/url]
RichardFek
8 Oct 25 at 1:00 am
I read this piece of writing completely regarding the comparison of most recent and previous technologies, it’s amazing article.
19837
8 Oct 25 at 1:02 am
My brother suggested I might like this blog. He was entirely right.
This post truly made my day. You can not imagine just how much time I had spent for this info!
Thanks!
neue online casinos
8 Oct 25 at 1:02 am
спортивные события [url=www.sport-novosti-1.ru/]www.sport-novosti-1.ru/[/url] .
sport novosti_tjpa
8 Oct 25 at 1:02 am
$MTAUR ICO is gaining traction over SHIB/XRP rallies. Token’s in-game convertibility ensures demand. Presale’s 1.4M USDT milestone proves it.
mtaur token
WilliamPargy
8 Oct 25 at 1:03 am
оргонит купить в Москве пирамида оберег для дома – Уточняющий запрос, указывающий на интерес к пирамидам-оберегам для дома. Предоставляет информацию
Edwardrit
8 Oct 25 at 1:04 am
новости легкой атлетики [url=https://www.sport-novosti-2.ru]https://www.sport-novosti-2.ru[/url] .
sport novosti_yqmn
8 Oct 25 at 1:05 am
Капельница от запоя на дому в Нижнем Новгороде — быстрый и эффективный способ снять симптомы похмелья и восстановить организм. Наши специалисты приедут к вам домой и проведут процедуру с использованием современных препаратов.
Узнать больше – [url=https://vyvod-iz-zapoya-nizhnij-novgorod12.ru/]нарколог на дом вывод из запоя в нижний новгороде[/url]
MarioCer
8 Oct 25 at 1:06 am
R777
PHP hook, building hooks in your application – Sjoerd Maessen blog at Sjoerd Maessen blog
R777
8 Oct 25 at 1:09 am
linebet somalia download
linebet registration
8 Oct 25 at 1:12 am
Если запой похлеще, «Похмельная Служба / Stop-Alko» в Екатеринбурге готова предложить услугу премиум-или VIP-уровня с продолжительной терапией.
Подробнее можно узнать тут – [url=https://vyvod-iz-zapoya-ekaterinburg25.ru/]vyvod-iz-zapoya-ekaterinburg25.ru/[/url]
Alfredheigo
8 Oct 25 at 1:17 am
Служба вывода из запоя на дому Stop-Alko в Екатеринбурге работает без перерывов, выезжает в любой район города, оказывает помощь с учётом всех медицинских стандартов.
Подробнее можно узнать тут – [url=https://vyvod-iz-zapoya-ekaterinburg26.ru/]вывод из запоя круглосуточно екатеринбург[/url]
Briangex
8 Oct 25 at 1:17 am
При госпитализации пациент находится под наблюдением 24/7, что снижает риск осложнений.
Детальнее – [url=https://vyvod-iz-zapoya-v-stacionare23.ru/]вывод из запоя в стационаре[/url]
Jeffreyneink
8 Oct 25 at 1:20 am
последние новости спорта [url=http://sportivnye-novosti-2.ru]последние новости спорта[/url] .
sportivnie novosti_wgma
8 Oct 25 at 1:26 am
В сердце Новосибирска расположен настоящий оазис для владельцев техники Apple — сервисный центр iClub, где профессионалы с более чем 11-летним опытом берутся за ремонт iPhone, MacBook, iPad и даже устройств других брендов, таких как Samsung и Xiaomi. Здесь вас ждет срочный ремонт в присутствии клиента, использование только оригинальных запчастей и гарантия до 12 месяцев, что подтверждают тысячи положительных отзывов от довольных пользователей, хвалящих быстроту и качество работы. Ищете ремонт смартфонов сяоми? — обратитесь на iclub.pro, где команда квалифицированных мастеров вернет ему жизнь без лишних наценок и обмана. Центр предлагает удобное расположение недалеко от метро, бесплатную парковку, оплату в рассрочку и даже услугу проверки устройств при покупке с рук, чтобы вы избежали подделок. С акциями вроде скидок до 30% на установку ОС и подарочными защитными стеклами, iClub становится идеальным выбором для тех, кто ценит честность, профессионализм и заботу о клиенте — доверьте свою технику экспертам и наслаждайтесь ее безупречной работой.
mulivinut
8 Oct 25 at 1:27 am
В Самаре стационар «Частного Медика 24» предлагает персонализированный подход — лечение запоя, детоксикация и дальнейшее восстановление под наблюдением специалистов.
Разобраться лучше – [url=https://vyvod-iz-zapoya-v-stacionare-samara24.ru/]вывод из запоя в стационаре[/url]
Jamessor
8 Oct 25 at 1:28 am