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!
buy medications from india: india pharmacy – online medicine delivery in india
Charlesdyelm
13 Sep 25 at 4:40 am
1win вход через вк [url=http://1win12005.ru/]1win вход через вк[/url]
1win_uool
13 Sep 25 at 4:42 am
This piece of writing gives clear idea for the new people of blogging, that genuinely how to do running a blog.
Fırat Engin bahis siteleri
13 Sep 25 at 4:44 am
электрические карнизы купить [url=https://karnizy-s-elektroprivodom-cena.ru/]karnizy-s-elektroprivodom-cena.ru[/url] .
karnizi s elektroprivodom cena_dukr
13 Sep 25 at 4:44 am
электрокарниз купить в москве [url=www.elektro-karniz77.ru/]www.elektro-karniz77.ru/[/url] .
elektro karniz_noSl
13 Sep 25 at 4:44 am
электрокарниз двухрядный [url=https://avtomaticheskie-karnizy.ru/]avtomaticheskie-karnizy.ru[/url] .
avtomaticheskie karnizi_ejSa
13 Sep 25 at 4:45 am
You ought to take part in a contest for one of
the highest quality websites online. I will recommend this website!
new crypto casinos
13 Sep 25 at 4:46 am
карнизы с электроприводом [url=karnizy-s-elektroprivodom-cena.ru]карнизы с электроприводом[/url] .
karnizi s elektroprivodom cena_mmkr
13 Sep 25 at 4:48 am
электрокарнизы для штор купить в москве [url=http://www.elektro-karniz77.ru]http://www.elektro-karniz77.ru[/url] .
elektro karniz_ujSl
13 Sep 25 at 4:49 am
автоматические гардины для штор [url=http://avtomaticheskie-karnizy.ru/]http://avtomaticheskie-karnizy.ru/[/url] .
avtomaticheskie karnizi_rpSa
13 Sep 25 at 4:49 am
кракен онион тор 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
13 Sep 25 at 4:49 am
электрические гардины для штор [url=elektrokarniz-cena.ru]электрические гардины для штор[/url] .
elektrokarniz cena_qePL
13 Sep 25 at 4:50 am
электрические гардины [url=http://www.karnizy-s-elektroprivodom-cena.ru]электрические гардины[/url] .
karnizi s elektroprivodom cena_pvkr
13 Sep 25 at 4:51 am
Is there a way to compare http://ibuprofenbloginfo.com/ from online pharmaciesкак bupropion xl 150 mg side effects
NtcyFlulk
13 Sep 25 at 4:53 am
Pills information. What side effects can this medication cause?
buying cheap neurontin without prescription
Actual news about drug. Get information now.
buying cheap neurontin without prescription
13 Sep 25 at 4:53 am
Такая форма медицинской помощи востребована в разных ситуациях: при запое, выраженном абстинентном синдроме, интоксикации, а также при необходимости купирования симптомов без транспортировки пациента.
Подробнее можно узнать тут – [url=https://narkolog-na-dom-v-krasnodare14.ru/]www.domen.ru[/url]
Robertosaids
13 Sep 25 at 4:54 am
электрокарнизы [url=https://elektro-karniz77.ru/]электрокарнизы[/url] .
elektro karniz_fnSl
13 Sep 25 at 4:55 am
карнизы для штор купить в москве [url=www.avtomaticheskie-karnizy.ru/]карнизы для штор купить в москве[/url] .
avtomaticheskie karnizi_hqSa
13 Sep 25 at 4:55 am
What are the top five benefits of using https://ibuprofenbloginfo.com/ pharmacy has the proper license to sell drugs? bupropion sr 150 mg
NtcyFlulk
13 Sep 25 at 4:57 am
Счастья жизни не ждут под окном,
https://bio.site/xuobqidbeu
Р’РѕС‚ так РЅРёС…СѓСЏ себе СЃ 2011 РіРѕРґР° РЅР° плаву:strong:, подумаеш какая РґРёРєРѕРІРёРЅРєР° 😀
Harryunsag
13 Sep 25 at 4:58 am
букмекер 1win [url=https://1win12004.ru]https://1win12004.ru[/url]
1win_azEr
13 Sep 25 at 4:58 am
электрокарниз двухрядный цена [url=https://www.elektrokarniz-cena.ru]https://www.elektrokarniz-cena.ru[/url] .
elektrokarniz cena_hgPL
13 Sep 25 at 4:59 am
займ без отказов мгновенно онлайн займ денег онлайн
onlayn zaym 368
13 Sep 25 at 5:00 am
купить курсовик сколько стоит написать курсовую
kursovaya-rabota-876
13 Sep 25 at 5:00 am
What we’re covering
[url=https://mega-dark.net]mgmarket6[/url]
• Israel is facing growing condemnation after it attacked Hamas leadership in the capital of Qatar, a US ally and key mediator in Gaza ceasefire talks — putting hostage negotiations at risk.
[url=https://megaweb15at.com]mgmarket5[/url]
• Hamas said the strike killed five members but failed to assassinate the negotiating delegation, the target of the strikes.
• US President Donald Trump has criticized the strike, saying that by the time his administration learned of the attack and told the Qataris, there was little he could do to stop it.
• The attack is the first publicly acknowledged strike on a Gulf state by Israel. Qatar’s prime minister was visibly angry and said his country’s tradition of diplomacy “won’t be deterred.”
https://megaweb333.com
mgmarket5
JamesBus
13 Sep 25 at 5:00 am
автоматические карнизы [url=www.karniz-s-elektroprivodom.ru]автоматические карнизы[/url] .
karniz s elektroprivodom_fnKt
13 Sep 25 at 5:01 am
электрический карниз для штор купить [url=https://karnizy-s-elektroprivodom-cena.ru/]karnizy-s-elektroprivodom-cena.ru[/url] .
karnizi s elektroprivodom cena_zxkr
13 Sep 25 at 5:01 am
займ денег онлайн займ без отказов мгновенно онлайн
zaym onlayn 308
13 Sep 25 at 5:03 am
электрокарнизы для штор [url=www.elektrokarniz-cena.ru/]электрокарнизы для штор[/url] .
elektrokarniz cena_oxPL
13 Sep 25 at 5:03 am
мостбет официальный сайт вход [url=www.mostbet12003.ru]www.mostbet12003.ru[/url]
mostbet_zfet
13 Sep 25 at 5:03 am
Meds information for patients. Long-Term Effects.
where can i buy cheap macrobid without prescription
Best trends of pills. Get here.
where can i buy cheap macrobid without prescription
13 Sep 25 at 5:03 am
электрокарниз недорого [url=https://avtomaticheskie-karnizy.ru/]avtomaticheskie-karnizy.ru[/url] .
avtomaticheskie karnizi_ujSa
13 Sep 25 at 5:04 am
электрокарнизы для штор купить в москве [url=www.elektro-karniz77.ru/]www.elektro-karniz77.ru/[/url] .
elektro karniz_alSl
13 Sep 25 at 5:04 am
Every weekend i used to pay a visit this web page, because i want enjoyment, as this this web page conations
actually good funny data too.
buy levofloxacin online
13 Sep 25 at 5:06 am
скачать mostbet на телефон [url=https://mostbet12008.ru]скачать mostbet на телефон[/url]
mostbet_zver
13 Sep 25 at 5:08 am
электрокарнизы купить в москве [url=https://www.elektrokarniz-cena.ru]электрокарнизы купить в москве[/url] .
elektrokarniz cena_unPL
13 Sep 25 at 5:09 am
установить кондиционер в квартире цена [url=http://kondicioner-obninsk-1.ru]установить кондиционер в квартире цена[/url] .
kondicioneri s ystanovkoi_mzmi
13 Sep 25 at 5:09 am
https://brookspqxq424.trexgame.net/los-errores-mas-comunes-antes-de-un-examen-antidoping
Enfrentar una prueba preocupacional puede ser un momento critico. Por eso, ahora tienes una formula avanzada desarrollada en Canada.
Su receta unica combina minerales, lo que prepara tu organismo y oculta temporalmente los rastros de toxinas. El resultado: una orina con parametros normales, lista para cumplir el objetivo.
Lo mas notable es su capacidad inmediata de respuesta. A diferencia de metodos caseros, no promete resultados permanentes, sino una solucion temporal que funciona cuando lo necesitas.
Miles de profesionales ya han comprobado su efectividad. Testimonios reales mencionan envios en menos de 24 horas.
Si quieres proteger tu futuro, esta alternativa te ofrece respaldo.
JuniorShido
13 Sep 25 at 5:10 am
электронный карниз для штор [url=http://elektro-karniz77.ru/]http://elektro-karniz77.ru/[/url] .
elektro karniz_peSl
13 Sep 25 at 5:10 am
электрические карнизы купить [url=http://avtomaticheskie-karnizy.ru/]http://avtomaticheskie-karnizy.ru/[/url] .
avtomaticheskie karnizi_btSa
13 Sep 25 at 5:10 am
Приобрести диплом университета!
Мы предлагаембыстро и выгодно приобрести диплом, который выполнен на оригинальной бумаге и заверен печатями, водяными знаками, подписями должностных лиц. Диплом пройдет любые проверки, даже при помощи специально предназначенного оборудования. Решите свои задачи быстро и просто с нашей компанией- [url=http://genesis-placement.com/employer/aurus-diplomany/]genesis-placement.com/employer/aurus-diplomany[/url]
Jariorpmg
13 Sep 25 at 5:13 am
электрокарниз [url=www.avtomaticheskie-karnizy.ru]электрокарниз[/url] .
avtomaticheskie karnizi_wmSa
13 Sep 25 at 5:14 am
карниз с электроприводом [url=www.karnizy-s-elektroprivodom-cena.ru/]карниз с электроприводом[/url] .
karnizi s elektroprivodom cena_bgkr
13 Sep 25 at 5:14 am
карниз с приводом для штор [url=www.elektro-karniz77.ru/]www.elektro-karniz77.ru/[/url] .
elektro karniz_tdSl
13 Sep 25 at 5:14 am
Наши варианты включают банковские карты, цифровые кошельки и криптовалюты,
гарантируя, что каждый клиент сможет выбрать
наиболее подходящий метод для своих денежных операций.
казино вулкан
13 Sep 25 at 5:15 am
скачать mostbet kg [url=http://mostbet12006.ru]http://mostbet12006.ru[/url]
mostbet_ptKl
13 Sep 25 at 5:15 am
Этот комплекс мер позволяет оказывать помощь пациентам на всех стадиях зависимости.
Подробнее можно узнать тут – [url=https://narkologicheskaya-klinika-sankt-peterburg14.ru/]наркологические клиники алкоголизм[/url]
Romanronse
13 Sep 25 at 5:15 am
электрокарниз купить в москве [url=http://www.elektrokarniz-cena.ru]электрокарниз купить в москве[/url] .
elektrokarniz cena_bePL
13 Sep 25 at 5:17 am
Hi there, its fastidious paragraph regarding media print, we all be familiar with media is a fantastic source of information.
ISS file online viewer
13 Sep 25 at 5:18 am
Запой — это серьёзная проблема, требующая профессиональной помощи. В владимире существуют клиники, которые предоставляют услуги по выводу из запоя, в которых обеспечивается безопасный выход из запоя. Лечение алкоголизма начинается с процесса детоксикации, позволяющего организму избавиться от алкоголя и восстановить здоровье. Стоимость вывода из запоя в владимире зависит от предоставляемых услуг и уровня медицинской помощи. Консультация нарколога в владимире способствует разработке индивидуального плана лечения. Психотерапия является важной составляющей успешной реабилитации от алкогольной зависимости. вывод из запоя цена Квалифицированная помощь при запое способствует как физическому, так и психологическому восстановлению. Обратившись за медицинской помощью в владимире, вы делаете шаг к здоровой жизни.
alkogolizmvladimirNeT
13 Sep 25 at 5:18 am