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://medicinskaya-tehnika.ru/]медицинская техника[/url] .
medicinskaya tehnika_vxEi
27 Oct 25 at 3:53 am
зашиваться от алкоголя [url=narkologicheskaya-klinika-24.ru]narkologicheskaya-klinika-24.ru[/url] .
narkologicheskaya klinika_upSr
27 Oct 25 at 3:54 am
Heya i’m for the first time here. I came across this board and I find
It truly helpful & it helped me out a lot. I’m hoping to offer
one thing back and help others such as you aided me.
legzo казино промокод
27 Oct 25 at 3:55 am
kraken РФ
кракен Россия
JamesDaync
27 Oct 25 at 3:55 am
купить диплом с внесением в реестр [url=https://www.frei-diplom5.ru]купить диплом с внесением в реестр[/url] .
Diplomi_fjPa
27 Oct 25 at 3:55 am
купить диплом в рыбинске [url=https://rudik-diplom15.ru]https://rudik-diplom15.ru[/url] .
Diplomi_okPi
27 Oct 25 at 3:55 am
купить диплом о высшем образовании с занесением в реестр цены [url=www.frei-diplom2.ru/]купить диплом о высшем образовании с занесением в реестр цены[/url] .
Diplomi_wgEa
27 Oct 25 at 3:56 am
кракен vk3
kraken vk5
Henryamerb
27 Oct 25 at 3:57 am
Эта публикация погружает вас в мир увлекательных фактов и удивительных открытий. Мы расскажем о ключевых событиях, которые изменили ход истории, и приоткроем завесу над научными достижениями, которые вдохновили миллионы. Узнайте, чему может научить нас прошлое и как применить эти знания в будущем.
Получить больше информации – https://vivod-iz-zapoya-1.ru/
Davidagera
27 Oct 25 at 3:57 am
диплом техникума купить в [url=http://educ-ua7.ru/]http://educ-ua7.ru/[/url] .
Diplomi_meea
27 Oct 25 at 3:57 am
купить диплом техникума ссср в тюмени [url=http://frei-diplom10.ru]купить диплом техникума ссср в тюмени[/url] .
Diplomi_naEa
27 Oct 25 at 3:58 am
Thank you for the good writeup. It in fact was a amusement account it.
Look advanced to far added agreeable from you!
By the way, how can we communicate?
homepage
27 Oct 25 at 3:59 am
купить диплом в кызыле [url=https://rudik-diplom10.ru]купить диплом в кызыле[/url] .
Diplomi_dqSa
27 Oct 25 at 3:59 am
Fantastic items from you, man. I’ve remember your stuff prior to and you are simply extremely
excellent. I actually like what you have received right here, really like what you are saying and the best way during which you assert it.
You make it entertaining and you still take care of to keep it sensible.
I can’t wait to read much more from you.
That is really a tremendous site.
omutogel
27 Oct 25 at 4:00 am
купить диплом с занесением реестра [url=http://www.frei-diplom4.ru]купить диплом с занесением реестра[/url] .
Diplomi_ehOl
27 Oct 25 at 4:00 am
частные наркологические клиники в москве [url=www.narkologicheskaya-klinika-24.ru]www.narkologicheskaya-klinika-24.ru[/url] .
narkologicheskaya klinika_veSr
27 Oct 25 at 4:01 am
kraken ссылка Kraken ссылка – это ключ к заветной двери, ведущей в глубины цифрового пространства, где правят свои законы. Убедитесь в подлинности источника, прежде чем доверить ему свои данные, ведь мошенники не дремлют. Остерегайтесь фишинговых сайтов и поддельных зеркал, чтобы ваше путешествие не обернулось разочарованием. Будьте бдительны и осмотрительны, и тогда сможете избежать неприятностей и насладиться всеми преимуществами платформы.
Kevinmoots
27 Oct 25 at 4:01 am
J’adore l’harmonie de Olympe Casino, c’est une plateforme qui resonne comme une lyre. Le catalogue est riche en melodies, comprenant des jeux optimises pour les cryptos. Renforcant votre tresor initial. Le support client est olympien, offrant des reponses claires. Les paiements sont securises et fluides, de temps a autre des offres plus genereuses seraient olympiennes. Pour conclure, Olympe Casino merite une ascension celeste pour ceux qui aiment parier en crypto ! Par ailleurs la plateforme est visuellement olympienne, donne envie de prolonger l’aventure. Egalement remarquable les paiements securises en crypto, offre des recompenses eternelles.
https://olympefr.com/|
LinerGrag4zef
27 Oct 25 at 4:01 am
купить диплом в рыбинске [url=www.rudik-diplom4.ru]www.rudik-diplom4.ru[/url] .
Diplomi_fgOr
27 Oct 25 at 4:01 am
Вызвать обработка квартиры от клопов дешево, где?
дератизация
KennethceM
27 Oct 25 at 4:02 am
Заказать диплом любого ВУЗа поспособствуем. Купить диплом специалиста в Липецке – [url=http://diplomybox.com/kupit-diplom-spetsialista-v-lipetske/]diplomybox.com/kupit-diplom-spetsialista-v-lipetske[/url]
Cazrbfl
27 Oct 25 at 4:03 am
Вызвать обработка квартиры от клопов дешево, где?
дезинфекция школы
KennethceM
27 Oct 25 at 4:03 am
купить диплом в кстово [url=https://rudik-diplom2.ru]https://rudik-diplom2.ru[/url] .
Diplomi_rkpi
27 Oct 25 at 4:03 am
Wow! This blog looks exactly like my old one! It’s on a totally different subject
but it has pretty much the same page layout and design. Excellent choice of colors!
ankara kürtaj
27 Oct 25 at 4:03 am
Вｙ linking math tо innovative tasks, OMT stirs սp a passion in trainees, motivating tһem tο accept tһe subject
and pursue examination proficiency.
Օpen уour kid’s complete capacity in mathematics ԝith OMT Math Tuition’ѕ expert-led classes, tailored tо Singapore’s
MOE syllabus fοr primary, secondary, ɑnd JC students.
Thе holistic Singapore Math approach, ᴡhich builds multilayered analytical capabilities, underscores ԝhy math tuition iss vital fⲟr mastering the curriculum
аnd prepqring for future careers.
Ꮃith PSLE mathematics contributing considerably
tо total ratings, tuition supplies extra resources
ⅼike design answers for pattern recognition аnd algebraic thinking.
Comprehensive insurance coverage ߋf tһe еntire O Level curriculum
in tuition ensurеs no topics, from collections to vectors, ɑгe
forgotten іn a pupil’s alteration.
Tuition incorporates pure ɑnd սsed mathematics seamlessly, preparing students fοr the interdisciplinary nature ᧐f А Level troubles.
OMT sets itseⅼf apɑrt with а proprietary curriculum that extends MOE material Ƅy
consisting of enrichment activities intended аt establishing mathematical intuition.
Team forums іn the platform ⅼet you review with peers
ѕia, clarifying doubts аnd improving ʏ᧐ur math performance.
Singapore’ѕ concentrate on holistic education and learning іs complemented
Ьy math tuition tһat builds logical reasoning for lifelong examination advantages.
Ꮋere іs my web paɡe :: singapore primary 6 math tuition
singapore primary 6 math tuition
27 Oct 25 at 4:04 am
кракен
kraken официальный
Henryamerb
27 Oct 25 at 4:05 am
купить диплом в самаре [url=rudik-diplom5.ru]купить диплом в самаре[/url] .
Diplomi_cpma
27 Oct 25 at 4:05 am
kraken официальный
кракен vk6
Henryamerb
27 Oct 25 at 4:05 am
медицинское оборудование [url=http://www.medicinskoe–oborudovanie.ru]медицинское оборудование[/url] .
medicinskoe oborydovanie_wbei
27 Oct 25 at 4:05 am
купить диплом программиста [url=http://www.rudik-diplom15.ru]купить диплом программиста[/url] .
Diplomi_nqPi
27 Oct 25 at 4:06 am
купить диплом колледжа в москве [url=www.frei-diplom10.ru/]www.frei-diplom10.ru/[/url] .
Diplomi_qnEa
27 Oct 25 at 4:06 am
диплом о высшем образовании купить с занесением в реестр [url=https://frei-diplom4.ru/]диплом о высшем образовании купить с занесением в реестр[/url] .
Diplomi_zxOl
27 Oct 25 at 4:07 am
купить проведенный диплом отзывы [url=frei-diplom5.ru]frei-diplom5.ru[/url] .
Diplomi_jbPa
27 Oct 25 at 4:08 am
https://confiafarmacia.com/# ConfiaFarmacia
Hermanereli
27 Oct 25 at 4:09 am
trendandstyle – Love how they update collections so often, keeps shopping exciting each visit.
Hank Valdez
27 Oct 25 at 4:09 am
старые дипломы купить [url=http://rudik-diplom10.ru/]старые дипломы купить[/url] .
Diplomi_uaSa
27 Oct 25 at 4:09 am
kraken marketplace
kraken market
Henryamerb
27 Oct 25 at 4:10 am
купить диплом о высшем образовании с занесением в реестр в ижевске [url=http://www.frei-diplom2.ru]купить диплом о высшем образовании с занесением в реестр в ижевске[/url] .
Diplomi_xvEa
27 Oct 25 at 4:11 am
Где вызвать обработка от педикулеза круглосуточно? Время позднее. https://dezchel.ru
KennethceM
27 Oct 25 at 4:13 am
купить диплом для иностранцев [url=rudik-diplom11.ru]купить диплом для иностранцев[/url] .
Diplomi_rfMi
27 Oct 25 at 4:13 am
купить диплом об окончании колледжа украина [url=www.frei-diplom8.ru/]www.frei-diplom8.ru/[/url] .
Diplomi_pfsr
27 Oct 25 at 4:14 am
купить диплом в буденновске [url=http://rudik-diplom5.ru/]http://rudik-diplom5.ru/[/url] .
Diplomi_mlma
27 Oct 25 at 4:15 am
как купить легальный диплом [url=https://frei-diplom4.ru/]https://frei-diplom4.ru/[/url] .
Diplomi_hcOl
27 Oct 25 at 4:15 am
It’s an awesome post for all the web viewers;
they will get advantage from it I am sure.
ankara kürtaj
27 Oct 25 at 4:15 am
Hi, i feel that i saw you visited my website so i came to go back the want?.I’m trying to find issues to enhance my web site!I guess its adequate to make use of some of your concepts!!
Also visit my page :: zinnat02
zinnat02
27 Oct 25 at 4:15 am
медицинская техника [url=http://medicinskaya-tehnika.ru]медицинская техника[/url] .
medicinskaya tehnika_rmEi
27 Oct 25 at 4:15 am
http://mannensapotek.com/# Sildenafil-tabletter pris
JamesSlilk
27 Oct 25 at 4:16 am
кракен онлайн
kraken vk5
Henryamerb
27 Oct 25 at 4:16 am
купить диплом в иваново [url=https://www.rudik-diplom2.ru]купить диплом в иваново[/url] .
Diplomi_wdpi
27 Oct 25 at 4:17 am
где можно купить диплом техникума в махачкале [url=frei-diplom7.ru]где можно купить диплом техникума в махачкале[/url] .
Diplomi_bqei
27 Oct 25 at 4:17 am