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!
best free online casino new zealand, online lester cut diamond casino heist pokies
australia and online casinos on united states, or casino uk free spins
lester cut diamond casino heist
3 Oct 25 at 4:05 pm
купить диплом во владикавказе [url=www.rudik-diplom5.ru/]www.rudik-diplom5.ru/[/url] .
Diplomi_tima
3 Oct 25 at 4:07 pm
купить диплом в хабаровске [url=http://rudik-diplom1.ru/]http://rudik-diplom1.ru/[/url] .
Diplomi_sger
3 Oct 25 at 4:07 pm
Excellent beat ! I would like to apprentice whilst you amend your website, how can i subscribe for a
weblog website? The account helped me a acceptable deal.
I had been tiny bit acquainted of this your broadcast offered bright transparent idea
VurinestaAi Erfahrungen
3 Oct 25 at 4:08 pm
وی ایزوله زومد لبز، یک مکمل با کیفیت بالا است
که از آبپنیر ایزوله با خلوص ۹۰–۹۵٪
تهیه شده و تقریبا فاقد چربی
و لاکتوز است.
وی ایزوله زومد لبز
3 Oct 25 at 4:09 pm
https://bargrill-myaso.ru
KevinEdica
3 Oct 25 at 4:10 pm
We’re a group of volunteers and opening a new scheme
in our community. Your site offered us with useful info
to work on. You’ve performed a formidable process and our entire community can be thankful to you.
청주출장마사지
3 Oct 25 at 4:11 pm
купить диплом в магнитогорске [url=rudik-diplom15.ru]rudik-diplom15.ru[/url] .
Diplomi_aePi
3 Oct 25 at 4:11 pm
купить сертификат специалиста [url=http://www.rudik-diplom14.ru]купить сертификат специалиста[/url] .
Diplomi_zrea
3 Oct 25 at 4:12 pm
купить диплом ссср [url=www.rudik-diplom5.ru/]купить диплом ссср[/url] .
Diplomi_vzma
3 Oct 25 at 4:14 pm
купить диплом стоматолога [url=https://rudik-diplom1.ru/]купить диплом стоматолога[/url] .
Diplomi_yqer
3 Oct 25 at 4:15 pm
где можно купить диплом медсестры [url=frei-diplom15.ru]где можно купить диплом медсестры[/url] .
Diplomi_lyoi
3 Oct 25 at 4:16 pm
https://rotorbuilds.com/profile/167986/
JamesDum
3 Oct 25 at 4:17 pm
купить диплом моряка [url=www.rudik-diplom7.ru/]купить диплом моряка[/url] .
Diplomi_znPl
3 Oct 25 at 4:17 pm
купить диплом в стерлитамаке [url=https://www.rudik-diplom2.ru]купить диплом в стерлитамаке[/url] .
Diplomi_hcpi
3 Oct 25 at 4:20 pm
Joined $MTAUR coin rush—bonuses galore. ICO’s whitepaper thorough. Endless fun ahead.
minotaurus coin
WilliamPargy
3 Oct 25 at 4:20 pm
купить диплом в северодвинске [url=www.rudik-diplom3.ru/]купить диплом в северодвинске[/url] .
Diplomi_pbei
3 Oct 25 at 4:20 pm
купить диплом о техническом образовании с занесением в реестр [url=frei-diplom3.ru]frei-diplom3.ru[/url] .
Diplomi_syKt
3 Oct 25 at 4:20 pm
купить диплом в балаково [url=https://rudik-diplom1.ru]купить диплом в балаково[/url] .
Diplomi_ijer
3 Oct 25 at 4:21 pm
диплом купить с занесением в реестр отзывы [url=http://frei-diplom5.ru]http://frei-diplom5.ru[/url] .
Diplomi_flPa
3 Oct 25 at 4:21 pm
купить диплом химика [url=http://rudik-diplom4.ru/]купить диплом химика[/url] .
Diplomi_oqOr
3 Oct 25 at 4:22 pm
eljiretdulces – The site feels lively and welcoming, I enjoyed scrolling today.
Lou Hougen
3 Oct 25 at 4:24 pm
We’re a gaggle of volunteers and starting a brand new scheme in our community.
Your website provided us with valuable information to work on. You’ve performed a formidable activity
and our whole group might be thankful to you.
https://xx88.com.ph/
3 Oct 25 at 4:24 pm
Just want to say your article is as amazing.
The clarity in your post is simply nice and i
could assume you’re an expert on this subject.
Fine with your permission let me to grab your RSS feed to keep up to date with forthcoming
post. Thanks a million and please carry on the enjoyable
work.
kitchen remodeling companies
3 Oct 25 at 4:24 pm
Мы используем новейшие образцы медицинской техники, что повышает безопасность процедур и скорость детоксикации.
Ознакомиться с деталями – [url=https://narkologicheskaya-pomoshh-ufa9.ru/]неотложная наркологическая помощь[/url]
LionelBok
3 Oct 25 at 4:25 pm
Hello There. I found your blog using msn. This is a
very well written article. I’ll be sure to bookmark it and come back to read more of your useful information. Thanks for the post.
I will definitely return.
Lucent Markbit Scam
3 Oct 25 at 4:27 pm
купить диплом в костроме [url=https://www.rudik-diplom14.ru]https://www.rudik-diplom14.ru[/url] .
Diplomi_cwea
3 Oct 25 at 4:27 pm
Can I simply say what a relief to discover somebody that actually
knows what they are talking about online. You actually realize how
to bring an issue to light and make it important.
More people should read this and understand this side of your story.
It’s surprising you’re not more popular given that you certainly possess the gift.
Profitgrove TEST
3 Oct 25 at 4:27 pm
https://md.openbikesensor.org/s/MY_t4DFJQ
Anthonyunona
3 Oct 25 at 4:28 pm
newbalance550 – A solid site for sneaker fans, reliable and easy to use.
Lorita Muenkel
3 Oct 25 at 4:28 pm
купить диплом в черкесске [url=https://www.rudik-diplom4.ru]купить диплом в черкесске[/url] .
Diplomi_ncOr
3 Oct 25 at 4:30 pm
купить диплом университета с занесением в реестр [url=http://frei-diplom6.ru/]купить диплом университета с занесением в реестр[/url] .
Diplomi_cwOl
3 Oct 25 at 4:30 pm
где купить диплом с реестром [url=https://www.frei-diplom3.ru]где купить диплом с реестром[/url] .
Diplomi_quKt
3 Oct 25 at 4:31 pm
Superb blog! Do you have any helpful hints for aspiring writers?
I’m planning to start my own website soon but I’m a little lost on everything.
Would you suggest starting with a free platform like WordPress or go for a
paid option? There are so many choices out there that
I’m completely confused .. Any suggestions? Many thanks!
How YouTube highlights comments
3 Oct 25 at 4:32 pm
купить диплом сантехника [url=www.rudik-diplom14.ru]купить диплом сантехника[/url] .
Diplomi_lpea
3 Oct 25 at 4:33 pm
We stumbled over here from a different web page and thought I may as well check things out.
I like what I see so now i am following you. Look forward to looking
over your web page again.
harga toto
3 Oct 25 at 4:34 pm
At this moment I am ready to do my breakfast, once having my breakfast coming yet again to read
more news.
CTR در سئو چیست
3 Oct 25 at 4:34 pm
Когда запой становится угрозой для жизни и здоровья, своевременная помощь профессионала может стать решающим фактором для скорейшего восстановления. В Мурманске, где суровые климатические условия добавляют стресса и осложнений, квалифицированные наркологи оказывают помощь на дому, обеспечивая оперативную детоксикацию и индивидуальную терапию в привычной обстановке. Такой подход позволяет пациентам избежать лишних перемещений и получить поддержку в комфортной атмосфере.
Подробнее можно узнать тут – [url=https://vyvod-iz-zapoya-murmansk0.ru/]вывод из запоя на дому[/url]
TrentImarf
3 Oct 25 at 4:35 pm
купить диплом в прокопьевске [url=rudik-diplom15.ru]купить диплом в прокопьевске[/url] .
Diplomi_npPi
3 Oct 25 at 4:35 pm
https://fdcexpress.ru
KevinEdica
3 Oct 25 at 4:36 pm
Процедура выезда врача на дом в Краснодаре строго регламентирована и включает несколько последовательных этапов. После поступления звонка и уточнения подробностей состояния пациента врач выезжает на место в течение 30–60 минут. На месте проводится первичный осмотр с оценкой жизненно важных показателей: артериального давления, уровня кислорода в крови, сердечного ритма и степени общей интоксикации.
Разобраться лучше – [url=https://narcolog-na-dom-krasnodar00.ru/]narkolog-na-dom-czena krasnodar[/url]
RalphPiday
3 Oct 25 at 4:37 pm
Длительный запой способен нанести непоправимый вред организму, привести к тяжелым нарушениям работы внутренних органов и поставить под угрозу жизнь пациента. В таких случаях необходимо срочное медицинское вмешательство, которое позволяет быстро стабилизировать состояние, вывести токсины и предотвратить развитие опасных осложнений. Клиника «ЗдоровьеНорм» в Краснодаре предлагает профессиональный вывод из запоя на дому, обеспечивая комплексное лечение с максимальной оперативностью и полной конфиденциальностью.
Изучить вопрос глубже – https://vyvod-iz-zapoya-krasnodar00.ru/vyvod-iz-zapoya-na-domu-krasnodar/
HenryMut
3 Oct 25 at 4:38 pm
купить диплом в грозном [url=http://rudik-diplom2.ru]купить диплом в грозном[/url] .
Diplomi_sqpi
3 Oct 25 at 4:38 pm
купить диплом в саратове [url=www.rudik-diplom3.ru]купить диплом в саратове[/url] .
Diplomi_lcei
3 Oct 25 at 4:40 pm
купить диплом в саратове [url=https://rudik-diplom8.ru]купить диплом в саратове[/url] .
Diplomi_xxMt
3 Oct 25 at 4:44 pm
купить диплом в томске [url=http://rudik-diplom11.ru/]http://rudik-diplom11.ru/[/url] .
Diplomi_xnMi
3 Oct 25 at 4:44 pm
купить диплом о среднем специальном образовании с занесением в реестр [url=http://www.frei-diplom4.ru]купить диплом о среднем специальном образовании с занесением в реестр[/url] .
Diplomi_quOl
3 Oct 25 at 4:45 pm
click through the up coming page
PHP hook, building hooks in your application – Sjoerd Maessen blog at Sjoerd Maessen blog
click through the up coming page
3 Oct 25 at 4:45 pm
What’s up, just wanted to tell you, I loved this post.
It was helpful. Keep on posting!
medical clinic Vaughan
3 Oct 25 at 4:46 pm
купить диплом средне техническое [url=www.rudik-diplom2.ru]купить диплом средне техническое[/url] .
Diplomi_fvpi
3 Oct 25 at 4:47 pm