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!
rozhau.ru [url=rozhau.ru]rozhau.ru[/url] .
rozhau.ru_mipt
8 Aug 25 at 1:18 pm
Fantastic website you have here but I was curious if you
knew of any user discussion forums that cover the same topics discussed in this article?
I’d really love to be a part of online community where I
can get comments from other knowledgeable people that share the same interest.
If you have any suggestions, please let me know.
Thank you!
toto slot 777
8 Aug 25 at 1:29 pm
купить рулонные шторы в москве [url=www.elektricheskie-rulonnye-shtory90.ru]купить рулонные шторы в москве[/url] .
elektricheskie rylonnie shtori_cksl
8 Aug 25 at 1:32 pm
купить аттестат 10 11 класс в красноярске [url=https://www.arus-diplom21.ru]купить аттестат 10 11 класс в красноярске[/url] .
Vigodno kypit diplom ob obrazovanii!_qypn
8 Aug 25 at 1:33 pm
электрические рулонные шторы [url=avtomaticheskie-rulonnye-shtory50.ru]электрические рулонные шторы[/url] .
avtomaticheskie rylonnie shtori_cnot
8 Aug 25 at 1:35 pm
Публикация приглашает вас исследовать неизведанное — от древних тайн до современных достижений науки. Вы узнаете, как случайные находки превращались в революции, а смелые мысли — в новые эры человеческого прогресса.
Детальнее – https://daisycounselling.com.au/image-2
Raymondgek
8 Aug 25 at 1:35 pm
Hello There. I found your blog using msn. This is a very well written article.
I’ll make sure to bookmark it and come back to read more of your
useful info. Thanks for the post. I’ll certainly comeback.
نحوه تماس با سازمان هدفمندی یارانه ها
8 Aug 25 at 1:37 pm
пластиковые окна рулонные шторы с электроприводом [url=http://rulonnye-shtory-s-elektroprivodom11.ru]http://rulonnye-shtory-s-elektroprivodom11.ru[/url] .
rylonnie shtori s elektroprivodom_cwSl
8 Aug 25 at 1:41 pm
бровист севастополь Макияж Севастополь
GeorgeSmops
8 Aug 25 at 1:44 pm
Очень рекомендую к прочтению:
Зацепил материал про reactive.su.
Вот, можете почитать:
[url=https://reactive.su]https://reactive.su[/url]
Всем мира и продуктивного дня
rusPoito
8 Aug 25 at 1:44 pm
Hey there this is kind of of off topic but I was wondering if
blogs use WYSIWYG editors or if you have to manually code
with HTML. I’m starting a blog soon but have no coding expertise so
I wanted to get guidance from someone with experience.
Any help would be greatly appreciated!
زمان برگزاری آزمون آیلتس 2025
8 Aug 25 at 1:44 pm
На сайте https://expertbp.ru/ получите абсолютно бесплатную консультацию от бюро переводов. Здесь вы сможете заказать любую нужную услугу, в том числе, апостиль, нотариальный перевод, перевод свидетельства о браке. Также доступно и срочное оказание услуги. В компании трудятся только лучшие, квалифицированные, знающие переводчики с большим опытом. Услуга будет оказана в ближайшее время. Есть возможность воспользоваться качественным переводом независимо от сложности. Все услуги оказываются по привлекательной цене.
LabejamGlame
8 Aug 25 at 1:54 pm
В этой публикации мы предлагаем подробные объяснения по актуальным вопросам, чтобы помочь читателям глубже понять их. Четкость и структурированность материала сделают его удобным для усвоения и применения в повседневной жизни.
Смотрите также… – https://osada-pachy.pl/?attachment_id=322
Jamesrhist
8 Aug 25 at 1:55 pm
https://www.rwaq.org/users/chuymarudl-20250805094010
Richardgen
8 Aug 25 at 1:58 pm
В наркологической клинике «Рестарт» используется комплексный подход к лечению абстинентного синдрома. Наши преимущества:
Получить больше информации – [url=https://snyatie-lomki-rnd7.ru/]снятие ломок на дому в краснодаре[/url]
RichardFaw
8 Aug 25 at 2:06 pm
https://freebongo.ru
JamesTer
8 Aug 25 at 2:07 pm
лечение запоя
tula-narkolog001.ru
вывод из запоя цена
izzapoyatulaNeT
8 Aug 25 at 2:09 pm
What’s up to every , since I am genuinely keen of reading this web site’s post to be updated on a regular basis.
It includes fastidious stuff.
Film restoration and enhancement
8 Aug 25 at 2:12 pm
рулонные жалюзи с электроприводом [url=https://elektricheskie-rulonnye-shtory90.ru/]рулонные жалюзи с электроприводом[/url] .
elektricheskie rylonnie shtori_sssl
8 Aug 25 at 2:13 pm
Для успешного и безопасного очищения организма от наркотиков применяются методы медикаментозной поддержки, что способствует уменьшению риска осложнений и облегчению состояния пациента.
Углубиться в тему – [url=https://lechenie-narkomanii-novosibirsk0.ru/]принудительное лечение наркомании[/url]
KennethHef
8 Aug 25 at 2:13 pm
Представьте себе дорогу, где любой отрезок пути насыщен духом ностальгии, а окна вагона раскрывают панорамы к завораживающие леса а также озёра Карельского края. Потому что [url=https://xn—-7sbocngdcdf3cckdefdav9p0a.xn--p1ai/]поезд карелия старинный[/url] — это гораздо больше, чем транспорт — реальная машина времени, переносящая каждого путешественника в обстановку той эпохи. Ретро-вагоны, мягкий свет ламп, уютные купе плюс запах только что сваренного кофе из вагона-ресторана формируют уникальный колорит. Сайт рускеальский-экспресс.рф поможет каждому в пару кликов подобрать маршрут, узнать расписание а также настроиться к незабываемому отдыху.
Когда хочется испытать магию поезда, то [url=https://xn—-7sbocngdcdf3cckdefdav9p0a.xn--p1ai/]рускеальский экспресс купить билеты сортавала[/url] — лучшее решение на сегодня. Состав связывает культурную столицу и жемчужиной Карелии — парком «Рускеала». Во время поездки любой гость станет участником уникального путешествия: от живописных видов за стеклом вагона и вплоть до погружения в историю на каждой остановке. Ваше путешествие начнётся с клика всего одной кнопки.
рускеальский-экспресс
8 Aug 25 at 2:13 pm
пластиковые окна рулонные шторы с электроприводом [url=http://www.avtomaticheskie-rulonnye-shtory50.ru]http://www.avtomaticheskie-rulonnye-shtory50.ru[/url] .
avtomaticheskie rylonnie shtori_hwot
8 Aug 25 at 2:15 pm
двойные рулонные шторы с электроприводом [url=http://elektricheskie-rulonnye-shtory90.ru]http://elektricheskie-rulonnye-shtory90.ru[/url] .
elektricheskie rylonnie shtori_xysl
8 Aug 25 at 2:17 pm
Good article! We are linking to this particularly great
article on our site. Keep up the great writing. https://www.laciotatentreprendre.fr/employer/listbb/
купить легальный диплом о высшем образовании
8 Aug 25 at 2:19 pm
рольшторы заказать [url=https://avtomaticheskie-rulonnye-shtory50.ru/]https://avtomaticheskie-rulonnye-shtory50.ru/[/url] .
avtomaticheskie rylonnie shtori_htot
8 Aug 25 at 2:19 pm
Live casino Mandiribet: Mandiribet login – Link alternatif Mandiribet
Scottbairl
8 Aug 25 at 2:20 pm
What’s up, I wish for to subscribe for this weblog to get most recent
updates, therefore where can i do it please
assist.
با رتبه ۸۰۰۰ تجربی منطقه ۳ چی قبول میشم
8 Aug 25 at 2:26 pm
Son dakika Dunya Haberleri Alt?n Fiyat?: Guvenli Liman Alt?n, yuzy?llard?r guvenli liman olarak kabul ediliyor. Ekonomik belirsizliklerin artt?g? donemlerde alt?n fiyatlar? genellikle yukselise geciyor. Yat?r?mc?lar ve tuketiciler icin alt?n fiyatlar?n? yak?ndan takip etmek, onemli bir finansal karar verme arac?.
RudolfPript
8 Aug 25 at 2:27 pm
Выезд нарколога на дом в Москве — услуга вывода из запоя от центра «Alco.Rehab». Работают круглосуточно.
Подробнее можно узнать тут – [url=https://https://vyvod-iz-zapoya-moskva11.ru//]вывод из запоя[/url]
Samueldax
8 Aug 25 at 2:29 pm
Очень рекомендую к прочтению:
По теме “pro-zenit.ru”, нашел много полезного.
Смотрите сами:
[url=https://pro-zenit.ru]https://pro-zenit.ru[/url]
Если у вас есть что добавить, не стесняйтесь.
rusPoito
8 Aug 25 at 2:30 pm
какие бывают рулонные шторы [url=https://www.rulonnye-elektroshtory.ru]какие бывают рулонные шторы[/url] .
rylonnie elektroshtori_qvot
8 Aug 25 at 2:39 pm
https://imageevent.com/reginajonesr/bfsqa
Richardgen
8 Aug 25 at 2:42 pm
Анонимная помощь при запое — врачи «Alco.Rehab» (Москва) приедут к вам в течение часа.
Углубиться в тему – [url=https://nazalnyj.ru/]срочный вывод из запоя в москве[/url]
AnthonyExank
8 Aug 25 at 2:44 pm
https://bs2bsme.at
Danielgause
8 Aug 25 at 2:47 pm
That is a really good tip especially to those fresh to the blogosphere.
Brief but very precise information… Many thanks for sharing this one.
A must read post!
Trane Repair
8 Aug 25 at 2:48 pm
When someone writes an post he/she maintains the image of a user
in his/her brain that how a user can understand it. Therefore that’s why this paragraph is great.
Thanks!
Buy Buphedrone online
8 Aug 25 at 2:49 pm
рулонные шторы на электроприводе [url=www.rulonnye-elektroshtory.ru/]рулонные шторы на электроприводе[/url] .
rylonnie elektroshtori_zrot
8 Aug 25 at 2:50 pm
Мы предлагаем вам подробное руководство, основанное на проверенных источниках и реальных примерах. Каждая часть публикации направлена на то, чтобы помочь вам разобраться в сложных вопросах и применить знания на практике.
Обратитесь за информацией – https://erhvervsklubfyn.dk/medlem/actief-hartmanns-a-s
Jamesrhist
8 Aug 25 at 2:51 pm
автоматические рулонные шторы на створку [url=www.elektricheskie-rulonnye-shtory90.ru/]www.elektricheskie-rulonnye-shtory90.ru/[/url] .
elektricheskie rylonnie shtori_zzsl
8 Aug 25 at 2:51 pm
рулонные шторы на балконные окна [url=http://avtomaticheskie-rulonnye-shtory50.ru]http://avtomaticheskie-rulonnye-shtory50.ru[/url] .
avtomaticheskie rylonnie shtori_cuot
8 Aug 25 at 2:52 pm
Этот информативный текст выделяется своими захватывающими аспектами, которые делают сложные темы доступными и понятными. Мы стремимся предложить читателям глубину знаний вместе с разнообразием интересных фактов. Откройте новые горизонты и развивайте свои способности познавать мир!
Смотрите также… – https://servitrafick.es/producto/bot-para-restaurante
Jamesrhist
8 Aug 25 at 2:53 pm
Hello there! This post couldn’t be written any better!
Reading this post reminds me of my old room mate!
He always kept chatting about this. I will forward this write-up
to him. Pretty sure he will have a good read.
Thank you for sharing!
mobil bekas
8 Aug 25 at 2:55 pm
https://lizachat.ru
JamesTer
8 Aug 25 at 2:58 pm
ролет штора [url=http://www.rulonnye-elektroshtory.ru]ролет штора[/url] .
rylonnie elektroshtori_khot
8 Aug 25 at 3:01 pm
трипскан
MichaelAdold
8 Aug 25 at 3:02 pm
Keep on writing, great job!
https://flamantmoscow.ru/
LhaneDrync
8 Aug 25 at 3:03 pm
автоматические шторы на окна [url=https://avtomaticheskie-rulonnye-shtory50.ru/]автоматические шторы на окна[/url] .
avtomaticheskie rylonnie shtori_srot
8 Aug 25 at 3:06 pm
рулонные шторы производство [url=elektricheskie-rulonnye-shtory90.ru]elektricheskie-rulonnye-shtory90.ru[/url] .
elektricheskie rylonnie shtori_fksl
8 Aug 25 at 3:06 pm
no deposit casino uk
https://vaishakbelle.com/
8 Aug 25 at 3:07 pm
Во многих случаях пациент или его родственники не решаются сразу вызвать врача. Для таких ситуаций предусмотрена услуга онлайн-консультации. Она проводится через защищённую видеосвязь, при желании — анонимно. На связи — врач-нарколог или психиатр, который отвечает на вопросы, оценивает ситуацию по визуальным и вербальным признакам, рекомендует план действий. Консультация может стать отправной точкой для дальнейшего вызова врача на дом или записи в клинику. Это особенно удобно для родственников, которые не знают, как подступиться к проблеме и убедить человека в необходимости помощи.
Разобраться лучше – [url=https://narkologicheskaya-pomoshh-tver0.ru/]оказание наркологической помощи в твери[/url]
GarryPrest
8 Aug 25 at 3:13 pm