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!
Hello there! This is kind of off topic but I need some help from an established blog.
Is it hard to set up your own blog? I’m not very techincal but I can figure things out
pretty fast. I’m thinking about making my
own but I’m not sure where to start. Do you have any points or suggestions?
Thank you
junk removal DMV
18 Jul 25 at 9:24 pm
Доказательную базу терапии подтверждают данные с Национального института наркологии.
Выяснить больше – [url=https://narkologicheskaya-klinika-sochi0.ru/]narkologicheskie kliniki alkogolizm sochi[/url]
DarwinGeada
18 Jul 25 at 9:24 pm
Гидроизоляция зданий https://gidrokva.ru и сооружений любой сложности. Фундаменты, подвалы, крыши, стены, инженерные конструкции.
gidrokva-882
18 Jul 25 at 9:26 pm
https://indiamedshub.shop/# online shopping pharmacy india
RobertEmard
18 Jul 25 at 9:29 pm
прогноз хоккей [url=http://www.prognozy-na-khokkej-segodnya1.ru]прогноз хоккей[/url] .
prognozi na hokkei segodnya_ceml
18 Jul 25 at 9:31 pm
прогноз на хоккей на сегодня [url=http://prognozy-na-khokkej-segodnya1.ru/]прогноз на хоккей на сегодня[/url] .
prognozi na hokkei segodnya_nwml
18 Jul 25 at 9:32 pm
Когда запой становится критическим, оперативное вмешательство имеет решающее значение для спасения здоровья и предотвращения необратимых последствий. Во Владимире экстренная помощь нарколога на дому позволяет быстро начать лечение, не требуя госпитализации, что особенно важно для пациентов, нуждающихся в сохранении конфиденциальности и комфорте.
Узнать больше – [url=https://vyvod-iz-zapoya-vladimir000.ru/]вывод из запоя цена владимир[/url]
MichaelBrees
18 Jul 25 at 9:32 pm
I every time spent my half an hour to read this blog’s articles or reviews every day along with a
cup of coffee.
marmaris travesti
18 Jul 25 at 9:34 pm
вывод из запоя круглосуточно иркутск
vivod-iz-zapoya-irkutsk001.ru
экстренный вывод из запоя иркутск
vivodirkutskNeT
18 Jul 25 at 9:40 pm
прогноз ставок на хоккей [url=http://www.prognozy-na-khokkej-segodnya1.ru]http://www.prognozy-na-khokkej-segodnya1.ru[/url] .
prognozi na hokkei segodnya_nyml
18 Jul 25 at 9:48 pm
IndiaMedsHub: india online pharmacy – IndiaMedsHub
BobbyAcany
18 Jul 25 at 9:51 pm
Bonjour, amis !
Je viens de trouver un article avec les nouveautes les plus chaudes sur le jeu Plinko dans les sites francais.
Si tu t’interesses a Plinko, cette lecture est a ne pas rater.
Consulte tout cela via le lien suivant :
https://marcoansaldo.com/jeux-de-plinko-la-chance-vous-attend/
Bonne lecture !
TimothysuTty
18 Jul 25 at 9:55 pm
Мегаполис после заката бодрствует, и мы вдобавок: частная центр лечения алкоголизма и наркомании клиника mcnl.ru работает 24/7. Без записей и бумаг — вызов доктора на дом за 40 минут, щадящий детокс под седацией, ультрабыстрая капельница, психотерапия на месте, долговечное сопровождение. Тайно, скрытно, эффективно — вернём трезвость без боли.
Timsothydet
18 Jul 25 at 9:56 pm
best online pharmacy india [url=https://indiamedshub.com/#]top online pharmacy india[/url] IndiaMedsHub
DavidRhinc
18 Jul 25 at 9:57 pm
Very quickly this web page will be famous among all blogging and site-building people, due to it’s nice
articles or reviews
Buy Anonymous Proxies
18 Jul 25 at 10:06 pm
http://medimexicorx.com/# MediMexicoRx
Vernonhon
18 Jul 25 at 10:15 pm
Современное общество сталкивается с множеством вызовов, связанных с различными зависимостями, которые наносят серьезный урон как физическому, так и психоэмоциональному состоянию человека. Алкоголизм, наркомания и другие виды зависимости не только нарушают здоровье, но и разрушают личные отношения, затрудняют трудовую деятельность и социальную адаптацию. В наркологической клинике “Сила воли” в Иркутске мы предлагаем профессиональную помощь в лечении зависимости и проведении реабилитационных мероприятий, направленных на восстановление здоровья и социальной интеграции пациентов.
Получить больше информации – https://kapelnica-ot-zapoya-irkutsk3.ru/kapelnica-ot-zapoya-v-stacionare-v-irkutske/
PatrickCrymn
18 Jul 25 at 10:16 pm
оценка скупка часов [url=www.ocenka-chasov-onlajn9.ru]www.ocenka-chasov-onlajn9.ru[/url] .
ocenka chasov onlain_guMn
18 Jul 25 at 10:17 pm
mostbet az casino [url=www.mostbet4055.ru]mostbet az casino[/url]
mostbet_xuKi
18 Jul 25 at 10:19 pm
Гидроизоляция зданий https://gidrokva.ru и сооружений любой сложности. Фундаменты, подвалы, крыши, стены, инженерные конструкции.
gidrokva-800
18 Jul 25 at 10:22 pm
Мегаполис в ночь бодрствует, и мы аналогично: эксклюзивная центр лечения алкоголизма клиника mcnl.ru работает 24/7. Без предварительной регистрации и бумаг — вызов специалиста по адресу за менее 45 минут, мягкий детокс в сне, сверхскоростная капельница, психотерапия на месте, долговечное сопровождение. Тихо, конфиденциально, результативно — вернем трезвость без страданий.
LewisGuatt
18 Jul 25 at 10:29 pm
sms bomber
GerardobaR
18 Jul 25 at 10:29 pm
Наркологическая клиника в Екатеринбурге представляет собой специализированное медицинское учреждение, ориентированное на диагностику, лечение и профилактику зависимости от алкоголя, наркотиков и других психоактивных веществ. Современные подходы и комплексные методы терапии позволяют эффективно справляться с разнообразными формами аддиктивного поведения, обеспечивая пациентам качественную медицинскую помощь и психологическую поддержку. Подробнее о современных методах лечения зависимости можно узнать на сайте Всемирной организации здравоохранения.
Ознакомиться с деталями – [url=https://narcologicheskaya-klinika-ekaterinburg00.ru/]частная наркологическая клиника в екатеринбурге[/url]
Robertosheal
18 Jul 25 at 10:32 pm
Системы автоматизированного дозирования обеспечивают точное введение медикаментов, что минимизирует риск побочных эффектов. Постоянный мониторинг жизненно важных показателей позволяет врачу корректировать терапию в режиме реального времени, гарантируя безопасность процедуры.
Получить дополнительную информацию – http://vyvod-iz-zapoya-vladimir0.ru
TerryAcith
18 Jul 25 at 10:43 pm
Гидроизоляция зданий https://gidrokva.ru и сооружений любой сложности. Фундаменты, подвалы, крыши, стены, инженерные конструкции.
gidrokva-53
18 Jul 25 at 10:48 pm
прогноз хоккей [url=http://prognozy-na-khokkej-segodnya.ru]http://prognozy-na-khokkej-segodnya.ru[/url] .
prognozi na hokkei segodnya_jvmr
18 Jul 25 at 10:50 pm
оценка швейцарских часов [url=https://ocenka-chasov-onlajn9.ru/]оценка швейцарских часов[/url] .
ocenka chasov onlain_jgMn
18 Jul 25 at 10:50 pm
buy modafinil from mexico no rx: buy from mexico pharmacy – buy propecia mexico
BobbyAcany
18 Jul 25 at 10:52 pm
Наши врачи уделяют внимание не только медицинским аспектам, но также социальным и психологическим факторам. Мы помогаем пациентам находить новый смысл в жизни, формировать новые увлечения и восстанавливать старые связи с близкими.
Подробнее тут – [url=https://kapelnica-ot-zapoya-irkutsk.ru/]капельница от запоя цена в иркутске[/url]
Josephshoow
18 Jul 25 at 10:52 pm
Игроки часто ищут vavada официальный сайт, и не зря — именно такие платформы обеспечивают честную игру и качественный сервис. Если вас интересует vavada официальный сайт, рекомендуем заглянуть сюда: vavada официальный сайт. Вы узнаете о бонусах, мобильной версии, рабочих зеркалах и многом другом. Проверяйте сами — vavada официальный сайт может приятно удивить!
Matthewrhica
18 Jul 25 at 10:53 pm
лечение запоя
vivod-iz-zapoya-irkutsk001.ru
лечение запоя
alkogolizmirkutskNeT
18 Jul 25 at 10:54 pm
Онлайн-психолог — ваш путь к счастью. Детский психолог онлайн поможет с детской застенчивостью.
психолог онлайн сейчас срочно
Ernestpoive
18 Jul 25 at 10:57 pm
mostbet com uz [url=mostbet4072.ru]mostbet com uz[/url]
mostbet_kuot
18 Jul 25 at 10:59 pm
купить диплом проведенный [url=www.arus-diplom31.ru/]купить диплом проведенный[/url] .
Priobresti diplom lubogo instityta!_yeOl
18 Jul 25 at 11:04 pm
кракен зеркало
DavidFoogs
18 Jul 25 at 11:06 pm
прогноз на сегодня футбол [url=http://prognozy-na-futbol-1.ru/]http://prognozy-na-futbol-1.ru/[/url] .
prognozi na fytbol_ljsi
18 Jul 25 at 11:15 pm
888starz account [url=https://www.888starzz.site]888starz account[/url] .
888starz_noOr
18 Jul 25 at 11:16 pm
online pharmacy india [url=http://indiamedshub.com/#]buy prescription drugs from india[/url] IndiaMedsHub
DavidRhinc
18 Jul 25 at 11:17 pm
оценщик часов москва [url=http://www.ocenka-chasov-onlajn8.ru]http://www.ocenka-chasov-onlajn8.ru[/url] .
ocenka chasov onlain_yjKt
18 Jul 25 at 11:18 pm
IndiaMedsHub: buy medicines online in india – IndiaMedsHub
BobbyAcany
18 Jul 25 at 11:19 pm
flood sms
GerardobaR
18 Jul 25 at 11:25 pm
Нарколог измеряет пульс, артериальное давление, частоту дыхания, насыщение кислородом, а также уточняет историю употребления и наличие хронических заболеваний. Это позволяет оперативно скорректировать состав и скорость инфузии.
Получить дополнительные сведения – [url=https://kapelnica-ot-zapoya-voronezh2.ru/]врач на дом капельница от запоя[/url]
JerryRag
18 Jul 25 at 11:27 pm
1win mx [url=https://www.1win3044.com]https://www.1win3044.com[/url]
1win_yuea
18 Jul 25 at 11:30 pm
Совместные занятия с другими пациентами создают атмосферу поддержки и понимания. Под руководством психотерапевта участники группы делятся опытом, обсуждают сложные ситуации и находят оптимальные способы удержаться от срыва.
Углубиться в тему – https://lechenie-alkogolizma-sochi0.ru/
WilliamToort
18 Jul 25 at 11:32 pm
оценщик часов москва [url=https://ocenka-chasov-onlajn8.ru/]https://ocenka-chasov-onlajn8.ru/[/url] .
ocenka chasov onlain_ueKt
18 Jul 25 at 11:37 pm
888starz скачать ios [url=www.www.carolinestorefinder.com]888starz скачать ios[/url] .
888starz_mdOr
18 Jul 25 at 11:45 pm
Click here https://hartleysheroes.ca/blog/hartleys-heroes-update/?unapproved=99350&moderation-hash=59e6583eb08c0bc8d4fcee3fbfa89c92
JasonNeony
18 Jul 25 at 11:46 pm
http://medimexicorx.com/# MediMexicoRx
RobertEmard
18 Jul 25 at 11:47 pm
После завершения основного курса лечения в наркологической клинике в Краснодаре пациентам предлагаются программы социальной реабилитации. Они направлены на восстановление социальных навыков, адаптацию в обществе и предотвращение рецидивов. Ключевым элементом здесь является поддержка со стороны профессиональных социальных работников и участие в группах взаимопомощи.
Выяснить больше – https://narkologicheskaya-klinika-krasnodar0.ru/narkologicheskaya-klinika-anonimno-krasnodar/
ThomasIdeaf
18 Jul 25 at 11:48 pm
Выездной формат позволяет избежать контактов с другими пациентами в клинике и очистить организм в привычной обстановке. Специалисты самостоятельно привозят весь необходимый набор медикаментов и расходных материалов.
Подробнее тут – http://narkologicheskaya-klinika-ekaterinburg0.ru/narkologicheskaya-klinika-otzyvy-v-ekb/
RaymondHal
18 Jul 25 at 11:52 pm