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!
Wow, this piece of writing is good, my sister is analyzing these things, so I am going to let
know her.
نحوه حساب سود بانکی
8 Aug 25 at 11:47 am
https://say.la/read-blog/123060
DustinUsefs
8 Aug 25 at 11:50 am
Please let me know if you’re looking for a writer for your site.
You have some really great articles and I think I would be a good
asset. If you ever want to take some of the load off, I’d
love to write some articles for your blog in exchange for a link back to mine.
Please blast me an e-mail if interested. Cheers!
BitPulseAI
8 Aug 25 at 11:51 am
электрические рулонные шторы купить москва [url=https://www.rulonnye-shtory-s-elektroprivodom11.ru]https://www.rulonnye-shtory-s-elektroprivodom11.ru[/url] .
rylonnie shtori s elektroprivodom_rdSl
8 Aug 25 at 11:57 am
У большинства действует риск игра с возможностью
приумножения текущих выигрышей.
вулкан казино зеркало
8 Aug 25 at 11:57 am
как купить диплом проведенный [url=www.arus-diplom35.ru/]как купить диплом проведенный[/url] .
Priobresti diplom ob obrazovanii!_seot
8 Aug 25 at 11:58 am
https://write.as/otello/
TraceyRealk
8 Aug 25 at 12:01 pm
Farmasi España ofrece promociones y artículos con aval internacional en el área de cuidado personal.
La fusión ideal entre lo natural y lo científico
con Farmasi Cosmetics España y Nutriplus España, colecciones enfocadas a un cuidado auténtico y responsable.
Farmasi España
8 Aug 25 at 12:05 pm
скачать приложение melbet на андроид [url=https://www.melbet1039.ru]https://www.melbet1039.ru[/url]
melbet_kxEl
8 Aug 25 at 12:08 pm
вывод из запоя
vivod-iz-zapoya-cherepovec008.ru
экстренный вывод из запоя
vivodzapojcherepovecNeT
8 Aug 25 at 12:09 pm
Fabulous, what a weblog it is! This webpage presents helpful facts to us, keep it up.
هتل در جزیره هرمز
8 Aug 25 at 12:11 pm
Эта информационная статья содержит полезные факты, советы и рекомендации, которые помогут вам быть в курсе последних тенденций и изменений в выбранной области. Материал составлен так, чтобы быть полезным и понятным каждому.
Погрузиться в научную дискуссию – https://fisioterapia-alcala126.com/20-anos-centro-fisioterapia-alcala
ClydeWop
8 Aug 25 at 12:16 pm
When I initially commented I clicked the “Notify me when new comments are added” checkbox and now each time a comment is added I get four emails with the same comment.
Is there any way you can remove me from that service? Many thanks!
نحوه سوزاندن سیم کارت ایرانسل
8 Aug 25 at 12:17 pm
rozhau.ru [url=rozhau.ru]rozhau.ru[/url] .
rozhau.ru_tgpt
8 Aug 25 at 12:17 pm
рулонные шторы с электроприводом и дистанционным управлением [url=http://rulonnye-elektroshtory.ru/]рулонные шторы с электроприводом и дистанционным управлением[/url] .
rylonnie elektroshtori_pdot
8 Aug 25 at 12:17 pm
рулонные шторы с пультом [url=https://elektricheskie-rulonnye-shtory90.ru]https://elektricheskie-rulonnye-shtory90.ru[/url] .
elektricheskie rylonnie shtori_pssl
8 Aug 25 at 12:28 pm
Лечение наркомании в клинике начинается с диагностики, позволяющей определить степень зависимости, выявить сопутствующие заболевания и выбрать оптимальную тактику терапии. Важным этапом является детоксикация — очищение организма от токсинов и продуктов распада наркотических веществ, что снижает риск осложнений и облегчает последующее восстановление.
Ознакомиться с деталями – [url=https://lechenie-narkomanii-tver0.ru/]лечение алкоголизма и наркомании центр тверь[/url]
DennisZep
8 Aug 25 at 12:28 pm
rozhau [url=www.rozhau.ru]www.rozhau.ru[/url] .
rozhau.ru_wtpt
8 Aug 25 at 12:28 pm
В этом информативном тексте представлены захватывающие события и факты, которые заставят вас задуматься. Мы обращаем внимание на важные моменты, которые часто остаются незамеченными, и предлагаем новые перспективы на привычные вещи. Подготовьтесь к тому, чтобы быть поглощенным увлекательными рассказами!
Что ещё нужно знать? – https://www.aya.co.il/someones-mane-hilton-budapest-6
Raymondgek
8 Aug 25 at 12:29 pm
электро рулонные шторы [url=https://www.avtomaticheskie-rulonnye-shtory50.ru]https://www.avtomaticheskie-rulonnye-shtory50.ru[/url] .
avtomaticheskie rylonnie shtori_neot
8 Aug 25 at 12:30 pm
рулонные шторы на створку [url=www.rulonnye-shtory-s-elektroprivodom11.ru]www.rulonnye-shtory-s-elektroprivodom11.ru[/url] .
rylonnie shtori s elektroprivodom_lzSl
8 Aug 25 at 12:30 pm
купить диплом с реестром красноярск [url=http://arus-diplom35.ru]купить диплом с реестром красноярск[/url] .
Zakazat diplom o visshem obrazovanii!_kaot
8 Aug 25 at 12:31 pm
https://www.passes.com/takoulubrun
Charlieancew
8 Aug 25 at 12:32 pm
Наркологическая клиника в Твери обеспечивает круглосуточное медицинское наблюдение, что позволяет своевременно выявлять и устранять возможные осложнения. Высококвалифицированные специалисты проводят регулярные обследования и корректируют терапию, обеспечивая безопасность и эффективность лечения.
Выяснить больше – [url=https://narkologicheskaya-klinika-tver0.ru/]наркологическая клиника вывод из запоя[/url]
RaymondFounk
8 Aug 25 at 12:33 pm
Get trained on with newest principles For online training, We
provide a virtual environment that helps in accessing each other’s systems.
The complete course material in pdf format, reference materials, course
code is provided to trainees. We have conducted
online sessions through any of the available requirements like Skype, WebEx,
GoToMeeting, Webinar, etc
explore sap datasphere foundational
8 Aug 25 at 12:38 pm
rozhau.ru [url=www.rozhau.ru/]www.rozhau.ru/[/url] .
rozhau.ru_pfpt
8 Aug 25 at 12:38 pm
Мы также подчеркиваем и то, что для желающих
узнать прогноз в целом сайт всегда пишет краткую сводку длиной в 1-2 предложения.
comment-51040
8 Aug 25 at 12:40 pm
Для оценки состояния пациента применяются современные методы диагностики, включая лабораторные исследования и психологическое тестирование. Индивидуальный план лечения разрабатывается с учётом истории болезни, сопутствующих заболеваний и социальной ситуации. Постоянный мониторинг позволяет своевременно корректировать программу лечения для максимальной эффективности.
Подробнее тут – [url=https://narkologicheskaya-klinika-novosibirsk0.ru/]наркологическая клиника вывод из запоя новосибирск[/url]
TimothyRok
8 Aug 25 at 12:41 pm
купить аттестат 11 класса в оренбурге [url=https://www.arus-diplom21.ru]https://www.arus-diplom21.ru[/url] .
Priobresti diplom yniversiteta!_oqpn
8 Aug 25 at 12:42 pm
Этот текст призван помочь читателю расширить кругозор и получить практические знания. Мы используем простой язык, наглядные примеры и структурированное изложение, чтобы сделать обучение максимально эффективным и увлекательным.
Нажмите, чтобы узнать больше – https://watercoolersuae.com/2024/04/25/understanding-electrical-codes-a-guide-for-diy-enthusiasts
Michaelset
8 Aug 25 at 12:44 pm
Этот текст призван помочь читателю расширить кругозор и получить практические знания. Мы используем простой язык, наглядные примеры и структурированное изложение, чтобы сделать обучение максимально эффективным и увлекательным.
Только для своих – https://metamarketing.ca/2023/03/29/why-is-your-social-media-account-not-doing-well
Michaelset
8 Aug 25 at 12:46 pm
Раннее обращение к специалистам позволяет провести качественную диагностику, подобрать адекватное лечение и обеспечить комплексную поддержку пациента.
Получить дополнительную информацию – [url=https://narkologicheskaya-pomoshh-novokuzneczk0.ru/]платная наркологическая помощь в новокузнецке[/url]
RaymondSer
8 Aug 25 at 12:48 pm
rozhau [url=rozhau.ru]rozhau.ru[/url] .
rozhau.ru_jspt
8 Aug 25 at 12:48 pm
Thanks to my father who shared with me regarding this web site,
this blog is actually awesome.
نحوه ابطال وکالت بلاعزل در فروش ملک
8 Aug 25 at 12:48 pm
rozhau.ru [url=http://rozhau.ru/]http://rozhau.ru/[/url] .
rozhau.ru_kzpt
8 Aug 25 at 12:50 pm
«УралРеаб» предлагает несколько форматов терапии, позволяющих выбрать оптимальный вариант в зависимости от тяжести зависимости, социальных обстоятельств и клинических показателей.
Подробнее тут – [url=https://lechenie-alkogolizma-ekaterinburg00.ru/]лечение алкоголизма в екатеринбурге[/url]
Normanniz
8 Aug 25 at 12:51 pm
рулонные шторы с автоматическим управлением [url=https://elektricheskie-rulonnye-shtory90.ru/]https://elektricheskie-rulonnye-shtory90.ru/[/url] .
elektricheskie rylonnie shtori_itsl
8 Aug 25 at 12:54 pm
электрическая рулонная штора [url=avtomaticheskie-rulonnye-shtory50.ru]avtomaticheskie-rulonnye-shtory50.ru[/url] .
avtomaticheskie rylonnie shtori_cuot
8 Aug 25 at 12:56 pm
https://bs2besd.cc
JulianBut
8 Aug 25 at 1:01 pm
Fantastic website. Plenty of useful info here. I am sending it to a few buddies ans additionally sharing in delicious.
And of course, thanks in your effort!
طراحی سایت فروشگاهی در قزوین
8 Aug 25 at 1:01 pm
купить аттестат за 11 классов цена [url=http://arus-diplom21.ru]http://arus-diplom21.ru[/url] .
Kypit diplom yniversiteta!_frpn
8 Aug 25 at 1:02 pm
Запой — состояние, характеризующееся неконтролируемым и продолжительным употреблением алкоголя, что вызывает сильную интоксикацию организма и нарушения в работе жизненно важных органов. При длительном запое организм испытывает колоссальную нагрузку, страдает сердечно-сосудистая система, печень, почки, а нервная система работает на пределе. Одним из наиболее эффективных методов быстрого и безопасного выхода из запоя является капельница. Наркологическая клиника «Анти-Кризис» в Краснодаре оказывает срочную помощь и вывод из запоя за 24 часа, обеспечивая индивидуальный подход, полную анонимность и доступные цены.
Подробнее – [url=https://kapelnica-ot-zapoya-krasnodar777.ru/]капельница от запоя анонимно[/url]
Francishaw
8 Aug 25 at 1:04 pm
rozhau.ru [url=https://www.rozhau.ru]https://www.rozhau.ru[/url] .
rozhau.ru_pzpt
8 Aug 25 at 1:07 pm
автоматические рулонные шторы на окна [url=http://www.rulonnye-shtory-s-elektroprivodom11.ru]http://www.rulonnye-shtory-s-elektroprivodom11.ru[/url] .
rylonnie shtori s elektroprivodom_mtSl
8 Aug 25 at 1:08 pm
Джой казино
джойказино официальный сайт
8 Aug 25 at 1:08 pm
There is definately a lot to know about this issue.
I love all the points you have made.
با رتبه ۵۰۰ تجربی کجا قبول میشم
8 Aug 25 at 1:08 pm
Thriving businesses recognize the importance of efficient financial management, which
is why Scotia Connect platform has become crucial for contemporary business.
The innovative platform delivers unparalleled versatility in handling diverse business needs.
If you’re controlling supply chain payments,
this platform adjusts to your unique requirements.
This complete data visualization creates extensive insights
that enable decision-makers identify opportunities for improvement.
Device flexibility ensures that organizational heads can access critical monetary details from any location. Help desk representatives
provide expert guidance as needed. This platform maintains to advance with shifting market demands.
scotia connect
8 Aug 25 at 1:10 pm
Мы предлагаем вам подробное руководство, основанное на проверенных источниках и реальных примерах. Каждая часть публикации направлена на то, чтобы помочь вам разобраться в сложных вопросах и применить знания на практике.
Узнать напрямую – https://infoempresaconsultores.com/2019/04/04/consulting-project
Jamesrhist
8 Aug 25 at 1:12 pm
рольшторы на окна купить в москве [url=http://www.rulonnye-shtory-s-elektroprivodom11.ru]http://www.rulonnye-shtory-s-elektroprivodom11.ru[/url] .
rylonnie shtori s elektroprivodom_sbSl
8 Aug 25 at 1:12 pm
https://hub.docker.com/u/eldusbails
Charlieancew
8 Aug 25 at 1:15 pm