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=www.frei-diplom1.ru/]купил диплом легально[/url] .
Diplomi_dtOi
30 Oct 25 at 11:18 pm
блокада седалищного нерва [url=https://mariacare.fi/]костоправ[/url]
AndrewWrawl
30 Oct 25 at 11:18 pm
All the latest here: https://www.haldinfoods.com/kupit-akkaunty-tik-tok-s-vozrastom-ot-2-rublej/
Terrellinfub
30 Oct 25 at 11:19 pm
курсы seo [url=www.kursy-seo-12.ru]курсы seo[/url] .
kyrsi seo_kzor
30 Oct 25 at 11:19 pm
WOW just what I was looking for. Came here by searching for do australians need a visa for turkey
visa for turkey from australia
30 Oct 25 at 11:19 pm
где купить диплом техникума высокого [url=https://frei-diplom8.ru]где купить диплом техникума высокого[/url] .
Diplomi_ycsr
30 Oct 25 at 11:20 pm
linebet скачать на андроид
linebet partners
30 Oct 25 at 11:21 pm
Перед процедурой врач оценивает состояние пациента, измеряет давление, пульс и уровень насыщения крови кислородом. После осмотра подбирается состав инфузии, включающий препараты для дезинтоксикации, восстановления водно-солевого баланса и нормализации работы органов. Введение растворов осуществляется внутривенно, под контролем специалиста. Длительность процедуры — от 40 минут до 1,5 часов.
Исследовать вопрос подробнее – [url=https://kapelnicza-ot-zapoya-v-volgograde17.ru/]капельница от запоя недорого волгоград[/url]
Stephenchork
30 Oct 25 at 11:21 pm
https://t.me/Beefcasino_rus/57
HighRollerMage
30 Oct 25 at 11:21 pm
купить диплом во владикавказе [url=http://www.rudik-diplom11.ru]http://www.rudik-diplom11.ru[/url] .
Diplomi_xyMi
30 Oct 25 at 11:23 pm
kamagra oral jelly: Kamagra 100mg prix France – Sildenafil générique
RobertJuike
30 Oct 25 at 11:23 pm
Технологии открывают новые границы кракен ссылка kraken онион kraken онион тор кракен онион
RichardPep
30 Oct 25 at 11:23 pm
купить диплом техникума с занесением в реестр [url=http://frei-diplom6.ru]купить диплом техникума с занесением в реестр[/url] .
Diplomi_fqOl
30 Oct 25 at 11:24 pm
acheter Kamagra en ligne: Sildenafil générique – Kamagra 100mg prix France
RobertJuike
30 Oct 25 at 11:24 pm
Диджитализация — ключ к успеху kra ссылка kraken ссылка тор kraken ссылка зеркало kraken ссылка на сайт
RichardPep
30 Oct 25 at 11:24 pm
кракен vk6
кракен маркетплейс
JamesDaync
30 Oct 25 at 11:24 pm
купить рулонные шторы москва [url=https://rulonnye-shtory-s-elektroprivodom7.ru/]купить рулонные шторы москва[/url] .
rylonnie shtori s elektroprivodom_uuMl
30 Oct 25 at 11:25 pm
курсы по seo [url=www.kursy-seo-12.ru/]курсы по seo[/url] .
kyrsi seo_zoor
30 Oct 25 at 11:25 pm
электрические карнизы купить [url=www.elektrokarniz499.ru/]www.elektrokarniz499.ru/[/url] .
elektrokarniz_mhKl
30 Oct 25 at 11:27 pm
купить диплом в твери [url=https://www.rudik-diplom5.ru]купить диплом в твери[/url] .
Diplomi_awma
30 Oct 25 at 11:27 pm
диплом техникума купить новосибирск [url=http://www.frei-diplom8.ru]диплом техникума купить новосибирск[/url] .
Diplomi_wjsr
30 Oct 25 at 11:28 pm
купить диплом в новороссийске [url=https://rudik-diplom8.ru]купить диплом в новороссийске[/url] .
Diplomi_zxMt
30 Oct 25 at 11:28 pm
где можно купить диплом техникума в ижевске [url=www.frei-diplom9.ru/]где можно купить диплом техникума в ижевске[/url] .
Diplomi_ttea
30 Oct 25 at 11:28 pm
Сколько времени занимает уничтожение клопов холодным туманом?
дезинфекция после чесотки
KennethceM
30 Oct 25 at 11:29 pm
ИТ-индустрия формирует будущее kraken сайт зеркала kraken актуальные ссылки кракен ссылка kraken kraken официальные ссылки
RichardPep
30 Oct 25 at 11:29 pm
DRINKIO приятно удивил точностью и скоростью. Курьеры приезжают без опозданий, заказы всегда соответствуют. Ассортимент богатый, сайт удобный. Радует круглосуточная доставка. Отличный сервис для жителей столицы. Доставка алкоголя на дом в Москве, https://drinkio105.ru/catalog/category/vino/
Ronaldskada
30 Oct 25 at 11:30 pm
Процесс терапии в наркологической клинике в Воронеже организован поэтапно. Это позволяет обеспечить системность и постепенность восстановления, снизить риски осложнений и повысить устойчивость результата.
Получить дополнительные сведения – [url=https://narkologicheskaya-klinika-v-voronezhe17.ru/]лечение в наркологической клинике воронеж[/url]
Leslieclews
30 Oct 25 at 11:30 pm
рулонные шторы электрические [url=www.rulonnye-shtory-s-elektroprivodom7.ru/]рулонные шторы электрические[/url] .
rylonnie shtori s elektroprivodom_rvMl
30 Oct 25 at 11:31 pm
В Воронеже команда «ВоронМед Профи» работает по принципу быстрой медицинской реакции — помощь оказывается независимо от времени суток и дня недели. Все выезды выполняются анонимно, без спецтранспорта и медицинской формы. Врач приезжает в гражданской одежде, что исключает ненужное внимание соседей и посторонних. В ходе осмотра специалист измеряет давление, пульс, температуру, оценивает уровень интоксикации и определяет степень обезвоживания. На основе полученных данных подбирается состав капельницы, который подаётся медленно и безопасно под контролем врача.
Получить больше информации – [url=https://narkolog-na-dom-v-voronezhe17.ru/]вызов нарколога на дом воронеж[/url]
Thomasguink
30 Oct 25 at 11:31 pm
Все детали и нюансы здесь: https://balforum.net/kak-sozdayutsya-bloknoty-ot-bumazhnogo-bloka-do-gotovogo-perepleta.html
StevenGathe
30 Oct 25 at 11:31 pm
диплом купить проведенный [url=frei-diplom6.ru]диплом купить проведенный[/url] .
Diplomi_naOl
30 Oct 25 at 11:31 pm
электрокарнизы для штор купить в москве [url=http://elektrokarniz797.ru]http://elektrokarniz797.ru[/url] .
elektrokarniz_kcEi
30 Oct 25 at 11:32 pm
купить диплом колледжа культуры и искусств [url=https://frei-diplom8.ru/]https://frei-diplom8.ru/[/url] .
Diplomi_jwsr
30 Oct 25 at 11:32 pm
More details One click: https://drdrink.co.th/?p=329188
Terrellinfub
30 Oct 25 at 11:33 pm
seo бесплатно [url=http://kursy-seo-12.ru]seo бесплатно[/url] .
kyrsi seo_kkor
30 Oct 25 at 11:33 pm
Hey there! I’ve been reading your site for a while now and finally
got the bravery to go ahead and give you a shout out
from Dallas Tx! Just wanted to tell you keep up the good work!
fire damage restoration near me
30 Oct 25 at 11:33 pm
купить диплом моряка [url=www.rudik-diplom5.ru/]купить диплом моряка[/url] .
Diplomi_qtma
30 Oct 25 at 11:34 pm
купить диплом ижевск с занесением в реестр [url=http://frei-diplom2.ru/]купить диплом ижевск с занесением в реестр[/url] .
Diplomi_edEa
30 Oct 25 at 11:35 pm
Клиника «ВоронежМед Альянс» придерживается принципа прозрачной медицины: каждый шаг понятен пациенту, решения принимаются совместно, а результаты фиксируются по объективным показателям. Такой формат создаёт чувство безопасности и доверия. Среди основных принципов:
Получить больше информации – http://narcologicheskaya-klinika-v-voronezhe17.ru
TrentonZetle
30 Oct 25 at 11:35 pm
как купить диплом с реестром [url=www.frei-diplom5.ru]как купить диплом с реестром[/url] .
Diplomi_mqPa
30 Oct 25 at 11:36 pm
Kamagra sans ordonnance: Kamagra pas cher France – Kamagra sans ordonnance
RobertJuike
30 Oct 25 at 11:36 pm
РедМетСплав предлагает обширный выбор высококачественных изделий из нестандартных материалов. Не важно, какие объемы вам необходимы – от небольших закупок до масштабных поставок, мы обеспечиваем оперативное исполнение вашего заказа.
Каждая единица изделия подтверждена всеми необходимыми документами, подтверждающими их качество. Дружелюбная помощь – наш стандарт – мы на связи, чтобы улаживать ваши вопросы а также предоставлять решения под специфику вашего бизнеса.
Доверьте вашу потребность в редких металлах профессионалам РедМетСплав и убедитесь в множестве наших преимуществ
Наша продукция:
Труба магниевая R04295 – UNS Пруток магниевый R04295 – UNS – это высококачественный сплав, обладающий отличной легкостью и прочностью. Магний является идеальным выбором для применения в аэрокосмической и автомобильной промышленности благодаря своим уникальным свойствам. Наши прутки соответствуют международным стандартам, что обеспечивает надежность и долговечность ваших изделий. Пруток магниевый R04295 – UNS легко обрабатывается и сваривается, что позволяет создать компоненты сложной формы. Не упустите возможность купить Пруток магниевый R04295 – UNS и расширить свои технические возможности!
SheilaAlemn
30 Oct 25 at 11:37 pm
The most interesting is here: https://www.pypo.com/what-to-consider-before-you-buy-tiktok-accounts-a-3/
Terrellinfub
30 Oct 25 at 11:38 pm
acheter Kamagra en ligne: Kamagra sans ordonnance – VitaHomme
RichardImmon
30 Oct 25 at 11:38 pm
I’m gone to say to my little brother, that he should also go
to see this blog on regular basis to obtain updated from latest news update.
Water Damage Cleanup
30 Oct 25 at 11:39 pm
seo бесплатно [url=http://kursy-seo-12.ru/]seo бесплатно[/url] .
kyrsi seo_yxor
30 Oct 25 at 11:39 pm
[url=https://umnye-shtory-s-elektroprivodom.ru/]купить умное окно Прокарниз[/url] – управляемые шторы, которые позволят вам легко контролировать свет и атмосферу в вашем доме.
Также, управляемые шторы помогают в поддержании в доме нужной температуры.
система умный дом шторы Prokarniz
30 Oct 25 at 11:40 pm
Hey there! I could have sworn I’ve been to this blog before but after
reading through some of the post I realized it’s new to me.
Anyways, I’m definitely happy I found it and
I’ll be book-marking and checking back frequently!
My web page – zinnat02
zinnat02
30 Oct 25 at 11:41 pm
купить диплом в клинцах [url=www.rudik-diplom4.ru/]купить диплом в клинцах[/url] .
Diplomi_ruOr
30 Oct 25 at 11:41 pm
купить легальный диплом колледжа [url=frei-diplom2.ru]купить легальный диплом колледжа[/url] .
Diplomi_ikEa
30 Oct 25 at 11:41 pm