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://rudik-diplom10.ru]https://rudik-diplom10.ru[/url] .
Diplomi_gmSa
25 Oct 25 at 7:43 pm
купить проведенный диплом о высшем образовании [url=www.frei-diplom3.ru/]купить проведенный диплом о высшем образовании[/url] .
Diplomi_wjKt
25 Oct 25 at 7:44 pm
кракен даркнет маркет
кракен ios
JamesDaync
25 Oct 25 at 7:45 pm
shopthebesttoday – Highly recommend this shop, never disappointed with my purchases.
Margrett Gueits
25 Oct 25 at 7:45 pm
купить вкладыш с оценками к диплому техникума [url=www.frei-diplom8.ru/]купить вкладыш с оценками к диплому техникума[/url] .
Diplomi_gnsr
25 Oct 25 at 7:45 pm
farmacia online para hombres [url=http://confiafarmacia.com/#]ConfiaFarmacia[/url] comprar Sildenafilo sin receta
Davidduese
25 Oct 25 at 7:47 pm
1xbet yeni adresi [url=http://www.1xbet-16.com]1xbet yeni adresi[/url] .
1xbet_xiOn
25 Oct 25 at 7:47 pm
Je suis totalement envoute par Spinit Casino, il procure une experience rapide. La selection de jeux est dynamique, comprenant des jeux compatibles avec les cryptos. Amplifiant le plaisir de jeu. Le support client est veloce, joignable a toute heure. Les retraits sont fluides comme un peloton, parfois des offres plus genereuses seraient veloces. Dans l’ensemble, Spinit Casino est une plateforme qui accelere pour les fans de casino en ligne ! A noter le design est moderne et dynamique, facilitate une immersion totale. Egalement appreciable les paiements securises en crypto, assure des transactions fiables.
casinospinitfr.com|
WheelWhisperB3zef
25 Oct 25 at 7:48 pm
1xbet t?rkiye [url=https://www.1xbet-10.com]1xbet t?rkiye[/url] .
1xbet_bnea
25 Oct 25 at 7:49 pm
Вызывали вывести тараканов недавно, результат отличный!
уничтожение моли
KennethceM
25 Oct 25 at 7:49 pm
Does your blog have a contact page? I’m having a tough time locating it but,
I’d like to shoot you an e-mail. I’ve got some recommendations
for your blog you might be interested in hearing.
Either way, great blog and I look forward to seeing it expand
over time.
KKWIN
25 Oct 25 at 7:49 pm
shopforhappiness – Easy to navigate, found exactly what I was looking for.
Jannie Keesecker
25 Oct 25 at 7:49 pm
Ich habe einen Narren gefressen an Snatch Casino, es bietet eine Welt voller Action. Das Spieleangebot ist reichhaltig und vielfaltig, mit traditionellen Tischspielen. Er steigert das Spielvergnugen sofort. Der Support ist zuverlassig und hilfsbereit. Transaktionen sind zuverlassig und effizient, manchmal regelma?igere Promos wurden das Spiel aufwerten. In Summe, Snatch Casino sorgt fur kontinuierlichen Spa?. Zusatzlich ist das Design stilvoll und modern, und ladt zum Verweilen ein. Ein bemerkenswertes Extra sind die sicheren Krypto-Zahlungen, sichere Zahlungen garantieren.
https://snatch-casino.de/de-de/|
blazesnakein1zef
25 Oct 25 at 7:50 pm
диплом высшего образования с занесением в реестр купить [url=https://www.frei-diplom3.ru]диплом высшего образования с занесением в реестр купить[/url] .
Diplomi_tpKt
25 Oct 25 at 7:50 pm
Цены на выведение тараканов выросли? Обсудим.
уничтожение клопов в мебели
KennethceM
25 Oct 25 at 7:51 pm
1xbet mobi [url=https://www.1xbet-13.com]https://www.1xbet-13.com[/url] .
1xbet_wcKa
25 Oct 25 at 7:52 pm
Tremendous things here. I’m very satisfied to peer your article.
Thank you so much and I am taking a look ahead to touch you.
Will you please drop me a e-mail?
carbide drill korea
25 Oct 25 at 7:52 pm
Благодарю за дезинфекция после умерших! Проблема решена быстро.
дезинфекция школы
KennethceM
25 Oct 25 at 7:53 pm
диплом техникума купить форум [url=https://frei-diplom8.ru]диплом техникума купить форум[/url] .
Diplomi_xosr
25 Oct 25 at 7:53 pm
скачать казино мостбет [url=mostbet12031.ru]mostbet12031.ru[/url]
mostbet_kg_vfMa
25 Oct 25 at 7:54 pm
Отзывы о обработка от клопов с гарантией реальные? Делитесь.
санэпидемстанция цены
KennethceM
25 Oct 25 at 7:54 pm
Хорошо работают реально ! ! ! рега МН-35ф реально индика суровая , наиболее множество сходств нашёл с натуралом , по Мне так это наиболее приближенный каннабиноид .. купить скорость, кокаин, мефедрон, гашиш Главное не кипишуй, продаван ровный, придет сам обрадуешся что тут затарился!
JacobDaf
25 Oct 25 at 7:55 pm
The Playamo gaming venue provides an remarkable entertainment experience with upwards of three thousand elite slot games, casino tables, and live dealer variants from top-tier software providers. Whether players are playing the spins on the contemporary digital slots, demonstrating your skills at blackjack, or immersing yourself in the genuine feel of live gaming, the site presents entertainment for every type of gaming enthusiast. With its sleek, straightforward layout, the venue provides flawless browsing via desktop and mobile, permitting you to use options at any time or location.
Playamo casino
AlfredLog
25 Oct 25 at 7:55 pm
что такое мостбет [url=https://www.mostbet12031.ru]что такое мостбет[/url]
mostbet_kg_ohMa
25 Oct 25 at 7:56 pm
Сравните цены на ноутбуки https://n-katalog.ru/category/noutbuki/list в десятках магазинов: для работы, учебы и игр. Характеристики, отзывы, фото, бенчмарки. Фильтры по процессору, ОЗУ, SSD, диагонали, видео, весу и автономности. Следите за акциями и динамикой стоимости — выбирайте выгодное предложение с доставкой.
n-katalog-132
25 Oct 25 at 7:56 pm
как купить диплом о высшем образовании с занесением в реестр [url=http://www.frei-diplom2.ru]как купить диплом о высшем образовании с занесением в реестр[/url] .
Diplomi_tbEa
25 Oct 25 at 7:56 pm
kraken vk2
кракен онлайн
JamesDaync
25 Oct 25 at 7:57 pm
онлайн займ интернет займ
zaimnakartu-]475
25 Oct 25 at 7:57 pm
J’adore l’atmosphere musicale de BassBet Casino, c’est une plateforme qui vibre comme un riff. La selection de jeux est melodieuse, incluant des paris sportifs dynamiques. Renforcant votre capital initial. Les agents repondent comme un solo, avec une aide precise. Les retraits sont fluides comme un riff, de temps a autre quelques tours gratuits supplementaires seraient bien venus. Dans l’ensemble, BassBet Casino est un incontournable pour les joueurs pour les joueurs en quete d’excitation ! A noter l’interface est fluide comme un riff, amplifie le plaisir de jouer. A souligner les evenements communautaires engageants, qui booste l’engagement.
bassbetcasinobonusfr.com|
RiverRiffE7zef
25 Oct 25 at 7:57 pm
диплом техникума купить цены [url=http://frei-diplom8.ru/]диплом техникума купить цены[/url] .
Diplomi_wqsr
25 Oct 25 at 7:58 pm
как купить диплом с проводкой [url=www.frei-diplom6.ru/]как купить диплом с проводкой[/url] .
Diplomi_ygOl
25 Oct 25 at 7:58 pm
купить проведенный диплом провести [url=https://frei-diplom1.ru/]купить проведенный диплом провести[/url] .
Diplomi_erOi
25 Oct 25 at 7:58 pm
Je suis emerveille par Impressario Casino, ca transporte dans un monde de raffinement. L’eventail de jeux est somptueux, proposant des jeux de table elegants. Boostant votre capital initial. Les agents repondent avec une douceur exquise, toujours pret a aider. Les paiements sont securises et rapides, neanmoins plus de promotions regulieres ajouteraient du charme. En bref, Impressario Casino est une plateforme qui enchante pour les amateurs de casino en ligne ! De plus le site est rapide et envoutant, donne envie de prolonger l’experience. A noter les options de paris variees, propose des avantages sur mesure.
Trouver le bonus|
LavenderGlowX3zef
25 Oct 25 at 7:58 pm
J’ai une passion brulante pour Impressario Casino, ca offre une experience cinematographique. Les titres proposes sont d’une elegance rare, avec des slots aux designs sophistiques. 100% jusqu’a 500 € + tours gratuits. Les agents repondent avec une classe rare, avec une aide efficace. Le processus est simple et gracieux, bien que des bonus plus varies seraient une star. Dans l’ensemble, Impressario Casino est un joyau pour les joueurs pour ceux qui parient avec des cryptos ! En plus le design est moderne et scintillant, ajoute une touche de prestige. Un point fort les options de paris variees, offre des recompenses continues.
Cliquer pour les infos|
AzureCrestY7zef
25 Oct 25 at 8:01 pm
The location https://fotoredaktor.top of Lesotho is well marked.
fotoredaktor-538
25 Oct 25 at 8:01 pm
Je suis absolument captive par Monte Cryptos Casino, on ressent une energie decentralisee. La selection de jeux est astronomique, comprenant des jeux optimises pour les cryptos. 100% jusqu’a 300 € + tours gratuits. Disponible 24/7 via chat ou email, avec une aide rapide et fiable. Les paiements sont securises par blockchain, de temps a autre des offres plus genereuses ajouteraient du charme. Dans l’ensemble, Monte Cryptos Casino garantit un plaisir constant pour les passionnes de sensations numeriques ! Par ailleurs l’interface est fluide comme un flux de donnees, ce qui rend chaque session plus immersive. Un avantage notable les options de paris variees, propose des avantages uniques.
Voir les mises Г jour|
QuantumByteS5zef
25 Oct 25 at 8:02 pm
MannensApotek [url=https://mannensapotek.shop/#]erektionspiller på nätet[/url] diskret leverans i Sverige
Davidduese
25 Oct 25 at 8:02 pm
Ресторан чистый после уничтожение клопов.
уничтожение клопов холодным туманом
KennethceM
25 Oct 25 at 8:02 pm
купить диплом института с реестром [url=http://frei-diplom2.ru/]купить диплом института с реестром[/url] .
Diplomi_xoEa
25 Oct 25 at 8:02 pm
Je suis emerveille par Spinit Casino, c’est une plateforme qui tourbillonne comme un conte. La variete des titres est magique, avec des slots aux designs enchantes. Avec des depots instantanes. Le suivi est irreprochable, offrant des reponses claires. Les paiements sont securises et rapides, cependant des offres plus genereuses seraient enchantees. Pour conclure, Spinit Casino est un incontournable pour les joueurs pour les amateurs de sensations enchantees ! Ajoutons que la plateforme est visuellement envoutante, amplifie le plaisir de jouer. Particulierement interessant le programme VIP avec des niveaux exclusifs, propose des avantages personnalises.
https://spinitcasinobonusfr.com/|
FairyWhirlG8zef
25 Oct 25 at 8:03 pm
bahis siteler 1xbet [url=http://1xbet-15.com]bahis siteler 1xbet[/url] .
1xbet_dvpl
25 Oct 25 at 8:03 pm
68GB – Cổng Game Cá Cược Chất Lượng Hàng Đầu
Thị Trường
68gb – 68 game bài hay còn được biết đến với tên khác là 68 game
bài, 68gb, 68gamebai đang là cổng game giải trí trực tuyến thu hút được rút nhiều sự quan tâm của người chơi.
68 game bài sở hữu giấy phép uy tín của PAGCOR và kho
game đồ sộ và hấp dẫn như : 68 game bài thể thao, 68 game bài xổ
số, 68 game bài đổi thưởng… https://mainstreet.uk.com/
68 game bài
25 Oct 25 at 8:04 pm
Найдите лучший товар на https://n-katalog.ru: подробные карточки, честные отзывы, рейтинги, фото, фильтры по параметрам и брендам. Сравнение цен, акции, кэшбэк-предложения и графики изменений. Примите уверенное решение и переходите к покупке в удобном магазине.
n-katalog-848
25 Oct 25 at 8:04 pm
купить диплом образование купить проведенный диплом [url=frei-diplom6.ru]купить диплом образование купить проведенный диплом[/url] .
Diplomi_psOl
25 Oct 25 at 8:05 pm
обработка от клопов в отеле для офиса, посоветуйте проверенных.
уничтожение черных тараканов
KennethceM
25 Oct 25 at 8:06 pm
купить диплом москва легально [url=http://frei-diplom2.ru/]http://frei-diplom2.ru/[/url] .
Diplomi_yoEa
25 Oct 25 at 8:06 pm
оформить микрозайм займ оформить
zaimnakartu-]952
25 Oct 25 at 8:06 pm
Найдите лучший товар на https://n-katalog.ru: подробные карточки, честные отзывы, рейтинги, фото, фильтры по параметрам и брендам. Сравнение цен, акции, кэшбэк-предложения и графики изменений. Примите уверенное решение и переходите к покупке в удобном магазине.
n-katalog-570
25 Oct 25 at 8:07 pm
Je suis stupefait par Monte Cryptos Casino, ca offre un plaisir numerique unique. Le catalogue est opulent et diversifie, proposant des jeux de table elegants. Le bonus d’accueil est eclatant. Le suivi est irreprochable, offrant des reponses claires. Le processus est lisse comme un wallet, mais des bonus plus varies seraient un plus. En bref, Monte Cryptos Casino vaut une exploration virtuelle pour les adeptes de jeux modernes ! De plus la plateforme est visuellement eblouissante, ajoute une touche de sophistication. Un avantage notable les options de paris variees, garantit des transactions fiables.
Cliquer pour les infos|
DigitalDriftZ3zef
25 Oct 25 at 8:08 pm
займы онлайн бесплатно взять займ онлайн
zaimnakartu-]269
25 Oct 25 at 8:09 pm