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=www.rudik-diplom4.ru/]купить диплом преподавателя[/url] .
Diplomi_gtOr
27 Oct 25 at 8:29 am
farmaci per potenza maschile: ordinare Viagra generico in modo sicuro – pillole per disfunzione erettile
RandySkync
27 Oct 25 at 8:29 am
J’ai un veritable coup de c?ur pour Sugar Casino, il propose une aventure palpitante. Le choix de jeux est tout simplement enorme, offrant des tables live interactives. Il donne un elan excitant. Le suivi est toujours au top. Les retraits sont ultra-rapides, a l’occasion des bonus plus varies seraient un plus. En bref, Sugar Casino est un endroit qui electrise. Ajoutons aussi la navigation est simple et intuitive, incite a rester plus longtemps. Egalement genial les options variees pour les paris sportifs, propose des privileges sur mesure.
AccГ©der maintenant|
StarHeartix8zef
27 Oct 25 at 8:30 am
WOW just what I was searching for. Came here by searching for casino
https://crux.za.com
27 Oct 25 at 8:30 am
kraken ссылка
kraken сайт
Henryamerb
27 Oct 25 at 8:32 am
Эта обзорная заметка содержит ключевые моменты и факты по актуальным вопросам. Она поможет читателям быстро ориентироваться в теме и узнать о самых важных аспектах сегодня. Получите краткий курс по современной информации и оставайтесь в курсе событий!
Изучить вопрос глубже – https://glosoftindia.com/through-the-cites-of-the-word-in-classical
RamonSak
27 Oct 25 at 8:33 am
медицинское оборудование для больниц [url=http://www.medicinskoe–oborudovanie.ru]http://www.medicinskoe–oborudovanie.ru[/url] .
medicinskoe oborydovanie_sxei
27 Oct 25 at 8:34 am
J’adore le dynamisme de Ruby Slots Casino, ca invite a l’aventure. Les titres proposes sont d’une richesse folle, proposant des jeux de cartes elegants. 100% jusqu’a 500 € avec des free spins. Les agents sont rapides et pros. Les gains sont transferes rapidement, cependant des offres plus genereuses rendraient l’experience meilleure. Pour finir, Ruby Slots Casino garantit un plaisir constant. A souligner la navigation est fluide et facile, donne envie de prolonger l’aventure. A noter les evenements communautaires engageants, qui dynamise l’engagement.
Ouvrir maintenant|
ironmindik1zef
27 Oct 25 at 8:35 am
медицинский наркологический центр [url=http://narkologicheskaya-klinika-24.ru]http://narkologicheskaya-klinika-24.ru[/url] .
narkologicheskaya klinika_weSr
27 Oct 25 at 8:35 am
аппараты медицинские [url=https://medicinskoe–oborudovanie.ru]https://medicinskoe–oborudovanie.ru[/url] .
medicinskoe oborydovanie_ntei
27 Oct 25 at 8:36 am
купить диплом в россоши [url=rudik-diplom15.ru]купить диплом в россоши[/url] .
Diplomi_onPi
27 Oct 25 at 8:36 am
kraken обмен
кракен вход
Henryamerb
27 Oct 25 at 8:38 am
Эта публикация погружает вас в мир увлекательных фактов и удивительных открытий. Мы расскажем о ключевых событиях, которые изменили ход истории, и приоткроем завесу над научными достижениями, которые вдохновили миллионы. Узнайте, чему может научить нас прошлое и как применить эти знания в будущем.
Хочешь знать всё? – https://crcpediatrico.org/index.php/timetable/event/test-2
KevinCeawN
27 Oct 25 at 8:39 am
диплом техникума купить екатеринбург [url=https://frei-diplom7.ru/]диплом техникума купить екатеринбург[/url] .
Diplomi_dsei
27 Oct 25 at 8:39 am
В данной статье вы найдете комплексный подход к изучению насущных тем. Мы комбинируем теоретические сведения с практическими советами, чтобы читатель мог не только понять проблему, но и найти пути её решения.
Осуществить глубокий анализ – https://vivehg.com/tendencias-inmobiliarias
Charlesclund
27 Oct 25 at 8:41 am
späte tore wetten (tiel72.Nl)
dass unfall samuel koch heute
tiel72.Nl
27 Oct 25 at 8:44 am
купить диплом об окончании колледжа украина [url=www.frei-diplom10.ru/]www.frei-diplom10.ru/[/url] .
Diplomi_pgEa
27 Oct 25 at 8:44 am
I have read so many posts on the topic of the blogger lovers but this post is in fact a nice article,
keep it up.
Libre Invest
27 Oct 25 at 8:46 am
https://paalk.com/posts/205036
ygqwoel
27 Oct 25 at 8:46 am
kraken СПб
кракен ios
Henryamerb
27 Oct 25 at 8:46 am
оборудование для больниц [url=http://medicinskoe–oborudovanie.ru]http://medicinskoe–oborudovanie.ru[/url] .
medicinskoe oborydovanie_ziei
27 Oct 25 at 8:47 am
kraken market
кракен вход
Henryamerb
27 Oct 25 at 8:47 am
I do not even understand how I stopped up right here, but I believed this submit used to be good.
I don’t realize who you are however certainly you’re going
to a famous blogger should you are not already.
Cheers!
match 3 games free
27 Oct 25 at 8:49 am
купить диплом в набережных челнах [url=rudik-diplom15.ru]купить диплом в набережных челнах[/url] .
Diplomi_dfPi
27 Oct 25 at 8:49 am
Этот информативный текст выделяется своими захватывающими аспектами, которые делают сложные темы доступными и понятными. Мы стремимся предложить читателям глубину знаний вместе с разнообразием интересных фактов. Откройте новые горизонты и развивайте свои способности познавать мир!
Получить полную информацию – https://okusurijoho.com/2015/10/13/velkommen-til-bloggen-min
Michaelalien
27 Oct 25 at 8:49 am
центр наркологической помощи [url=https://narkologicheskaya-klinika-24.ru/]narkologicheskaya-klinika-24.ru[/url] .
narkologicheskaya klinika_hiSr
27 Oct 25 at 8:51 am
[url=https://www.mirkeramiki.com.ua/]строительные базы Одессы[/url]
HarryImalm
27 Oct 25 at 8:51 am
кракен онлайн
кракен сайт
Henryamerb
27 Oct 25 at 8:52 am
купить диплом в костроме [url=https://rudik-diplom11.ru]https://rudik-diplom11.ru[/url] .
Diplomi_fcMi
27 Oct 25 at 8:52 am
где купить диплом техникума пять плюс [url=https://frei-diplom7.ru/]где купить диплом техникума пять плюс[/url] .
Diplomi_ouei
27 Oct 25 at 8:52 am
Этот текст призван помочь читателю расширить кругозор и получить практические знания. Мы используем простой язык, наглядные примеры и структурированное изложение, чтобы сделать обучение максимально эффективным и увлекательным.
Посмотреть всё – https://opzo.app/unlock-the-power-of-hr-efficiency-with-opzopeople
StevenNok
27 Oct 25 at 8:53 am
Hi, I think your web site could possibly be having internet
browser compatibility problems. When I take a look at your site in Safari, it looks fine
however, when opening in I.E., it has some overlapping issues.
I just wanted to provide you with a quick heads up!
Apart from that, excellent site!
PetSafe SmartSpin features
27 Oct 25 at 8:54 am
HerenGezondheid [url=https://herengezondheid.shop/#]betrouwbare online apotheek[/url] Sildenafil zonder recept bestellen
Davidduese
27 Oct 25 at 8:55 am
[…] 독일 제약사 **바이엘(Bayer)**에서 개발한 의약품으로, 레비트라구매 주성분은 […]
레비트라 구매 방법, 가장 안전하고 현명한 선택 가이드 – aigeniusstudio.net
27 Oct 25 at 8:57 am
kraken СПб
kraken вход
Henryamerb
27 Oct 25 at 8:58 am
где купить диплом среднем [url=http://rudik-diplom2.ru]где купить диплом среднем[/url] .
Diplomi_eipi
27 Oct 25 at 8:58 am
В этом информативном обзоре собраны самые интересные статистические данные и факты, которые помогут лучше понять текущие тренды. Мы представим вам цифры и графики, которые иллюстрируют, как развиваются различные сферы жизни. Эта информация станет отличной основой для глубокого анализа и принятия обоснованных решений.
Погрузиться в детали – http://www.jeffdeyo.com/loving-god-when-you-dont-feel-like-it
TerryJer
27 Oct 25 at 9:00 am
купить диплом техникума в казани [url=www.frei-diplom7.ru]купить диплом техникума в казани[/url] .
Diplomi_yhei
27 Oct 25 at 9:00 am
My relatives always say that I am wasting my time here at web,
but I know I am getting know-how all the time by reading such nice articles.
J88
27 Oct 25 at 9:01 am
Hey I know this is off topic but I was wondering if you knew of any widgets
I could add to my blog that automatically tweet my newest twitter
updates. I’ve been looking for a plug-in like this for quite some time
and was hoping maybe you would have some experience with
something like this. Please let me know if you run into anything.
I truly enjoy reading your blog and I look forward to your
new updates.
rox casino промокод
27 Oct 25 at 9:01 am
клиника наркология [url=www.narkologicheskaya-klinika-25.ru]www.narkologicheskaya-klinika-25.ru[/url] .
narkologicheskaya klinika_cvPl
27 Oct 25 at 9:02 am
https://www.diigo.com/item/note/8tv0g/2bv9?k=2c8cbb9fd2e4e63b8214987d6666843c
JeremyHep
27 Oct 25 at 9:02 am
купить диплом в энгельсе [url=http://rudik-diplom11.ru]http://rudik-diplom11.ru[/url] .
Diplomi_juMi
27 Oct 25 at 9:02 am
https://infoguiasostenibilidad.airelibre.com/melbet-kazino-sloti-skachat-na-android/
Michaelcop
27 Oct 25 at 9:02 am
кракен qr код
kraken android
Henryamerb
27 Oct 25 at 9:06 am
наркологический диспансер москва [url=www.narkologicheskaya-klinika-24.ru/]наркологический диспансер москва[/url] .
narkologicheskaya klinika_qcSr
27 Oct 25 at 9:06 am
кракен ссылка
kraken tor
Henryamerb
27 Oct 25 at 9:07 am
Je ne me lasse pas de Ruby Slots Casino, ca transporte dans un univers de plaisirs. Il y a une abondance de jeux excitants, proposant des jeux de cartes elegants. 100% jusqu’a 500 € plus des tours gratuits. Le support client est irreprochable. Le processus est fluide et intuitif, toutefois des offres plus genereuses seraient top. En fin de compte, Ruby Slots Casino merite un detour palpitant. Par ailleurs le design est moderne et attrayant, amplifie l’adrenaline du jeu. A noter les nombreuses options de paris sportifs, assure des transactions fiables.
Explorer maintenant|
ghostglowor1zef
27 Oct 25 at 9:07 am
Thanks for every other great article. The place else may anybody get that kind of info in such an ideal manner of writing?
I have a presentation subsequent week, and I’m at the
search for such information.
visa for turkey from australia
27 Oct 25 at 9:09 am
В этой публикации мы предлагаем подробные объяснения по актуальным вопросам, чтобы помочь читателям глубже понять их. Четкость и структурированность материала сделают его удобным для усвоения и применения в повседневной жизни.
Читать дальше – https://library.gctu.edu.gh/announcements/gctu-librarians-receive-training-on-the-administration-of-dspace
Jameschisa
27 Oct 25 at 9:10 am