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!
потолочкин натяжные потолки самара отзывы [url=https://www.stretch-ceilings-samara-1.ru]https://www.stretch-ceilings-samara-1.ru[/url] .
natyajnie potolki samara_susl
14 Oct 25 at 4:14 pm
переустройство нежилого помещения [url=https://pereplanirovka-nezhilogo-pomeshcheniya9.ru/]https://pereplanirovka-nezhilogo-pomeshcheniya9.ru/[/url] .
pereplanirovka nejilogo pomesheniya_aeKl
14 Oct 25 at 4:17 pm
https://britmedsdirect.com/# private online pharmacy UK
Raymondspemn
14 Oct 25 at 4:17 pm
электрокарниз двухрядный [url=karniz-shtor-elektroprivodom.ru]karniz-shtor-elektroprivodom.ru[/url] .
karniz dlya shtor s elektroprivodom_jxer
14 Oct 25 at 4:18 pm
карнизы с электроприводом купить [url=http://www.elektrokarnizy797.ru]карнизы с электроприводом купить[/url] .
elektrokarnizi_zzMl
14 Oct 25 at 4:18 pm
Незамедлительно после поступления вызова нарколог приезжает на дом для проведения тщательного осмотра. Специалист измеряет жизненно важные показатели, такие как пульс, артериальное давление и температура, и собирает анамнез для оценки степени алкогольной интоксикации.
Подробнее можно узнать тут – http://kapelnica-ot-zapoya-arkhangelsk00.ru
Stevenunurf
14 Oct 25 at 4:18 pm
Приобрести диплом любого университета мы поможем. Купить диплом техникума, колледжа в Ульяновске – [url=http://diplomybox.com/kupit-diplom-tekhnikuma-kolledzha-v-ulyanovske/]diplomybox.com/kupit-diplom-tekhnikuma-kolledzha-v-ulyanovske[/url]
Cazrzhs
14 Oct 25 at 4:18 pm
узаконивание перепланировки нежилого помещения [url=https://pereplanirovka-nezhilogo-pomeshcheniya10.ru/]узаконивание перепланировки нежилого помещения[/url] .
pereplanirovka nejilogo pomesheniya_ydSr
14 Oct 25 at 4:19 pm
Домашняя помощь — это не “облегченная версия” клиники. Команда «Балтийский МедЦентр» использует переносное оборудование и стандартизированные протоколы, позволяющие воспроизвести критически важные этапы стационарного вмешательства в условиях квартиры или частного дома. Врач заранее получает от оператора структурированный опросник по симптомам и сопутствующим заболеваниям, подбирает базовую схему инфузий, проверяет возможные лекарственные взаимодействия и берет с собой расширенный набор медикаментов. По прибытии специалист заново оценивает состояние и при необходимости корректирует назначения, ориентируясь на жизненные показатели, данные экспресс-диагностики и неврологический статус.
Углубиться в тему – [url=https://narcolog-na-dom-kaliningrad0.ru/]врач нарколог на дом калининград[/url]
Philliprob
14 Oct 25 at 4:19 pm
потолочек су [url=https://stretch-ceilings-samara.ru/]stretch-ceilings-samara.ru[/url] .
natyajnie potolki samara_qxkl
14 Oct 25 at 4:19 pm
услуги мини-экскаватора [url=https://arenda-mini-ekskavatora-v-moskve-2.ru/]https://arenda-mini-ekskavatora-v-moskve-2.ru/[/url] .
arenda mini ekskavatora v moskve_vjKt
14 Oct 25 at 4:20 pm
где купить диплом техникума пять плюс [url=www.frei-diplom10.ru/]где купить диплом техникума пять плюс[/url] .
Diplomi_xrEa
14 Oct 25 at 4:20 pm
жалюзи для пластиковых окон с электроприводом [url=https://zhalyuzi-s-elektroprivodom77.ru]https://zhalyuzi-s-elektroprivodom77.ru[/url] .
jaluzi na okna s elektroprivodom_vspa
14 Oct 25 at 4:22 pm
натяжные потолки недорого самара цена [url=http://natyazhnye-potolki-samara-1.ru/]http://natyazhnye-potolki-samara-1.ru/[/url] .
natyajnie potolki samara_laor
14 Oct 25 at 4:24 pm
My coder is trying to persuade me to move to .net from PHP.
I have always disliked the idea because of the expenses.
But he’s tryiong none the less. I’ve been using WordPress on various websites
for about a year and am nervous about switching to another platform.
I have heard fantastic things about blogengine.net. Is there
a way I can transfer all my wordpress content into it?
Any kind of help would be really appreciated!
https://www.google.li/url?sa=i&url=http1winapk.co
14 Oct 25 at 4:24 pm
potolochkin ru [url=https://stretch-ceilings-samara-1.ru/]https://stretch-ceilings-samara-1.ru/[/url] .
natyajnie potolki samara_rqsl
14 Oct 25 at 4:25 pm
Когда проблемы с алкоголизмом достигают критической точки, оперативное вмешательство становится жизненно необходимым. В Мариуполе квалифицированные наркологи оказывают помощь на дому, обеспечивая оперативную детоксикацию организма, стабилизацию жизненно важных показателей и психологическую поддержку. Такой формат лечения позволяет пациенту получить качественную медицинскую помощь в привычной домашней обстановке, сохраняя конфиденциальность и минимизируя стресс, связанный с посещением стационара.
Разобраться лучше – http://narcolog-na-dom-mariupol0.ru
DonaldSKYNC
14 Oct 25 at 4:25 pm
Перед применением препаратов проводится обследование, позволяющее исключить противопоказания. Это особенно важно при сопутствующих заболеваниях, таких как сердечно-сосудистые или печеночные патологии.
Подробнее тут – http://vyvod-iz-zapoya-ulan-ude00.ru/
DonaldVes
14 Oct 25 at 4:26 pm
сайт натяжной потолок [url=www.stretch-ceilings-samara.ru/]www.stretch-ceilings-samara.ru/[/url] .
natyajnie potolki samara_mpkl
14 Oct 25 at 4:26 pm
Терапевтическая стратегия выстраивается вокруг понятных клинических ориентиров, что делает процесс предсказуемым и повышает приверженность пациента к лечению.
Получить дополнительные сведения – https://lechenie-alkogolizma-lugansk0.ru/gde-mozhno-zakodirovatsya-v-luganske
Rickyrob
14 Oct 25 at 4:26 pm
*Седативные компоненты применяются по строгим показаниям, с мониторингом дыхания и сатурации.
Узнать больше – [url=https://vyvod-iz-zapoya-ulan-ude0.ru/]вывод из запоя на дому цена улан-удэ[/url]
LouisDof
14 Oct 25 at 4:26 pm
перепланировка нежилых помещений [url=https://pereplanirovka-nezhilogo-pomeshcheniya10.ru/]перепланировка нежилых помещений[/url] .
pereplanirovka nejilogo pomesheniya_utSr
14 Oct 25 at 4:27 pm
аренда маленького экскаватора [url=http://arenda-mini-ekskavatora-v-moskve-2.ru/]аренда маленького экскаватора[/url] .
arenda mini ekskavatora v moskve_wjKt
14 Oct 25 at 4:27 pm
фитнес клуб официальный сайт фитнес клуб цены
fitnes-klub-403
14 Oct 25 at 4:27 pm
тканевые электрожалюзи [url=https://www.zhalyuzi-s-elektroprivodom77.ru]https://www.zhalyuzi-s-elektroprivodom77.ru[/url] .
jaluzi na okna s elektroprivodom_yxpa
14 Oct 25 at 4:28 pm
https://md.fachschaften.org/s/SVcGkFmVU
lhttyfa
14 Oct 25 at 4:29 pm
Лечение вывода из запоя на дому в Мурманске организовано по четко структурированной схеме, включающей следующие этапы, каждый из которых играет ключевую роль в оперативном восстановлении здоровья:
Получить больше информации – https://vyvod-iz-zapoya-murmansk00.ru/vyvod-iz-zapoya-czena-murmansk/
Sammywroth
14 Oct 25 at 4:30 pm
Its like you read my mind! You seem to know so much about this,
like you wrote the book in it or something. I think that you
can do with some pics to drive the message home a bit, but other than that,
this is excellent blog. A fantastic read. I will certainly be back.
에볼루션바카라
14 Oct 25 at 4:30 pm
потолочкин ру натяжные потолки отзывы [url=https://natyazhnye-potolki-samara-1.ru]https://natyazhnye-potolki-samara-1.ru[/url] .
natyajnie potolki samara_ator
14 Oct 25 at 4:31 pm
Диагностический блок включает сбор анамнеза, оценку витальных показателей, скрининговые шкалы по тревоге, депрессии и патологическому влечению, лабораторные тесты по показаниям. На основании полученных данных выбирается формат помощи и составляется медикаментозная схема с учётом взаимодействий препаратов и вероятных рисков.
Подробнее можно узнать тут – [url=https://narkologicheskaya-klinika-v-luganske0.ru/]наркологическая клиника[/url]
MichaeldraFe
14 Oct 25 at 4:32 pm
электрокарнизы в москве [url=https://karniz-shtor-elektroprivodom.ru]электрокарнизы в москве[/url] .
karniz dlya shtor s elektroprivodom_tver
14 Oct 25 at 4:32 pm
Вывод из запоя в Луганске рассматривается как последовательное медицинское вмешательство, направленное на снижение интоксикации, стабилизацию витальных показателей и профилактику острых осложнений. На фоне длительного употребления алкоголя у пациента формируются нарушения водно-электролитного баланса, колебания артериального давления, тахикардия, расстройства сна и повышенная тревожность. Коррекция этих состояний требует наблюдаемого формата помощи, применения стандартизированных протоколов и междисциплинарного взаимодействия.
Выяснить больше – [url=https://vyvod-iz-zapoya-lugansk0.ru/]вывод из запоя с выездом в луганске[/url]
Raymondabuck
14 Oct 25 at 4:32 pm
потолочкин потолки натяжные отзывы [url=www.stretch-ceilings-samara-1.ru/]www.stretch-ceilings-samara-1.ru/[/url] .
natyajnie potolki samara_spsl
14 Oct 25 at 4:33 pm
Me ecoei no ritmo de Stake Casino, tem uma energia de jogo tao pulsante quanto um eco em caverna. Tem uma enxurrada de jogos de cassino irados. com caca-niqueis modernos que ecoam como sinos. O atendimento esta sempre ativo 24/7. disponivel por chat ou e-mail. As transacoes sao simples como um reverb. entretanto mais recompensas fariam o coracao ecoar. Resumindo, Stake Casino e um cassino online que e uma camara de diversao para os exploradores de jogos online! Como extra o design e fluido como uma onda sonora. elevando a imersao ao nivel de um coral.
stake cripto|
twistyneonemu4zef
14 Oct 25 at 4:36 pm
жалюзи автоматические цена [url=https://www.zhalyuzi-s-elektroprivodom77.ru]жалюзи автоматические цена[/url] .
jaluzi na okna s elektroprivodom_pwpa
14 Oct 25 at 4:36 pm
карниз с приводом для штор [url=www.elektrokarnizy797.ru]www.elektrokarnizy797.ru[/url] .
elektrokarnizi_rkMl
14 Oct 25 at 4:36 pm
us wahl Usa wahlen wettquoten (http://Www.elearningfhml.Nl)
Www.elearningfhml.Nl
14 Oct 25 at 4:36 pm
Готовитесь к IELTS и хотите прогнозируемый результат? В CT Group в Алматы обучают по актуальным форматам Listening/Reading/Writing/Speaking, дают проверочные тесты и персональные рекомендации по прокачке словаря и тайм-менеджменту. У школы сильные преподаватели и понятные пакеты занятий — от интенсивов до индивидуальных программ. Запишитесь на консультацию и узнайте расписание на https://www.ctgroup.kz/ielts/ — начните подготовку с планом, который подстроят под вашу цель и сроки.
tobitaryKet
14 Oct 25 at 4:37 pm
curacao wettanbieter
Feel free to surf to my homepage; wetten gratis Ohne Einzahlung
wetten gratis Ohne Einzahlung
14 Oct 25 at 4:38 pm
электрокарнизы [url=http://www.elektrokarnizy797.ru]электрокарнизы[/url] .
elektrokarnizi_ugMl
14 Oct 25 at 4:39 pm
купить диплом в южно-сахалинске [url=http://rudik-diplom14.ru]купить диплом в южно-сахалинске[/url] .
Diplomi_vnea
14 Oct 25 at 4:42 pm
Перед тем как перейти к описанию конкретных методов, следует понимать, что успешное лечение требует комплексного взаимодействия специалистов разных профилей и активного участия самого пациента.
Изучить вопрос глубже – [url=https://lechenie-narkomanii-omsk0.ru/]лечение наркомании реабилитация омск[/url]
Henrylap
14 Oct 25 at 4:43 pm
узаконить перепланировку нежилого помещения [url=https://www.pereplanirovka-nezhilogo-pomeshcheniya9.ru]https://www.pereplanirovka-nezhilogo-pomeshcheniya9.ru[/url] .
pereplanirovka nejilogo pomesheniya_ouKl
14 Oct 25 at 4:43 pm
Hi there to all, how is all, I think every one is getting
more from this web page, and your views are nice for new users.
Live SGP Tercepat
14 Oct 25 at 4:44 pm
горизонтальные жалюзи с электроприводом [url=https://zhalyuzi-s-elektroprivodom77.ru/]горизонтальные жалюзи с электроприводом[/url] .
jaluzi na okna s elektroprivodom_tfpa
14 Oct 25 at 4:46 pm
Way cool! Some very valid points! I appreciate you penning this post plus the rest of the site is very good.
Argento Luxeron
14 Oct 25 at 4:47 pm
согласование перепланировок нежилых помещений [url=http://www.pereplanirovka-nezhilogo-pomeshcheniya10.ru]http://www.pereplanirovka-nezhilogo-pomeshcheniya10.ru[/url] .
pereplanirovka nejilogo pomesheniya_bpSr
14 Oct 25 at 4:47 pm
адрес фитнес клуба фитнес клуб цены
fitnes-klub-790
14 Oct 25 at 4:47 pm
аренда спецтехники московская область [url=https://www.arenda-mini-ekskavatora-v-moskve-2.ru]аренда спецтехники московская область[/url] .
arenda mini ekskavatora v moskve_wwKt
14 Oct 25 at 4:48 pm
потолки натяжные в самаре [url=www.stretch-ceilings-samara.ru]www.stretch-ceilings-samara.ru[/url] .
natyajnie potolki samara_twkl
14 Oct 25 at 4:48 pm