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!
mostbet приложение [url=www.mostbet4157.ru]mostbet приложение[/url]
mostbet_snOi
7 Sep 25 at 9:06 am
частная наркологическая клиника москва [url=www.narkologicheskaya-klinika-12.ru/]www.narkologicheskaya-klinika-12.ru/[/url] .
narkologicheskaya klinika_wkMn
7 Sep 25 at 9:06 am
строительство домов в иркутской области [url=https://www.stroitelstvo-domov-irkutsk-2.ru]https://www.stroitelstvo-domov-irkutsk-2.ru[/url] .
stroitelstvo domov irkytsk_hcOi
7 Sep 25 at 9:07 am
9418
youtubehva
7 Sep 25 at 9:07 am
купить диплом украины цена [url=https://educ-ua20.ru]купить диплом украины цена[/url] .
Diplomi_geEn
7 Sep 25 at 9:09 am
что такое мостбет [url=http://mostbet4157.ru/]что такое мостбет[/url]
mostbet_dbOi
7 Sep 25 at 9:12 am
ТОП ПРОДАЖИ 24/7 – ПРИОБРЕСТИ MEF ALFA BOSHK1
Georgehot
7 Sep 25 at 9:12 am
реабилитационный центр наркологический [url=www.narkologicheskaya-klinika-11.ru]www.narkologicheskaya-klinika-11.ru[/url] .
narkologicheskaya klinika_ukPn
7 Sep 25 at 9:12 am
анонимная наркологическая помощь [url=https://narkologicheskaya-klinika-12.ru]https://narkologicheskaya-klinika-12.ru[/url] .
narkologicheskaya klinika_ouMn
7 Sep 25 at 9:13 am
психолог нарколог в москве [url=https://narkologicheskaya-klinika-11.ru]https://narkologicheskaya-klinika-11.ru[/url] .
narkologicheskaya klinika_pfPn
7 Sep 25 at 9:16 am
Hmm is anyone else encountering problems with the pictures on this blog loading?
I’m trying to figure out if its a problem on my end or if it’s
the blog. Any suggestions would be greatly appreciated.
water heater repair services
7 Sep 25 at 9:18 am
Je suis dingue de Bruno Casino, ca degage une ambiance de jeu explosive. Les choix de jeux au casino sont varies et enivrants, comprenant des jeux de casino optimises pour les cryptomonnaies. Les agents du casino sont vifs comme l’eclair, avec une aide qui fait mouche. Les transactions du casino sont simples comme un souffle, par moments des bonus de casino plus frequents seraient geniaux. Pour resumer, Bruno Casino offre une experience de casino memorable pour les passionnes de casinos en ligne ! En plus le site du casino est une merveille graphique, ajoute une touche de panache au casino.
bruno casino personal account|
spunkyfrog2zef
7 Sep 25 at 9:20 am
наркологические клиники москвы [url=http://narkologicheskaya-klinika-12.ru]http://narkologicheskaya-klinika-12.ru[/url] .
narkologicheskaya klinika_heMn
7 Sep 25 at 9:23 am
маркетинговый блог [url=https://blog-o-marketinge.ru]маркетинговый блог[/url] .
blog o marketinge_bkSn
7 Sep 25 at 9:23 am
Hello, I believe your blog could be having browser compatibility
problems. Whenever I look at your site in Safari, it looks fine however, when opening in I.E., it’s got some overlapping issues.
I just wanted to provide you with a quick heads up! Other than that,
fantastic website!
Look into my web site … สล็อตค่ายดัง TGAGAME
สล็อตค่ายดัง TGAGAME
7 Sep 25 at 9:25 am
наркология анонимно [url=http://www.narkologicheskaya-klinika-12.ru]http://www.narkologicheskaya-klinika-12.ru[/url] .
narkologicheskaya klinika_iwMn
7 Sep 25 at 9:26 am
ск домстрой [url=https://stroitelstvo-domov-irkutsk-2.ru/]stroitelstvo-domov-irkutsk-2.ru[/url] .
stroitelstvo domov irkytsk_jrOi
7 Sep 25 at 9:27 am
веб-аналитика блог [url=http://www.blog-o-marketinge.ru]http://www.blog-o-marketinge.ru[/url] .
blog o marketinge_kjSn
7 Sep 25 at 9:27 am
dark web market nexus darknet market darknet websites [url=https://privatedarknetmarket.com/ ]dark websites [/url]
Robertalima
7 Sep 25 at 9:28 am
nexus market darknet nexusdarknet site link darkmarket list [url=https://darknetmarketstore.com/ ]nexus link [/url]
Jamespem
7 Sep 25 at 9:28 am
ставки на спорт кыргызстан [url=www.mostbet4153.ru]www.mostbet4153.ru[/url]
mostbet_stmi
7 Sep 25 at 9:29 am
Нужна санкнижку в течение суток в СПб без прохождения врачей и лишних процедур? В клинике [url=https://doktora-gerasenko-med.ru]https://doktora-gerasenko-med.ru[/url] можно оформить или перевыпустить санитарную книжку, документы для плавания, ГИБДД, листки нетрудоспособности, справки из диспансеров, справки КЭК и другие законные бумаги — всё быстро, легально и без обращения в поликлинику. Узнайте детали — санитарная книжка сегодня, быстрое оформление справки, справка без медкомиссии.
Spravkiwkc
7 Sep 25 at 9:30 am
Why people still use to read news papers when in this technological world the
whole thing is presented on web?
Also visit my web-site … avia master
avia master
7 Sep 25 at 9:31 am
Highly descriptive article, I liked that bit.
Will there be a part 2?
pink salt trick for weight loss
7 Sep 25 at 9:32 am
строительство домов в иркутской области [url=https://stroitelstvo-domov-irkutsk-2.ru]https://stroitelstvo-domov-irkutsk-2.ru[/url] .
stroitelstvo domov irkytsk_kjOi
7 Sep 25 at 9:33 am
https://informationng.com/wp-content/pages/?le-code-promo-1xbet-actuel.html
owjuxob
7 Sep 25 at 9:34 am
ТОП ПРОДАЖИ 24/7 – ПРИОБРЕСТИ MEF ALFA BOSHK1
Georgehot
7 Sep 25 at 9:35 am
стратегия продвижения блог [url=https://www.blog-o-marketinge.ru]https://www.blog-o-marketinge.ru[/url] .
blog o marketinge_bgSn
7 Sep 25 at 9:36 am
наркологические клиники москвы [url=https://narkologicheskaya-klinika-11.ru/]https://narkologicheskaya-klinika-11.ru/[/url] .
narkologicheskaya klinika_pyPn
7 Sep 25 at 9:36 am
строительство дома под ключ иркутск [url=https://stroitelstvo-domov-irkutsk-2.ru/]https://stroitelstvo-domov-irkutsk-2.ru/[/url] .
stroitelstvo domov irkytsk_gaOi
7 Sep 25 at 9:38 am
Когда запой выходит за рамки нескольких суток, интоксикация организма достигает критического уровня: нарушается водно-электролитный баланс, появляются признаки токсического поражения печени и нервной системы. В таких случаях самостоятельные попытки прекратить употребление алкоголя могут привести к тяжёлым осложнениям — судорогам, алкогольному психозу, острой сердечной недостаточности. В Санкт-Петербурге и Ленинградской области доступны профессиональные услуги по выводу из запоя, выполняемые опытными наркологами как на дому, так и в специализированных клиниках.
Получить дополнительные сведения – http://nadezhnyj-vyvod-iz-zapoya.ru/
Davidhib
7 Sep 25 at 9:40 am
купить диплом о среднем образовании цена [url=https://educ-ua20.ru]купить диплом о среднем образовании цена[/url] .
Diplomi_iuEn
7 Sep 25 at 9:42 am
наркологические клиники москва [url=www.narkologicheskaya-klinika-11.ru]www.narkologicheskaya-klinika-11.ru[/url] .
narkologicheskaya klinika_ubPn
7 Sep 25 at 9:42 am
блог о рекламе и аналитике [url=blog-o-marketinge.ru]blog-o-marketinge.ru[/url] .
blog o marketinge_rgSn
7 Sep 25 at 9:43 am
блог о маркетинге [url=https://blog-o-marketinge1.ru/]блог о маркетинге[/url] .
blog o marketinge_jtsa
7 Sep 25 at 9:43 am
наркологическая клиника москва [url=http://narkologicheskaya-klinika-12.ru]http://narkologicheskaya-klinika-12.ru[/url] .
narkologicheskaya klinika_zaMn
7 Sep 25 at 9:45 am
[url=http://omegatest.ru/minpromtorg/]реестр Минпромторга[/url]
Edwinfot
7 Sep 25 at 9:45 am
Estou completamente enlouquecido por LeaoWin Casino, oferece uma aventura de cassino que e uma fera. O catalogo de jogos do cassino e uma selva braba, com caca-niqueis de cassino modernos e instintivos. Os agentes do cassino sao rapidos como uma cacada, garantindo suporte de cassino direto e sem rugas. O processo do cassino e limpo e sem emboscada, as vezes mais bonus regulares no cassino seria top. Na real, LeaoWin Casino vale demais explorar esse cassino para os amantes de cassinos online! E mais o design do cassino e uma explosao visual feroz, aumenta a imersao no cassino a mil.
leaowin02 casino inloggen|
fluffycrab3zef
7 Sep 25 at 9:45 am
kratonbet login [url=https://linklist.bio/kratonbet777#]kratonbet login[/url] kratonbet alternatif
CharlesJam
7 Sep 25 at 9:45 am
материалы по seo [url=http://www.blog-o-marketinge.ru]материалы по seo[/url] .
blog o marketinge_wcSn
7 Sep 25 at 9:47 am
медицинский наркологический центр [url=https://narkologicheskaya-klinika-11.ru]https://narkologicheskaya-klinika-11.ru[/url] .
narkologicheskaya klinika_rlPn
7 Sep 25 at 9:47 am
Заказать диплом о высшем образовании!
Наша компания предлагаетбыстро купить диплом, который выполняется на оригинальном бланке и заверен мокрыми печатями, штампами, подписями должностных лиц. Данный диплом способен пройти лубую проверку, даже при помощи специально предназначенного оборудования. Решайте свои задачи быстро и просто с нашим сервисом- [url=http://klm9.net/employer/aurus-diplomany/]klm9.net/employer/aurus-diplomany[/url]
Jariorndo
7 Sep 25 at 9:49 am
материалы по маркетингу [url=https://www.blog-o-marketinge.ru]https://www.blog-o-marketinge.ru[/url] .
blog o marketinge_pbSn
7 Sep 25 at 9:51 am
наркологический диспансер москва [url=www.narkologicheskaya-klinika-12.ru]www.narkologicheskaya-klinika-12.ru[/url] .
narkologicheskaya klinika_jnMn
7 Sep 25 at 9:51 am
мостбет. [url=www.mostbet4156.ru]www.mostbet4156.ru[/url]
mostbet_ktma
7 Sep 25 at 9:52 am
kraken onion ссылка kraken onion, kraken onion ссылка, kraken onion зеркала, kraken рабочая ссылка onion, сайт kraken onion, kraken darknet, kraken darknet market, kraken darknet ссылка, сайт kraken darknet, kraken актуальные ссылки, кракен ссылка kraken, kraken официальные ссылки, kraken ссылка тор, kraken ссылка зеркало, kraken ссылка на сайт, kraken онион, kraken онион тор, кракен онион, кракен онион тор, кракен онион зеркало, кракен даркнет маркет, кракен darknet, кракен onion, кракен ссылка onion, кракен onion сайт, kra ссылка, kraken сайт, kraken актуальные ссылки, kraken зеркало, kraken ссылка зеркало, kraken зеркало рабочее, актуальные зеркала kraken, kraken сайт зеркала, kraken маркетплейс зеркало, кракен ссылка, кракен даркнет
RichardPep
7 Sep 25 at 9:52 am
как продвигать сайт статьи [url=http://blog-o-marketinge1.ru]http://blog-o-marketinge1.ru[/url] .
blog o marketinge_uwsa
7 Sep 25 at 9:53 am
адреса наркологических клиник [url=https://narkologicheskaya-klinika-12.ru/]narkologicheskaya-klinika-12.ru[/url] .
narkologicheskaya klinika_ohMn
7 Sep 25 at 9:57 am
Даже после тяжёлого запоя капельница от специалистов Stop Alko в Люберцах помогает вернуть ясность ума и нормализовать сон.
Подробнее – [url=https://kapelnica-ot-zapoya-lyubercy13.ru/]капельница от запоя на дому цена в подольске[/url]
JasonDar
7 Sep 25 at 9:57 am
391
youtubeqix
7 Sep 25 at 9:57 am