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=https://vyvod-iz-zapoya-nizhnij-novgorod12.ru/]вывод из запоя круглосуточно нижний новгород[/url]
Miltondiolo
19 Oct 25 at 3:28 am
Ukrainian President Volodymyr Zelensky condemned Russian attacks on the Ukrainian regions of Kharkiv, Zaporizhzhia and Sumy on Monday, saying that the Kremlin intends to “humiliate diplomatic efforts” just hours before European leaders visit the White House.
[url=https://kra42cc.com]kra40 cc[/url]
“The Russian war machine continues to destroy lives despite everything,” Zelensky said in a statement, hours before he’s due to meet US President Donald Trump in the Oval Office. “That is precisely why we are seeking assistance to put an end to the killings. That is why reliable security guarantees are required. That is why Russia should not be rewarded for its participation in this war.”
[url=https://kra41cc.net]kra42 at[/url]
“Everyone seeks dignified peace and true security,” the Ukrainian president said. “And at this very moment, the Russians are attacking Kharkiv, Zaporizhzhia, the Sumy region, and Odesa, destroying residential buildings and our civilian infrastructure.”
At least seven people were killed in Russia’s attack? on Kharkiv and a further three killed in the ballistic missile strike on the city of Zaporizhzhia, with scores more injured, according to Ukrainian authorities.
“This was a demonstrative and cynical Russian strike,” Zelensky added.
kra35
https://kra-41cc.com
Michaelbaf
19 Oct 25 at 3:28 am
купить диплом в ялте [url=http://rudik-diplom1.ru]купить диплом в ялте[/url] .
Diplomi_sber
19 Oct 25 at 3:29 am
I loved as much as you’ll receive carried out right here.
The sketch is tasteful, your authored subject matter
stylish. nonetheless, you command get bought an nervousness over that
you wish be delivering the following. unwell unquestionably come more formerly again as
exactly the same nearly a lot often inside case you shield this increase.
GELATIN TRICK WITH 3 INGREDIENTS
19 Oct 25 at 3:30 am
услуги по согласованию перепланировки квартиры [url=www.soglasovanie-pereplanirovki-kvartiry3.ru]www.soglasovanie-pereplanirovki-kvartiry3.ru[/url] .
soglasovanie pereplanirovki kvartiri _dqPi
19 Oct 25 at 3:30 am
купить диплом о высшем образовании с занесением в реестр владивосток [url=www.frei-diplom6.ru/]www.frei-diplom6.ru/[/url] .
Diplomi_owOl
19 Oct 25 at 3:31 am
перепланировка услуги [url=www.soglasovanie-pereplanirovki-kvartiry4.ru]www.soglasovanie-pereplanirovki-kvartiry4.ru[/url] .
soglasovanie pereplanirovki kvartiri _cpOr
19 Oct 25 at 3:31 am
купить диплом архитектора [url=http://rudik-diplom10.ru]купить диплом архитектора[/url] .
Diplomi_acSa
19 Oct 25 at 3:33 am
Вызов нарколога на дом в Краснодаре доступен в любое время суток. Клиника «Детокс» гарантирует профессиональную помощь.
Углубиться в тему – [url=https://narkolog-na-dom-krasnodar29.ru/]вызвать нарколога на дом срочно[/url]
StevenPrabY
19 Oct 25 at 3:35 am
согласование [url=http://soglasovanie-pereplanirovki-kvartiry14.ru/]http://soglasovanie-pereplanirovki-kvartiry14.ru/[/url] .
soglasovanie pereplanirovki kvartiri _ubEl
19 Oct 25 at 3:37 am
купить диплом в ачинске [url=http://rudik-diplom8.ru/]купить диплом в ачинске[/url] .
Diplomi_guMt
19 Oct 25 at 3:37 am
Spinrise
Angelolix
19 Oct 25 at 3:37 am
согласование перепланировки цена в москве [url=https://zakazat-proekt-pereplanirovki-kvartiry11.ru/]https://zakazat-proekt-pereplanirovki-kvartiry11.ru/[/url] .
zakazat proekt pereplanirovki kvartiri_pget
19 Oct 25 at 3:38 am
купить диплом с занесением в реестр самара [url=https://frei-diplom6.ru]https://frei-diplom6.ru[/url] .
Diplomi_roOl
19 Oct 25 at 3:38 am
купить проведенный диплом кого [url=https://www.frei-diplom5.ru]купить проведенный диплом кого[/url] .
Diplomi_bhPa
19 Oct 25 at 3:38 am
сколько стоит согласование перепланировки [url=http://stoimost-soglasovaniya-pereplanirovki-kvartiry.ru/]http://stoimost-soglasovaniya-pereplanirovki-kvartiry.ru/[/url] .
stoimost soglasovaniya pereplanirovki kvartiri_mtPt
19 Oct 25 at 3:39 am
купить диплом о техническом образовании с занесением в реестр [url=https://frei-diplom3.ru/]https://frei-diplom3.ru/[/url] .
Diplomi_xvKt
19 Oct 25 at 3:39 am
прогноз хоккей на сегодня от профессионалов бесплатно [url=https://prognozy-na-khokkej5.ru]https://prognozy-na-khokkej5.ru[/url] .
prognozi na hokkei_ubEa
19 Oct 25 at 3:40 am
купить диплом в воткинске [url=http://www.rudik-diplom5.ru]купить диплом в воткинске[/url] .
Diplomi_yxma
19 Oct 25 at 3:41 am
купить диплом о среднем специальном [url=http://rudik-diplom10.ru]купить диплом о среднем специальном[/url] .
Diplomi_iaSa
19 Oct 25 at 3:41 am
диплом об окончании техникума купить в [url=http://educ-ua7.ru]http://educ-ua7.ru[/url] .
Diplomi_wrea
19 Oct 25 at 3:41 am
купить диплом в нижнем тагиле [url=https://www.rudik-diplom11.ru]купить диплом в нижнем тагиле[/url] .
Diplomi_tgMi
19 Oct 25 at 3:42 am
где согласовать перепланировку квартиры [url=http://soglasovanie-pereplanirovki-kvartiry3.ru/]http://soglasovanie-pereplanirovki-kvartiry3.ru/[/url] .
soglasovanie pereplanirovki kvartiri _yoPi
19 Oct 25 at 3:42 am
соглосование [url=http://soglasovanie-pereplanirovki-kvartiry4.ru]http://soglasovanie-pereplanirovki-kvartiry4.ru[/url] .
soglasovanie pereplanirovki kvartiri _kxOr
19 Oct 25 at 3:42 am
купить диплом в магадане [url=https://www.rudik-diplom3.ru]купить диплом в магадане[/url] .
Diplomi_qlei
19 Oct 25 at 3:42 am
купить диплом о высшем образовании реестр [url=https://frei-diplom4.ru/]купить диплом о высшем образовании реестр[/url] .
Diplomi_zpOl
19 Oct 25 at 3:43 am
кракен vk3
кракен зеркало
JamesDaync
19 Oct 25 at 3:43 am
прогнозы на хоккей [url=www.prognozy-na-khokkej5.ru]прогнозы на хоккей[/url] .
prognozi na hokkei_bhEa
19 Oct 25 at 3:44 am
можно ли купить диплом медсестры [url=https://frei-diplom14.ru/]можно ли купить диплом медсестры[/url] .
Diplomi_rboi
19 Oct 25 at 3:44 am
купить диплом специалиста [url=https://rudik-diplom4.ru]купить диплом специалиста[/url] .
Diplomi_bqOr
19 Oct 25 at 3:44 am
купить диплом в магадане [url=rudik-diplom1.ru]купить диплом в магадане[/url] .
Diplomi_poer
19 Oct 25 at 3:45 am
заказ перепланировки квартиры [url=http://proekt-pereplanirovki-kvartiry17.ru]http://proekt-pereplanirovki-kvartiry17.ru[/url] .
proekt pereplanirovki kvartiri_uwml
19 Oct 25 at 3:45 am
купить диплом прораба [url=http://www.rudik-diplom8.ru]купить диплом прораба[/url] .
Diplomi_gpMt
19 Oct 25 at 3:45 am
купить диплом в владивостоке [url=http://www.rudik-diplom10.ru]купить диплом в владивостоке[/url] .
Diplomi_vbSa
19 Oct 25 at 3:46 am
москва купить диплом о высшем образовании с занесением в реестр [url=https://frei-diplom3.ru/]москва купить диплом о высшем образовании с занесением в реестр[/url] .
Diplomi_wtKt
19 Oct 25 at 3:46 am
купить диплом в рубцовске [url=http://www.rudik-diplom5.ru]http://www.rudik-diplom5.ru[/url] .
Diplomi_pbma
19 Oct 25 at 3:47 am
стоимость перепланировки квартиры [url=https://www.proekt-pereplanirovki-kvartiry17.ru]стоимость перепланировки квартиры[/url] .
proekt pereplanirovki kvartiri_gmml
19 Oct 25 at 3:48 am
диплом купить медицинского техникума [url=educ-ua7.ru]educ-ua7.ru[/url] .
Diplomi_alea
19 Oct 25 at 3:48 am
диплом реестр купить [url=http://frei-diplom6.ru]диплом реестр купить[/url] .
Diplomi_rtOl
19 Oct 25 at 3:48 am
Если вы ищете надежную клинику для вывода из запоя в Сочи, обратитесь в «Детокс». Здесь опытные специалисты окажут необходимую помощь в стационаре. Услуга доступна круглосуточно, анонимно и начинается от 2000 ?.
Исследовать вопрос подробнее – [url=https://vyvod-iz-zapoya-sochi24.ru/]вывод из запоя на дому недорого в сочи[/url]
Bryankax
19 Oct 25 at 3:49 am
купить диплом в благовещенске [url=https://rudik-diplom3.ru]купить диплом в благовещенске[/url] .
Diplomi_jaei
19 Oct 25 at 3:49 am
купить диплом с занесением в реестр в уфе [url=https://frei-diplom4.ru/]https://frei-diplom4.ru/[/url] .
Diplomi_oqOl
19 Oct 25 at 3:49 am
Saved as a favorite, I like your blog!
slot gacor
19 Oct 25 at 3:50 am
стоимость регистрации перепланировки [url=www.stoimost-soglasovaniya-pereplanirovki-kvartiry.ru/]www.stoimost-soglasovaniya-pereplanirovki-kvartiry.ru/[/url] .
stoimost soglasovaniya pereplanirovki kvartiri_clPt
19 Oct 25 at 3:50 am
где можно купить диплом медсестры [url=https://frei-diplom13.ru/]где можно купить диплом медсестры[/url] .
Diplomi_ppkt
19 Oct 25 at 3:51 am
согласование перепланировки помещений [url=www.soglasovanie-pereplanirovki-kvartiry3.ru/]www.soglasovanie-pereplanirovki-kvartiry3.ru/[/url] .
soglasovanie pereplanirovki kvartiri _fjPi
19 Oct 25 at 3:51 am
заказать перепланировку [url=https://soglasovanie-pereplanirovki-kvartiry4.ru/]https://soglasovanie-pereplanirovki-kvartiry4.ru/[/url] .
soglasovanie pereplanirovki kvartiri _haOr
19 Oct 25 at 3:51 am
прогноз на сегодня футбол [url=https://prognozy-na-futbol-10.ru]прогноз на сегодня футбол[/url] .
prognozi na fytbol_jzOi
19 Oct 25 at 3:52 am
Купить диплом техникума в Одесса [url=https://educ-ua7.ru/]https://educ-ua7.ru/[/url] .
Diplomi_gbea
19 Oct 25 at 3:52 am
перепланировка [url=https://soglasovanie-pereplanirovki-kvartiry4.ru]перепланировка[/url] .
soglasovanie pereplanirovki kvartiri _cfOr
19 Oct 25 at 3:54 am