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!
This information is priceless. Where can I find out more?
казино риобет
Dichaelwaw
12 Sep 25 at 1:17 pm
согласование проекта перепланировки квартиры [url=https://soglasovanie-pereplanirovki-kvartiry17.ru/]согласование проекта перепланировки квартиры[/url] .
soglasovanie pereplanirovki kvartiri _vqol
12 Sep 25 at 1:18 pm
Публикация предлагает читателю не просто информацию, а инструменты для анализа и саморазвития. Мы стимулируем критическое мышление, предлагая различные точки зрения и призывая к самостоятельному поиску решений.
Получить исчерпывающие сведения – https://sharenting.it/2020/07/16/test-sharenting-corriere-it
CaseyWoope
12 Sep 25 at 1:20 pm
букмекерская контора теннесси скачать [url=https://mostbet12006.ru]https://mostbet12006.ru[/url]
mostbet_vvKl
12 Sep 25 at 1:22 pm
экспертиза перепланировки квартиры [url=http://soglasovanie-pereplanirovki-kvartiry17.ru/]экспертиза перепланировки квартиры[/url] .
soglasovanie pereplanirovki kvartiri _byol
12 Sep 25 at 1:22 pm
https://dzen.ru/id/685ced32970bb0614cf18a3d Путь сильного: “Путь сильного” – это метафорический термин, обозначающий процесс личностного роста, развития и достижения успеха, требующий значительных усилий, самодисциплины и упорства. Этот путь не обязательно связан с физической силой, хотя она может быть частью этого процесса. “Путь сильного” подразумевает развитие силы воли, характера, интеллекта, эмоционального интеллекта и других качеств, необходимых для достижения поставленных целей и преодоления жизненных трудностей. Ключевые элементы “пути сильного” включают: Самоопределение: Четкое понимание своих целей, ценностей, желаний и стремлений. Самодисциплина: Способность контролировать свои импульсы, управлять своим временем, придерживаться своих планов и выполнять поставленные задачи. Упорство: Способность не сдаваться перед трудностями, продолжать двигаться вперед, несмотря на неудачи и препятствия. Обучение: Постоянное приобретение новых знаний, навыков и умений, необходимых для достижения целей. Самоанализ: Способность оценивать свои действия, выявлять ошибки и извлекать уроки из опыта. Ответственность: Готовность брать на себя ответственность за свои поступки и их последствия. Эмоциональная устойчивость: Способность управлять своими эмоциями, справляться со стрессом, сохранять спокойствие в сложных ситуациях. Решительность: Способность принимать решения и действовать, не поддаваясь сомнениям и страхам. Адаптивность: Способность приспосабливаться к изменяющимся условиям, быстро реагировать на новые вызовы. Позитивное мышление: Способность видеть возможности, а не проблемы, и сохранять оптимизм в любой ситуации. “Путь сильного” – это не статичное состояние, а динамичный процесс. Это постоянное стремление к самосовершенствованию, преодолению своих слабостей и достижению новых высот. Это путь, который требует постоянных усилий, но который в конечном итоге приводит к личностному росту, успеху и удовлетворенности жизнью.
Wayneliz
12 Sep 25 at 1:23 pm
согласование перепланировки квартиры [url=https://soglasovanie-pereplanirovki-kvartiry17.ru/]согласование перепланировки квартиры[/url] .
soglasovanie pereplanirovki kvartiri _zdol
12 Sep 25 at 1:26 pm
Hi, I read your blogs on a regular basis.
Your writing style is witty, keep up the good work!
rose toy
12 Sep 25 at 1:27 pm
mostbet download [url=http://mostbet12007.ru]http://mostbet12007.ru[/url]
mostbet_lspt
12 Sep 25 at 1:29 pm
1win скачать на айфон [url=http://1win12006.ru/]1win скачать на айфон[/url]
1win_fykn
12 Sep 25 at 1:31 pm
https://morningdirectory.com/listings861351/grab-your-1xbet-today-promo-code-and-win-more
ioimoga
12 Sep 25 at 1:32 pm
Thanks very interesting blog!
88fc
12 Sep 25 at 1:32 pm
Эта публикация дает возможность задействовать различные источники информации и представить их в удобной форме. Читатели смогут быстро найти нужные данные и получить ответы на интересующие их вопросы. Мы стремимся к четкости и доступности материала для всех!
Смотрите также… – https://rcotec.be/huis/camylla-battani-l8y9fvgxree-unsplash-2
Jimmiekex
12 Sep 25 at 1:33 pm
Hello i am kavin, its my first occasion to commenting anyplace, when i read this post i thought i could also create comment
due to this good post.
LucroX AI
12 Sep 25 at 1:34 pm
Качество тоже супер.
https://yamap.com/users/4804276
Через Skype мы больше не работаем, об этом мы объявляли пару недель назад.
Rodneynub
12 Sep 25 at 1:35 pm
Do you mind if I quote a couple of your posts as long as I provide credit and sources back to your website?
My website is in the very same area of interest as yours and my users would genuinely benefit from
some of the information you present here. Please let me know
if this alright with you. Many thanks!
audit firm singapore
12 Sep 25 at 1:39 pm
Этот обзор дает возможность взглянуть на историю и науку под новым углом. Мы представляем редкие факты, неожиданные связи и значимые события, которые помогут вам глубже понять развитие цивилизации и роль человека в ней.
Есть чему поучиться – https://dollzanddinoz.com/behind-the-season
CaseyWoope
12 Sep 25 at 1:39 pm
1win скачать на телефон iphone [url=www.1win12005.ru]www.1win12005.ru[/url]
1win_sdol
12 Sep 25 at 1:39 pm
скачать 1win казино [url=www.1win12005.ru]www.1win12005.ru[/url]
1win_paol
12 Sep 25 at 1:40 pm
стоит купить диплом о высшем образовании [url=https://www.educ-ua2.ru]стоит купить диплом о высшем образовании[/url] .
Diplomi_hmOt
12 Sep 25 at 1:45 pm
купить диплом в техникуме [url=http://educ-ua10.ru/]купить диплом в техникуме[/url] .
Diplomi_ioKl
12 Sep 25 at 1:47 pm
мостбет скачать приложение на андроид [url=http://mostbet12003.ru]http://mostbet12003.ru[/url]
mostbet_qyet
12 Sep 25 at 1:47 pm
No matter if some one searches for his required thing, thus he/she wants to be
available that in detail, therefore that thing is maintained over here.
rtp gacor
12 Sep 25 at 1:49 pm
Эта публикация дает возможность задействовать различные источники информации и представить их в удобной форме. Читатели смогут быстро найти нужные данные и получить ответы на интересующие их вопросы. Мы стремимся к четкости и доступности материала для всех!
Посмотреть подробности – https://www.ochicochiya.com/%E5%86%99%E7%9C%9F-2024-08-11-%E5%A4%8F%E5%AD%A3%E4%BC%91%E6%A5%AD%E3%81%8A%E7%9F%A5%E3%82%89%E3%81%9B
Jimmiekex
12 Sep 25 at 1:49 pm
Кракен (kraken) – ты знаешь что это,
уже годами проверенный сервис российского даркнета.
Недавно мы запустили p2p обмены и теперь вы можете обменивать
любую сумму для пополнения.
Всегда есть свежая ссылка кракен
через ВПН:
кракен регистрация
web page
12 Sep 25 at 1:51 pm
https://taplink.cc/toprucasino
CurtisGlorb
12 Sep 25 at 1:55 pm
Популярный сайт «HackerLive» предлагает воспользоваться услугами продвинутых и опытных специалистов, которые в любое время взломают почту, узнают пароли от социальных сетей, а также обеспечат защиту ваших данных. При этом вы сможете надеяться на полную конфиденциальность, а потому о том, что вы решили воспользоваться помощью хакера, точно никто не узнает. На сайте https://hackerlive.biz вы найдете контактные данные программистов, хакеров, которые с легкостью возьмутся даже за самую сложную работу, выполнят ее блестяще и за разумную цену.
ciyukref
12 Sep 25 at 1:56 pm
Greetings! I’ve been following your site for a while now and finally got the
courage to go ahead and give you a shout out from Lubbock Tx!
Just wanted to mention keep up the excellent work!
Voryxa Yieldora
12 Sep 25 at 1:56 pm
Процесс вывода из запоя на дому в Мариуполе построен по четко отлаженной схеме, что позволяет быстро и безопасно восстановить здоровье пациента.
Узнать больше – http://narcolog-na-dom-mariupol0.ru
ChanceAbash
12 Sep 25 at 1:59 pm
I’m extremely impressed with your writing skills as well as
with the layout on your blog. Is this a paid theme or did you modify it yourself?
Either way keep up the excellent quality writing, it’s
rare to see a nice blog like this one today.
Blackwood Gainflow
12 Sep 25 at 1:59 pm
Р’СЃРµ РѕРє – связался РїРѕ скайпу, продавец адекват – “пошел навстречу”. оплатил – Р±СѓРґСѓ ждать трека.
https://www.brownbook.net/business/54235165/где-можно-купить-гашиш-в-кенши/
Сильно!!!5 из 5!!
Rodneynub
12 Sep 25 at 1:59 pm
Врач уточняет, как долго продолжается запой, какой алкоголь употребляется и имеются ли сопутствующие заболевания. Тщательный анализ этих данных позволяет подобрать оптимальные методы детоксикации и снизить риск осложнений.
Детальнее – https://narcolog-na-dom-mariupol00.ru/narkolog-na-dom-czena-mariupol
Shawnram
12 Sep 25 at 2:00 pm
Поставили [url=https://razvitieagro.ru/ventilyacionnoe-oborudovanie-dlya-pticefabrik/]рециркуляционные вентиляторы v flofan[/url]. Честно, не ожидали такой разницы. Воздух стал постоянно двигаться, влажность снизилась, и животные чувствуют себя лучше. Мы заметили, что корм стал съедаться активнее, а продуктивность выросла. Такое впечатление, будто даже само помещение ожило. Иногда действительно маленькая деталь решает большие проблемы.
Prorezavnax
12 Sep 25 at 2:01 pm
Когда запой становится угрозой для жизни и здоровья, своевременная помощь профессионала может стать решающим фактором для скорейшего восстановления. В Мурманске, где суровые климатические условия добавляют стресса и осложнений, квалифицированные наркологи оказывают помощь на дому, обеспечивая оперативную детоксикацию и индивидуальную терапию в привычной обстановке. Такой подход позволяет пациентам избежать лишних перемещений и получить поддержку в комфортной атмосфере.
Исследовать вопрос подробнее – [url=https://vyvod-iz-zapoya-murmansk0.ru/]вывод из запоя недорого[/url]
Jamesver
12 Sep 25 at 2:01 pm
Процесс лечения капельничным методом от запоя организован по четко структурированной схеме, позволяющей обеспечить оперативное и безопасное восстановление организма.
Разобраться лучше – https://kapelnica-ot-zapoya-arkhangelsk0.ru/kapelnicza-ot-zapoya-czena-arkhangelsk/
KennethSwelf
12 Sep 25 at 2:03 pm
Лечение вывода из запоя в Архангельске проводится по четко структурированной схеме, которая позволяет оперативно стабилизировать состояние пациента и начать процесс восстановления.
Ознакомиться с деталями – [url=https://kapelnica-ot-zapoya-arkhangelsk00.ru/]капельница от запоя стоимость архангельск[/url]
Robertfal
12 Sep 25 at 2:06 pm
Ситуации, связанные с алкогольной или наркотической интоксикацией, редко дают время на раздумья. В эти моменты важны не только знания врача, но и скорость реагирования, конфиденциальность и возможность начать лечение там, где пациенту психологически безопасно — дома. Наркологическая клиника «Балтийский МедЦентр» в Калининграде выстроила полноценный выездной формат помощи 24/7: врач прибывает в течение 30 минут, на месте проводит диагностику, стартовую стабилизацию и инфузионную терапию (капельницы), затем выдает подробный план дальнейших шагов. Такой подход снижает риски осложнений, помогает быстрее вернуть контроль над ситуацией и избавляет от дополнительного стресса, связанного с поездкой в стационар.
Разобраться лучше – [url=https://narcolog-na-dom-kaliningrad0.ru/]вызвать нарколога на дом в калининграде[/url]
RussellCed
12 Sep 25 at 2:07 pm
Промокод 1WIN на 500% на первые 20 депозитов:
http://electrospeed.teamforum.ru/viewtopic.php?f=3&t=6250. Актуальность промокода: настоящий момент. Сумма бонуса по промокоду: до 200 000 рублей.
JosephInisy
12 Sep 25 at 2:08 pm
Чтобы у семьи было чёткое понимание, что и в какой последовательности мы делаем, ниже — рабочий алгоритм для стационара и для выезда на дом (шаги идентичны, различается только объём мониторинга и доступная диагностика).
Детальнее – http://kapelnica-ot-zapoya-vidnoe7.ru/kapelnica-ot-zapoya-kruglosutochno-v-vidnom/
EugeneSoype
12 Sep 25 at 2:08 pm
Now I am going to do my breakfast, after having my breakfast coming yet again to
read further news.
sump pump replacement near me
12 Sep 25 at 2:10 pm
You’ve defined this in a method that lastly made it click on for me.
ira gold custodian
12 Sep 25 at 2:10 pm
I think the admin of this site is actually working hard for his website, for the
reason that here every stuff is quality based material.
Eternal Lunesta
12 Sep 25 at 2:12 pm
1win официальный сайт вход в личный кабинет [url=https://www.1win12006.ru]https://www.1win12006.ru[/url]
1win_szkn
12 Sep 25 at 2:14 pm
купить диплом медсестры с занесением в реестр [url=http://educ-ua15.ru/]http://educ-ua15.ru/[/url] .
Diplomi_qxmi
12 Sep 25 at 2:15 pm
I’m extremely impressed with your writing skills as well as with the layout on your blog.
Is this a paid theme or did you modify it yourself? Anyway
keep up the nice quality writing, it is rare to see a nice blog like this one these
days.
WW88
12 Sep 25 at 2:15 pm
портретпофотоназаказ Фото на холсте Барнаул Услуга печати фотографий на холсте, предлагаемая в городе Барнауле.
ThomasJouck
12 Sep 25 at 2:17 pm
https://candetoxblend.mystrikingly.com
Prepararse una prueba de orina ya no tiene que ser una pesadilla. Existe un suplemento de última generación que responde en horas.
El secreto está en su mezcla, que ajusta el cuerpo con creatina, provocando que la orina oculte los marcadores de THC. Esto asegura parámetros adecuados en solo 2 horas, con ventana segura para rendir tu test.
Lo mejor: no se requieren procesos eternos, diseñado para candidatos en entrevistas laborales.
Miles de personas en Chile confirman su rapidez. 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
12 Sep 25 at 2:18 pm
скачать бесплатно мостбет [url=https://mostbet12003.ru/]https://mostbet12003.ru/[/url]
mostbet_rhet
12 Sep 25 at 2:18 pm
Недавно установили [url=https://razvitieagro.ru/vytyazhnye-ventilyacionnye-shaxty/]шахты вентиляционные[/url] на складе. Теперь воздух всегда свежий, запахи исчезли, а работать стало комфортнее. Это вроде простая конструкция, но эффект от неё огромный. Мы довольны результатом и уже думаем расширять систему.
Prorezavnax
12 Sep 25 at 2:22 pm
Pretty! This was a really wonderful post. Thank you for supplying this information.
รับปรึกษา seo
12 Sep 25 at 2:23 pm