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!
В Краснодаре клиника «Детокс» предоставляет услугу вызова нарколога на дом. Специалисты приедут к вам в течение 1–2 часов, проведут осмотр и назначат необходимое лечение. Все процедуры проводятся анонимно и с соблюдением конфиденциальности.
Подробнее можно узнать тут – [url=https://narkolog-na-dom-krasnodar29.ru/]врач нарколог на дом в краснодаре[/url]
BrianDrura
22 Oct 25 at 8:33 pm
лечение запоя смоленск
vivod-iz-zapoya-smolensk022.ru
вывод из запоя круглосуточно смоленск
alkogolizmsmolenskNeT
22 Oct 25 at 8:33 pm
CHATURBATE
CHATURBATE
22 Oct 25 at 8:33 pm
Когда нужна срочная помощь, служба Stop-Alko в Екатеринбурге может выехать на дом, провести диагностику, капельницу и восстановление сил.
Разобраться лучше – [url=https://vyvod-iz-zapoya-ekaterinburg26.ru/]вывод из запоя цена[/url]
ClydeLak
22 Oct 25 at 8:35 pm
Вызов нарколога на дом через «Stop-Alko» в Екатеринбурге — это помощь, когда вы не можете самостоятельно добраться до клиники. Первая помощь сразу у вас дома.
Получить дополнительные сведения – [url=https://vyvod-iz-zapoya-ekaterinburg27.ru/]нарколог вывод из запоя[/url]
RichardDaB
22 Oct 25 at 8:36 pm
Folks, composed lah, registering іn а renowned primary school еnsures reduced
class sizes fоr individualized focus ɑnd highest PSLE marks.
Heyy hey, parents, calm lah, excellent establishment implies Ƅetter peer effеct, motivating academic
аnd career aspirations.
Folks, competitive approach actvated lah, strong primary arithmetic гesults in better science understanding and engineering dreams.
Oh dear, mіnus strong mathematics during primary school, еvｅn top establishment kids mіght
struggle wіth secondary calculations, thiѕ cultivate tһiѕ immeԁiately leh.
Aiyah, primary math teaches practical սseѕ including budgeting, ѕo ensure yoսr child masters tһat properly Ƅeginning yоung.
Alas, primary math teaches practical սses such as money management, thus mɑke sure үoսr kid gets it correctly starting еarly.
Listen up, calm pom pi pі, mathematics proves аmong inn tһe
highеst subjects in primary school, laying groundwork іn A-Level advanced math.
Damai Primary School cultivates ɑɑn inspiring environment tһat motivates
curiosity аnd development.
Caring teachers and interеsting programs help support ѡell-rounded people.
Sengkang Green Primary School supplies eco-friendly education ᴡith development.
Ƭһe school supports green thinkers.
Moms аnd dads ѵalue its sustainability focus.
Мy pаɡe … Kaizenare math tuition
Kaizenare math tuition
22 Oct 25 at 8:38 pm
что такое медицинский перевод [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_xgEr
22 Oct 25 at 8:39 pm
sportwetten bonus forum
Here is my web-site … wettbüro berlin in der nähe
wettbüro berlin in der nähe
22 Oct 25 at 8:40 pm
Капельница от запоя на дому в Нижнем Новгороде — быстрый и эффективный способ снять симптомы похмелья и восстановить организм. Наши специалисты приедут к вам домой и проведут процедуру с использованием современных препаратов.
Детальнее – [url=https://vyvod-iz-zapoya-nizhnij-novgorod13.ru/]вывод из запоя капельница на дому в нижний новгороде[/url]
DarrellUnsug
22 Oct 25 at 8:42 pm
Вывод из запоя в Воронеже проходит анонимно, с круглосуточной поддержкой специалистов.
Узнать больше – https://vyvod-iz-zapoya-v-stacionare-voronezh23.ru
Charlesomido
22 Oct 25 at 8:42 pm
Для тех, кто хочет поплакать:
Подборка самых трогательных фильмов.
новинки сериалов онлайн
22 Oct 25 at 8:42 pm
ім’я дамір походження
JessieVinge
22 Oct 25 at 8:43 pm
технический перевод информация [url=http://dzen.ru/a/aPFFa3ZMdGVq1wVQ/]http://dzen.ru/a/aPFFa3ZMdGVq1wVQ/[/url] .
Tehnicheskii perevod_waml
22 Oct 25 at 8:44 pm
медицинский перевод на английский [url=www.teletype.in/@alexd78/HN462R01hzy/]www.teletype.in/@alexd78/HN462R01hzy/[/url] .
Vidi perevodov v buro Perevod i Pravo_zost
22 Oct 25 at 8:44 pm
https://www.medtronik.ru проверенные источники бонусных кодов и фрибетов
Aaronawads
22 Oct 25 at 8:45 pm
трансы Челябинск География Поддержки: От Сибири до Юга России Каждый из каналов, будь то @ts_novosibirsk (трансы Новосибирск, трансы новосибирска), @ts_ekaterinburgh (трансы Екатеринбург, трансы Екатеринбурга), @ts_voronezh (трансы Воронеж, трансы Воронежа), @transy_volgograd (трансы Волгоград, трансы волгограда) или @ts_chelyabinska (трансы Челябинск, трансы челябинска), отражает уникальную специфику своего региона. В них аккумулируется информация о локальных ресурсах, специалистах, мероприятиях и безопасных пространствах, создавая атмосферу взаимной поддержки и понимания. Эти платформы становятся своеобразными цифровыми хабами, объединяющими транс-сообщество в каждом конкретном городе.
ChrisVOisa
22 Oct 25 at 8:46 pm
купить диплом техникума или колледжа [url=https://frei-diplom7.ru]купить диплом техникума или колледжа[/url] .
Diplomi_pdei
22 Oct 25 at 8:47 pm
Если вы ищете надежную клинику для вывода из запоя в Сочи, обратитесь в «Детокс». Здесь опытные специалисты окажут необходимую помощь в стационаре. Услуга доступна круглосуточно, анонимно и начинается от 2000 ?.
Разобраться лучше – [url=https://vyvod-iz-zapoya-sochi24.ru/]помощь вывод из запоя сочи[/url]
ClintonEmpib
22 Oct 25 at 8:48 pm
Wow, well-known oneѕ incorporate illusion tricks, encouraging
creativity f᧐r showbiz jobs.
Listen uⲣ, elite institutions incorporate puzzles, refining logic
for analytical ⲟr analyst positions.
Do not play play lah, link а good primary school witһ math proficiency inn order to assure elevated PSLE marks аnd smooth ϲhanges.
Oi oi, Singapore folks, math ｒemains proЬably tһe extremely importаnt primary discipline, promoting innovation tһrough challenge-tackling
in grouhndbreaking professions.
Αpaгt tߋ school resources, emphasize on math for prevent common errors including careless blunders іn exams.
Guardians, fearful of losing approach activated lah, solid
primary math guides іn better STEM grasp ɑs weⅼl as engineering goals.
In addіtion from institution facilities, emphasize ⲟn arithmetic tо avoіd common mistakes sսch as inattentive blunders ɑt exams.
Pei Hwa Presbyterian Primary School рrovides ɑ values-based education іn ɑ nurturing environment.
Dedicated teachers foster character ɑnd intellectual growth.
Sanctuary Primary School օffers a tranquil setting f᧐r holistic development.
The school nurtures creativity ɑnd confidence.
Parents vɑlue its calm, helpful environment.
Feel free tⲟ visit my web blog; Orchid Park Secondary School (http://giggetter.com/)
http://giggetter.com/
22 Oct 25 at 8:48 pm
Вывод из запоя в Самаре проводится с проверенными препаратами, с учётом состояния пациента и без лишнего стресса.
Получить дополнительные сведения – [url=https://vyvod-iz-zapoya-v-stacionare-samara23.ru/]вывод из запоя в стационаре анонимно[/url]
DannyPowly
22 Oct 25 at 8:50 pm
перевод технического текста с английского на русский [url=https://teletype.in/@alexd78/HN462R01hzy/]teletype.in/@alexd78/HN462R01hzy[/url] .
Vidi perevodov v buro Perevod i Pravo_jsst
22 Oct 25 at 8:50 pm
bester starcraft wettanbieter
My homepage :: Sportwetten Online seriöS
Sportwetten Online seriöS
22 Oct 25 at 8:51 pm
особенности медицинского перевода [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_ttEr
22 Oct 25 at 8:53 pm
Как купить Шмаль в Ржеве?Друзья, расскажите – есть сайт https://russia-maps.ru
. Цены нормальные, доставка есть. Кто-то пробовал с ними? Как у них с товаром?
Stevenref
22 Oct 25 at 8:54 pm
технический перевод требования [url=https://dzen.ru/a/aPFFa3ZMdGVq1wVQ/]https://dzen.ru/a/aPFFa3ZMdGVq1wVQ/[/url] .
Tehnicheskii perevod_rwml
22 Oct 25 at 8:57 pm
yourtrustedonlinestore.shop – Smooth checkout process and fast delivery made my experience very positive today.
Marlene Leonides
22 Oct 25 at 8:57 pm
как купить диплом колледжа [url=https://frei-diplom7.ru]https://frei-diplom7.ru[/url] .
Diplomi_wxei
22 Oct 25 at 9:02 pm
Магазин ровный! Я заказал 1000ф, оплатил ЯД, оператора попросил отправить посыль на следующий день , без задержки т.к. сроки получения очень поджимают. На что оператор адекватно ответил что все сделают.На следующий вечер получил трек, посылочка собранна и вот вот выезжает))) если уже не выехала) Магазину как и его администрации – от души за оперативность и отношение к клиенту.
Приобрести онлайн кокаин, мефедрон, гашиш, бошки
Хороший магазин,менеджер приятный по общению,недовесов не было у меня
BobbyShipt
22 Oct 25 at 9:03 pm
Стационар «Частного Медика 24» — это круглосуточная помощь при запое, современные капельницы и заботливый уход.
Получить дополнительные сведения – [url=https://vyvod-iz-zapoya-v-stacionare21.ru/]вывод из запоя в стационаре клиника в нижний новгороде[/url]
RichardHig
22 Oct 25 at 9:04 pm
что такое медицинский перевод [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_cwEr
22 Oct 25 at 9:06 pm
Добро пожаловать в мир изысканной флористики!
Наша компания “Новые цветы” – это профессиональный цветочный магазин
с собственной производственной
базой в Казани. Мы предлагаем:
• Более 1000 готовых букетов и композиций
• Индивидуальные заказы любой сложности
• Собственные теплицы свежих цветов
• Широкий ассортимент растений в
горшках
• Профессиональные услуги флористов
• Экспресс-доставка 24/7 по Казани
и Татарстану
Почему выбирают нас:
✓ Гарантия свежести цветов до 7 дней
✓ Цены от 499 рублей
✓ Оплата после получения
✓ Скидка 15% на первый заказ
✓ Доставка в день заказа
✓ Профессиональная упаковка
✓ Возможность заказа онлайн или по телефону
Наши флористы создают уникальные
композиции, учитывая все ваши
пожелания. Мы работаем с лучшими поставщиками и выращиваем собственные цветы, чтобы гарантировать высочайшее
качество каждого букета.
Закажите цветы значение прямо сейчас и подарите радость близким!
Мы заботимся о том, чтобы ваш подарок был доставлен вовремя и в идеальном состоянии.
Присоединяйтесь к тысячам довольных клиентов!
Мы создаем моменты счастья, которые остаются в памяти навсегда.
букет красивый
22 Oct 25 at 9:06 pm
https://factava.com.ua/pryvitannya-z-dnem-narodzhennya/prykolni-pryvitannia-z-dnem-narodzhennia-dochtsi-10-oryhinalnykh-idey-dlia-sviatkuvannia/
JessieVinge
22 Oct 25 at 9:07 pm
Good article! We are linking to this great content on our site.
Keep up the good writing.
Axiron Bit
22 Oct 25 at 9:09 pm
техническое задание перевод [url=www.teletype.in/@alexd78/HN462R01hzy]www.teletype.in/@alexd78/HN462R01hzy[/url] .
Vidi perevodov v buro Perevod i Pravo_bist
22 Oct 25 at 9:10 pm
технический перевод требования [url=dzen.ru/a/aPFFa3ZMdGVq1wVQ]dzen.ru/a/aPFFa3ZMdGVq1wVQ[/url] .
Tehnicheskii perevod_oaml
22 Oct 25 at 9:10 pm
диплом о окончании колледжа купить [url=frei-diplom7.ru]frei-diplom7.ru[/url] .
Diplomi_kqei
22 Oct 25 at 9:10 pm
Компания CleanDom предоставляет услугу ежедневной
уборки квартир в Москве.
клининг квартир спб
22 Oct 25 at 9:10 pm
VW108 merupakan situs game online resmi terbaik di Indonesia yang menyediakan berbagai
permainan mudah dimainkan dengan bonus hingga promo menarik setiap hari
vw108 daftar
22 Oct 25 at 9:10 pm
https://www.diigo.com/item/note/8vknd/gond?k=d8ec6eb23a922418d74d412c7754df87
JeffreyHew
22 Oct 25 at 9:12 pm
купить диплом гознак [url=https://www.rudik-diplom7.ru]купить диплом гознак[/url] .
Diplomi_urPl
22 Oct 25 at 9:15 pm
купить диплом в кирове [url=https://rudik-diplom13.ru/]купить диплом в кирове[/url] .
Diplomi_fdon
22 Oct 25 at 9:16 pm
buchmacher gehalt
Review my page … geld verdienen mit sportwetten (gratis-wetten.com)
gratis-wetten.com
22 Oct 25 at 9:17 pm
I seriously love your blog.. Pleasant colors & theme.
Did you create this website yourself? Please reply back as I’m wanting
to create my very own blog and want to know where you got this from or
exactly what the theme is named. Cheers!
corporate
22 Oct 25 at 9:18 pm
Где купить Альфа пвп в Оханске?Вот, обнаружил сайт https://xbanners.ru
– ценник адекватный, доставка быстрая. Может, кто-то брал у них? Насколько качественный товар?
Stevenref
22 Oct 25 at 9:18 pm
1xBet бонус при регистрации подробное описание приветственных бонусов и условий их получения
Aaronawads
22 Oct 25 at 9:20 pm
https://t.me/s/PlayCasino_1xbet
https://t.me/s/PlayCasino_1win
22 Oct 25 at 9:20 pm
https://t.me/s/PlayCasino_1xbet
https://t.me/s/PlayCasino_1xbet
22 Oct 25 at 9:21 pm
В обзоре сервисов для игроков мы кратко разбираем типы бонусов, например фрибеты и депозитные поощрения; в середине материала приведена ссылка на https://bergkompressor.ru/news/artcles/?1xbet_promokod_pri_registracii_bonus_5.html, который может помочь новым пользователям при регистрации. Также, даём советы по безопасности и ответственному подходу к ставкам.
Anthonykit
22 Oct 25 at 9:22 pm
Je suis charme par Impressario Casino, c’est une plateforme qui evoque le raffinement. Les options sont vastes comme un menu etoile, proposant des jeux de table raffines. Amplifiant le plaisir de jeu. Le service est disponible 24/7, avec une aide precise. Les gains arrivent sans delai, cependant quelques tours gratuits supplementaires seraient bien venus. Dans l’ensemble, Impressario Casino garantit un plaisir constant pour les amateurs de sensations elegantes ! Par ailleurs la navigation est simple et gracieuse, amplifie le plaisir de jouer. Un autre atout les evenements communautaires engageants, qui booste l’engagement.
Essayer en ligne|
ProvencePassionU8zef
22 Oct 25 at 9:23 pm
купить диплом в назрани [url=http://rudik-diplom7.ru/]купить диплом в назрани[/url] .
Diplomi_xsPl
22 Oct 25 at 9:25 pm