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://econbiz.ir/
https://econbiz.ir/
13 Aug 25 at 6:41 am
Наш подход охватывает все аспекты реабилитации, помогая пациентам справиться с зависимостями и вернуться к полноценной жизни.
Получить больше информации – http://медицина-вывод-из-запоя.рф/vyvod-iz-zapoya-na-domu-v-nizhnem-novgoroge.xn--p1ai/
WinstonGoado
13 Aug 25 at 6:47 am
https://gorod.kr.ua/forum/showthread.php?p=262728
Thomastazow
13 Aug 25 at 6:47 am
debaltsevoer.ru
Richardweing
13 Aug 25 at 6:50 am
What i don’t realize is in reality how you are no longer actually
a lot more smartly-preferred than you might be now.
You’re so intelligent. You recognize therefore considerably on the subject of this subject, produced me in my view imagine it
from so many numerous angles. Its like women and men don’t seem to be interested until
it is something to accomplish with Lady gaga!
Your personal stuffs great. All the time
maintain it up!
planet 7 casino
13 Aug 25 at 6:52 am
Hey! This is my first comment here so I just
wanted to give a quick shout out and say I truly enjoy
reading your posts. Can you recommend any other blogs/websites/forums that cover the same topics?
Thank you!
ساعت کاری مراکز اعتراض به خلافی خودرو
13 Aug 25 at 6:52 am
https://gorlovkarel.ru
TylerDrirM
13 Aug 25 at 6:55 am
1win официальный войти [url=https://1win1170.ru]https://1win1170.ru[/url]
1win_kg_vpEr
13 Aug 25 at 6:57 am
mexican drugstore online: Mexican Pharmacy Hub – mexican online pharmacies prescription drugs
Justinsoync
13 Aug 25 at 7:00 am
На сайте https://feringer.shop/ воспользуйтесь возможностью приобрести печи высокого качества для саун, бань. Все они надежные, практичные, простые в использовании и обязательно впишутся в общую концепцию. В каталоге вы найдете печи для сауны, бани, дымоходы, порталы ламель, дымоходы стартовые. Регулярно появляются новинки по привлекательной стоимости. Важной особенностью печей является то, что они существенно понижают расход дров. Печи Ферингер отличаются привлекательным внешним видом, длительным сроком эксплуатации.
LelagScoug
13 Aug 25 at 7:00 am
https://www.pinterest.com.au/pin/961307482967460818/
WillisBes
13 Aug 25 at 7:01 am
Ahaa, its fastidious dialogue concerning this post here
at this website, I have read all that, so at this time me
also commenting at this place.
My site; Inflatable Rentals in Phoenix
Inflatable Rentals in Phoenix
13 Aug 25 at 7:02 am
Urban traffic in Dallas absolutely influences car insurance dallas texas
fees.
car insurance dallas texas
13 Aug 25 at 7:03 am
aviator игра на деньги скачать [url=1win1171.ru]1win1171.ru[/url]
1win_kg_jemr
13 Aug 25 at 7:06 am
Далее начинается этап детоксикации — это основа безопасного и эффективного вывода из запоя. Используются капельницы с современными очищающими и поддерживающими препаратами, комплекс витаминов, препараты для поддержки печени, почек и сердечно-сосудистой системы. При необходимости назначаются средства для стабилизации психоэмоционального состояния, купирования судорог, нормализации сна и снижения тревожности.
Выяснить больше – https://vyvod-iz-zapoya-balashiha5.ru
Timothynum
13 Aug 25 at 7:09 am
Hello, for all time i used to check website posts here in the early
hours in the morning, because i love to gain knowledge of
more and more.
신용카드현금화
13 Aug 25 at 7:13 am
https://makeevkatop.ru
TylerDrirM
13 Aug 25 at 7:16 am
Genuinely when someone doesn’t be aware of afterward its up to other people that they will assist, so here it takes place.
Feel free to visit my blog Lyft inspection online
Lyft inspection online
13 Aug 25 at 7:20 am
Обожаю отечественные драмы — эмоции просто топ!
Ресурс определённо крутая штука,
если хотите смотреть новинки сериалов
—
Начал смотреть новый сезон —
включил здесь:
Озвучка топ — на одном дыхании
глянул. Всё это —
Уважуха за удобство. Теперь всегда смотрю сериалы на https://artcurator.ru/luchshie-platformy-dlya-russkikh-serialov.html — уже добавил в закладки.
Кто уже видел? — давайте поделимся мнением.
где смотреть русские сериалы с английскими субтитрами
13 Aug 25 at 7:22 am
1win casino [url=http://1win1169.ru]1win casino[/url]
1win_kg_gipn
13 Aug 25 at 7:23 am
В «РеабПермь» не применяются универсальные схемы. Каждая программа формируется на основе медицинских показателей, психологического профиля, уровня мотивации, социальных факторов и стадии зависимости. Для этого в клинике используется многоступенчатая модель: от стабилизации состояния до полной реабилитации с возвращением к самостоятельной жизни. Все этапы адаптированы под индивидуальные особенности пациента, а при необходимости программа корректируется в процессе лечения.
Получить дополнительную информацию – https://lechenie-narkomanii-perm0.ru/
Rogerpet
13 Aug 25 at 7:24 am
We stumbled over here by a different web address and thought I should check things out.
I like what I see so i am just following you. Look forward to exploring your
web page repeatedly.
انتخاب رشته با تراز کنکور ۱۴۰۴
13 Aug 25 at 7:24 am
debaltsevoty.ru
Richardweing
13 Aug 25 at 7:24 am
Для повышения эффективности терапии применяются физиотерапевтические процедуры и витаминные комплексы, которые ускоряют восстановление и повышают сопротивляемость организма стрессам.
Ознакомиться с деталями – [url=https://narkologicheskaya-klinika-omsk0.ru/]наркологическая клиника стационар омск[/url]
Ernestadelm
13 Aug 25 at 7:36 am
дизайнерские кашпо на стену [url=https://dizaynerskie-kashpo-nsk.ru]https://dizaynerskie-kashpo-nsk.ru[/url] .
dizainerskie kashpo_espi
13 Aug 25 at 7:36 am
1с облако аренда 1с в облаке цена
1c-oblako-811
13 Aug 25 at 7:37 am
https://antracitfel.ru
TylerDrirM
13 Aug 25 at 7:37 am
1с облако вход 1с сервис облако
1c-oblako-684
13 Aug 25 at 7:38 am
You can definitely see your enthusiasm in the article you write.
The sector hopes for more passionate writers such as you who are not afraid to say
how they believe. At all times follow your heart.
نحوه محاسبه تراز نمونه دولتی
13 Aug 25 at 7:42 am
Все про уютный дом, как сделать дом уютным для всех, советы по ведению дома, как создать уют в доме своими руками, советы по дизайну интерьера https://ujut-v-dome.ru/
Josephcrata
13 Aug 25 at 7:42 am
Really when someone doesn’t be aware of afterward its up to other people that
they will help, so here it happens.
real money online casinos
13 Aug 25 at 7:46 am
Предлагаем вашему вниманию интересную справочную статью, в которой собраны ключевые моменты и нюансы по актуальным вопросам. Эта информация будет полезна как для профессионалов, так и для тех, кто только начинает изучать тему. Узнайте ответы на важные вопросы и расширьте свои знания!
Что ещё? Расскажи всё! – https://dinfoderbutik.se/rundbalar_hosilage
Warrendycle
13 Aug 25 at 7:48 am
Эта информационная заметка содержит увлекательные сведения, которые могут вас удивить! Мы собрали интересные факты, которые сделают вашу жизнь ярче и полнее. Узнайте нечто новое о привычных аспектах повседневности и откройте для себя удивительный мир информации.
Погрузиться в детали – https://tapki.com/ru/domain/na-polzy.ru
Lanceinduh
13 Aug 25 at 7:51 am
После обращения по телефону или через сайт диспетчер уточняет адрес и состояние пациента. В экстренных случаях команда врачей может прибыть уже в течение 60 минут, обычно — за 1–2 часа. На месте проводится первичный осмотр: проверяются жизненные показатели, уточняется история употребления, сопутствующие заболевания. Врач определяет наиболее безопасную и эффективную тактику, исходя из возраста, состояния здоровья и длительности запоя.
Углубиться в тему – [url=https://vyvod-iz-zapoya-noginsk5.ru/]vyvod-iz-zapoya-noginsk5.ru/[/url]
Anthonyinops
13 Aug 25 at 7:55 am
1xставка зеркало [url=www.1win1165.ru]www.1win1165.ru[/url]
1win_fzMl
13 Aug 25 at 7:56 am
makeevkabest.ru
Richardweing
13 Aug 25 at 7:58 am
https://mariupolol.ru
TylerDrirM
13 Aug 25 at 7:58 am
1win стать партнером [url=http://1win1171.ru]http://1win1171.ru[/url]
1win_kg_wbmr
13 Aug 25 at 8:08 am
1win вход с компьютера [url=https://www.1win1168.ru]1win вход с компьютера[/url]
1win_abma
13 Aug 25 at 8:11 am
1xBet промокоды букмекерских контор — это одна из самых популярных и надежных платформ, которая предлагает уникальные возможности и привлекательные бонусы для своих пользователей. Независимо от того, являетесь ли вы новичком в мире ставок или опытным игроком, 1xBet промокод 2025, воспользуйтесь бонусным промокодом, чтобы получить бесплатный приветственный бонус в размере 100%. При регистрации введите данный код и получите бонус до 32 500 рублей (или эквивалент в другой валюте до 130$).
HerbertRip
13 Aug 25 at 8:11 am
Чем раньше начато лечение, тем выше вероятность полного восстановления здоровья без тяжёлых последствий для организма и психики. В клинике «Наркосфера» к каждому случаю подходят максимально внимательно и индивидуально.
Получить дополнительную информацию – https://narkologicheskaya-klinika-balashiha5.ru/chastnaya-narkologicheskaya-klinika-v-balashihe
Jamestum
13 Aug 25 at 8:12 am
экстренный вывод из запоя
vivod-iz-zapoya-minsk006.ru
вывод из запоя круглосуточно
vivodminskNeT
13 Aug 25 at 8:14 am
https://www.pinterest.ca/pin/1105281933557177584/
Arthurmox
13 Aug 25 at 8:17 am
1х зеркало [url=https://www.1win1164.ru]1х зеркало[/url]
1win_cnSl
13 Aug 25 at 8:18 am
https://enakievofel.ru
JasonLat
13 Aug 25 at 8:19 am
гидроизоляция цена [url=http://www.gidroizolyaciya-cena-3.ru]http://www.gidroizolyaciya-cena-3.ru[/url] .
gidroizolyaciya cena_nzSi
13 Aug 25 at 8:22 am
интернет по адресу
ufa-domashnij-internet004.ru
интернет провайдеры в уфе по адресу дома
inernetufaelini
13 Aug 25 at 8:26 am
If you would like to improve your knowledge just keep visiting this web page and be updated with the newest news update posted
here.
best bitcoin casinos
13 Aug 25 at 8:29 am
что такое 1win [url=https://1win1165.ru/]что такое 1win[/url]
1win_lgMl
13 Aug 25 at 8:30 am
гидроизоляция цена [url=http://gidroizolyaciya-cena-3.ru/]http://gidroizolyaciya-cena-3.ru/[/url] .
gidroizolyaciya cena_ljSi
13 Aug 25 at 8:31 am