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=http://educ-ua11.ru]как купить диплом проведенный[/url] .
Diplomi_vvPi
13 Sep 25 at 1:51 am
прокарниз [url=https://elektro-karniz77.ru/]https://elektro-karniz77.ru/[/url] .
elektro karniz_coSl
13 Sep 25 at 1:51 am
The sports betting site is licensed by the Curacao Gaming Commission and consists of
categories within the sportsbook, such as live sports events, bouts,
e-sports, and even video games.
web page
13 Sep 25 at 1:51 am
бонусный баланс 1win [url=https://1win12004.ru]https://1win12004.ru[/url]
1win_qgEr
13 Sep 25 at 1:52 am
займы онлайн на карту займы онлайн на карту
zaym onlayn 610
13 Sep 25 at 1:52 am
Very energetic blog, I loved that bit. Will there be a part 2?
Neyrolomarix Platform
13 Sep 25 at 1:55 am
займ онлайн срочно займы онлайн без процентов
onlayn zaym 374
13 Sep 25 at 1:56 am
фотонахолстебарнаул Фото на холсте Фото на холсте – это готовое изделие, полученное в результате печати фотографии на холсте и натяжки полотна на подрамник. Это популярный элемент декора, который придает фотографии вид картины, написанной маслом или акрилом. Фактура холста и яркие, сочные цвета создают неповторимый эффект, делая изображение более выразительным и привлекательным. Фото на холсте может быть выполнено в различных стилях и размерах, что позволяет подобрать оптимальный вариант для любого интерьера и повода. Это также отличный подарок, который подчеркнет индивидуальность и вкус дарящего.
ThomasJouck
13 Sep 25 at 1:57 am
В «РостовМедЦентре» лечение начинается с подробной оценки факторов риска и мотивации. Клиническая команда анализирует стаж употребления, тип вещества, эпизоды срывов, соматический фон, лекарства, которые пациент принимает постоянно, и уровень социальной поддержки. Уже на первой встрече составляется «дорожная карта» на ближайшие 72 часа: диагностический минимум, объём медицинских вмешательств, пространство для психологической работы и точки контроля. Безопасность — не абстракция: скорости инфузий рассчитываются в инфузомате, седацию подбирают по шкалам тревоги и с обязательным контролем сатурации, а лекарственные взаимодействия сверяет клинический фармаколог. Пациент получает прозрачные цели на день, на неделю и на месяц — без обещаний мгновенных чудес и без стигмы.
Подробнее – http://narkologicheskaya-klinika-rostov-na-donu14.ru/chastnaya-narkologicheskaya-klinika/
Jackiemoips
13 Sep 25 at 1:58 am
карнизы для штор с электроприводом [url=avtomaticheskie-karnizy.ru]карнизы для штор с электроприводом[/url] .
avtomaticheskie karnizi_stSa
13 Sep 25 at 1:58 am
электрокранизы [url=http://elektro-karniz77.ru]http://elektro-karniz77.ru[/url] .
elektro karniz_neSl
13 Sep 25 at 2:01 am
Промокод для 1xBet это особая комбинация символов и цифр на бонус до 32 500 рублей. Действует это предложение только для новых игроков и после регистрации они получают 130% от суммы пополнения первого депозита.
Используйте Промокод который описсан более подробно в этой статье
где ввести промокод 1хбет чтобы получить гарантированный бонус в размере 100% до 32500 рублей (или эквивалентную сумму в другой валюте €130). Это предложение доступно только для новых пользователей.
Воспользуйтесь этим кодом, чтобы получить бонус от 1хбет. Просто введите код в анкете при регистрации и пополните свой счет на сумму от 100 рублей. Вам будет начислен бонус в размере 130%, который может достигать до 32500 рублей.
У нас вы можете получить бесплатный промокод, который даст вам дополнительные бонусы и преимущества при игре на сайте 1xBet. Для того чтобы воспользоваться этим промокодом, вам необходимо зарегистрироваться на сайте и пройти процедуру верификации. После этого вы сможете получить бонус по промокоду или при пополнении счета. Также вы можете получить бонус, если пригласите друга или примете участие в определенных акциях.
RobertGaivy
13 Sep 25 at 2:01 am
canadian medications [url=https://truenorthpharm.shop/#]TrueNorth Pharm[/url] TrueNorth Pharm
Michaelphype
13 Sep 25 at 2:01 am
карниз электро [url=www.avtomaticheskie-karnizy.ru]www.avtomaticheskie-karnizy.ru[/url] .
avtomaticheskie karnizi_eqSa
13 Sep 25 at 2:02 am
купить диплом с реестром о высшем образовании [url=www.educ-ua11.ru/]купить диплом с реестром о высшем образовании[/url] .
Diplomi_vnPi
13 Sep 25 at 2:02 am
карниз для штор электрический [url=https://www.elektro-karniz77.ru]https://www.elektro-karniz77.ru[/url] .
elektro karniz_gqSl
13 Sep 25 at 2:04 am
Medicine information. Generic Name.
how to get cheap proscar without insurance
Best trends of medicines. Read now.
how to get cheap proscar without insurance
13 Sep 25 at 2:05 am
«Как отмечает врач-нарколог Андрей Николаевич Селиванов, «своевременный визит специалиста на дом позволяет избежать тяжёлых осложнений и ускоряет стабилизацию состояния»».
Подробнее – [url=https://narkolog-na-dom-sankt-peterburg14.ru/]вызвать нарколога на дом в санкт-петербурге[/url]
Robertfloum
13 Sep 25 at 2:05 am
электрокарниз недорого [url=http://karnizy-s-elektroprivodom-cena.ru/]http://karnizy-s-elektroprivodom-cena.ru/[/url] .
karnizi s elektroprivodom cena_dxkr
13 Sep 25 at 2:07 am
карнизы с электроприводом купить [url=www.elektrokarniz-cena.ru/]карнизы с электроприводом купить[/url] .
elektrokarniz cena_qyPL
13 Sep 25 at 2:09 am
Аудиопоздравления сверху телефон
https://audiosms.ru/
13 Sep 25 at 2:09 am
TrueNorth Pharm: TrueNorth Pharm – canadian pharmacy ltd
Teddyroowl
13 Sep 25 at 2:09 am
best indian pharmacy [url=http://curabharatusa.com/#]india pharmacy[/url] buy medicine online india
Michaelphype
13 Sep 25 at 2:10 am
1win зеркало сайта на сегодня [url=1win12008.ru]1win12008.ru[/url]
1win_gysn
13 Sep 25 at 2:12 am
I do not even understand how I finished up here, but I believed this put up
used to be good. I do not recognize who you might be but definitely you
are going to a well-known blogger if you happen to are not already.
Cheers!
독학기숙학원
13 Sep 25 at 2:13 am
подключить домашний интернет в ростове
inernetvkvartiru-rostov004.ru
домашний интернет
internetrostovelini
13 Sep 25 at 2:14 am
блин… РѕРґРёРЅ заказ выбил, затестил. теперь опять РІ аське молчок
https://www.metooo.io/u/68b8ad0834e6203564b51408
Отличнный магазин
Harryunsag
13 Sep 25 at 2:14 am
прокарниз [url=https://karnizy-s-elektroprivodom-cena.ru/]karnizy-s-elektroprivodom-cena.ru[/url] .
karnizi s elektroprivodom cena_bgkr
13 Sep 25 at 2:14 am
Pills information sheet. What side effects can this medication cause?
can i get generic allegra tablets
Actual information about medicament. Read information now.
can i get generic allegra tablets
13 Sep 25 at 2:15 am
электрические карнизы купить [url=elektrokarniz-cena.ru]elektrokarniz-cena.ru[/url] .
elektrokarniz cena_mzPL
13 Sep 25 at 2:16 am
Этап
Выяснить больше – [url=https://kapelnica-ot-zapoya-vidnoe7.ru/]поставить капельницу от запоя[/url]
EugeneSoype
13 Sep 25 at 2:19 am
электрокарниз двухрядный [url=https://avtomaticheskie-karnizy.ru/]avtomaticheskie-karnizy.ru[/url] .
avtomaticheskie karnizi_ewSa
13 Sep 25 at 2:21 am
купить проведенный диплом кого [url=https://www.educ-ua15.ru]купить проведенный диплом кого[/url] .
Diplomi_pbmi
13 Sep 25 at 2:22 am
Hey there! Do you use Twitter? I’d like to follow you if that would be okay.
I’m absolutely enjoying your blog and look forward to new posts.
tripscan top
13 Sep 25 at 2:23 am
электрические гардины [url=www.karniz-s-elektroprivodom.ru/]электрические гардины[/url] .
karniz s elektroprivodom_ysKt
13 Sep 25 at 2:23 am
автоматические гардины для штор [url=http://karnizy-s-elektroprivodom-cena.ru/]http://karnizy-s-elektroprivodom-cena.ru/[/url] .
karnizi s elektroprivodom cena_okkr
13 Sep 25 at 2:24 am
электрокарниз недорого [url=http://www.elektro-karniz77.ru]http://www.elektro-karniz77.ru[/url] .
elektro karniz_soSl
13 Sep 25 at 2:24 am
карнизы для штор с электроприводом [url=https://avtomaticheskie-karnizy-dlya-shtor.ru/]карнизы для штор с электроприводом[/url] .
avtomaticheskie karnizi dlya shtor_meOr
13 Sep 25 at 2:25 am
прокарниз [url=http://elektrokarniz-cena.ru]http://elektrokarniz-cena.ru[/url] .
elektrokarniz cena_kwPL
13 Sep 25 at 2:26 am
электрокранизы [url=https://karnizy-s-elektroprivodom-cena.ru]https://karnizy-s-elektroprivodom-cena.ru[/url] .
karnizi s elektroprivodom cena_rrkr
13 Sep 25 at 2:28 am
электрокарниз двухрядный [url=avtomaticheskie-karnizy.ru]avtomaticheskie-karnizy.ru[/url] .
avtomaticheskie karnizi_fpSa
13 Sep 25 at 2:29 am
электрические карнизы купить [url=http://elektrokarniz-cena.ru]http://elektrokarniz-cena.ru[/url] .
elektrokarniz cena_daPL
13 Sep 25 at 2:29 am
карнизы для штор купить в москве [url=https://elektro-karniz77.ru/]elektro-karniz77.ru[/url] .
elektro karniz_kpSl
13 Sep 25 at 2:31 am
карнизы для штор купить в москве [url=https://www.avtomaticheskie-karnizy.ru]карнизы для штор купить в москве[/url] .
avtomaticheskie karnizi_snSa
13 Sep 25 at 2:34 am
займы онлайн без отказа с плохой займ онлайн
zaym onlayn 112
13 Sep 25 at 2:35 am
электрические карнизы купить [url=elektro-karniz77.ru]elektro-karniz77.ru[/url] .
elektro karniz_ngSl
13 Sep 25 at 2:37 am
2 трека где то по 30мг.
https://wirtube.de/a/swordofrage977/video-channels
Сам прикинь, меня пёрло почти
Harryunsag
13 Sep 25 at 2:37 am
What we’re covering
[url=https://megaweb2at.com]mgmarket6.at[/url]
• Israel is facing growing condemnation after it attacked Hamas leadership in the capital of Qatar, a US ally and key mediator in Gaza ceasefire talks — putting hostage negotiations at risk.
[url=https://marketdark.net]mgmarket7 at[/url]
• Hamas said the strike killed five members but failed to assassinate the negotiating delegation, the target of the strikes.
• US President Donald Trump has criticized the strike, saying that by the time his administration learned of the attack and told the Qataris, there was little he could do to stop it.
• The attack is the first publicly acknowledged strike on a Gulf state by Israel. Qatar’s prime minister was visibly angry and said his country’s tradition of diplomacy “won’t be deterred.”
https://megaweb333.com
mgmarket4 at
JasonBup
13 Sep 25 at 2:38 am
быстрый займ на карту онлайн оформить займ онлайн
onlayn zaym 45
13 Sep 25 at 2:39 am
https://martinnhns210.tearosediner.net/alimentos-que-pueden-alterar-un-examen-de-orina-y-qu-evitar
Superar un control sorpresa puede ser un momento critico. Por eso, existe una formula avanzada creada con altos estandares.
Su mezcla unica combina minerales, lo que estimula tu organismo y oculta temporalmente los rastros de alcaloides. El resultado: una muestra limpia, lista para pasar cualquier control.
Lo mas notable es su ventana de efectividad de 4 a 5 horas. A diferencia de detox irreales, no promete limpiezas magicas, sino una estrategia de emergencia que te respalda en situaciones criticas.
Miles de postulantes ya han validado su discrecion. Testimonios reales mencionan paquetes 100% confidenciales.
Si no deseas dejar nada al azar, esta alternativa te ofrece seguridad.
JuniorShido
13 Sep 25 at 2:40 am