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://elektrokarnizy797.ru/]карниз с электроприводом[/url] .
elektrokarnizi_wjMl
13 Oct 25 at 4:54 pm
согласование перепланировки нежилых помещений [url=https://pereplanirovka-nezhilogo-pomeshcheniya8.ru/]pereplanirovka-nezhilogo-pomeshcheniya8.ru[/url] .
pereplanirovka nejilogo pomesheniya_qzki
13 Oct 25 at 4:56 pm
Вывод из запоя в Рязани является востребованной медицинской услугой, направленной на стабилизацию состояния пациента после длительного употребления алкоголя. Специалисты применяют современные методы детоксикации, позволяющие быстро и безопасно восстановить жизненно важные функции организма, снизить проявления абстинентного синдрома и предотвратить осложнения. Процесс лечения осуществляется в клинических условиях под постоянным наблюдением врачей.
Подробнее – [url=https://vyvod-iz-zapoya-ryazan14.ru/]вывод из запоя вызов на дом в рязани[/url]
Kennethfueft
13 Oct 25 at 4:57 pm
It’s hard to come by well-informed people in this particular subject, but you sound like you know
what you’re talking about! Thanks
My blog :: ремонт стиральных машин сзао
ремонт стиральных машин сзао
13 Oct 25 at 4:57 pm
online pharmacy: pharmacy online UK – BritMeds Direct
Brettesofe
13 Oct 25 at 4:58 pm
Автоматические гаражные ворота давно перестали быть роскошью и стали необходимым элементом комфортной жизни. Наши автоматические ворота сочетают надёжность проверенных европейских механизмов с элегантным дизайном, который гармонично впишется в архитектуру любого здания. Мы предлагаем полный цикл услуг: от профессиональной консультации и точного замера до установки под ключ и гарантийного обслуживания. Доверьте безопасность своего дома профессионалам — получите бесплатный расчёт стоимости уже сегодня: Здесь
CraigStaps
13 Oct 25 at 4:58 pm
как узаконить перепланировку нежилого помещения [url=www.pereplanirovka-nezhilogo-pomeshcheniya8.ru]www.pereplanirovka-nezhilogo-pomeshcheniya8.ru[/url] .
pereplanirovka nejilogo pomesheniya_zgki
13 Oct 25 at 4:58 pm
Асфальтирование – это сложный многоэтапный процесс, превращающий грубую основу в гладкое и долговечное дорожное покрытие. Это не просто укладка черной массы, а кропотливая работа, требующая опыта, знаний и применения специализированной техники.
От качества асфальтирования напрямую зависит комфорт и безопасность движения, долговечность дороги и экономическая эффективность ее эксплуатации. Помогите выбрать подрядчика под [url=https://crimeaguide.com/forum/viewtopic.php?f=5&t=16207]асфальтирование под ключ[/url]
Armandospeab
13 Oct 25 at 4:59 pm
Mandingo
Brentsek
13 Oct 25 at 4:59 pm
электрокарнизы [url=http://www.karniz-elektroprivodom.ru]электрокарнизы[/url] .
karniz elektroprivodom shtor kypit_pyei
13 Oct 25 at 4:59 pm
можно ли купить диплом медсестры [url=www.frei-diplom15.ru]можно ли купить диплом медсестры[/url] .
Diplomi_vaoi
13 Oct 25 at 5:03 pm
перепланировка нежилого помещения в нежилом здании законодательство [url=www.pereplanirovka-nezhilogo-pomeshcheniya8.ru/]www.pereplanirovka-nezhilogo-pomeshcheniya8.ru/[/url] .
pereplanirovka nejilogo pomesheniya_vrki
13 Oct 25 at 5:07 pm
купить диплом в ханты-мансийске [url=rudik-diplom13.ru]купить диплом в ханты-мансийске[/url] .
Diplomi_rton
13 Oct 25 at 5:07 pm
Je suis epate par Locowin Casino, ca transporte dans un monde captivant. Il y a une multitude de jeux excitants, avec des slots au design innovant. Accompagne de tours gratuits sans wager. L’assistance est efficace et pro, joignable a toute heure. Les retraits sont ultra-rapides, mais des recompenses supplementaires seraient un atout. En resume, Locowin Casino garantit du fun a chaque instant pour les passionnes de jeux modernes ! Notons aussi le design est moderne et fluide, amplifie le plaisir de jouer. Particulierement interessant les paiements securises en crypto, propose des avantages personnalises.
Regarder de prГЁs|
VortexSpinA2zef
13 Oct 25 at 5:10 pm
neue wettseiten
Here is my site Besten sportwetten seiten
Besten sportwetten seiten
13 Oct 25 at 5:10 pm
услуги экскаватора в москве [url=http://www.arenda-ekskavatora-pogruzchika-cena-2.ru]услуги экскаватора в москве[/url] .
arenda ekskavatora pogryzchika cena_asst
13 Oct 25 at 5:12 pm
Minotaurus token’s multi-chain support key. Presale raise impressive. Unlocks thrilling. minotaurus token
WilliamPargy
13 Oct 25 at 5:13 pm
купить диплом в славянске-на-кубани [url=http://www.rudik-diplom12.ru]http://www.rudik-diplom12.ru[/url] .
Diplomi_stPi
13 Oct 25 at 5:13 pm
аренда экскаватора стоимость [url=www.arenda-ekskavatora-pogruzchika-cena-2.ru]www.arenda-ekskavatora-pogruzchika-cena-2.ru[/url] .
arenda ekskavatora pogryzchika cena_spst
13 Oct 25 at 5:15 pm
Состав инфузии мы подбираем под доминирующие симптомы и сопутствующие заболевания. Цель — вернуть управляемость телу, а не «насытить» организм всем сразу. Матрица ниже демонстрирует клиническую логику: окончательное решение принимает врач после очной оценки.
Углубиться в тему – [url=https://vyvod-iz-zapoya-v-ryazani14.ru/]скорая вывод из запоя в рязани[/url]
Marcuscom
13 Oct 25 at 5:15 pm
перепланировка и согласование [url=https://pereplanirovka-nezhilogo-pomeshcheniya8.ru]https://pereplanirovka-nezhilogo-pomeshcheniya8.ru[/url] .
pereplanirovka nejilogo pomesheniya_zpki
13 Oct 25 at 5:15 pm
https://telegra.ph/Avito-benzogeneratory-b-u-kupit-10-13-3
RobertCeany
13 Oct 25 at 5:18 pm
проект перепланировки нежилого помещения стоимость [url=www.pereplanirovka-nezhilogo-pomeshcheniya8.ru/]www.pereplanirovka-nezhilogo-pomeshcheniya8.ru/[/url] .
pereplanirovka nejilogo pomesheniya_haki
13 Oct 25 at 5:19 pm
online pharmacy: BritMeds Direct – private online pharmacy UK
JamesDes
13 Oct 25 at 5:19 pm
проект перепланировки нежилого помещения стоимость [url=pereplanirovka-nezhilogo-pomeshcheniya8.ru]pereplanirovka-nezhilogo-pomeshcheniya8.ru[/url] .
pereplanirovka nejilogo pomesheniya_hwki
13 Oct 25 at 5:24 pm
Автоматические гаражные ворота давно перестали быть роскошью и стали необходимым элементом комфортной жизни. Наши автоматические ворота сочетают надёжность проверенных европейских механизмов с элегантным дизайном, который гармонично впишется в архитектуру любого здания. Мы предлагаем полный цикл услуг: от профессиональной консультации и точного замера до установки под ключ и гарантийного обслуживания. Доверьте безопасность своего дома профессионалам — получите бесплатный расчёт стоимости уже сегодня: Автоматические ворота купить
CraigStaps
13 Oct 25 at 5:25 pm
услуги аренда экскаватора погрузчика [url=http://arenda-ekskavatora-pogruzchika-cena-2.ru/]http://arenda-ekskavatora-pogruzchika-cena-2.ru/[/url] .
arenda ekskavatora pogryzchika cena_whst
13 Oct 25 at 5:25 pm
کاربران گرامی، پلتفرمهای شرطبندی صرفاً سرمایهتان را
میگیرند، همچنین سلامت عصبیتان را نابود مینمایند.
خودم ورود با هیجان کردم، ولی ناگهان درگیر اعتیاد درآمدم وشغلام رها
کردم. ریسک آنها جاها جدیتر از امری
است که تصور میکنید. اجتناب کامل در چنین ضروری است!
قمارخانه آنلاین جعلی
13 Oct 25 at 5:28 pm
Для достижения стойкой ремиссии применяются современные и безопасные методики, которые подбираются индивидуально для каждого пациента.
Подробнее тут – [url=https://lechenie-alkogolizma-omsk0.ru/]здоровье лечение алкоголизма в омске[/url]
JamesTax
13 Oct 25 at 5:28 pm
Надёжный источник информации: https://amigo-tours.ru
Jamessof
13 Oct 25 at 5:29 pm
Узнавайте события первыми: https://efaflex.ru
HenryTrath
13 Oct 25 at 5:29 pm
Только проверенные факты: https://wildlife.by
JorgePhync
13 Oct 25 at 5:29 pm
вывод из запоя омск
vivod-iz-zapoya-omsk010.ru
вывод из запоя цена
vivodzapojomskNeT
13 Oct 25 at 5:30 pm
согласование перепланировки нежилых помещений [url=http://www.pereplanirovka-nezhilogo-pomeshcheniya8.ru]http://www.pereplanirovka-nezhilogo-pomeshcheniya8.ru[/url] .
pereplanirovka nejilogo pomesheniya_hpki
13 Oct 25 at 5:32 pm
стоимость аренды экскаватора погрузчика за час [url=https://arenda-ekskavatora-pogruzchika-cena-2.ru/]https://arenda-ekskavatora-pogruzchika-cena-2.ru/[/url] .
arenda ekskavatora pogryzchika cena_mist
13 Oct 25 at 5:32 pm
Je suis captive par Casinia Casino, on ressent une aura radieuse. L’eventail de jeux est resplendissant, offrant des sessions live captivantes. Avec un Bonus Crab unique pour debuter. Le suivi est irreprochable, toujours pret a eclairer. Les transactions sont fiables et rapides, parfois plus de promos regulieres ajouteraient de l’eclat. En bref, Casinia Casino garantit un plaisir radiant a chaque instant pour les amateurs de casino en ligne ! De plus l’interface est fluide comme un rayon, facilite une immersion totale. Particulierement captivant les evenements communautaires captivants, cree une communaute vibrante.
Découvrir aujourd’hui|
Mirild4zef
13 Oct 25 at 5:33 pm
электрокарниз купить в москве [url=https://www.karniz-shtor-elektroprivodom.ru]электрокарниз купить в москве[/url] .
karniz dlya shtor s elektroprivodom_reer
13 Oct 25 at 5:35 pm
Every weekend i used to pay a visit this website, because
i want enjoyment, for the reason that this
this web page conations genuinely good funny material too.
bokep johnny sins
13 Oct 25 at 5:35 pm
Описание
Углубиться в тему – https://vyvod-iz-zapoya-odincovo6.ru
ArturoHow
13 Oct 25 at 5:37 pm
проект перепланировки нежилого помещения стоимость [url=http://pereplanirovka-nezhilogo-pomeshcheniya8.ru/]http://pereplanirovka-nezhilogo-pomeshcheniya8.ru/[/url] .
pereplanirovka nejilogo pomesheniya_rvki
13 Oct 25 at 5:37 pm
аренда экскаватора в москве цена [url=www.arenda-ekskavatora-pogruzchika-cena-2.ru]аренда экскаватора в москве цена[/url] .
arenda ekskavatora pogryzchika cena_ihst
13 Oct 25 at 5:41 pm
перепланировка нежилого здания [url=pereplanirovka-nezhilogo-pomeshcheniya8.ru]pereplanirovka-nezhilogo-pomeshcheniya8.ru[/url] .
pereplanirovka nejilogo pomesheniya_scki
13 Oct 25 at 5:41 pm
masturbate
Brentsek
13 Oct 25 at 5:41 pm
Процедура начинается с осмотра и сбора анамнеза. После этого специалист проводит экстренную детоксикацию, снимает симптомы абстинентного синдрома, назначает поддерживающую терапию и даёт рекомендации по дальнейшим шагам. По желанию родственников или самого пациента помощь может быть оказана и в условиях стационара клиники.
Узнать больше – [url=https://narkologicheskaya-pomoshch-domodedovo6.ru/]srochnaya-narkologicheskaya-pomoshch-domodedovo[/url]
EugeneOrask
13 Oct 25 at 5:42 pm
Психотерапия во Владимире в клинике «Новая Эра» проводится высококвалифицированными специалистами с большим опытом работы в сфере зависимостей.
Получить дополнительные сведения – [url=https://lechenie-narkomanii-vladimir0.ru/]лечение наркомании кодирование[/url]
MarvinVab
13 Oct 25 at 5:42 pm
купить права
купить права категории б, купить водительские права, купить права москва, купить права россии, купить права без автошколы, купить права онлайн, купить права срочно, купить права на машину
Davidsouse
13 Oct 25 at 5:43 pm
трактор погрузчик аренда [url=http://arenda-ekskavatora-pogruzchika-cena-2.ru/]http://arenda-ekskavatora-pogruzchika-cena-2.ru/[/url] .
arenda ekskavatora pogryzchika cena_sest
13 Oct 25 at 5:44 pm
ТехноСвязь из Екатеринбурга уже два десятилетия производит печатные платы по зарубежным технологиям: стеклотекстолит, алюминий, многослой, плюс автоматический/ручной монтаж, трафареты SMT, поставка компонентов и прототипирование. На https://www.techno-svyaz.ru/ просто разместить заказ от единичных образцов до серий, а сроки держат короткими за счёт собственного участка и опытной команды. Проектирование под ваши ТЗ, маркировка панелей, доставка — один подрядчик на весь цикл. Постоянным клиентам — гибкие условия и предсказуемое качество.
dowykyGrath
13 Oct 25 at 5:44 pm
https://telegra.ph/Bronezhilet-skrytogo-nosheniya-kupit-v-spb-10-12-4
RobertCeany
13 Oct 25 at 5:44 pm
If you want to learn everything about online platforms in the United States, then this is definitely worth checking out. Explore the full details via the link below:
online casino real money no deposit free spins
Angellip
13 Oct 25 at 5:45 pm