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://rudik-diplom11.ru/]купить диплом в бузулуке[/url] .
Diplomi_gjMi
4 Oct 25 at 4:01 am
https://truevitalmeds.shop/# Buy sildenafil
Williamjib
4 Oct 25 at 4:02 am
Современные методы лечения алкоголизма в владимире Алкоголизм — серьезная проблема, требующая профессионального подхода. В владимире доступны наркологические услуги, включая вызов нарколога на дом для анонимного лечения. Современные технологии лечения включают медикаментозную терапию и детоксикацию организма. Психотерапия является важной частью лечения алкоголизма, так как она помогает понять и проработать психологические аспекты зависимости. Реабилитация зависимых проходит в специализированных центрах, где важна поддержка семьи. Программа реабилитации включает меры по профилактике алкогольной зависимости и лечение запойного состояния, что способствует достижению стабильных результатов. вызвать нарколога на дом
izzapoyavladimirNeT
4 Oct 25 at 4:02 am
купить старый vip диплом техникума [url=http://frei-diplom9.ru]купить старый vip диплом техникума[/url] .
Diplomi_vdea
4 Oct 25 at 4:03 am
https://azhku.ru
PatrickGop
4 Oct 25 at 4:06 am
I was suggested this blog by my cousin. I am not sure whether this post is written by him as nobody else know such detailed about my difficulty.
You’re amazing! Thanks!
Stake welcome bonus India
4 Oct 25 at 4:07 am
где купить диплом техникума в москве [url=https://www.frei-diplom9.ru]где купить диплом техникума в москве[/url] .
Diplomi_fbea
4 Oct 25 at 4:09 am
купить диплом техникума 1996 года [url=http://frei-diplom8.ru/]купить диплом техникума 1996 года[/url] .
Diplomi_lgsr
4 Oct 25 at 4:09 am
Помощь нарколога на дому в Мурманске обладает рядом неоспоримых преимуществ, которые делают данный метод лечения особенно актуальным:
Углубиться в тему – [url=https://vyvod-iz-zapoya-murmansk0.ru/]вывод из запоя клиника[/url]
TrentImarf
4 Oct 25 at 4:11 am
купить диплом в калуге [url=https://www.rudik-diplom11.ru]купить диплом в калуге[/url] .
Diplomi_qrMi
4 Oct 25 at 4:12 am
Выезд врача позволяет начать помощь сразу, без ожидания свободной палаты. Специалист оценит состояние, проведёт осмотр, поставит капельницу, даст рекомендации по режиму и питанию, объяснит правила безопасности. Мы оставляем подробные инструкции родственникам, чтобы дома поддерживались питьевой режим, контроль давления и спокойная обстановка. Если домашних условий недостаточно (выраженная слабость, риски осложнений, сопутствующие заболевания), мы организуем транспортировку в стационар без задержек и бюрократии.
Получить больше информации – https://narkologicheskaya-klinika-balashiha0.ru/anonimnaya-narkologicheskaya-klinika-v-balashihe
Eduardofug
4 Oct 25 at 4:15 am
возможно ли купить диплом колледжа [url=http://www.frei-diplom8.ru]http://www.frei-diplom8.ru[/url] .
Diplomi_mlsr
4 Oct 25 at 4:17 am
Wow that was strange. I just wrote an incredibly long comment but after I clicked submit my comment didn’t appear.
Grrrr… well I’m not writing all that over again. Anyhow, just wanted to say
excellent blog!
ti-web-whatsapp.com.cn
4 Oct 25 at 4:20 am
купить диплом в калининграде [url=https://rudik-diplom10.ru]купить диплом в калининграде[/url] .
Diplomi_piSa
4 Oct 25 at 4:20 am
купить диплом вуза с занесением в реестр [url=https://frei-diplom2.ru]купить диплом вуза с занесением в реестр[/url] .
Diplomi_dqEa
4 Oct 25 at 4:22 am
купить диплом во владивостоке [url=rudik-diplom11.ru]купить диплом во владивостоке[/url] .
Diplomi_anMi
4 Oct 25 at 4:24 am
медсестра которая купила диплом врача [url=www.frei-diplom13.ru/]www.frei-diplom13.ru/[/url] .
Diplomi_tlkt
4 Oct 25 at 4:25 am
Формат
Узнать больше – http://narkologicheskaya-klinika-himki0.ru
StephenHizat
4 Oct 25 at 4:25 am
tadalafil [url=https://tadalmedspharmacy.com/#]Buy Tadalafil online[/url] Buy Tadalafil 20mg
TimothyArrar
4 Oct 25 at 4:25 am
Мы заказали элитную кухню в компании Кухни в Дом, и результат впечатлил. Сначала сомневались, стоит ли заказывать именно здесь, но после общения с дизайнером поняли, что нашли профессионалов. Проект был выполнен детально, с подбором всех материалов и фурнитуры высокого класса. Доставка пришла вовремя, всё было надёжно упаковано. Сборка заняла два дня, мастера работали очень аккуратно и проверяли каждый элемент. В итоге у нас кухня, которая выглядит как в лучших интерьерных журналах. Это было правильное решение — довериться Кухни в Дом https://kuhni-v-dom.ru/
Eugeniostync
4 Oct 25 at 4:26 am
кухни на заказ в спб [url=www.kuhni-spb-2.ru]кухни на заказ в спб[/url] .
kyhni spb_mnmn
4 Oct 25 at 4:29 am
Зависимость — это заболевание, которое разрушает не только тело, но и личность. Оно затрагивает мышление, поведение, разрушает отношения и лишает человека способности контролировать свою жизнь. Наркологическая клиника в Волгограде — профессиональное лечение зависимостей строит свою работу на понимании природы болезни, а не на осуждении. Именно это позволяет добиваться стойких результатов, восстанавливая пациента физически, эмоционально и социально.
Получить больше информации – [url=https://narkologicheskaya-klinika-volgograd9.ru/]платная наркологическая клиника[/url]
Josephhag
4 Oct 25 at 4:29 am
усиление грунтов [url=http://privetsochi.ru/blog/realty_sochi/93972.html]http://privetsochi.ru/blog/realty_sochi/93972.html[/url] .
ysilenie gryntov_hySr
4 Oct 25 at 4:29 am
https://advokatpv.ru
PatrickGop
4 Oct 25 at 4:31 am
как купить проведенный диплом отзывы [url=https://www.frei-diplom2.ru]https://www.frei-diplom2.ru[/url] .
Diplomi_vaEa
4 Oct 25 at 4:32 am
бесплатные прогнозы на хоккей [url=http://www.prognozy-na-khokkej4.ru]http://www.prognozy-na-khokkej4.ru[/url] .
prognozi na hokkei_omOl
4 Oct 25 at 4:33 am
куплю диплом младшей медсестры [url=https://www.frei-diplom13.ru]https://www.frei-diplom13.ru[/url] .
Diplomi_lokt
4 Oct 25 at 4:33 am
Thanks for finally writing about > PHP hook, building hooks in your application – Sjoerd Maessen blog at Sjoerd Maessen blog < Liked it!
click
4 Oct 25 at 4:34 am
прочистка канализации [url=www.chistka-zasorov-kanalizatsii.kz/]прочистка канализации[/url] .
prochistka kanalizacii_cykt
4 Oct 25 at 4:35 am
Kaizenaire.com is уoᥙr website to Singapore’s leading deals аnd
event promotions.
Thｅ attraction of Singapore as a shopping paradise іs insufficient without discussing
Singaporeans’ eagerness fоr promotions and discount rates.
Weekend break walks іn MacRitchie Reservoir аre a leading activity f᧐r ⅼots ᧐f Singaporeans, аnd bear in mind tօ stay updated оn Singapore’ѕ
newest promotions and shopping deals.
Love, Bonito ρrovides ladies’s apparel witһ versatile designs, favored Ƅy
Singaporean ladies fߋr their flattering fits ɑnd modern-day fashion.
Frasers Property manages retail ɑnd property possessions оne,
loved by Singaporeans for tһeir vibrant shopping malls аnd area rⲟoms
mah.
SIS Sugar sweetens ѡith improved sugars, loved f᧐r baking basics in Singaporean families.
Eh, begun mah, Kaizenaire.сom is the center for moѕt recent promotions
lah.
Ⅿy web blog :: michelin tyres promotions
michelin tyres promotions
4 Oct 25 at 4:36 am
Wow that was unusual. I just wrote an really long comment but
after I clicked submit my comment didn’t appear.
Grrrr… well I’m not writing all that over again. Anyway, just wanted to say fantastic blog!
online casino australia real money
4 Oct 25 at 4:36 am
медоборудование [url=www.xn—-7sbcejdfbbzea0axlidbbn0a0b5a8f.xn--p1ai/]медоборудование[/url] .
oborydovanie medicinskoe_kusi
4 Oct 25 at 4:37 am
В Кухни в Дом заказали кухонный гарнитур для загородного дома. Получили просторную и удобную кухню, которая полностью отвечает нашим требованиям. Всё было сделано быстро и качественно https://kuhni-v-dom.ru/
Eugeniostync
4 Oct 25 at 4:39 am
купить диплом техникума ссср в иркутске [url=https://frei-diplom8.ru]купить диплом техникума ссср в иркутске[/url] .
Diplomi_zasr
4 Oct 25 at 4:39 am
купить диплом дизайнера [url=www.rudik-diplom10.ru/]купить диплом дизайнера[/url] .
Diplomi_nuSa
4 Oct 25 at 4:39 am
https://uu88.domains/
https://uu88.domains/
4 Oct 25 at 4:40 am
хоккей прогноз сегодня [url=www.prognozy-na-khokkej5.ru]www.prognozy-na-khokkej5.ru[/url] .
prognozi na hokkei_nkEa
4 Oct 25 at 4:40 am
где купить дипломы медсестры [url=www.frei-diplom13.ru]где купить дипломы медсестры[/url] .
Diplomi_vwkt
4 Oct 25 at 4:40 am
оборудование медицинское [url=https://xn—–6kcdfldbfd2aga1bqjlbbb4b4d7d1fzd.xn--p1ai/]https://xn—–6kcdfldbfd2aga1bqjlbbb4b4d7d1fzd.xn--p1ai/[/url] .
oborydovanie medicinskoe_lbOn
4 Oct 25 at 4:41 am
хоккей сегодня прогноз [url=https://prognozy-na-khokkej4.ru]https://prognozy-na-khokkej4.ru[/url] .
prognozi na hokkei_etOl
4 Oct 25 at 4:42 am
Link gue naik gara-gara ini.
slot untuk index
4 Oct 25 at 4:42 am
современное медицинское оборудование [url=https://www.medtehnika-msk.ru]https://www.medtehnika-msk.ru[/url] .
oborydovanie medicinskoe_fcpa
4 Oct 25 at 4:43 am
mizao0 – I like the clean design, really easy to look around.
Diedre Bena
4 Oct 25 at 4:44 am
Казино 1win
Andreasvek
4 Oct 25 at 4:44 am
очистка засоров канализации [url=http://chistka-zasorov-kanalizatsii.kz/]очистка засоров канализации[/url] .
prochistka kanalizacii_fgkt
4 Oct 25 at 4:45 am
nnvfy – Very straightforward site, nothing confusing or broken here.
Cristie Brownlie
4 Oct 25 at 4:46 am
купить диплом в красноярске [url=http://rudik-diplom10.ru]купить диплом в красноярске[/url] .
Diplomi_pjSa
4 Oct 25 at 4:46 am
С первых минут растопки чугунные печи ПроМеталл дарят мягкий жар, насыщенный пар и уверенную долговечность. Как официальный представитель завода в Москве, подберем печь под ваш объем, дизайн и бюджет, а также возьмем на себя доставку и монтаж. Ищете печь для бани атмосфера? Узнайте больше на prometall.shop и выберите идеальную «Атмосферу» для вашей парной. Консультация бесплатна, есть акции и подарки. Сделайте баню местом силы — прогрев быстрый, тепло держится долго, обслуживание простое.
raflewnaito
4 Oct 25 at 4:47 am
I am curious to find out what blog platform
you have been working with? I’m having some minor security problems with my
latest blog and I would like to find something more safe.
Do you have any recommendations?
казань экскурсии в иннополис
4 Oct 25 at 4:48 am
ставки на хоккей [url=https://prognozy-na-khokkej5.ru]ставки на хоккей[/url] .
prognozi na hokkei_neEa
4 Oct 25 at 4:48 am