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=www.educ-ua7.ru]www.educ-ua7.ru[/url] .
Diplomi_tuea
19 Oct 25 at 2:11 am
проект на перепланировку квартиры цена [url=proekt-pereplanirovki-kvartiry17.ru]proekt-pereplanirovki-kvartiry17.ru[/url] .
proekt pereplanirovki kvartiri_weml
19 Oct 25 at 2:12 am
купить диплом историка [url=https://rudik-diplom8.ru]купить диплом историка[/url] .
Diplomi_hsMt
19 Oct 25 at 2:13 am
современное медицинское оборудование [url=https://xn—–6kcdfldbfd2aga1bqjlbbb4b4d7d1fzd.xn--p1ai/]https://xn—–6kcdfldbfd2aga1bqjlbbb4b4d7d1fzd.xn--p1ai/[/url] .
oborydovanie medicinskoe_cgOn
19 Oct 25 at 2:13 am
купить диплом магистра [url=http://www.rudik-diplom4.ru]купить диплом магистра[/url] .
Diplomi_qcOr
19 Oct 25 at 2:13 am
купить диплом образование купить проведенный диплом [url=http://frei-diplom4.ru/]купить диплом образование купить проведенный диплом[/url] .
Diplomi_haOl
19 Oct 25 at 2:16 am
перепланировка офиса [url=https://soglasovanie-pereplanirovki-kvartiry14.ru/]soglasovanie-pereplanirovki-kvartiry14.ru[/url] .
soglasovanie pereplanirovki kvartiri _zbEl
19 Oct 25 at 2:16 am
купить диплом в нефтекамске [url=https://rudik-diplom5.ru/]купить диплом в нефтекамске[/url] .
Diplomi_huma
19 Oct 25 at 2:17 am
лучшие прогнозы на хоккей на сегодня [url=https://www.prognozy-na-khokkej5.ru]https://www.prognozy-na-khokkej5.ru[/url] .
prognozi na hokkei_ljEa
19 Oct 25 at 2:17 am
сколько стоит перепланировка в москве [url=https://stoimost-soglasovaniya-pereplanirovki-kvartiry.ru/]stoimost-soglasovaniya-pereplanirovki-kvartiry.ru[/url] .
stoimost soglasovaniya pereplanirovki kvartiri_rqPt
19 Oct 25 at 2:17 am
купить дипломы о высшем [url=https://rudik-diplom3.ru/]купить дипломы о высшем[/url] .
Diplomi_toei
19 Oct 25 at 2:17 am
купить диплом об окончании [url=https://educ-ua7.ru]https://educ-ua7.ru[/url] .
Diplomi_uyea
19 Oct 25 at 2:18 am
условия бонуса melbet [url=http://melbetbonusy.ru]условия бонуса melbet[/url] .
melbet_yxOi
19 Oct 25 at 2:18 am
купить диплом в копейске [url=http://www.rudik-diplom11.ru]купить диплом в копейске[/url] .
Diplomi_ooMi
19 Oct 25 at 2:18 am
согласование [url=www.soglasovanie-pereplanirovki-kvartiry3.ru/]www.soglasovanie-pereplanirovki-kvartiry3.ru/[/url] .
soglasovanie pereplanirovki kvartiri _qtPi
19 Oct 25 at 2:21 am
strongfoundation – Easy to navigate site, made exploring the services effortless.
Suzan Burden
19 Oct 25 at 2:22 am
globalmarketinsight – Very clear charts and commentary, easy to follow for beginners too.
Ward Vettel
19 Oct 25 at 2:22 am
купить диплом механика [url=http://rudik-diplom3.ru/]купить диплом механика[/url] .
Diplomi_ecei
19 Oct 25 at 2:22 am
диплом техникума купить с проводкой [url=https://educ-ua7.ru]https://educ-ua7.ru[/url] .
Diplomi_gyea
19 Oct 25 at 2:23 am
перепланировка москва [url=http://www.soglasovanie-pereplanirovki-kvartiry4.ru]перепланировка москва[/url] .
soglasovanie pereplanirovki kvartiri _xhOr
19 Oct 25 at 2:23 am
купить диплом в кинешме [url=https://rudik-diplom4.ru]купить диплом в кинешме[/url] .
Diplomi_fdOr
19 Oct 25 at 2:24 am
согласование перепланировки цена [url=https://zakazat-proekt-pereplanirovki-kvartiry11.ru]https://zakazat-proekt-pereplanirovki-kvartiry11.ru[/url] .
zakazat proekt pereplanirovki kvartiri_hiet
19 Oct 25 at 2:24 am
регистрация перепланировки [url=http://soglasovanie-pereplanirovki-kvartiry4.ru]регистрация перепланировки[/url] .
soglasovanie pereplanirovki kvartiri _ehOr
19 Oct 25 at 2:25 am
You’re so cool! I don’t think I have read through anything like this before.
So good to discover somebody with unique thoughts on this subject matter.
Seriously.. thank you for starting this up. This website is one thing that’s needed on the internet, someone with some originality!
88fc
19 Oct 25 at 2:25 am
диплом высшего образования с занесением в реестр купить [url=www.frei-diplom2.ru/]диплом высшего образования с занесением в реестр купить[/url] .
Diplomi_ahEa
19 Oct 25 at 2:25 am
перепланировка комнаты [url=www.soglasovanie-pereplanirovki-kvartiry14.ru]www.soglasovanie-pereplanirovki-kvartiry14.ru[/url] .
soglasovanie pereplanirovki kvartiri _luEl
19 Oct 25 at 2:26 am
купить диплом в глазове [url=rudik-diplom11.ru]купить диплом в глазове[/url] .
Diplomi_rgMi
19 Oct 25 at 2:26 am
медсестра которая купила диплом врача [url=www.frei-diplom13.ru/]www.frei-diplom13.ru/[/url] .
Diplomi_jxkt
19 Oct 25 at 2:26 am
Way cool! Some very valid points! I appreciate you penning this post plus the
rest of the site is also really good.
Also visit my page … ข้อมูลเบื้องต้นเกี่ยวกับหวยออนไลน์
ข้อมูลเบื้องต้นเกี่ยวกับหวยออนไลน์
19 Oct 25 at 2:27 am
подготовка проекта перепланировки [url=https://www.proekt-pereplanirovki-kvartiry17.ru]подготовка проекта перепланировки[/url] .
proekt pereplanirovki kvartiri_fqml
19 Oct 25 at 2:27 am
Диджитализация охватывает всё kraken ссылка зеркало kraken актуальные ссылки kraken зеркало kraken ссылка зеркало
RichardPep
19 Oct 25 at 2:28 am
купить диплом о среднем профессиональном образовании с занесением в реестр [url=https://www.frei-diplom5.ru]купить диплом о среднем профессиональном образовании с занесением в реестр[/url] .
Diplomi_tePa
19 Oct 25 at 2:28 am
экспресс на футбол сегодня [url=https://prognozy-na-futbol-10.ru/]prognozy-na-futbol-10.ru[/url] .
prognozi na fytbol_mqOi
19 Oct 25 at 2:29 am
узаконивание перепланировки цена [url=http://stoimost-soglasovaniya-pereplanirovki-kvartiry.ru]http://stoimost-soglasovaniya-pereplanirovki-kvartiry.ru[/url] .
stoimost soglasovaniya pereplanirovki kvartiri_mbPt
19 Oct 25 at 2:30 am
перепланировка комнаты [url=http://soglasovanie-pereplanirovki-kvartiry3.ru]http://soglasovanie-pereplanirovki-kvartiry3.ru[/url] .
soglasovanie pereplanirovki kvartiri _dhPi
19 Oct 25 at 2:30 am
куплю диплом высшего образования [url=http://rudik-diplom1.ru]куплю диплом высшего образования[/url] .
Diplomi_qter
19 Oct 25 at 2:31 am
купить диплом строителя [url=https://rudik-diplom8.ru]купить диплом строителя[/url] .
Diplomi_xyMt
19 Oct 25 at 2:32 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://kra42.net]kra41[/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.”
[url=https://kra42-cc.net]kra39 at[/url]
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.
[url=https://kra—42cc.ru]kra35 cc[/url]
“This was a demonstrative and cynical Russian strike,” Zelensky added.
kra37 cc
https://kra-41–at.ru
HectorBoaps
19 Oct 25 at 2:32 am
купить диплом в набережных челнах [url=https://rudik-diplom13.ru/]купить диплом в набережных челнах[/url] .
Diplomi_jyon
19 Oct 25 at 2:33 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://kra-42at.com]kra41[/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://kra42—at.ru]kra38 cc[/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.
kra40 cc
https://kra-42-cc.com
AndrewBlunk
19 Oct 25 at 2:34 am
сколько стоит купить диплом медсестры [url=http://frei-diplom14.ru]сколько стоит купить диплом медсестры[/url] .
Diplomi_nhoi
19 Oct 25 at 2:35 am
узаконивание перепланировки цена [url=www.zakazat-proekt-pereplanirovki-kvartiry11.ru]www.zakazat-proekt-pereplanirovki-kvartiry11.ru[/url] .
zakazat proekt pereplanirovki kvartiri_odet
19 Oct 25 at 2:37 am
купить диплом с занесением в реестр вуза [url=https://frei-diplom2.ru/]купить диплом с занесением в реестр вуза[/url] .
Diplomi_ygEa
19 Oct 25 at 2:37 am
купить диплом в усть-илимске [url=https://rudik-diplom1.ru]https://rudik-diplom1.ru[/url] .
Diplomi_lmer
19 Oct 25 at 2:37 am
согласование перепланировки помещений [url=soglasovanie-pereplanirovki-kvartiry14.ru]soglasovanie-pereplanirovki-kvartiry14.ru[/url] .
soglasovanie pereplanirovki kvartiri _qvEl
19 Oct 25 at 2:37 am
В шляпных коробках «Флорион» раскрывает цветы как ювелирные миниатюры: гармоничные сочетания роз, орхидей, эустомы и гортензии выглядят современно и безупречно держат форму. Удобная подача, продуманная палитра и авторские названия композиций помогают точно передать эмоцию, а заказать легко на https://www.florion.ru/catalog/cvety-v-shlyapnoy-korobke — от лаконичных боксов до эффектных премиум-версий. Доставка по Москве и внимательная сборка — как в лучших ателье флористики.
getibyblurl
19 Oct 25 at 2:37 am
медицинское оборудование для больниц [url=xn—–6kcdfldbfd2aga1bqjlbbb4b4d7d1fzd.xn--p1ai]xn—–6kcdfldbfd2aga1bqjlbbb4b4d7d1fzd.xn--p1ai[/url] .
oborydovanie medicinskoe_ooOn
19 Oct 25 at 2:38 am
перепланировка квартиры согласование [url=https://soglasovanie-pereplanirovki-kvartiry4.ru/]перепланировка квартиры согласование[/url] .
soglasovanie pereplanirovki kvartiri _yzOr
19 Oct 25 at 2:38 am
куплю диплом медсестры в москве [url=https://frei-diplom13.ru]куплю диплом медсестры в москве[/url] .
Diplomi_bqkt
19 Oct 25 at 2:39 am
Купить диплом техникума в Луганск [url=https://educ-ua7.ru/]https://educ-ua7.ru/[/url] .
Diplomi_vvea
19 Oct 25 at 2:40 am