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!
MediVertraut [url=https://medivertraut.shop/#]Sildenafil 100 mg bestellen[/url] Potenzmittel rezeptfrei kaufen
CharlesNeono
22 Oct 25 at 9:08 am
перевод технической документации [url=https://dzen.ru/a/aPFFa3ZMdGVq1wVQ/]https://dzen.ru/a/aPFFa3ZMdGVq1wVQ/[/url] .
Tehnicheskii perevod_urml
22 Oct 25 at 9:08 am
медицинский перевод на английский [url=http://teletype.in/@alexd78/HN462R01hzy/]http://teletype.in/@alexd78/HN462R01hzy/[/url] .
Vidi perevodov v buro Perevod i Pravo_prst
22 Oct 25 at 9:09 am
купить диплом в перми [url=https://rudik-diplom8.ru]купить диплом в перми[/url] .
Diplomi_ahMt
22 Oct 25 at 9:10 am
В данной статье вы найдете комплексный подход к изучению насущных тем. Мы комбинируем теоретические сведения с практическими советами, чтобы читатель мог не только понять проблему, но и найти пути её решения.
Это стоит прочитать полностью – https://hestiadeco.com/slow-deco-une-decoration-plus-humaine-et-durable
Charlesadamb
22 Oct 25 at 9:11 am
купить диплом в волжском [url=http://rudik-diplom1.ru/]купить диплом в волжском[/url] .
Diplomi_nker
22 Oct 25 at 9:11 am
This is very interesting, You’re a very skilled blogger.
I have joined your rss feed and look forward to seeking more of your magnificent
post. Also, I have shared your website in my social networks!
insurer
22 Oct 25 at 9:11 am
kraken вход
kraken darknet
JamesDaync
22 Oct 25 at 9:13 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_bzEr
22 Oct 25 at 9:13 am
купить диплом в архангельске с занесением в реестр [url=www.frei-diplom1.ru]купить диплом в архангельске с занесением в реестр[/url] .
Diplomi_siOi
22 Oct 25 at 9:13 am
Ищете паровая котельная дизельная? Векостер vecoster.com представляют собой современные системы, предназначенные для обеспечения технологии паром. Высокая эффективность, надежность и безопасность делают эти котельные оптимальным выбором для производств самых разных направлений. Также на сайте вы найдете промышленные паровые котельные. Оборудование поддерживает двухтопливную работу — на природном газе и дизеле. Такой выбор обеспечивает гибкость, позволяя ориентироваться на локальную доступность и экономику топлива.
katijaGancy
22 Oct 25 at 9:13 am
Superb blog! Do you have any suggestions for aspiring writers?
I’m planning to start my own blog soon but I’m a little lost on everything.
Would you suggest starting with a free platform like
Wordpress or go for a paid option? There are so many options out there that I’m completely
confused .. Any tips? Cheers!
Trezik Forge GPT
22 Oct 25 at 9:14 am
купить диплом техникума украина [url=https://www.educ-ua7.ru]https://www.educ-ua7.ru[/url] .
Diplomi_xfea
22 Oct 25 at 9:14 am
рейтинг сео [url=http://top-10-seo-prodvizhenie.ru]рейтинг сео[/url] .
top 10 seo prodvijenie_iaKa
22 Oct 25 at 9:14 am
Публикация предлагает уникальную подборку информации, которая будет интересна как специалистам, так и широкому кругу читателей. Здесь вы найдете ответы на часто задаваемые вопросы и полезные инсайты для дальнейшего применения.
Детальнее – https://careers.epilpoint.it/estetista-specializzata-monopoli-2
Seymourlaf
22 Oct 25 at 9:17 am
купить диплом в первоуральске [url=https://rudik-diplom12.ru]https://rudik-diplom12.ru[/url] .
Diplomi_pqPi
22 Oct 25 at 9:18 am
купить диплом с реестром красноярск [url=www.frei-diplom1.ru]купить диплом с реестром красноярск[/url] .
Diplomi_uhOi
22 Oct 25 at 9:18 am
Этот информативный материал предлагает содержательную информацию по множеству задач и вопросов. Мы призываем вас исследовать различные идеи и факты, обобщая их для более глубокого понимания. Наша цель — сделать обучение доступным и увлекательным.
Узнайте всю правду – https://mitinews.com/%E0%B8%82%E0%B9%88%E0%B8%B2%E0%B8%A7%E0%B8%8A%E0%B8%B2%E0%B8%A2%E0%B9%81%E0%B8%94%E0%B8%99/%E0%B8%A3%E0%B8%AD%E0%B8%87%E0%B9%80%E0%B8%A5%E0%B8%82%E0%B8%B2%E0%B8%98%E0%B8%B4%E0%B8%81%E0%B8%B2%E0%B8%A3%E0%B8%A8%E0%B8%B9%E0%B8%99%E0%B8%A2%E0%B9%8C%E0%B8%AD%E0%B8%B3%E0%B8%99%E0%B8%A7%E0%B8%A2
Jeremylam
22 Oct 25 at 9:19 am
купить диплом в белово [url=https://www.rudik-diplom2.ru]https://www.rudik-diplom2.ru[/url] .
Diplomi_zwpi
22 Oct 25 at 9:19 am
купить диплом в брянске техникума [url=http://www.frei-diplom8.ru]купить диплом в брянске техникума[/url] .
Diplomi_hksr
22 Oct 25 at 9:20 am
Этот обзор дает возможность взглянуть на историю и науку под новым углом. Мы представляем редкие факты, неожиданные связи и значимые события, которые помогут вам глубже понять развитие цивилизации и роль человека в ней.
Полезно знать – https://vipprox.com/exploring-atlantas-modern-homes
RobertPes
22 Oct 25 at 9:21 am
купить диплом вуза с проводкой [url=www.frei-diplom2.ru]www.frei-diplom2.ru[/url] .
Diplomi_yhEa
22 Oct 25 at 9:22 am
купить диплом высшего образования с занесением в реестр [url=http://www.frei-diplom3.ru]купить диплом высшего образования с занесением в реестр[/url] .
Diplomi_rlKt
22 Oct 25 at 9:22 am
купить диплом в михайловске [url=https://www.rudik-diplom7.ru]https://www.rudik-diplom7.ru[/url] .
Diplomi_hsPl
22 Oct 25 at 9:24 am
кракен vpn
kraken vk5
JamesDaync
22 Oct 25 at 9:24 am
Технический перевод [url=https://dzen.ru/a/aPFFa3ZMdGVq1wVQ/]dzen.ru/a/aPFFa3ZMdGVq1wVQ[/url] .
Tehnicheskii perevod_zfml
22 Oct 25 at 9:25 am
Viagra générique pas cher: pharmacie française agréée en ligne – Viagra pas cher livraison rapide france
WilliamUnjup
22 Oct 25 at 9:25 am
возможно ли купить диплом техникума [url=https://www.educ-ua7.ru]https://www.educ-ua7.ru[/url] .
Diplomi_wrea
22 Oct 25 at 9:26 am
Hi, i read your blog occasionally and i own a similar
one and i was just wondering if you get a lot of spam remarks?
If so how do you protect against it, any plugin or anything
you can suggest? I get so much lately it’s driving me crazy so
any help is very much appreciated.
Custom Couches
22 Oct 25 at 9:27 am
https://bluepeakmeds.com/# BluePeakMeds
MichaelZow
22 Oct 25 at 9:28 am
DRINKIO приятно удивил качеством обслуживания. Курьеры пунктуальные, заказы доставляют быстро и аккуратно. Сайт удобный, оформление не занимает много времени. Радует, что сервис работает круглосуточно — всегда можно оформить заказ. Цены приемлемые, ассортимент отличный. Лучшая доставка алкоголя по Москве https://drinkio105.ru/
Arthurtok
22 Oct 25 at 9:28 am
Игроки могут рассчитывать на эксклюзивные турнирные приглашения и
персональные подарки.
7ка
22 Oct 25 at 9:28 am
диплом купить с внесением в реестр [url=https://frei-diplom3.ru]диплом купить с внесением в реестр[/url] .
Diplomi_yyKt
22 Oct 25 at 9:28 am
раскрутка сайтов москва [url=http://seo-prodvizhenie-reiting-kompanij.ru/]раскрутка сайтов москва[/url] .
seo prodvijenie reiting kompanii_mzst
22 Oct 25 at 9:29 am
Hi there! Quick question that’s entirely
off topic. Do you know how to make your site mobile friendly?
My weblog looks weird when viewing from my iphone4.
I’m trying to find a template or plugin that might be able to fix this issue.
If you have any recommendations, please share. Appreciate it!
1xbet casino промокод
22 Oct 25 at 9:30 am
купить диплом об окончании техникума спб [url=www.frei-diplom8.ru/]купить диплом об окончании техникума спб[/url] .
Diplomi_zzsr
22 Oct 25 at 9:31 am
купить диплом о среднем [url=https://rudik-diplom8.ru]купить диплом о среднем[/url] .
Diplomi_ftMt
22 Oct 25 at 9:31 am
сайтов продвижение в топ [url=http://www.top-10-seo-prodvizhenie.ru]сайтов продвижение в топ[/url] .
top 10 seo prodvijenie_mkKa
22 Oct 25 at 9:32 am
где можно купить диплом медицинского колледжа [url=www.frei-diplom9.ru]www.frei-diplom9.ru[/url] .
Diplomi_qrea
22 Oct 25 at 9:32 am
Будущее — за технологиями kraken onion ссылка kraken зеркало рабочее актуальные зеркала kraken kraken сайт зеркала
RichardPep
22 Oct 25 at 9:33 am
купить диплом с проведением [url=frei-diplom3.ru]купить диплом с проведением[/url] .
Diplomi_xvKt
22 Oct 25 at 9:33 am
kraken официальный
кракен Россия
JamesDaync
22 Oct 25 at 9:33 am
[url=https://4domains.su/]Как научиться планировать день[/url] — вопрос, который задают себе люди, стремящиеся достигать целей без стресса. Планирование — это не просто ежедневник с заметками, а способ управлять своей энергией. Начните с определения приоритетов. Выделите ключевые направления: работа, здоровье, отдых, обучение. План, в котором нет места отдыху, обречён на провал. Не переоценивайте силы, чтобы избежать выгорания. Составляйте список из ключевых пунктов, которые приближают вас к цели. После основных дел займитесь второстепенными. Планируйте сложные дела на часы, когда вы наиболее активны. Если вы продуктивны утром — делайте важное до обеда, если вечером — переносите фокус на вторую половину дня. Цифровое планирование экономит время и снижает забывчивость. Главное — не приложение, а ваше намерение. Полезно вечером подводить итоги дня. Это не контроль, а развитие привычки. Не забывайте включать в план отдых, прогулки, хобби. Главное — не идеальный план, а постоянство. Со временем вы заметите, что день стал управляемым. Тот, кто управляет своим днём, управляет жизнью
https://4domains.su/
Robertpaila
22 Oct 25 at 9:33 am
сео москва [url=https://www.seo-prodvizhenie-reiting-kompanij.ru]сео москва[/url] .
seo prodvijenie reiting kompanii_uxst
22 Oct 25 at 9:33 am
купить диплом в мурманске с занесением в реестр [url=http://frei-diplom1.ru]купить диплом в мурманске с занесением в реестр[/url] .
Diplomi_zcOi
22 Oct 25 at 9:34 am
seo agentura [url=http://top-10-seo-prodvizhenie.ru/]seo agentura[/url] .
top 10 seo prodvijenie_gyKa
22 Oct 25 at 9:34 am
В данной статье вы найдете комплексный подход к изучению насущных тем. Мы комбинируем теоретические сведения с практическими советами, чтобы читатель мог не только понять проблему, но и найти пути её решения.
Узнать из первых рук – https://bts-avp.fr/exercice-pratique-realiser-une-captation-live
AndrewWaing
22 Oct 25 at 9:35 am
Эта информационная статья содержит полезные факты, советы и рекомендации, которые помогут вам быть в курсе последних тенденций и изменений в выбранной области. Материал составлен так, чтобы быть полезным и понятным каждому.
Эксклюзивная информация – https://okamoto-alumi.jp/2019/07/08/%E6%98%9F%E3%81%BE%E3%81%A4%E3%82%8A
MichaelAloni
22 Oct 25 at 9:37 am
медицинский перевод с английского [url=http://telegra.ph/Medicinskij-perevod-tochnost-kak-vopros-zhizni-i-zdorovya-10-16]http://telegra.ph/Medicinskij-perevod-tochnost-kak-vopros-zhizni-i-zdorovya-10-16[/url] .
Medicinskii perevod_clEr
22 Oct 25 at 9:37 am
Unlock your images with WebPtoJPGHero.com, the simple, free solution for solving WebP compatibility issues. While the WebP format helps websites load faster, it can leave you with files you can’t easily edit or share. Our online tool provides an instant fix, transforming any WebP image into a high-quality JPG that works seamlessly across all your devices and applications. You can fine-tune the output quality to balance clarity and file size, and even save time by converting an entire batch of photos at once. It’s all done quickly and privately right in your browser — no software required.
ShaneDrync
22 Oct 25 at 9:37 am