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!
aporek: Trygg Med – uringlass apotek
Kennethrip
17 Jul 25 at 10:15 pm
Психолог онлайн поможет справиться с депрессией. Детский психолог онлайн найдет общий язык с подростками.
пообщаться с психологом онлайн
Ernestpoive
17 Jul 25 at 10:21 pm
can you get generic imdur without rx
buy generic imdur for sale
17 Jul 25 at 10:22 pm
Hmm is anyone else having problems with the images on this blog loading?
I’m trying to find out if its a problem on my
end or if it’s the blog. Any feedback would be greatly appreciated.
wire fraud
17 Jul 25 at 10:23 pm
При выборе пакет телевизионных каналов для цифрового телевидения в новосибирске, важно учитывать множество факторов. Телекоммуникационные компании предлагают широкий выбор услуг ТВ, включая кабельное телевидение, спутниковое и интернет-телевидение. На сайте domashij-internet-novosibirsk004.ru можно найти сравнение тарифов и подобрать наиболее подходящий пакет. Популярные каналы представляют собой развлекательный контент, спортивные и новости. Пакет для всей семьи обычно предлагает HD-каналы, что особенно привлекательно для зрителей. Подписка на ТВ может варьироваться в зависимости от интересов. Основным аспектом является выбор пакета, который удовлетворяет ваши интересы и финансовым возможностям, чтобы наслаждаться качественным цифровым телевидением.
internetelini
17 Jul 25 at 10:23 pm
Затяжной запой опасен для жизни. Врачи наркологической клиники в Химках проводят срочный вывод из запоя — на дому или в стационаре. Анонимно, безопасно, круглосуточно.
Подробнее – [url=https://vyvod-iz-zapoya-himki12.ru/]наркологический вывод из запоя город химки[/url]
MariaGer
17 Jul 25 at 10:23 pm
После поступления вызова нарколог клиники «АльфаНаркология» оперативно выезжает по указанному адресу. На месте врач проводит первичную диагностику, оценивая степень интоксикации, физическое и психологическое состояние пациента. По результатам осмотра врач подбирает индивидуальный комплекс лечебных процедур, в который входит постановка капельницы с растворами для детоксикации, препараты для стабилизации работы органов и нормализации психического состояния.
Ознакомиться с деталями – [url=https://narcolog-na-dom-sankt-peterburg000.ru/]vrach-narkolog-na-dom sankt-peterburg[/url]
NormanIncib
17 Jul 25 at 10:26 pm
В течение процедуры пациент находится под непрерывным наблюдением: внутривенные капельницы с регидратационными растворами, витаминно-минеральными комплексами и гепатопротекторами обеспечивают восстановление функций печени, нормализацию обменных процессов и поддержку работы сердечно-сосудистой системы. При необходимости к лечению привлекаются узкопрофильные врачи — кардиолог, невролог или терапевт — что делает процесс максимально комплексным. По завершении выведения из запоя врач предоставляет подробный план поддерживающей терапии с рекомендациями по питанию, питьевому режиму и графику повторных консультаций.
Подробнее тут – [url=https://vyvod-iz-zapoya-reutov4.ru/]vyvod iz zapoya anonimno reutov[/url]
Jeromeincub
17 Jul 25 at 10:27 pm
оценка часов цена [url=ocenka-chasov-onlajn8.ru]ocenka-chasov-onlajn8.ru[/url] .
ocenka chasov onlain_vrKt
17 Jul 25 at 10:37 pm
Наркологическая клиника «МедЛайн» предоставляет профессиональные услуги врача-нарколога с выездом на дом в Новосибирске и Новосибирской области. Мы оперативно помогаем пациентам справиться с тяжелыми состояниями при алкогольной и наркотической зависимости. Экстренный выезд наших специалистов доступен круглосуточно, а лечение проводится с применением проверенных методик и препаратов, что гарантирует безопасность и конфиденциальность каждому пациенту.
Ознакомиться с деталями – https://narcolog-na-dom-novosibirsk00.ru/narkolog-na-dom-czena-novosibirsk/
ManuelLut
17 Jul 25 at 10:43 pm
офисные перегородки Стеклянные перегородки
Dannyfaign
17 Jul 25 at 10:44 pm
Онлайн-психолог — это забота о вашем здоровье. Детский психолог онлайн поможет с социализацией.
калуга прием психологов
Ernestpoive
17 Jul 25 at 10:46 pm
Специалист уточняет, сколько времени продолжается запой, какой тип алкоголя употребляется, а также наличие сопутствующих заболеваний. Тщательный анализ этих данных помогает определить оптимальные методы детоксикации и скорректировать терапевтическую стратегию для минимизации риска осложнений.
Детальнее – http://narcolog-na-dom-ryazan0.ru/
StephenRof
17 Jul 25 at 10:46 pm
sms bomber usa
GerardobaR
17 Jul 25 at 10:47 pm
Близкий человек в запое? Не ждите ухудшения. Обратитесь в клинику — здесь проведут профессиональный вывод из запоя с последующим восстановлением организма.
[url=https://kapelnica-ot-zapoya-lyubercy13.ru/]posle-kapelniczy-ot-zapoya lyubercy[/url] – [url=https://kapelnica-ot-zapoya-lyubercy13.ru/]капельница от запоя город. московская область[/url]
BenitoPet
17 Jul 25 at 10:56 pm
Stream live Cricket and Football events online. Stay updated with upcoming matches, highlights, and schedules.
Join the excitement with E2BET today!
YoSinTV - Live Cricket and Football Streaming
17 Jul 25 at 10:59 pm
прогнозы на спорт от профессионалов на сегодня [url=https://www.prognozy-na-sport-2.ru]https://www.prognozy-na-sport-2.ru[/url] .
prognozi na sport_nwSn
17 Jul 25 at 11:02 pm
mostbet esports mərclər [url=http://mostbet4055.ru/]http://mostbet4055.ru/[/url]
mostbet_orKi
17 Jul 25 at 11:04 pm
Онлайн-консультации с психологом — это новаторство. Детский психолог онлайн поможет с детской агрессией.
хороший психолог в калуге
Ernestpoive
17 Jul 25 at 11:06 pm
Amazing! This blog looks exactly like my old one!
It’s on a completely different topic but it has pretty much
the same layout and design. Wonderful choice of colors!
купить виагру
17 Jul 25 at 11:07 pm
купить диплом с занесением в реестр в кемерово [url=arus-diplom34.ru]arus-diplom34.ru[/url] .
Priobresti diplom instityta!_fokn
17 Jul 25 at 11:10 pm
I know this web page provides quality based articles or reviews and other material,
is there any other website which presents such information in quality?
https://keysoftintl.com/
Tips Produktivitas
17 Jul 25 at 11:16 pm
аттестат купить за 11 классов в москве [url=http://arus-diplom24.ru]аттестат купить за 11 классов в москве[/url] .
Diplomi_nusa
17 Jul 25 at 11:19 pm
прогноз на футбол сегодня [url=http://www.prognozy-na-futbol-2.ru]прогноз на футбол сегодня[/url] .
prognozi na fytbol_wwmi
17 Jul 25 at 11:21 pm
https://birvodokanal.ru
Lesteretedy
17 Jul 25 at 11:22 pm
прогноз от профессионалов [url=http://www.prognozy-na-sport-2.ru]http://www.prognozy-na-sport-2.ru[/url] .
prognozi na sport_eeSn
17 Jul 25 at 11:25 pm
Г¶ppna apotek idag [url=https://snabbapoteket.shop/#]hГҐltagning apotek[/url] billiga dregglisar
ScottFup
17 Jul 25 at 11:26 pm
1win ios yukle [url=http://1win3043.com/]http://1win3043.com/[/url]
1win_jhEt
17 Jul 25 at 11:29 pm
диплом купить с проведением [url=arus-diplom34.ru]диплом купить с проведением[/url] .
Priobresti diplom o visshem obrazovanii!_pjkn
17 Jul 25 at 11:30 pm
экстренный вывод из запоя челябинск
vivod-iz-zapoya-chelyabinsk002.ru
экстренный вывод из запоя челябинск
zapojchelyabinskNeT
17 Jul 25 at 11:30 pm
После поступления вызова врач наркологической клиники «МедАльянс» прибывает на дом в течение 30–60 минут. Сначала специалист оценивает общее состояние пациента, измеряет давление, уровень кислорода в крови и уточняет детали анамнеза.
Получить дополнительную информацию – http://kapelnica-ot-zapoya-moskva000.ru
Jamesblins
17 Jul 25 at 11:37 pm
как зарегистрироваться в мелбет [url=www.melbet3003.com]www.melbet3003.com[/url]
melbet_kcKn
17 Jul 25 at 11:39 pm
В рамках услуги вызова нарколога на дом используется современное оборудование и препараты, одобренные для амбулаторного применения.
Исследовать вопрос подробнее – http://
WillieDek
17 Jul 25 at 11:42 pm
Запой – серьезная угроза для организма! Круглосуточная наркологическая помощь в Волгоградской области – это спасение! Мы работаем 24/7, чтобы вы могли получить помощь, когда она вам нужна больше всего. Наш подход – оперативно, безопасно и с учетом ваших особенностей. Мы работаем быстро и качественно, чтобы помочь вам как можно скорее. Мы проведем детоксикацию и стабилизируем ваше состояние в комфортных условиях. Мы оцениваем ваше состояние, чтобы подобрать оптимальное лечение.
Подробнее тут – [url=https://vyvod-iz-zapoya-volgograd000.ru/]вывод из запоя цены волгоград[/url]
DavidVeget
17 Jul 25 at 11:43 pm
Близкий человек в запое? Не ждите ухудшения. Обратитесь в клинику — здесь проведут профессиональный вывод из запоя с последующим восстановлением организма.
Разобраться лучше – [url=https://vyvod-iz-zapoya-himki11.ru/]вывод из запоя клиника[/url]
Nicoleemoft
17 Jul 25 at 11:43 pm
прогноз футбол [url=https://prognozy-na-futbol-1.ru]https://prognozy-na-futbol-1.ru[/url] .
prognozi na fytbol_qosi
17 Jul 25 at 11:43 pm
Актуальные тренды сегодня медиатренды: фото, видео и медиа. Всё о том, что популярно сегодня — в России и в мире. Мода, визуальные стили, digital-направления и соцсети. Следите за трендами и оставайтесь в курсе главных новинок каждого дня.
jb5-989
17 Jul 25 at 11:46 pm
душевая перегородка из стекла Раздвижные стеклянные перегородки предлагают уникальное решение для организации пространства в офисах и жилых помещениях. Их легко устанавливать и использовать, а механизм раздвижения позволяет экономить место, что особенно важно в небольших помещениях. Они могут быть выполнены в различных стилях и отделках, что делает их подходящими для любого интерьера, будь то минимализм или классика. Стеклянные ограждения
Dannyfaign
17 Jul 25 at 11:48 pm
Запой – опасная стадия алкоголизма, когда организм требует постоянного поступления алкоголя. Лечение на дому – это конфиденциально, удобно и позволяет начать детоксикацию в комфортных условиях. При запое каждая минута на счету, поэтому важно быстро обратиться за помощью. Врач поможет очистить организм от токсинов, восстановить баланс и нормализовать работу внутренних органов. Для успешного лечения запоя важен комплексный подход, включающий лекарства и работу с психологом. Первый шаг – очищение организма от алкоголя с помощью капельниц и других препаратов.
Получить дополнительную информацию – [url=https://vyvod-iz-zapoya-volgograd0.ru/]https://vyvod-iz-zapoya-volgograd0.ru/[/url]
Michaelacism
17 Jul 25 at 11:52 pm
Актуальные тренды сегодня подробнее: фото, видео и медиа. Всё о том, что популярно сегодня — в России и в мире. Мода, визуальные стили, digital-направления и соцсети. Следите за трендами и оставайтесь в курсе главных новинок каждого дня.
jb5-851
17 Jul 25 at 11:54 pm
https://tryggmed.com/# føflekk sjekk apotek
MichaelDeeli
17 Jul 25 at 11:56 pm
футбол прогноз на сегодня [url=www.prognozy-na-futbol-2.ru]www.prognozy-na-futbol-2.ru[/url] .
prognozi na fytbol_cumi
17 Jul 25 at 11:59 pm
купить диплом москва легально [url=https://arus-diplom34.ru]https://arus-diplom34.ru[/url] .
Zakazat diplom o visshem obrazovanii!_dhkn
18 Jul 25 at 12:00 am
apotwkwt: skalpell apotek – ibuprofen apotek
Altonjah
18 Jul 25 at 12:01 am
Психолог онлайн даст поддержку в любой ситуации. Детский психолог онлайн поможет ребенку найти друзей.
записаться к психологу калуга
Ernestpoive
18 Jul 25 at 12:03 am
прогнозы на футбол [url=http://www.prognozy-na-futbol-1.ru]http://www.prognozy-na-futbol-1.ru[/url] .
prognozi na fytbol_zbsi
18 Jul 25 at 12:04 am
sГ¤ljer apotek: receptfria lГ¤kemedel mot inkontinens – apotek klamydia test
Altonjah
18 Jul 25 at 12:09 am
Click site https://www.system-age.co.jp/gogaduka/wordpress/img_0569/
RichardPutty
18 Jul 25 at 12:11 am
Каждый день запоя увеличивает риск для жизни. Не рискуйте — специалисты в Люберцах приедут на дом и окажут экстренную помощь. Без боли, стресса и ожидания.
[url=https://kapelnica-ot-zapoya-lyubercy11.ru/]капельница от запоя клиника в люберцах[/url] – [url=https://kapelnica-ot-zapoya-lyubercy11.ru/]капельница от запоя клиника люберцы[/url]
MichaelPAm
18 Jul 25 at 12:14 am
прогнозы на спорт с высокой проходимостью бесплатно с большим коэффициентом [url=http://www.prognozy-na-sport-1.ru]http://www.prognozy-na-sport-1.ru[/url] .
prognozi na sport_olol
18 Jul 25 at 12:14 am