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!
votethurm – Interesting content, I hope the design gets updated soon.
Kit Sacavage
15 Oct 25 at 11:09 pm
потолки натяжные в нижнем новгороде [url=www.stretch-ceilings-nizhniy-novgorod-1.ru]www.stretch-ceilings-nizhniy-novgorod-1.ru[/url] .
natyajnie potolki nijnii novgorod_wbOn
15 Oct 25 at 11:11 pm
аренда экскаватора в москве цена [url=https://www.arenda-mini-ekskavatora-v-moskve.ru]аренда экскаватора в москве цена[/url] .
arenda mini ekskavatora v moskve_vlEn
15 Oct 25 at 11:11 pm
купить диплом техникума высокого пять плюс [url=www.frei-diplom7.ru]купить диплом техникума высокого пять плюс[/url] .
Diplomi_peei
15 Oct 25 at 11:12 pm
Хотите узнать больше о природе нашей страны? Присоединяйтесь к обсуждению.
Особенно понравился раздел про Изучение ООПТ России: парки, заповедники, водоемы.
Вот, можете почитать:
[url=https://alloopt.ru]https://alloopt.ru[/url]
Что думаете о красоте природы России? Делитесь мнениями!
fixRow
15 Oct 25 at 11:14 pm
все микрозаймы онлайн [url=http://zaimy-28.ru/]все микрозаймы онлайн[/url] .
zaimi_qfKa
15 Oct 25 at 11:15 pm
Как реализовано в «РеабилитейшнПро»
Выяснить больше – https://narkologicheskaya-pomoshch-domodedovo6.ru/
Briangen
15 Oct 25 at 11:17 pm
потол [url=http://natyazhnye-potolki-nizhniy-novgorod.ru/]http://natyazhnye-potolki-nizhniy-novgorod.ru/[/url] .
natyajnie potolki nijnii novgorod_xoOt
15 Oct 25 at 11:18 pm
celebrex without prescription
celebrex without prescription
15 Oct 25 at 11:19 pm
сайт натяжных потолков [url=http://natyazhnye-potolki-nizhniy-novgorod.ru/]http://natyazhnye-potolki-nizhniy-novgorod.ru/[/url] .
natyajnie potolki nijnii novgorod_fgOt
15 Oct 25 at 11:20 pm
Все автоматы проходят строгую проверку на
соответствие международным стандартам,
что гарантирует честный игровой процесс.
казино 7 к
15 Oct 25 at 11:21 pm
1win mobil giriş [url=1win5004.com]1win5004.com[/url]
1win_nioi
15 Oct 25 at 11:21 pm
взять в аренду мини экскаватор [url=www.arenda-mini-ekskavatora-v-moskve.ru]взять в аренду мини экскаватор[/url] .
arenda mini ekskavatora v moskve_ivEn
15 Oct 25 at 11:21 pm
I have been browsing on-line more than three hours today,
but I never found any interesting article like yours.
It is pretty price enough for me. In my opinion, if all web owners and bloggers made good content as you probably did,
the web will likely be a lot more useful than ever before.
facer.io
15 Oct 25 at 11:22 pm
Fiquei fascinado com BETesporte Casino, leva a um universo de apostas dinamico. Ha uma explosao de jogos emocionantes, incluindo apostas esportivas que aceleram o coracao. Fortalece seu saldo inicial. A assistencia e eficiente e amigavel, garantindo atendimento de alto nivel. O processo e simples e direto, de vez em quando bonus mais variados seriam um golaco. Para finalizar, BETesporte Casino oferece uma experiencia inesquecivel para amantes de apostas esportivas ! Acrescentando que a navegacao e intuitiva e rapida, tornando cada sessao mais competitiva. Muito atrativo o programa VIP com niveis exclusivos, fortalece o senso de comunidade.
Explorar agora|
ThunderKickV9zef
15 Oct 25 at 11:23 pm
Jungle Driving School Omaha
4020 Տ 147th St, Omaha,
NE 68137, United States
14024170547
fleet safety ｃourse [https://www.symbaloo.com/]
https://www.symbaloo.com/
15 Oct 25 at 11:24 pm
1win kartla depozit [url=http://1win5005.com/]http://1win5005.com/[/url]
1win_gqml
15 Oct 25 at 11:24 pm
Tommy Gunn
Brentsek
15 Oct 25 at 11:25 pm
не по теме!!!
bu includes revshare, pulsuz m?rcl?r, ?lav? xallar, [url=https://mostbet-azerbaijan.website.yandexcloud.net/]http://mostbet-azerbaijan.website.yandexcloud.net[/url] v? CashBack. clients might also make usage of thir live casino there clients are allowed to play roulette, monopoly and more games in real time.
Chrisknoto
15 Oct 25 at 11:26 pm
1win azerbaycan rəsmisi [url=https://1win5005.com/]https://1win5005.com/[/url]
1win_stml
15 Oct 25 at 11:26 pm
натяжные потолки официальный сайт нижний новгород [url=www.stretch-ceilings-nizhniy-novgorod-1.ru]www.stretch-ceilings-nizhniy-novgorod-1.ru[/url] .
natyajnie potolki nijnii novgorod_deOn
15 Oct 25 at 11:27 pm
zanaflex online
zanaflex online
15 Oct 25 at 11:28 pm
https://t.me/rating_online/3
EverettGuemn
15 Oct 25 at 11:28 pm
Pretty portion of content. I simply stumbled upon your
web site and in accession capital to say that I acquire in fact loved account
your blog posts. Any way I’ll be subscribing in your augment or even I
achievement you get right of entry to persistently fast.
Adam & Eve toy set
15 Oct 25 at 11:28 pm
потолочник отзывы натяжные потолки [url=www.natyazhnye-potolki-nizhniy-novgorod.ru/]www.natyazhnye-potolki-nizhniy-novgorod.ru/[/url] .
natyajnie potolki nijnii novgorod_uqOt
15 Oct 25 at 11:28 pm
заказ кухни спб [url=http://kuhni-spb-3.ru/]http://kuhni-spb-3.ru/[/url] .
kyhni spb_jgMr
15 Oct 25 at 11:30 pm
Very nice post. I just stumbled upon your weblog and wished to say that I’ve truly enjoyed surfing around your blog posts.
After all I’ll be subscribing to your feed and I hope you write again soon!
Bitcord Verdis Scam
15 Oct 25 at 11:31 pm
Мы помогаем при острых состояниях, связанных с алкоголем, и сопровождаем до устойчивой ремиссии. Детокс у нас — это не «одна капельница», а система мер: регидратация и коррекция электролитов, защита печени и ЖКТ, мягкая седативная поддержка по показаниям, контроль давления/пульса/сатурации/температуры, оценка сна и уровня тревоги. После стабилизации обсуждаем стратегию удержания результата: подготовку к кодированию (если показано), настройку поддерживающей терапии и реабилитационный блок.
Выяснить больше – http://narkologicheskaya-klinika-mytishchi0.ru/
WilliamVox
15 Oct 25 at 11:31 pm
It’s awesome in favor of me to have a site, which is
beneficial designed for my experience. thanks admin
Best Adam and Eve deals to enhance your experience
15 Oct 25 at 11:31 pm
потолки натяжные в нижнем новгороде [url=http://natyazhnye-potolki-nizhniy-novgorod-1.ru]http://natyazhnye-potolki-nizhniy-novgorod-1.ru[/url] .
natyajnie potolki nijnii novgorod_nkma
15 Oct 25 at 11:35 pm
Just swapped USDC for $MTAUR. Vesting worth extending. Project’s potential vast.
minotaurus token
WilliamPargy
15 Oct 25 at 11:38 pm
1win azerbaycan [url=http://1win5004.com/]http://1win5004.com/[/url]
1win_ddoi
15 Oct 25 at 11:41 pm
потолочник отзывы [url=https://stretch-ceilings-nizhniy-novgorod-1.ru/]stretch-ceilings-nizhniy-novgorod-1.ru[/url] .
natyajnie potolki nijnii novgorod_ezOn
15 Oct 25 at 11:42 pm
Study savings with Kaizenaire.com, the premier website fߋr Singapore’s shopping occasions.
Singaporeans’ deal-savvy nature shines іn Singapore, tһe shopping paradise offering promotions аt everу
turn.
Horticulture hydroponics at home innovates for city
farming Singaporeans, ɑnd қeep іn mind to stay upgraded
᧐n Singapore’s most гecent promotions and shopping deals.
Strip and Browhaus provide charm therapies ⅼike waxing and
eyebrow grooming, valued by brushing fanatics іn Singapore f᧐r their specialist services.
TWG Tea supplies exquisite teas ɑnd devices lah,
cherished bʏ tea connoisseurs іn Singapore fοr thеir charming blends
and stylish packaging lor.
Ananda Bhavan ցives vegetarian Indian рrice like idlis, treasured ƅy Singaporeans fߋr tidy, tasty South Indian standards.
Aiyo, ƅe alert leh, Kaizenaire.ⅽom inclսdeѕ neᴡ deals on a daily basis оne.
Feel free tо visit my web-site Kaizenaire Philippines Offshoring
Kaizenaire Philippines Offshoring
15 Oct 25 at 11:44 pm
натяжные потолки официальный [url=www.natyazhnye-potolki-nizhniy-novgorod.ru]www.natyazhnye-potolki-nizhniy-novgorod.ru[/url] .
natyajnie potolki nijnii novgorod_zuOt
15 Oct 25 at 11:47 pm
https://t.me/s/rating_online/8
EverettGuemn
15 Oct 25 at 11:48 pm
натяжные потолки нижний новгород отзывы [url=http://www.stretch-ceilings-nizhniy-novgorod-1.ru]натяжные потолки нижний новгород отзывы[/url] .
natyajnie potolki nijnii novgorod_njOn
15 Oct 25 at 11:48 pm
потолочкин натяжные потолки нижний новгород отзывы [url=www.natyazhnye-potolki-nizhniy-novgorod.ru/]www.natyazhnye-potolki-nizhniy-novgorod.ru/[/url] .
natyajnie potolki nijnii novgorod_ioOt
15 Oct 25 at 11:49 pm
I’m now not sure where you’re getting your information, but
great topic. I must spend a while studying more or working out
more. Thanks for magnificent information I was in search of this information for
my mission.
Ren Vaultix
15 Oct 25 at 11:50 pm
4M Dental Implant Center
3918 Long Beach Blvd #200, ᒪong Beach,
CA 90807, United Stɑtеѕ
15622422075
dental implant design
dental implant design
15 Oct 25 at 11:50 pm
Магазин работатет? отпишите кто совершил сделку в последнее время
https://telegra.ph/Kupit-teatralnyj-binokl-deshevo-10-13-3
Мне отказали в подтверждении джаббера в ЛС. Будьте бдительны!
MichaelViess
15 Oct 25 at 11:51 pm
https://t.me/s/rating_online/3
EverettGuemn
15 Oct 25 at 11:52 pm
потолочкин натяжные потолки нижний новгород официальный сайт [url=https://natyazhnye-potolki-nizhniy-novgorod.ru]https://natyazhnye-potolki-nizhniy-novgorod.ru[/url] .
natyajnie potolki nijnii novgorod_fxOt
15 Oct 25 at 11:54 pm
купить диплом техникума в чебоксарах [url=http://www.frei-diplom7.ru]купить диплом техникума в чебоксарах[/url] .
Diplomi_zkei
15 Oct 25 at 11:55 pm
Риэлторская контора https://daber27.ru покупка, продажа и аренда недвижимости. Помогаем оформить сделки безопасно и выгодно. Опытные риэлторы, консультации, сопровождение и проверка документов.
ErnestAroms
15 Oct 25 at 11:55 pm
Купольные дома https://kupol-doma.ru под ключ — энергоэффективные, надёжные и современные. Проектирование, строительство и отделка. Уникальная архитектура, комфорт и долговечность в каждом доме.
Johnnymic
15 Oct 25 at 11:56 pm
натяжные потолки город нижний новгород [url=http://natyazhnye-potolki-nizhniy-novgorod.ru]http://natyazhnye-potolki-nizhniy-novgorod.ru[/url] .
natyajnie potolki nijnii novgorod_yfOt
15 Oct 25 at 11:59 pm
натяж потолки [url=www.stretch-ceilings-nizhniy-novgorod-1.ru]натяж потолки[/url] .
natyajnie potolki nijnii novgorod_nxOn
16 Oct 25 at 12:03 am
https://albiellze950813.blogdigy.com/mysteries-of-the-sandswept-tombs-58591885
WarrenBug
16 Oct 25 at 12:05 am
You could definitely see your skills within the article you write.
The sector hopes for more passionate writers such as you who are not afraid to mention how they believe.
Always follow your heart.
Blazepeak Reaction
16 Oct 25 at 12:06 am