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!
Sou totalmente viciado em PlayPIX Casino, oferece um prazer intenso e indomavel. A variedade de titulos e estonteante, com slots de design inovador. Fortalece seu saldo inicial. O servico esta disponivel 24/7, com suporte rapido e preciso. Os pagamentos sao seguros e fluidos, embora recompensas extras seriam eletrizantes. Em sintese, PlayPIX Casino e uma plataforma que brilha para amantes de emocoes fortes ! Acrescentando que a interface e fluida e estilosa, instiga a prolongar a experiencia. Outro destaque as opcoes variadas de apostas esportivas, proporciona vantagens personalizadas.
Ir ver|
JungleVibeK8zef
21 Oct 25 at 3:08 pm
Just grabbed some $MTAUR coins during the presale—feels like getting in on the ground floor of something huge. The audited smart contracts give me peace of mind, unlike sketchier projects. Can’t wait for the game beta to test those power-ups.
minotaurus coin
WilliamPargy
21 Oct 25 at 3:09 pm
hey there and thank you for your information – I have definitely picked up something new from right here.
I did however expertise some technical points using this site, since I experienced
to reload the site a lot of times previous to I could get it to
load properly. I had been wondering if your hosting is OK?
Not that I am complaining, but slow loading instances
times will very frequently affect your placement in google and could damage your high quality score if ads and marketing with Adwords.
Anyway I am adding this RSS to my email and could look out for a lot more of your
respective intriguing content. Make sure you update this
again very soon.
excavation haul-out dirt service
21 Oct 25 at 3:11 pm
$MTAUR coin’s low entry price at 0.0001 USDT is a steal compared to its listing target. The maze-running gameplay with crypto creatures has me hooked already. Presale perks like vesting extensions are cherry on top.
mtaur token
WilliamPargy
21 Oct 25 at 3:11 pm
Компания «СибЗТА» https://sibzta.su производит задвижки, клапаны и другую трубопроводную арматуру с 2014 года. Материалы: сталь, чугун, нержавейка. Прочные уплотнения, стандарты ГОСТ, индивидуальные решения под заказ, быстрая доставка и гарантия.
sibzta
21 Oct 25 at 3:12 pm
Где купить Экстази в Спасск-Дальнии?Обратите внимание – https://ProHedge.ru
. Цены приличные, доставку обещают. Кто-нибудь пробовал у них? Как у них с надежностью?
Stevenref
21 Oct 25 at 3:12 pm
Interesting blog! Is your theme custom made or did you download
it from somewhere? A theme like yours with a few simple adjustements would really make my blog stand out.
Please let me know where you got your design. With thanks
bbq4d
21 Oct 25 at 3:13 pm
comprar Cialis online España: farmacias online seguras en españa – comprar Cialis online España
JosephPseus
21 Oct 25 at 3:13 pm
продвижение сайтов рф [url=http://reiting-seo-agentstv.ru]продвижение сайтов рф[/url] .
reiting seo agentstv_kisa
21 Oct 25 at 3:14 pm
نکته مهم حساس راجع به پلتفرمهای بازیهای شرطی آنلاین.
خودم با عنوان فردی که اتفاق مستقیم دارد، میگویم که چنین سایتها وسیله برای غارت سرمایه افراد
هستند. شرط شروع برنده است، لیکن سپس برنامهها
به گونهای تنظیم میگردند که بازیکن همیشه شکستخورده گردید.
تهدید وابستگی قویتر از تمام امر دیگری
است و تواند آیندهتان را نابود کند.
دور بمانید!
کلاهبردار شرط بندی فوتبال
21 Oct 25 at 3:15 pm
Компания «СибЗТА» https://sibzta.su производит задвижки, клапаны и другую трубопроводную арматуру с 2014 года. Материалы: сталь, чугун, нержавейка. Прочные уплотнения, стандарты ГОСТ, индивидуальные решения под заказ, быстрая доставка и гарантия.
sibzta
21 Oct 25 at 3:15 pm
рейтинг digital компаний [url=www.luchshie-digital-agencstva.ru]www.luchshie-digital-agencstva.ru[/url] .
lychshie digital agentstva_iooi
21 Oct 25 at 3:15 pm
For newest information you have to pay a quick visit web and on web I found this site as a most excellent web site for newest updates.
staffinggoals.com
EarnestAbent
21 Oct 25 at 3:17 pm
https://sugarrushx.com/
DarylCeviZ
21 Oct 25 at 3:17 pm
pin up uz [url=http://pinup5008.ru]pin up uz[/url]
pin_up_uz_oqSt
21 Oct 25 at 3:19 pm
Sweet Bonanza
Danielignit
21 Oct 25 at 3:19 pm
Its like you read my mind! You seem to understand a lot about this, like you wrote the ebook in it or something.
I think that you could do with a few % to drive the message house a bit, but
instead of that, that is fantastic blog. An excellent read.
I’ll certainly be back.
relationship wellness tips
21 Oct 25 at 3:20 pm
топ компаний по продвижению сайтов [url=https://reiting-seo-kompanii.ru/]топ компаний по продвижению сайтов[/url] .
reiting seo kompanii_fzsn
21 Oct 25 at 3:20 pm
Wolf Gold
DarylCeviZ
21 Oct 25 at 3:21 pm
компании по продвижению сайта [url=http://seo-prodvizhenie-reiting.ru/]компании по продвижению сайта[/url] .
seo prodvijenie reiting_eiEa
21 Oct 25 at 3:21 pm
сео продвижение заказать москва [url=www.reiting-seo-agentstv-moskvy.ru/]www.reiting-seo-agentstv-moskvy.ru/[/url] .
reiting seo agentstv moskvi_xnMl
21 Oct 25 at 3:21 pm
https://chilli-heat.com/
DarylCeviZ
21 Oct 25 at 3:22 pm
Компания «СибЗТА» https://sibzta.su производит задвижки, клапаны и другую трубопроводную арматуру с 2014 года. Материалы: сталь, чугун, нержавейка. Прочные уплотнения, стандарты ГОСТ, индивидуальные решения под заказ, быстрая доставка и гарантия.
sibzta
21 Oct 25 at 3:24 pm
агентство seo [url=http://seo-prodvizhenie-reiting.ru]агентство seo[/url] .
seo prodvijenie reiting_pdEa
21 Oct 25 at 3:24 pm
Wow, this paragraph is pleasant, my sister is analyzing these kinds of things, so I am going to
convey her.
dewa scatter
21 Oct 25 at 3:24 pm
топ агентств россии [url=http://www.luchshie-digital-agencstva.ru]http://www.luchshie-digital-agencstva.ru[/url] .
lychshie digital agentstva_ecoi
21 Oct 25 at 3:27 pm
I’ve learn some good stuff here. Definitely worth bookmarking for revisiting.
I surprise how so much effort you place to create this type of excellent informative web site.
Meteor Profit Ervaringen
21 Oct 25 at 3:27 pm
tadalafilo 5 mg precio [url=https://tadalafiloexpress.com/#]Tadalafilo Express[/url] farmacia online fiable en España
GeorgeHot
21 Oct 25 at 3:29 pm
сео студия [url=reiting-seo-agentstv-moskvy.ru]reiting-seo-agentstv-moskvy.ru[/url] .
reiting seo agentstv moskvi_efMl
21 Oct 25 at 3:31 pm
An interesting discussion is worth comment. There’s no doubt that that you
need to publish more on this topic, it may not be
a taboo subject but typically people do not talk about these
topics. To the next! Cheers!!
live online casino
21 Oct 25 at 3:31 pm
My partner and I stumbled over here by a different page and thought I might as well check things out.
I like what I see so i am just following you. Look forward to finding out about your web page for a second time.
web site
21 Oct 25 at 3:32 pm
купить диплом [url=www.rudik-diplom2.ru/]купить диплом[/url] .
Diplomi_hjpi
21 Oct 25 at 3:33 pm
https://sites.lafayette.edu/alleyj/2014/04/04/pechakucha/#comment-403073
Matthewlex
21 Oct 25 at 3:33 pm
seo рейтинг [url=http://seo-prodvizhenie-reiting.ru/]http://seo-prodvizhenie-reiting.ru/[/url] .
seo prodvijenie reiting_kxEa
21 Oct 25 at 3:34 pm
Wow, marvelous blog layout! How long have you been blogging for?
you make blogging look easy. The overall look of your site is fantastic, let alone the
content!
закладки
21 Oct 25 at 3:34 pm
Промокод 1xBet — пропишите его в графу «Промокод» при регистрации, пополните свой аккаунт на сумму от 100 RUB и получите вознаграждением в размере 100% (до 32 500 RUB).В личном кабинете перейдите в раздел «Бонусы» и перейдите к вариант «Ввести код».Укажите полученный бонусный код в специальное окно. Нажмите подтвердить и ознакомьтесь с условиями использования.Рабочий код 1xBet 2026 можно узнать по ссылке — http://www.medtronik.ru/images/pages/1hbet_2021_promokod_pri_registracii.html.
Jasonbrado
21 Oct 25 at 3:36 pm
ПРодавец,есть из скорости что нибудь качественное?
https://dokuchaevskpj.ru
РЕСПЕКТОС МАгаЗИНУ=)
ErwinAroug
21 Oct 25 at 3:37 pm
seo group [url=www.seo-prodvizhenie-reiting.ru/]www.seo-prodvizhenie-reiting.ru/[/url] .
seo prodvijenie reiting_oiEa
21 Oct 25 at 3:40 pm
I don’t know if it’s just me or if everybody else encountering problems with your website.
It looks like some of the text on your posts are
running off the screen. Can someone else please comment and
let me know if this is happening to them as well?
This might be a problem with my browser because
I’ve had this happen before. Thanks
dewascatter link alternatif
21 Oct 25 at 3:42 pm
pin up virtual sport tikish [url=https://pinup5007.ru/]pin up virtual sport tikish[/url]
pin_up_uz_egsr
21 Oct 25 at 3:43 pm
где купить диплом техникума старого [url=https://www.frei-diplom10.ru]где купить диплом техникума старого[/url] .
Diplomi_esEa
21 Oct 25 at 3:44 pm
рейтинг интернет агентств seo [url=https://reiting-seo-kompanii.ru/]https://reiting-seo-kompanii.ru/[/url] .
reiting seo kompanii_ppsn
21 Oct 25 at 3:45 pm
рейтинг компаний seo оптимизации [url=https://reiting-seo-kompanii.ru/]https://reiting-seo-kompanii.ru/[/url] .
reiting seo kompanii_jasn
21 Oct 25 at 3:47 pm
pin up karta orqali depozit [url=https://www.pinup5008.ru]https://www.pinup5008.ru[/url]
pin_up_uz_qqSt
21 Oct 25 at 3:48 pm
creativityneverends – The layout is clean and the tone is welcoming; makes me want to create right now.
Woodrow Giacomini
21 Oct 25 at 3:48 pm
digital маркетинг агентства [url=http://luchshie-digital-agencstva.ru]http://luchshie-digital-agencstva.ru[/url] .
lychshie digital agentstva_dsoi
21 Oct 25 at 3:49 pm
Just swapped USDC for $MTAUR. Vesting worth extending. Project’s potential vast.
mtaur coin
WilliamPargy
21 Oct 25 at 3:50 pm
Great delivery.Sound arguments. Keep up the amazing spirit.
boyarka
21 Oct 25 at 3:52 pm
лечение запоя краснодар
narkolog-krasnodar020.ru
вывод из запоя круглосуточно
zapojkrasnodarNeT
21 Oct 25 at 3:52 pm
https://baidak.ru/
Eugenioves
21 Oct 25 at 3:53 pm