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://www.frei-diplom7.ru]купить диплом техникума чистый[/url] .
Diplomi_kdei
23 Oct 25 at 2:05 am
Thanks for some other informative site. Where else may
I am getting that kind of information written in such a perfect approach?
I’ve a challenge that I am simply now operating on, and I have been on the look out for such
info.
Yupoo Balenciaga
23 Oct 25 at 2:06 am
где купить диплом о среднем образование [url=www.rudik-diplom12.ru]где купить диплом о среднем образование[/url] .
Diplomi_ysPi
23 Oct 25 at 2:07 am
виды технического перевода [url=www.dzen.ru/a/aPFFa3ZMdGVq1wVQ]www.dzen.ru/a/aPFFa3ZMdGVq1wVQ[/url] .
Tehnicheskii perevod_lrml
23 Oct 25 at 2:07 am
перевод медицинских документов [url=telegra.ph/Medicinskij-perevod-tochnost-kak-vopros-zhizni-i-zdorovya-10-16]telegra.ph/Medicinskij-perevod-tochnost-kak-vopros-zhizni-i-zdorovya-10-16[/url] .
Medicinskii perevod_rxEr
23 Oct 25 at 2:08 am
Если вы или ваш близкий нуждаетесь в профессиональной помощи при запое, клиника «Детокс» в Краснодаре предлагает услугу вызова нарколога на дом. Врач приедет в течение 1–2 часов, проведёт необходимое обследование и назначит лечение. Услуга доступна круглосуточно и анонимно.
Получить дополнительную информацию – [url=https://narkolog-na-dom-krasnodar25.ru/]вызвать врача нарколога на дом[/url]
AndrewENlit
23 Oct 25 at 2:08 am
Не поняла?
Закладки тут – купить гашиш, мефедрон, альфа-пвп
Пару строк отписал паронойный напряг бы снял да дальше работал…
Thomasneump
23 Oct 25 at 2:09 am
Если вы или ваш близкий нуждаетесь в профессиональной помощи при запое, клиника «Детокс» в Сочи предлагает вывод из запоя в стационаре. Под наблюдением опытных врачей пациент получит необходимую медицинскую помощь и поддержку. Услуга доступна круглосуточно, анонимно и начинается от 2000 ?.
Детальнее – [url=https://vyvod-iz-zapoya-sochi24.ru/]вывод из запоя круглосуточно в сочи[/url]
ClintonEmpib
23 Oct 25 at 2:10 am
В Краснодаре клиника «Детокс» предоставляет услугу вызова нарколога на дом. Специалисты приедут к вам в течение 1–2 часов, проведут осмотр и назначат необходимое лечение. Все процедуры проводятся анонимно и с соблюдением конфиденциальности.
Разобраться лучше – [url=https://narkolog-na-dom-krasnodar27.ru/]вызов нарколога на дом[/url]
Davidles
23 Oct 25 at 2:10 am
виступ на відкритті меморіальної дошки
JessieVinge
23 Oct 25 at 2:11 am
74364.pw – Useful guides here; saved two posts for reference this weekend.
Dillon Pargo
23 Oct 25 at 2:11 am
В обзоре возможностей для игроков мы подробно разбираем типы бонусов, включая фрибеты и депозитные поощрения; в середине материала приведена ссылка на 1xBet промокод на сегодня, который может и помочь новым пользователям при регистрации. Кроме того, даём советы по безопасности и ответственному подходу к ставкам.
Anthonykit
23 Oct 25 at 2:12 am
виды технического перевода [url=http://dzen.ru/a/aPFFa3ZMdGVq1wVQ]http://dzen.ru/a/aPFFa3ZMdGVq1wVQ[/url] .
Tehnicheskii perevod_drml
23 Oct 25 at 2:14 am
медицинский перевод на английский [url=www.telegra.ph/Medicinskij-perevod-tochnost-kak-vopros-zhizni-i-zdorovya-10-16]www.telegra.ph/Medicinskij-perevod-tochnost-kak-vopros-zhizni-i-zdorovya-10-16[/url] .
Medicinskii perevod_ouEr
23 Oct 25 at 2:14 am
It’s appropriate time to make some plans for the future
and it’s time to be happy. I have learn this publish and if I may just I wish to
recommend you few fascinating issues or tips.
Perhaps you could write next articles regarding this article.
I desire to read more things approximately it!
Dravixen
23 Oct 25 at 2:17 am
где можно купить диплом техникума в челябинске [url=https://www.frei-diplom7.ru]где можно купить диплом техникума в челябинске[/url] .
Diplomi_mpei
23 Oct 25 at 2:19 am
Refresh Renovation Southwest Charlotte
1251 Arrow Pine Ɗr c121,
Charlotte, NC 28273, United Ѕtates
+19803517882
With home start project your renovations refresh
With home start project your renovations refresh
23 Oct 25 at 2:20 am
бюро переводов в Москве [url=teletype.in/@alexd78/HN462R01hzy]teletype.in/@alexd78/HN462R01hzy[/url] .
Vidi perevodov v buro Perevod i Pravo_nost
23 Oct 25 at 2:21 am
Клиника «Похмельная служба» в Нижнем Новгороде предлагает капельницу от запоя с выездом на дом. Наши специалисты обеспечат вам комфортное и безопасное лечение в привычной обстановке.
Разобраться лучше – [url=https://vyvod-iz-zapoya-nizhnij-novgorod13.ru/]вывод из запоя в стационаре[/url]
DarrellUnsug
23 Oct 25 at 2:22 am
техническое задание перевод [url=http://teletype.in/@alexd78/HN462R01hzy/]http://teletype.in/@alexd78/HN462R01hzy/[/url] .
Vidi perevodov v buro Perevod i Pravo_zist
23 Oct 25 at 2:24 am
технический перевод требования [url=https://dzen.ru/a/aPFFa3ZMdGVq1wVQ/]https://dzen.ru/a/aPFFa3ZMdGVq1wVQ/[/url] .
Tehnicheskii perevod_usml
23 Oct 25 at 2:24 am
требования медицинского перевода [url=www.telegra.ph/Medicinskij-perevod-tochnost-kak-vopros-zhizni-i-zdorovya-10-16/]www.telegra.ph/Medicinskij-perevod-tochnost-kak-vopros-zhizni-i-zdorovya-10-16/[/url] .
Medicinskii perevod_zlEr
23 Oct 25 at 2:25 am
купить диплом бурильщика [url=http://rudik-diplom12.ru]http://rudik-diplom12.ru[/url] .
Diplomi_vvPi
23 Oct 25 at 2:26 am
медицинский технический перевод [url=https://teletype.in/@alexd78/HN462R01hzy/]teletype.in/@alexd78/HN462R01hzy[/url] .
Vidi perevodov v buro Perevod i Pravo_efst
23 Oct 25 at 2:33 am
Вывод из запоя в Самаре на базе стационара — когда важен результат, стабильность и медицинская поддержка 24/7.
Изучить вопрос глубже – [url=https://vyvod-iz-zapoya-v-stacionare-samara23.ru/]быстрый вывод из запоя в стационаре[/url]
DannyPowly
23 Oct 25 at 2:33 am
coatsjps.pw – The color palette is calm and well balanced, very easy on the eyes.
Marylouise Kretschmer
23 Oct 25 at 2:33 am
wqpyp.pw – I found some good content here, easy to read and nicely structured.
Shauna Soltero
23 Oct 25 at 2:33 am
diwang2.pw – Pages load fast, giving a pleasant browsing experience throughout.
Sarai Wengert
23 Oct 25 at 2:35 am
Клиника «Детокс» в Сочи предлагает услугу вывода из запоя в стационаре. Под наблюдением профессиональных врачей пациент получит необходимую медицинскую помощь и поддержку. Услуга доступна круглосуточно, анонимно и начинается от 2000 ?.
Ознакомиться с деталями – [url=https://vyvod-iz-zapoya-sochi24.ru/]помощь вывод из запоя в сочи[/url]
ClintonEmpib
23 Oct 25 at 2:36 am
технический английский перевод [url=dzen.ru/a/aPFFa3ZMdGVq1wVQ]dzen.ru/a/aPFFa3ZMdGVq1wVQ[/url] .
Tehnicheskii perevod_mrml
23 Oct 25 at 2:36 am
медицинский перевод [url=https://telegra.ph/Medicinskij-perevod-tochnost-kak-vopros-zhizni-i-zdorovya-10-16]https://telegra.ph/Medicinskij-perevod-tochnost-kak-vopros-zhizni-i-zdorovya-10-16[/url] .
Medicinskii perevod_hrEr
23 Oct 25 at 2:37 am
купить диплом техникума в череповце [url=http://frei-diplom7.ru/]купить диплом техникума в череповце[/url] .
Diplomi_igei
23 Oct 25 at 2:38 am
It’s impressive that you are getting thoughts from this article
as well as from our discussion made at this time.
roofers near me
23 Oct 25 at 2:39 am
Где купить Лирику в Марьянскае?Привет всем, ищу проверенный магазин – нашел https://domodedovobt.ru
. Цены нормальные, курьерская доставка. Кто-нибудь знаком их услугами? Как с качеством?
Stevenref
23 Oct 25 at 2:39 am
Одним из самых привлекательных аспектов вызова нарколога на дом является гибкость. Вы можете согласовать время визита врача, подходящее именно для вас, включая вечернее или ночное время. Это позволяет совмещать лечение с работой и личными делами, не нарушая привычный ритм жизни.
Подробнее можно узнать тут – [url=https://narcolog-na-dom-moskva55.ru/]нарколог на дом круглосуточно цены москва[/url]
Bretttah
23 Oct 25 at 2:39 am
Круглосуточный стационарный вывод из запоя в Воронеже — доступная помощь в любое время. Вы можете обратиться к нам в любое время суток, и мы окажем необходимую медицинскую помощь.
Подробнее можно узнать тут – [url=https://vyvod-iz-zapoya-v-stacionare-voronezh23.ru/]наркология вывод из запоя в стационаре в воронеже[/url]
Charlesomido
23 Oct 25 at 2:41 am
медицинский перевод [url=http://www.teletype.in/@alexd78/HN462R01hzy]http://www.teletype.in/@alexd78/HN462R01hzy[/url] .
Vidi perevodov v buro Perevod i Pravo_prst
23 Oct 25 at 2:42 am
one x bet [url=https://1xbet-giris-5.com]https://1xbet-giris-5.com[/url] .
1xbet giris_pxSa
23 Oct 25 at 2:42 am
технический перевод в металлургии [url=http://dzen.ru/a/aPFFa3ZMdGVq1wVQ/]http://dzen.ru/a/aPFFa3ZMdGVq1wVQ/[/url] .
Tehnicheskii perevod_pjml
23 Oct 25 at 2:44 am
We absolutely love your blog and find most of your
post’s to be just what I’m looking for. Would you offer guest writers to write
content to suit your needs? I wouldn’t mind writing
a post or elaborating on most of the subjects you write in relation to here.
Again, awesome weblog!
خرید سی پی
23 Oct 25 at 2:45 am
медицинский перевод на английский [url=www.telegra.ph/Medicinskij-perevod-tochnost-kak-vopros-zhizni-i-zdorovya-10-16]www.telegra.ph/Medicinskij-perevod-tochnost-kak-vopros-zhizni-i-zdorovya-10-16[/url] .
Medicinskii perevod_wqEr
23 Oct 25 at 2:45 am
вопросы юридического перевода [url=http://teletype.in/@alexd78/HN462R01hzy/]http://teletype.in/@alexd78/HN462R01hzy/[/url] .
Vidi perevodov v buro Perevod i Pravo_zsst
23 Oct 25 at 2:50 am
Капельница от запоя на дому в Нижнем Новгороде — удобное решение для тех, кто не может посетить клинику. Наши специалисты приедут к вам домой и проведут необходимую процедуру.
Получить дополнительные сведения – [url=https://vyvod-iz-zapoya-nizhnij-novgorod13.ru/]вывод из запоя круглосуточно[/url]
DarrellUnsug
23 Oct 25 at 2:51 am
технический перевод это [url=https://dzen.ru/a/aPFFa3ZMdGVq1wVQ/]https://dzen.ru/a/aPFFa3ZMdGVq1wVQ/[/url] .
Tehnicheskii perevod_blml
23 Oct 25 at 2:54 am
медицинский перевод справок [url=https://telegra.ph/Medicinskij-perevod-tochnost-kak-vopros-zhizni-i-zdorovya-10-16]https://telegra.ph/Medicinskij-perevod-tochnost-kak-vopros-zhizni-i-zdorovya-10-16[/url] .
Medicinskii perevod_udEr
23 Oct 25 at 2:55 am
I have read some just right stuff here. Certainly value bookmarking for
revisiting. I surprise how a lot attempt you place to make any such excellent informative site.
sports jerseys
23 Oct 25 at 2:57 am
медицинский технический перевод [url=www.teletype.in/@alexd78/HN462R01hzy]www.teletype.in/@alexd78/HN462R01hzy[/url] .
Vidi perevodov v buro Perevod i Pravo_kyst
23 Oct 25 at 2:58 am
Госпитализация в стационаре «Частного Медика 24» позволяет стабилизировать состояние, снять интоксикацию и начать новую жизнь.
Ознакомиться с деталями – [url=https://vyvod-iz-zapoya-v-stacionare-samara23.ru/]нарколог вывод из запоя в стационаре[/url]
DannyPowly
23 Oct 25 at 2:58 am
юридический перевод [url=http://teletype.in/@alexd78/HN462R01hzy]http://teletype.in/@alexd78/HN462R01hzy[/url] .
Vidi perevodov v buro Perevod i Pravo_kyst
23 Oct 25 at 3:00 am
1xbet giri? 2025 [url=1xbet-giris-2.com]1xbet-giris-2.com[/url] .
1xbet giris_qrPt
23 Oct 25 at 3:00 am