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!
I am genuinely delighted to glance at this webpage posts which carries lots of valuable
data, thanks for providing these statistics.
kontol Panjang
14 Oct 25 at 5:44 pm
купить диплом в георгиевске [url=https://www.rudik-diplom14.ru]купить диплом в георгиевске[/url] .
Diplomi_tkea
14 Oct 25 at 5:45 pm
электрокарнизы в москве [url=www.elektrokarnizy797.ru]электрокарнизы в москве[/url] .
elektrokarnizi_foMl
14 Oct 25 at 5:46 pm
Have you ever thought about creating an e-book or guest
authoring on other websites? I have a blog centered on the same topics you
discuss and would really like to have you share some stories/information. I know my subscribers would
enjoy your work. If you are even remotely interested, feel free to send me an e-mail.
casino utan omsättningskrav
14 Oct 25 at 5:47 pm
Thanks for finally talking about > PHP hook, building hooks in your
application – Sjoerd Maessen blog at Sjoerd Maessen blog < Loved it!
useful gardening tips
14 Oct 25 at 5:47 pm
Tenho um entusiasmo vibrante por BETesporte Casino, me leva a um universo de apostas vibrante. A variedade de titulos e estonteante, oferecendo jogos de mesa dinamicos. O bonus de boas-vindas e empolgante. A assistencia e eficiente e amigavel, garantindo um atendimento de elite. Os pagamentos sao seguros e fluidos, contudo mais apostas gratis seriam incriveis. Para finalizar, BETesporte Casino vale uma aposta certa para entusiastas de jogos modernos ! Adicionalmente o design e moderno e vibrante, aumenta o prazer de apostar. Muito atrativo os pagamentos seguros em cripto, assegura transacoes confiaveis.
Ler mais|
BlazeStrikerT3zef
14 Oct 25 at 5:50 pm
Кинопроекты 2019 года под продюсерским руководством Игоря Щербакова собраны на [url=https://www.igor-scherbakov.ru/prodyuser-filmov-2019]этой странице[/url]. Он умеет находить сильные сценарии и собирать талантливые команды, чтобы воплотить их в жизнь. Его продюсирование это не просто финансирование, а творческое соучастие.
AnekWap
14 Oct 25 at 5:50 pm
цены на натяжные потолки в самаре [url=https://stretch-ceilings-samara.ru]https://stretch-ceilings-samara.ru[/url] .
natyajnie potolki samara_wtkl
14 Oct 25 at 5:54 pm
https://social.sktorrent.eu/read-blog/51118
abmkktv
14 Oct 25 at 5:55 pm
потолочник потолки [url=natyazhnye-potolki-samara-1.ru]natyazhnye-potolki-samara-1.ru[/url] .
natyajnie potolki samara_bdor
14 Oct 25 at 5:56 pm
фитнес клуб фитнес клуб цены
fitnes-klub-313
14 Oct 25 at 5:57 pm
потолочник отзывы натяжные потолки [url=www.stretch-ceilings-samara-1.ru]www.stretch-ceilings-samara-1.ru[/url] .
natyajnie potolki samara_qbsl
14 Oct 25 at 6:00 pm
электрокарнизы купить в москве [url=www.elektrokarnizy797.ru]электрокарнизы купить в москве[/url] .
elektrokarnizi_mvMl
14 Oct 25 at 6:03 pm
Sou totalmente viciado em PlayPIX Casino, proporciona uma aventura pulsante. A variedade de titulos e estonteante, oferecendo jogos de mesa envolventes. Fortalece seu saldo inicial. O acompanhamento e impecavel, acessivel a qualquer momento. Os ganhos chegam sem atraso, de vez em quando mais rodadas gratis seriam um diferencial. No geral, PlayPIX Casino e uma plataforma que brilha para quem aposta com cripto ! Acrescentando que o site e rapido e cativante, adiciona um toque de conforto. Igualmente impressionante os pagamentos seguros em cripto, fortalece o senso de comunidade.
Aprender os detalhes|
BlazeRhythmQ6zef
14 Oct 25 at 6:03 pm
generic amoxicillin [url=http://amoxicareonline.com/#]buy amoxicillin[/url] Amoxicillin online UK
Jameshoasy
14 Oct 25 at 6:03 pm
купить диплом техникума велика [url=https://frei-diplom10.ru]купить диплом техникума велика[/url] .
Diplomi_gsEa
14 Oct 25 at 6:04 pm
Thanks for the auspicious writeup. It in fact used to be a
enjoyment account it. Glance complicated to far introduced agreeable from you!
However, how could we keep up a correspondence?
por huv
14 Oct 25 at 6:04 pm
Делятся подарки на две глобальных категории –
для спорта и для онлайн-казино.
пин ап казино мобильная версия
14 Oct 25 at 6:07 pm
купить диплом в салавате [url=www.rudik-diplom9.ru/]купить диплом в салавате[/url] .
Diplomi_rxei
14 Oct 25 at 6:08 pm
Mandingo
Brentsek
14 Oct 25 at 6:11 pm
натяжные потолки самара с установкой [url=http://www.stretch-ceilings-samara.ru]http://www.stretch-ceilings-samara.ru[/url] .
natyajnie potolki samara_uhkl
14 Oct 25 at 6:11 pm
перепланировка в нежилом помещении [url=http://pereplanirovka-nezhilogo-pomeshcheniya9.ru/]http://pereplanirovka-nezhilogo-pomeshcheniya9.ru/[/url] .
pereplanirovka nejilogo pomesheniya_knKl
14 Oct 25 at 6:12 pm
I was extremely pleased to uncover this website. I wanted to thank you
for ones time for this wonderful read!! I definitely liked every bit of it and I have you
bookmarked to check out new stuff in your website.
sblc monetization
14 Oct 25 at 6:12 pm
потолочкин ру натяжные потолки [url=http://natyazhnye-potolki-samara-1.ru]http://natyazhnye-potolki-samara-1.ru[/url] .
natyajnie potolki samara_ijor
14 Oct 25 at 6:12 pm
купить диплом университета [url=rudik-diplom15.ru]купить диплом университета[/url] .
Diplomi_stPi
14 Oct 25 at 6:12 pm
https://rapchat.com/profile/D2C5FC40-49EE-11F0-8DC7-ED25C75DF500
Nathanhip
14 Oct 25 at 6:12 pm
электрокарнизы цена [url=www.elektrokarnizy797.ru/]электрокарнизы цена[/url] .
elektrokarnizi_xjMl
14 Oct 25 at 6:12 pm
sportwetten bild tipps
Also visit my webpage … live wetten österreich
live wetten österreich
14 Oct 25 at 6:13 pm
Grabbed more $MTAUR; vesting bonuses worth it. ICO’s legal setup solid. Creature battles thrilling.
minotaurus ico
WilliamPargy
14 Oct 25 at 6:15 pm
переустройство нежилого помещения [url=www.pereplanirovka-nezhilogo-pomeshcheniya9.ru/]www.pereplanirovka-nezhilogo-pomeshcheniya9.ru/[/url] .
pereplanirovka nejilogo pomesheniya_maKl
14 Oct 25 at 6:15 pm
Viagra online UK [url=https://britpharmonline.com/#]order ED pills online UK[/url] order ED pills online UK
Jameshoasy
14 Oct 25 at 6:17 pm
Наркозависимость — это не просто вредная привычка, а тяжёлое хроническое заболевание, требующее комплексного и последовательного лечения. В клинике «РеабКузбасс» в Новокузнецке разработаны персонализированные программы помощи, учитывающие медицинские, психологические и социальные аспекты проблемы. Каждому пациенту подбирается уникальный маршрут восстановления, начиная с первичной диагностики и заканчивая адаптацией к жизни без наркотиков. Поддержка оказывается круглосуточно, с полным соблюдением конфиденциальности. Психотерапевты и врачи работают в тесной связке, чтобы не только устранить физическую зависимость, но и восстановить личность пациента, вернуть ему мотивацию к жизни и уверенность в будущем.
Ознакомиться с деталями – http://lechenie-narkomanii-novokuzneczk0.ru
Johnnyjab
14 Oct 25 at 6:18 pm
фитнес клуб москва https://fitnes-klub-msk.ru
fitnes-klub-807
14 Oct 25 at 6:20 pm
viagra: order ED pills online UK – order ED pills online UK
Brettesofe
14 Oct 25 at 6:23 pm
купить вкладыш с оценками к диплому техникума [url=https://frei-diplom12.ru]купить вкладыш с оценками к диплому техникума[/url] .
Diplomi_txPt
14 Oct 25 at 6:23 pm
BJ88 Pilipinas: pinagkakatiwalaang online casino at sports betting.
Malalaking bonus, kumpletong laro, GCash/Maya/InstaPay/PESONet payments, at mabilis na withdrawal.
Sumali sa BJ88 ngayon!
BJ88 Pilipinas – Ang Iyong Panalo
14 Oct 25 at 6:23 pm
My relatives every time say that I am wasting my time here
at net, however I know I am getting know-how everyday by
reading such fastidious articles.
Nn88
14 Oct 25 at 6:23 pm
потолочник [url=https://stretch-ceilings-samara-1.ru/]потолочник[/url] .
natyajnie potolki samara_mssl
14 Oct 25 at 6:24 pm
электрические карнизы для штор в москве [url=https://www.elektrokarnizy797.ru]https://www.elektrokarnizy797.ru[/url] .
elektrokarnizi_qxMl
14 Oct 25 at 6:25 pm
тканевый натяжной потолок самара [url=https://stretch-ceilings-samara.ru/]stretch-ceilings-samara.ru[/url] .
natyajnie potolki samara_bdkl
14 Oct 25 at 6:25 pm
потолочник натяжные потолки [url=http://natyazhnye-potolki-samara-1.ru/]http://natyazhnye-potolki-samara-1.ru/[/url] .
natyajnie potolki samara_wsor
14 Oct 25 at 6:25 pm
согласование перепланировки нежилого помещения [url=https://pereplanirovka-nezhilogo-pomeshcheniya9.ru/]согласование перепланировки нежилого помещения[/url] .
pereplanirovka nejilogo pomesheniya_imKl
14 Oct 25 at 6:25 pm
EverythingStartsWithYou – Great source for mindset shifts, gratitude, and forward momentum.
Sharlene Bethurem
14 Oct 25 at 6:27 pm
В клинике «Альтернатива» применяются современные методы терапии, включающие медикаментозное лечение, психотерапию и социальную реабилитацию.
Получить больше информации – [url=https://narkologicheskaya-pomoshh-novokuzneczk0.ru/]оказание наркологической помощи[/url]
Henrymiply
14 Oct 25 at 6:27 pm
электрокарниз москва [url=http://elektrokarnizy797.ru/]http://elektrokarnizy797.ru/[/url] .
elektrokarnizi_xmMl
14 Oct 25 at 6:27 pm
Joined $MTAUR coin presale—easy entry. ICO’s marketing sharp. Creatures whimsical.
minotaurus coin
WilliamPargy
14 Oct 25 at 6:29 pm
Me impressionei com BETesporte Casino, e uma plataforma que pulsa com a energia de um estadio lotado. Ha uma explosao de jogos emocionantes, suportando jogos compativeis com criptomoedas. Fortalece seu saldo inicial. O servico esta disponivel 24/7, garantindo um atendimento de elite. Os pagamentos sao seguros e fluidos, no entanto bonus mais variados seriam um golaco. Resumindo, BETesporte Casino oferece uma experiencia inesquecivel para fas de cassino online ! Alem disso o design e moderno e vibrante, aumenta o prazer de apostar. Outro destaque os torneios regulares para rivalidade, proporciona vantagens personalizadas.
Explorar a pГЎgina|
BlazeStrikerT3zef
14 Oct 25 at 6:36 pm
Just bought $MTAUR; seamless swap. Vesting extensions smart. Maze treasures tempting.
minotaurus coin
WilliamPargy
14 Oct 25 at 6:40 pm
перепланировка нежилого помещения в многоквартирном доме [url=http://pereplanirovka-nezhilogo-pomeshcheniya9.ru/]перепланировка нежилого помещения в многоквартирном доме[/url] .
pereplanirovka nejilogo pomesheniya_wwKl
14 Oct 25 at 6:40 pm
натяжной потолок самара цена [url=stretch-ceilings-samara-1.ru]натяжной потолок самара цена[/url] .
natyajnie potolki samara_xvsl
14 Oct 25 at 6:41 pm