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=http://pesnibardov.ru/f/ucp.php?mode=login/]купить аттестат 11 классов цена в твери[/url]
Diplomi_elPn
17 Sep 25 at 7:51 am
купить диплом о средне специальном образовании реестр [url=http://poverkhnost.tv/forum/profile.php?id=23592/]купить диплом о средне специальном образовании реестр[/url] .
Kypit diplom ob obrazovanii!_hckt
17 Sep 25 at 7:51 am
купить диплом магистра украины [url=www.educ-ua18.ru/]купить диплом магистра украины[/url] .
Diplomi_urPi
17 Sep 25 at 7:52 am
купить диплом в херсоне [url=www.educ-ua2.ru]www.educ-ua2.ru[/url] .
Diplomi_euOt
17 Sep 25 at 7:54 am
bs2best at, bs2web at и bs2 market: глубокий анализ технологий 2025 года
bs2best at
bs2best.at blacksprut Official
Jamesner
17 Sep 25 at 7:55 am
Heya i am for the first time here. I found this board and I find It really useful & it helped me out much.
I hope to give something back and help others like you aided me.
institut-wanxiang
17 Sep 25 at 7:55 am
Купить диплом колледжа в Полтава [url=https://educ-ua7.ru/]Купить диплом колледжа в Полтава[/url] .
Diplomi_srEr
17 Sep 25 at 7:55 am
согласование перепланировки нежилых помещений [url=www.pereplanirovka-nezhilogo-pomeshcheniya3.ru]www.pereplanirovka-nezhilogo-pomeshcheniya3.ru[/url] .
pereplanirovka nejilogo pomesheniya_vusa
17 Sep 25 at 7:56 am
Franchising Path Carlsbad
Carlsbad, ⅭA 92008, United Statｅs
+18587536197
Bookmarks
Bookmarks
17 Sep 25 at 7:56 am
смотреть боевики [url=https://kinogo-11.top]https://kinogo-11.top[/url] .
kinogo_ixMa
17 Sep 25 at 7:57 am
купить диплом бакалавра недорого [url=https://www.educ-ua20.ru]купить диплом бакалавра недорого[/url] .
Diplomi_xdEn
17 Sep 25 at 7:59 am
перепланировка в нежилом помещении [url=pereplanirovka-nezhilogo-pomeshcheniya1.ru]pereplanirovka-nezhilogo-pomeshcheniya1.ru[/url] .
pereplanirovka nejilogo pomesheniya_bksi
17 Sep 25 at 8:00 am
Заказать диплом любого университета!
Мы предлагаемвыгодно приобрести диплом, который выполнен на оригинальном бланке и заверен мокрыми печатями, штампами, подписями. Данный документ пройдет любые проверки, даже с применением специально предназначенного оборудования. Достигайте свои цели максимально быстро с нашей компанией- [url=http://red.dariofalero.com/read-blog/18970_kupit-diplom-v-moskve.html/]red.dariofalero.com/read-blog/18970_kupit-diplom-v-moskve.html[/url]
Jariorxwn
17 Sep 25 at 8:00 am
купить диплом университета в киеве [url=http://www.educ-ua4.ru]купить диплом университета в киеве[/url] .
Diplomi_pcPl
17 Sep 25 at 8:00 am
порядок согласования перепланировки нежилого помещения [url=www.pereplanirovka-nezhilogo-pomeshcheniya3.ru/]www.pereplanirovka-nezhilogo-pomeshcheniya3.ru/[/url] .
pereplanirovka nejilogo pomesheniya_yasa
17 Sep 25 at 8:00 am
купить аттестат за 11 класс [url=http://educ-ua5.ru]купить аттестат за 11 класс[/url] .
Diplomi_ceKl
17 Sep 25 at 8:01 am
Мы предлагаем документы институтов, которые расположены в любом регионе Российской Федерации. Заказать диплом о высшем образовании:
[url=http://mikropomoc.pl/profile/lilaordell9209/]купить аттестат 11 классов в ярославле[/url]
Diplomi_urPn
17 Sep 25 at 8:01 am
купить оригинальный аттестат за 11 класс [url=www.arus-diplom25.ru]купить оригинальный аттестат за 11 класс[/url] .
Diplomi_jvot
17 Sep 25 at 8:03 am
перепланировка нежилого здания [url=http://pereplanirovka-nezhilogo-pomeshcheniya1.ru/]http://pereplanirovka-nezhilogo-pomeshcheniya1.ru/[/url] .
pereplanirovka nejilogo pomesheniya_visi
17 Sep 25 at 8:04 am
узаконивание перепланировки нежилого помещения [url=https://pereplanirovka-nezhilogo-pomeshcheniya3.ru/]узаконивание перепланировки нежилого помещения[/url] .
pereplanirovka nejilogo pomesheniya_efsa
17 Sep 25 at 8:04 am
https://kl99.football/
https://kl99.football/
17 Sep 25 at 8:05 am
1вин регистрация на официальном сайте [url=https://1win12014.ru/]1вин регистрация на официальном сайте[/url]
1win_hzOl
17 Sep 25 at 8:05 am
This is my first time pay a quick visit at here and i am genuinely happy to read everthing at
alone place.
WhatsApp網頁版
17 Sep 25 at 8:05 am
Настольные игры своими руками, Развивающие
игры своими руками, Отвлечь ребёнка от смартфона.
https://work04.analog-design.net/rating-reliable-virtual-casinos-how-to-determine-optimal-gambling-house/
17 Sep 25 at 8:06 am
I am extremely inspired with your writing skills and also with the structure for your blog.
Is this a paid subject matter or did you modify it your self?
Either way stay up the nice high quality writing, it is rare to see a nice blog like this one
today..
مهندسی عمران در چه رشته ای است
17 Sep 25 at 8:06 am
купить диплом о образовании в киеве [url=www.educ-ua17.ru/]www.educ-ua17.ru/[/url] .
Diplomi_clSl
17 Sep 25 at 8:06 am
Заказать диплом ВУЗа!
Мы предлагаембыстро приобрести диплом, который выполняется на оригинальном бланке и заверен мокрыми печатями, водяными знаками, подписями должностных лиц. Документ способен пройти любые проверки, даже с применением специального оборудования. Достигайте цели быстро с нашей компанией- [url=http://msk.flybb.ru/viewtopic.php?f=2&t=1207&sid=251699d1f34e422e510fcd2a825d5a75/]msk.flybb.ru/viewtopic.php?f=2&t=1207&sid=251699d1f34e422e510fcd2a825d5a75[/url]
Jariorldr
17 Sep 25 at 8:07 am
Мы можем предложить документы университетов, которые находятся в любом регионе Российской Федерации. Заказать диплом о высшем образовании:
[url=http://terorizam.listbb.ru/viewtopic.php?f=3&t=2564/]купить чистый аттестат за 11 класс[/url]
Diplomi_jqPn
17 Sep 25 at 8:07 am
перепланировка нежилого помещения в нежилом здании законодательство [url=http://pereplanirovka-nezhilogo-pomeshcheniya1.ru]http://pereplanirovka-nezhilogo-pomeshcheniya1.ru[/url] .
pereplanirovka nejilogo pomesheniya_ntsi
17 Sep 25 at 8:08 am
Pretty! This was an extremely wonderful post.
Many thanks for providing these details.
sme loan broker
17 Sep 25 at 8:08 am
кинопоиск смотреть онлайн [url=www.kinogo-11.top]www.kinogo-11.top[/url] .
kinogo_ikMa
17 Sep 25 at 8:08 am
Your style is very unique compared to other folks I’ve read stuff from.
Thanks for posting when you’ve got the opportunity, Guess I will just book mark this web site.
Break Your Bones Script keyless
17 Sep 25 at 8:09 am
Купить онлайн кокаин, мефедрон, амф, альфа-пвп
Магазин не чистый на руку. Уже пишет с другого жабера. Народ у кого осталось переписка состарого жабера сверьте ник. И прошу сделать посты что таковое не придуманная мною сказка.
KennethImire
17 Sep 25 at 8:11 am
What’s up colleagues, its great post concerning tutoringand completely explained,
keep it up all the time.
دانشگاه علوم توانبخشی تهران
17 Sep 25 at 8:11 am
Заказать диплом ВУЗа!
Наша компания предлагаетвыгодно купить диплом, который выполняется на бланке ГОЗНАКа и заверен мокрыми печатями, штампами, подписями. Документ способен пройти любые проверки, даже при помощи специального оборудования. Достигайте своих целей максимально быстро с нашей компанией- [url=http://nyumbanirealtygroup.com/author/fannygaines12/]nyumbanirealtygroup.com/author/fannygaines12[/url]
Jariorsbx
17 Sep 25 at 8:11 am
согласование проекта перепланировки нежилого помещения [url=http://pereplanirovka-nezhilogo-pomeshcheniya3.ru/]http://pereplanirovka-nezhilogo-pomeshcheniya3.ru/[/url] .
pereplanirovka nejilogo pomesheniya_mhsa
17 Sep 25 at 8:12 am
купить диплом о высшем образовании в украине [url=http://educ-ua20.ru]купить диплом о высшем образовании в украине[/url] .
Diplomi_nhEn
17 Sep 25 at 8:12 am
советские фильмы смотреть онлайн бесплатно [url=www.kinogo-11.top]www.kinogo-11.top[/url] .
kinogo_ryMa
17 Sep 25 at 8:12 am
диплом внесенный в реестр купить [url=www.makeagif.com/user/vadyymemelnvv/]диплом внесенный в реестр купить[/url] .
Priobresti diplom o visshem obrazovanii!_xqkt
17 Sep 25 at 8:12 am
купить диплом магистра украины [url=http://educ-ua5.ru]купить диплом магистра украины[/url] .
Diplomi_fyKl
17 Sep 25 at 8:13 am
порядок согласования перепланировки нежилого помещения [url=http://pereplanirovka-nezhilogo-pomeshcheniya.ru]http://pereplanirovka-nezhilogo-pomeshcheniya.ru[/url] .
pereplanirovka nejilogo pomesheniya_ofKn
17 Sep 25 at 8:14 am
bs2best at, bs2web at и bs2 market: глубокий анализ технологий 2025 года
blsp at
bs2best.at blacksprut marketplace Official
CharlesNarry
17 Sep 25 at 8:14 am
купить диплом училища в киеве [url=https://educ-ua17.ru/]купить диплом училища в киеве[/url] .
Diplomi_xwSl
17 Sep 25 at 8:14 am
whoah this weblog is wonderful i like studying your posts. Keep up the great work! You recognize, a lot of individuals are hunting round for this info, you can help them greatly.
Razed Australia
LhaneDrync
17 Sep 25 at 8:15 am
купить дипломы вуза о высшем образовании [url=http://www.educ-ua2.ru]купить дипломы вуза о высшем образовании[/url] .
Diplomi_lsOt
17 Sep 25 at 8:15 am
Купить диплом техникума в Винница [url=www.educ-ua7.ru/]Купить диплом техникума в Винница[/url] .
Diplomi_sxEr
17 Sep 25 at 8:15 am
купить аттестат 11 класс чебоксары [url=http://arus-diplom25.ru/]купить аттестат 11 класс чебоксары[/url] .
Diplomi_lyot
17 Sep 25 at 8:16 am
купить легально диплом [url=https://educ-ua13.ru/]купить легально диплом[/url] .
Diplomi_eupn
17 Sep 25 at 8:16 am
купить диплом университета с занесением в реестр [url=https://arus-diplom34.ru/]купить диплом университета с занесением в реестр[/url] .
Diplomi_oter
17 Sep 25 at 8:16 am
согласование проекта перепланировки нежилого помещения [url=https://www.pereplanirovka-nezhilogo-pomeshcheniya1.ru]https://www.pereplanirovka-nezhilogo-pomeshcheniya1.ru[/url] .
pereplanirovka nejilogo pomesheniya_ixsi
17 Sep 25 at 8:16 am