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://www.stoimost-soglasovaniya-pereplanirovki-kvartiry.ru]http://www.stoimost-soglasovaniya-pereplanirovki-kvartiry.ru[/url] .
stoimost soglasovaniya pereplanirovki kvartiri_edPt
18 Oct 25 at 4:12 pm
melbet букмекерская контора официальный сайт [url=https://melbetbonusy.ru/]melbet букмекерская контора официальный сайт[/url] .
melbet_ieOi
18 Oct 25 at 4:13 pm
miglior prezzo Cialis originale: dove comprare Cialis in Italia – farmacia online italiana Cialis
RaymondNit
18 Oct 25 at 4:15 pm
Почувствуйте вкус победы с Драгон Мани!
Регистрируйтесь и получите стартовый бонус!
У нас только честные игры и мгновенные выплаты
драгон казино
Brianwer
18 Oct 25 at 4:15 pm
Nice blog here! Also your website lots up very fast!
What web host are you using? Can I am getting your associate link in your host?
I desire my web site loaded up as quickly as yours lol
1win приложение
18 Oct 25 at 4:15 pm
Капельница от запоя на дому в Нижнем Новгороде — удобное решение для тех, кто не может посетить клинику. Наши специалисты приедут к вам домой и проведут необходимую процедуру.
Исследовать вопрос подробнее – [url=https://vyvod-iz-zapoya-nizhnij-novgorod12.ru/]вывод из запоя на дому цена в нижний новгороде[/url]
Miltondiolo
18 Oct 25 at 4:16 pm
перепланировка [url=https://soglasovanie-pereplanirovki-kvartiry3.ru/]soglasovanie-pereplanirovki-kvartiry3.ru[/url] .
soglasovanie pereplanirovki kvartiri _sbPi
18 Oct 25 at 4:17 pm
https://t.me/s/Official_1xbet_1xbet/1714
Josephadvem
18 Oct 25 at 4:18 pm
https://t.me/Official_1xbet_1xbet/1774
Josephadvem
18 Oct 25 at 4:19 pm
контора мелбет [url=https://melbetbonusy.ru/]контора мелбет[/url] .
melbet_hfOi
18 Oct 25 at 4:20 pm
I believe everything published was actually very logical.
However, what about this? what if you wrote a catchier title?
I ain’t saying your information isn’t good, however suppose you added something
to possibly get people’s attention? I mean PHP hook, building hooks in your application – Sjoerd
Maessen blog at Sjoerd Maessen blog is kinda vanilla. You could look
at Yahoo’s home page and watch how they create post headlines to grab
people interested. You might add a related video or a related pic or two to grab people excited about everything’ve got to
say. In my opinion, it could bring your posts a little bit more interesting.
sell to buy
18 Oct 25 at 4:21 pm
где сделать проект перепланировки квартиры [url=http://proekt-pereplanirovki-kvartiry16.ru/]http://proekt-pereplanirovki-kvartiry16.ru/[/url] .
proekt pereplanirovki kvartiri_xqMl
18 Oct 25 at 4:21 pm
https://tadalafiloexpress.com/# farmacia barata
MickeySum
18 Oct 25 at 4:22 pm
I do not even understand how I finished up right here, but I believed this post was great.
I do not recognise who you might be but certainly you’re going to a well-known blogger if you happen to aren’t already.
Cheers!
BETFLIX68
18 Oct 25 at 4:22 pm
That is very interesting, You’re an excessively professional
blogger. I have joined your feed and stay up for in quest of extra of your fantastic
post. Additionally, I’ve shared your site in my social
networks
casino 88fc
18 Oct 25 at 4:23 pm
согласование перепланировок [url=www.soglasovanie-pereplanirovki-kvartiry11.ru/]www.soglasovanie-pereplanirovki-kvartiry11.ru/[/url] .
soglasovanie pereplanirovki kvartiri _esMi
18 Oct 25 at 4:25 pm
https://t.me/Official_1xbet_1xbet/1746
Josephadvem
18 Oct 25 at 4:25 pm
https://telegra.ph/Kupit-binokl-10-30-10-12-4
JesseHow
18 Oct 25 at 4:26 pm
стоимость перепланировки квартиры в бти [url=https://zakazat-proekt-pereplanirovki-kvartiry11.ru/]zakazat-proekt-pereplanirovki-kvartiry11.ru[/url] .
zakazat proekt pereplanirovki kvartiri_gyet
18 Oct 25 at 4:26 pm
cjukfcjdfybt [url=http://soglasovanie-pereplanirovki-kvartiry11.ru]http://soglasovanie-pereplanirovki-kvartiry11.ru[/url] .
soglasovanie pereplanirovki kvartiri _ktMi
18 Oct 25 at 4:28 pm
В Сочи клиника «Детокс» предлагает полный курс вывода из запоя в стационаре. Круглосуточный медицинский контроль гарантирует безопасность и эффективность лечения.
Выяснить больше – [url=https://vyvod-iz-zapoya-sochi24.ru/]вывод из запоя[/url]
Bryankax
18 Oct 25 at 4:28 pm
mostvet [url=http://mostbet4185.ru/]http://mostbet4185.ru/[/url]
mostbet_uz_wwer
18 Oct 25 at 4:28 pm
согласование проекта перепланировки квартиры [url=http://soglasovanie-pereplanirovki-kvartiry4.ru/]согласование проекта перепланировки квартиры[/url] .
soglasovanie pereplanirovki kvartiri _rvOr
18 Oct 25 at 4:28 pm
сколько стоит согласование перепланировки [url=http://www.zakazat-proekt-pereplanirovki-kvartiry11.ru]http://www.zakazat-proekt-pereplanirovki-kvartiry11.ru[/url] .
zakazat proekt pereplanirovki kvartiri_kmet
18 Oct 25 at 4:29 pm
mostbet humo orqali pul o‘tkazish [url=http://mostbet4182.ru/]http://mostbet4182.ru/[/url]
mostbet_uz_vlkt
18 Oct 25 at 4:30 pm
услуги по согласованию перепланировки квартиры [url=https://soglasovanie-pereplanirovki-kvartiry3.ru/]https://soglasovanie-pereplanirovki-kvartiry3.ru/[/url] .
soglasovanie pereplanirovki kvartiri _rrPi
18 Oct 25 at 4:31 pm
перепланировка комнаты [url=http://www.soglasovanie-pereplanirovki-kvartiry14.ru]http://www.soglasovanie-pereplanirovki-kvartiry14.ru[/url] .
soglasovanie pereplanirovki kvartiri _wpEl
18 Oct 25 at 4:31 pm
Terrific article! This is the kind of info that should be shared across the web.
Disgrace on the seek engines for no longer positioning this
submit upper! Come on over and consult with my website .
Thanks =)
홍대셔츠룸
18 Oct 25 at 4:31 pm
заказ перепланировки квартиры [url=http://www.soglasovanie-pereplanirovki-kvartiry14.ru]http://www.soglasovanie-pereplanirovki-kvartiry14.ru[/url] .
soglasovanie pereplanirovki kvartiri _xrEl
18 Oct 25 at 4:33 pm
В Краснодаре клиника «Детокс» высылает нарколога на дом для срочной помощи при запое. Быстро и безопасно.
Углубиться в тему – [url=https://narkolog-na-dom-krasnodar29.ru/]психиатр нарколог на дом в краснодаре[/url]
StevenPrabY
18 Oct 25 at 4:34 pm
melbet зеркало казино [url=http://melbetbonusy.ru/]melbet зеркало казино[/url] .
melbet_cdOi
18 Oct 25 at 4:36 pm
These are truly great ideas in concerning blogging.
You have touched some nice factors here. Any way keep up
wrinting.
77bet
18 Oct 25 at 4:36 pm
I have read several good stuff here. Certainly value bookmarking for revisiting.
I wonder how so much effort you put to make the sort of fantastic informative web site.
kontol
18 Oct 25 at 4:38 pm
стоимость перепланировки [url=https://stoimost-soglasovaniya-pereplanirovki-kvartiry.ru/]https://stoimost-soglasovaniya-pereplanirovki-kvartiry.ru/[/url] .
stoimost soglasovaniya pereplanirovki kvartiri_ltPt
18 Oct 25 at 4:39 pm
стоимость согласования перепланировки квартиры в москве [url=http://zakazat-proekt-pereplanirovki-kvartiry11.ru]http://zakazat-proekt-pereplanirovki-kvartiry11.ru[/url] .
zakazat proekt pereplanirovki kvartiri_cnet
18 Oct 25 at 4:39 pm
клиенты знают нас и нашу работу [url=http://www.soglasovanie-pereplanirovki-kvartiry4.ru]http://www.soglasovanie-pereplanirovki-kvartiry4.ru[/url] .
soglasovanie pereplanirovki kvartiri _sxOr
18 Oct 25 at 4:40 pm
сколько стоит проект перепланировки [url=http://proekt-pereplanirovki-kvartiry16.ru]http://proekt-pereplanirovki-kvartiry16.ru[/url] .
proekt pereplanirovki kvartiri_bhMl
18 Oct 25 at 4:41 pm
стоимость согласования перепланировки в бти [url=https://www.stoimost-soglasovaniya-pereplanirovki-kvartiry.ru]https://www.stoimost-soglasovaniya-pereplanirovki-kvartiry.ru[/url] .
stoimost soglasovaniya pereplanirovki kvartiri_ooPt
18 Oct 25 at 4:41 pm
где согласовать перепланировку квартиры [url=www.soglasovanie-pereplanirovki-kvartiry11.ru/]www.soglasovanie-pereplanirovki-kvartiry11.ru/[/url] .
soglasovanie pereplanirovki kvartiri _qpMi
18 Oct 25 at 4:42 pm
мелбет букмекерская контора [url=https://melbetbonusy.ru]мелбет букмекерская контора[/url] .
melbet_ebOi
18 Oct 25 at 4:43 pm
перепланировка квартиры стоимость [url=http://www.proekt-pereplanirovki-kvartiry16.ru]http://www.proekt-pereplanirovki-kvartiry16.ru[/url] .
proekt pereplanirovki kvartiri_eqMl
18 Oct 25 at 4:44 pm
Нарколог прибывает в назначенное время, проводит замеры артериального давления, пульса, сатурации кислорода и температуры. Выполняется экспресс-анализ на содержание алкоголя в крови и оценка водно-электролитного баланса.
Получить дополнительные сведения – [url=https://narkologicheskaya-klinika-rostov13.ru/]запой наркологическая клиника[/url]
JosephNoirl
18 Oct 25 at 4:45 pm
Minotaurus ICO’s whitepaper highlights balanced token release. $MTAUR holders shape via DAO—democratic and cool. Casual market entry is spot on.
mtaur token
WilliamPargy
18 Oct 25 at 4:46 pm
video experience
MichaelSig
18 Oct 25 at 4:46 pm
согласование перепланировки помещений [url=www.soglasovanie-pereplanirovki-kvartiry3.ru]www.soglasovanie-pereplanirovki-kvartiry3.ru[/url] .
soglasovanie pereplanirovki kvartiri _irPi
18 Oct 25 at 4:46 pm
согласование перепланировок [url=www.soglasovanie-pereplanirovki-kvartiry14.ru]www.soglasovanie-pereplanirovki-kvartiry14.ru[/url] .
soglasovanie pereplanirovki kvartiri _pbEl
18 Oct 25 at 4:48 pm
узаконить перепланировку в москве цена [url=https://www.zakazat-proekt-pereplanirovki-kvartiry11.ru]https://www.zakazat-proekt-pereplanirovki-kvartiry11.ru[/url] .
zakazat proekt pereplanirovki kvartiri_eket
18 Oct 25 at 4:49 pm
https://t.me/Official_1xbet_1xbet/1757
Josephadvem
18 Oct 25 at 4:49 pm
Клиника «Детокс» в Сочи предлагает услугу вывода из запоя в стационаре. Под наблюдением профессиональных врачей пациент получит необходимую медицинскую помощь и поддержку. Услуга доступна круглосуточно, анонимно и начинается от 2000 ?.
Ознакомиться с деталями – [url=https://vyvod-iz-zapoya-sochi23.ru/]вывод из запоя на дому недорого в сочи[/url]
Gordontrive
18 Oct 25 at 4:49 pm
перепланировка услуги [url=https://soglasovanie-pereplanirovki-kvartiry4.ru/]soglasovanie-pereplanirovki-kvartiry4.ru[/url] .
soglasovanie pereplanirovki kvartiri _xqOr
18 Oct 25 at 4:53 pm