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!
https://www.speedrun.com/users/candetoxblend
Enfrentar un test preocupacional ya no tiene que ser un problema. Existe una alternativa científica que responde en horas.
El secreto está en su fórmula canadiense, que ajusta el cuerpo con creatina, provocando que la orina enmascare los metabolitos de toxinas. Esto asegura una muestra limpia en solo 2 horas, con efectividad durante 4 a 5 horas.
Lo mejor: no necesitas semanas de detox, diseñado para quienes enfrentan pruebas imprevistas.
Miles de clientes confirman su seguridad. Los envíos son 100% discretos, lo que refuerza la seguridad.
Cuando el examen no admite errores, esta fórmula es la respuesta que estabas buscando.
JuniorShido
16 Sep 25 at 5:20 pm
Публикация посвящена жизненным историям людей, успешно справившихся с зависимостью. Мы покажем, что выход есть, и он начинается с первого шага — принятия проблемы и желания измениться.
См. подробности – [url=https://lux-clinic.ru/stati/osnovnye-prichiny-narkomanii.html]биологические причины наркомании[/url]
Stevedom
16 Sep 25 at 5:20 pm
электрокарниз [url=http://karniz-s-elektroprivodom-kupit.ru/]http://karniz-s-elektroprivodom-kupit.ru/[/url] .
karniz s elektroprivodom kypit_lfEr
16 Sep 25 at 5:21 pm
киного [url=http://www.kinogo-12.top]киного[/url] .
kinogo_jdol
16 Sep 25 at 5:21 pm
карниз для штор с электроприводом [url=www.karniz-s-elektroprivodom-kupit.ru]www.karniz-s-elektroprivodom-kupit.ru[/url] .
karniz s elektroprivodom kypit_lmEr
16 Sep 25 at 5:24 pm
Hello to all, how is all, I think every one is getting more from this
web site, and your views are nice in favor of new people.
شهریه دانشگاه خاتم
16 Sep 25 at 5:25 pm
рулонные шторы на пластиковые окна на кухню [url=https://elektricheskie-rulonnye-shtory15.ru/]https://elektricheskie-rulonnye-shtory15.ru/[/url] .
elektricheskie rylonnie shtori_hyEi
16 Sep 25 at 5:26 pm
Проводив час в інтернеті онлайн
більше трьох годин, але не знайшов жодного матеріалу, який би мене так
вразив, як ваш матеріал про автомобілі!
Це реально варте уваги! На мою думку,
якби всі блогери створювали такий крутий контент
про тачки, інтернет був
би значно цікавішим!
дтп юа
16 Sep 25 at 5:27 pm
При возникновении проблемы с зависимостью или если вы знаете человека, нуждающегося помощь, обратите внимание обратиться к специалистам. Клиника наркологии в владимире предлагает срочную помощь при алкоголизма и наркомании. Консультация к наркологу поможет определить нужный курс лечения. Центр лечения наркозависимости предоставляет медицинскую помощь и психотерапию, в дополнение поддержку семьи. Анонимное лечение обеспечивает безопасность и конфиденциальность. Реабилитационные программы для наркозависимых включает профилактику рецидивов и реинтеграцию после зависимости. Первый шаг к новому началу начинается в этом месте. vivod-iz-zapoya-vladimir018.ru
zapojvladimirNeT
16 Sep 25 at 5:27 pm
kamagra kaufen ohne rezept online: generisches sildenafil alternative – Viagra online bestellen Schweiz
Israelpaync
16 Sep 25 at 5:27 pm
рулонные шторы в москве [url=http://avtomaticheskie-rulonnye-shtory5.ru]http://avtomaticheskie-rulonnye-shtory5.ru[/url] .
avtomaticheskie rylonnie shtori_nvsr
16 Sep 25 at 5:28 pm
рулонные шторы с направляющими купить [url=http://www.elektricheskie-rulonnye-shtory15.ru]http://www.elektricheskie-rulonnye-shtory15.ru[/url] .
elektricheskie rylonnie shtori_obEi
16 Sep 25 at 5:30 pm
Если вы любите делать снимки на телефон, то это приложение
точно будет вам по вкусу, ведь в нем много особенностей и оно
достаточно простое, интуитивно понятное.
www.russiacontest.tabippo.net/2025/07/22/rating-safe-virtual-casinos-how-to-determine-the-best-club/
16 Sep 25 at 5:31 pm
двойные рулонные шторы с электроприводом [url=www.avtomaticheskie-rulonnye-shtory5.ru/]двойные рулонные шторы с электроприводом[/url] .
avtomaticheskie rylonnie shtori_mhsr
16 Sep 25 at 5:32 pm
I loved as much as you’ll receive carried out right here.
The sketch is tasteful, your authored subject matter stylish.
nonetheless, you command get got an impatience
over that you wish be delivering the following.
unwell unquestionably come more formerly again since exactly the same nearly
very often inside case you shield this increase.
website singapore
16 Sep 25 at 5:34 pm
рулонные шторы на электроприводе [url=avtomaticheskie-rulonnye-shtory5.ru]avtomaticheskie-rulonnye-shtory5.ru[/url] .
avtomaticheskie rylonnie shtori_ypsr
16 Sep 25 at 5:35 pm
Touche. Solid arguments. Keep up the good effort.
online casino gambling
16 Sep 25 at 5:37 pm
фильмы про войну смотреть онлайн [url=http://kinogo-12.top/]http://kinogo-12.top/[/url] .
kinogo_tlol
16 Sep 25 at 5:37 pm
1win вывод денег отзывы [url=1win12015.ru]1win12015.ru[/url]
1win_xqei
16 Sep 25 at 5:38 pm
It’s not my first time to pay a quick visit this website,
i am visiting this website dailly and get fastidious information from here
every day.
Fidato Bitvista
16 Sep 25 at 5:40 pm
Наркологическая помощь в Раменском в клинике «Возрождение» — это быстрый выезд профильного врача, безопасная детокс-терапия и полноценные программы восстановления без постановки на учёт. Мы работаем 24/7, аккуратно стабилизируем состояние на дому или принимаем в стационаре, подбираем лечение с учётом возраста, сопутствующих заболеваний и текущих анализов. Уже при первом обращении координатор уточняет симптомы, оценивает риски, предлагает ближайшее окно выезда и объясняет, как подготовиться к визиту. Наша задача — не временно приглушить симптомы, а выстроить путь к устойчивой ремиссии и вернуть пациенту контроль над жизнью, при этом сохраняя конфиденциальность каждого шага.
Подробнее можно узнать тут – http://narkologicheskaya-pomoshch-ramenskoe7.ru/kruglosutochnaya-narkologicheskaya-pomoshch-v-ramenskom/
Jacobham
16 Sep 25 at 5:41 pm
https://intimgesund.com/# IntimGesund
Williamves
16 Sep 25 at 5:41 pm
фильмы ужасов смотреть онлайн [url=http://www.kinogo-12.top]http://www.kinogo-12.top[/url] .
kinogo_vyol
16 Sep 25 at 5:41 pm
I am really glad to glance at this weblog posts which includes lots of valuable data,
thanks for providing such data.
Stream Fertinex Cap
16 Sep 25 at 5:43 pm
куда вводить промокод в 1win [url=https://1win12016.ru/]https://1win12016.ru/[/url]
1win_ecOa
16 Sep 25 at 5:44 pm
смотреть мультфильмы онлайн бесплатно [url=http://www.kinogo-12.top]http://www.kinogo-12.top[/url] .
kinogo_ilol
16 Sep 25 at 5:44 pm
стоимость рулонных жалюзи [url=http://avtomaticheskie-rulonnye-shtory5.ru/]http://avtomaticheskie-rulonnye-shtory5.ru/[/url] .
avtomaticheskie rylonnie shtori_wbsr
16 Sep 25 at 5:44 pm
Купить мефедрон, гашиш, шишки, альфа-пвп
Брал неоднократно совместки, всё всегда ровно! так держать!
DavidZef
16 Sep 25 at 5:45 pm
электрокарнизы купить в москве [url=karniz-s-elektroprivodom-kupit.ru]karniz-s-elektroprivodom-kupit.ru[/url] .
karniz s elektroprivodom kypit_baEr
16 Sep 25 at 5:46 pm
карниз для штор электрический [url=https://karniz-s-elektroprivodom-kupit.ru/]https://karniz-s-elektroprivodom-kupit.ru/[/url] .
karniz s elektroprivodom kypit_ysEr
16 Sep 25 at 5:50 pm
автоматические рулонные шторы с электроприводом [url=http://elektricheskie-rulonnye-shtory15.ru]http://elektricheskie-rulonnye-shtory15.ru[/url] .
elektricheskie rylonnie shtori_qoEi
16 Sep 25 at 5:50 pm
карниз с электроприводом [url=https://karniz-s-elektroprivodom-kupit.ru/]https://karniz-s-elektroprivodom-kupit.ru/[/url] .
karniz s elektroprivodom kypit_bhEr
16 Sep 25 at 5:53 pm
перепланировка и согласование [url=http://www.pereplanirovka-nezhilogo-pomeshcheniya3.ru]http://www.pereplanirovka-nezhilogo-pomeshcheniya3.ru[/url] .
pereplanirovka nejilogo pomesheniya_dtsa
16 Sep 25 at 5:53 pm
Can I simply say what a relief to discover someone who genuinely understands what they are discussing
online. You definitely understand how to bring a problem
to light and make it important. A lot more people must look at this and understand
this side of the story. I was surprised you’re not more popular given that you surely
have the gift.
سامانه کارا وام
16 Sep 25 at 5:54 pm
производитель рулонных штор [url=www.elektricheskie-rulonnye-shtory15.ru/]www.elektricheskie-rulonnye-shtory15.ru/[/url] .
elektricheskie rylonnie shtori_pbEi
16 Sep 25 at 5:54 pm
What’s up, I wish for to subscribe for this webpage
to take most recent updates, thus where can i do it
please assist.
The Water Heater Warehouse Water Heater leaks Fullerton CA
16 Sep 25 at 5:55 pm
мостбет вход на сегодня [url=http://mostbet12014.ru]http://mostbet12014.ru[/url]
mostbet_enKl
16 Sep 25 at 5:55 pm
günstigste online apotheke: Gesund Direkt 24 – online apotheke günstig
Donaldanype
16 Sep 25 at 5:56 pm
рулонные шторы с электроприводом [url=https://avtomaticheskie-rulonnye-shtory5.ru]https://avtomaticheskie-rulonnye-shtory5.ru[/url] .
avtomaticheskie rylonnie shtori_cfsr
16 Sep 25 at 5:57 pm
готовые рулонные шторы купить в москве [url=https://elektricheskie-rulonnye-shtory15.ru]https://elektricheskie-rulonnye-shtory15.ru[/url] .
elektricheskie rylonnie shtori_cvEi
16 Sep 25 at 5:57 pm
игра авиатор как выиграть [url=https://www.1win12016.ru]игра авиатор как выиграть[/url]
1win_xqOa
16 Sep 25 at 6:00 pm
рулонные жалюзи на окна цена [url=www.avtomaticheskie-rulonnye-shtory5.ru/]www.avtomaticheskie-rulonnye-shtory5.ru/[/url] .
avtomaticheskie rylonnie shtori_zhsr
16 Sep 25 at 6:01 pm
перепланировка нежилого помещения в нежилом здании [url=http://pereplanirovka-nezhilogo-pomeshcheniya2.ru]перепланировка нежилого помещения в нежилом здании[/url] .
pereplanirovka nejilogo pomesheniya_kpEt
16 Sep 25 at 6:02 pm
Bubbles and Pearls играть в риобет
GeorgeDum
16 Sep 25 at 6:02 pm
1 win скачать на айфон [url=www.1win12018.ru]www.1win12018.ru[/url]
1win_fnet
16 Sep 25 at 6:02 pm
https://potenzapothekede.shop/# cialis generika ohne rezept
Williamves
16 Sep 25 at 6:02 pm
электрокарниз недорого [url=https://karniz-s-elektroprivodom-kupit.ru/]karniz-s-elektroprivodom-kupit.ru[/url] .
karniz s elektroprivodom kypit_scEr
16 Sep 25 at 6:02 pm
Секс знакомства
Секс знакомства
16 Sep 25 at 6:04 pm
электро жалюзи на окна [url=http://www.avtomaticheskie-rulonnye-shtory5.ru]http://www.avtomaticheskie-rulonnye-shtory5.ru[/url] .
avtomaticheskie rylonnie shtori_dusr
16 Sep 25 at 6:06 pm
Казино 1xbet слот Born Wild
Edgarclome
16 Sep 25 at 6:06 pm