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!
As the admin of this web page is working, no hesitation very soon it will be well-known, due to its feature contents.
index
15 Sep 25 at 9:44 am
Greetings, I do believe your blog might be having web browser compatibility issues.
When I look at your website in Safari, it looks fine however, if opening in IE, it has some overlapping issues.
I simply wanted to provide you with a quick heads up! Other than that,
wonderful site!
hat hub script grow a garden
15 Sep 25 at 9:44 am
Портал для женщин https://womanfashionista.com всё самое важное в одном месте: уход за собой, мода, дом, семья и карьера. Читайте полезные статьи, находите вдохновение и делитесь опытом.
MatthewTok
15 Sep 25 at 9:45 am
Портал для женщин https://womanfashionista.com всё самое важное в одном месте: уход за собой, мода, дом, семья и карьера. Читайте полезные статьи, находите вдохновение и делитесь опытом.
MatthewTok
15 Sep 25 at 9:48 am
Статья (где продать скины) даёт читателям конкретные советы по выбору площадки для продажи скинов, рекомендует создавать аккаунты на нескольких сервисах ради наиболее выгодных условий и предупреждает о необходимости изучить комиссионную политику каждой платформы перед продажей. Информация структурирована так, чтобы облегчить выбор и сделать процесс безопасным и максимально удобным независимо от региона проживания пользователя.
RomanNam
15 Sep 25 at 9:48 am
Портал для женщин https://womanfashionista.com всё самое важное в одном месте: уход за собой, мода, дом, семья и карьера. Читайте полезные статьи, находите вдохновение и делитесь опытом.
MatthewTok
15 Sep 25 at 9:49 am
сколько стоит купить диплом в одессе [url=www.educ-ua2.ru/]сколько стоит купить диплом в одессе[/url] .
Diplomi_hhOt
15 Sep 25 at 9:50 am
Эта публикация завернет вас в вихрь увлекательного контента, сбрасывая стереотипы и открывая двери к новым идеям. Каждый абзац станет для вас открытием, полным ярких примеров и впечатляющих достижений. Подготовьтесь быть вовлеченными и удивленными каждый раз, когда продолжите читать.
Что ещё нужно знать? – https://equity-voice.com/elections-2017-what-is-the-disability-agenda
Williamaculp
15 Sep 25 at 9:54 am
Thanks to my father who told me on the topic of this blog, this website
is in fact remarkable.
canadian pharmaceuticals online
15 Sep 25 at 9:54 am
KidsFilmFestival.ru — это пространство для любителей кино и сериалов, где обсуждаются свежие премьеры, яркие образы и современные тенденции. На сайте собраны рецензии, статьи и аналитика, отражающие актуальные темы — от культурной идентичности и социальных вопросов до вдохновения и поиска гармонии. Здесь кино становится зеркалом общества, а каждая история открывает новые грани человеческого опыта.
Zonenbit
15 Sep 25 at 9:54 am
автоматические гардины для штор [url=http://elektrokarniz-cena.ru/]автоматические гардины для штор[/url] .
elektrokarniz cena_mrPL
15 Sep 25 at 9:55 am
мостбет официальный сайт вход [url=mostbet12011.ru]mostbet12011.ru[/url]
mostbet_raOt
15 Sep 25 at 9:55 am
купить диплом украины цена [url=http://educ-ua5.ru/]купить диплом украины цена[/url] .
Diplomi_gkKl
15 Sep 25 at 9:58 am
электрокарниз недорого [url=elektro-karniz77.ru]elektro-karniz77.ru[/url] .
elektro karniz_ypSl
15 Sep 25 at 10:00 am
You can definitely see your enthusiasm within the work you write.
The sector hopes for more passionate writers like you who
aren’t afraid to mention how they believe. Always go after your heart.
13WIN
15 Sep 25 at 10:01 am
Онлайн-казино Vavada знаменито бонусами.
Бездепы и промокоды дают шанс начать бесплатно.
Соревнования делают процесс азартным.
Ассортимент слотов поддерживается провайдерами.
Создать аккаунт легко, поэтому можно сразу активировать промо.
Узнай больше по ссылке: https://hinterlandmn.com
WilliamVaw
15 Sep 25 at 10:01 am
электрокарнизы для штор купить [url=https://karniz-s-elektroprivodom.ru/]электрокарнизы для штор купить[/url] .
karniz s elektroprivodom_ikKt
15 Sep 25 at 10:02 am
Сайт детского сада https://malush16.ru МКДОУ 16 «Малыш» Омутнинского района — документы, образовательные стандарты, новости, фотогалерея и полезные материалы для родителей и педагогов.
Jamesseath
15 Sep 25 at 10:02 am
Hey there! This is kind of off topic but I need some
guidance from an established blog. Is it difficult to set up your own blog?
I’m not very techincal but I can figure things out pretty fast.
I’m thinking about creating my own but I’m not sure where to start.
Do you have any points or suggestions? Cheers
Shift Kantrex
15 Sep 25 at 10:02 am
карнизы с электроприводом [url=avtomaticheskie-karnizy.ru]карнизы с электроприводом[/url] .
avtomaticheskie karnizi_dzSa
15 Sep 25 at 10:02 am
Сайт детского сада https://malush16.ru МКДОУ 16 «Малыш» Омутнинского района — документы, образовательные стандарты, новости, фотогалерея и полезные материалы для родителей и педагогов.
Jamesseath
15 Sep 25 at 10:04 am
Сайт детского сада https://malush16.ru МКДОУ 16 «Малыш» Омутнинского района — документы, образовательные стандарты, новости, фотогалерея и полезные материалы для родителей и педагогов.
Jamesseath
15 Sep 25 at 10:06 am
электрокарниз недорого [url=http://elektro-karniz77.ru/]http://elektro-karniz77.ru/[/url] .
elektro karniz_nuSl
15 Sep 25 at 10:06 am
canadian pharmacy world: canadian pharmacy – real canadian pharmacy
Teddyroowl
15 Sep 25 at 10:08 am
электрокарнизы для штор [url=http://avtomaticheskie-karnizy.ru]электрокарнизы для штор[/url] .
avtomaticheskie karnizi_otSa
15 Sep 25 at 10:08 am
http://truenorthpharm.com/# TrueNorth Pharm
JeremyBip
15 Sep 25 at 10:09 am
Ahaa, its good discussion about this piece of writing here at this weblog, I have read all that,
so now me also commenting here.
Almax Capital
15 Sep 25 at 10:09 am
Купить диплом техникума в Запорожье [url=http://educ-ua10.ru]Купить диплом техникума в Запорожье[/url] .
Diplomi_cdKl
15 Sep 25 at 10:11 am
электрокарниз [url=https://elektro-karniz77.ru]электрокарниз[/url] .
elektro karniz_bnSl
15 Sep 25 at 10:11 am
After I originally left a comment I seem to have
clicked the -Notify me when new comments are added- checkbox and from now on whenever a
comment is added I receive four emails with the exact same comment.
Perhaps there is a means you can remove me from that
service? Kudos!
SAOBET
15 Sep 25 at 10:12 am
электрические гардины для штор [url=www.avtomaticheskie-karnizy.ru]www.avtomaticheskie-karnizy.ru[/url] .
avtomaticheskie karnizi_sjSa
15 Sep 25 at 10:13 am
bitácora de Ecuador
bitácora de Ecuador
15 Sep 25 at 10:14 am
where can i get glycomet without insurance
can i get generic glycomet prices
15 Sep 25 at 10:14 am
I visited various web sites but the audio quality for audio songs current at this
site is in fact superb.
скачать Селектор казино
15 Sep 25 at 10:19 am
карниз моторизованный [url=https://elektrokarniz-cena.ru]https://elektrokarniz-cena.ru[/url] .
elektrokarniz cena_gsPL
15 Sep 25 at 10:20 am
купить диплом с занесением в реестр украина [url=http://www.arus-diplom31.ru]http://www.arus-diplom31.ru[/url] .
Zakazat diplom o visshem obrazovanii!_cxOl
15 Sep 25 at 10:21 am
ОТКАПЫВАНИЕ НА ДОМУ: РЕКОМЕНДАЦИИ Открытие участка для благоустройства – это ключевой этап домашнего проекта. Откапывание‚ или земляные работы‚ включает в себя множество задач‚ таких как копка ямы для фундамента‚ дренажные системы и водопроводные работы. Верный выбор инструментов для копки и аренда оборудования помогут упростить процессы. Работы по благоустройству сада требуют внимательного планирования. Уход за участком‚ особенно в периодические работы в саду‚ поможет сохранить красоту ландшафта. Не забудьте учесть ландшафтный дизайн‚ который может включать в себя элементы‚ требующие земляных работ. Обратите внимание на советы по копке: выбирайте подходящие инструменты‚ следите за безопасностью и учитывайте тип почвы. Профессиональные земельные услуги могут помочь с профессиональным выполнением работ. Заходите на vivod-iz-zapoya-krasnoyarsk014.ru для получения дополнительной информации и услуг.
zapojkrasnoyarskNeT
15 Sep 25 at 10:21 am
гардина с электроприводом [url=www.elektrokarniz-cena.ru]гардина с электроприводом[/url] .
elektrokarniz cena_lyPL
15 Sep 25 at 10:26 am
скачать мостбет официальный [url=http://mostbet12010.ru]http://mostbet12010.ru[/url]
mostbet_avPt
15 Sep 25 at 10:27 am
mostbet mobile [url=http://mostbet12012.ru]http://mostbet12012.ru[/url]
mostbet_xxSl
15 Sep 25 at 10:31 am
электрокарнизы для штор купить в москве [url=www.elektrokarniz-cena.ru]электрокарнизы для штор купить в москве[/url] .
elektrokarniz cena_hePL
15 Sep 25 at 10:31 am
карниз для штор электрический [url=https://elektro-karniz77.ru/]https://elektro-karniz77.ru/[/url] .
elektro karniz_npSl
15 Sep 25 at 10:32 am
как потратить бонусный счет в 1win [url=www.1win12012.ru]www.1win12012.ru[/url]
1win_ygmr
15 Sep 25 at 10:33 am
электрокарнизы для штор купить [url=avtomaticheskie-karnizy.ru]avtomaticheskie-karnizy.ru[/url] .
avtomaticheskie karnizi_fcSa
15 Sep 25 at 10:33 am
регистрация мостбет [url=www.mostbet12011.ru]www.mostbet12011.ru[/url]
mostbet_qxOt
15 Sep 25 at 10:34 am
Посетите сайт https://psyhologi.pro/ и вы получите возможность освоить востребованную профессию, такую как психолог-консультант. Мы предлагаем курсы профессиональной переподготовки на психолога с дистанционным обучением. Узнайте больше на сайте что это за профессия, модули обучения и наших практиков и куратора курса.
BekalhWaink
15 Sep 25 at 10:36 am
карниз с приводом для штор [url=https://www.elektro-karniz77.ru]https://www.elektro-karniz77.ru[/url] .
elektro karniz_seSl
15 Sep 25 at 10:36 am
карнизы с электроприводом купить [url=https://avtomaticheskie-karnizy.ru]https://avtomaticheskie-karnizy.ru[/url] .
avtomaticheskie karnizi_zaSa
15 Sep 25 at 10:37 am
Medicine information for patients. Long-Term Effects.
where to buy mobic tablets
Everything information about meds. Get now.
where to buy mobic tablets
15 Sep 25 at 10:37 am
I really like it when folks get together and share opinions.
Great website, keep it up!
real money online casinos
15 Sep 25 at 10:38 am