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!

Written by Sjoerd Maessen

May 23rd, 2011 at 8:02 pm

Posted in API

Tagged with modular, Observer, SPL, Subject

7,465 Responses to 'PHP hook, building hooks in your application'

Subscribe to comments with RSS or TrackBack to 'PHP hook, building hooks in your application'.

Затяжной запой опасен для жизни. Врачи наркологической клиники в Ростове-На-Дону проводят срочный вывод из запоя — на дому или в стационаре. Анонимно, безопасно, круглосуточно.
Узнать больше – [url=https://vyvod-iz-zapoya-rostov17.ru/]вывод из запоя на дому цена в ростове-на-дону[/url]

RobertPah

29 Jul 25 at 9:32 pm
Затяжной запой опасен для жизни. Врачи наркологической клиники в Ростове-На-Дону проводят срочный вывод из запоя — на дому или в стационаре. Анонимно, безопасно, круглосуточно.
Прочитать подробнее – [url=https://vyvod-iz-zapoya-rostov11.ru/]vyvod-iz-zapoya gorod rostov-na-donu[/url]

Williamlek

29 Jul 25 at 9:34 pm
Кроме того, анонимность является важной составляющей этой услуги. Лечение дома исключает возможность столкновения с посторонними людьми и помогает пациентам сохранить свою репутацию. Клиника «Гармония и Свет» обеспечивает полную конфиденциальность, предоставляя пациентам возможность получать помощь без лишних вопросов и обсуждений.
Исследовать вопрос подробнее – http://narcolog-na-dom-ektb55.ru/narkolog-na-dom-ekaterinburg-tseny/

Davidgab

29 Jul 25 at 9:35 pm
Hey there would you mind letting me know which web host you’re
working with? I’ve loaded your blog in 3 different internet browsers and I must say this
blog loads a lot quicker then most. Can you recommend a good
internet hosting provider at a fair price? Thanks, I appreciate it!

Feel free to visit my blog … خرید بک لینک

خرید بک لینک

29 Jul 25 at 9:36 pm
Dragon money Dragon Money – это не просто название, это врата в мир безграничных возможностей и захватывающих азартных приключений. Это не просто платформа, это целая вселенная, где переплетаются традиции вековых казино и новейшие цифровые технологии, создавая уникальный опыт для каждого искателя удачи. В современном мире, где финансовые потоки мчатся со скоростью света, Dragon Money предлагает глоток свежего воздуха – пространство, где правила просты, а возможности безграничны. Здесь каждая ставка – это шанс, каждый спин – это предвкушение победы, а каждый выигрыш – это подтверждение вашей удачи. Но Dragon Money – это не только про выигрыши и джекпоты. Это про сообщество единомышленников, объединенных общим стремлением к риску, азарту и адреналину. Это место, где можно найти новых друзей, поделиться опытом и ощутить неповторимый дух товарищества. Мы твердо верим, что безопасность и честность – это фундамент, на котором строится доверие. Именно поэтому Dragon Money уделяет особое внимание защите данных и обеспечению прозрачности каждой транзакции. Мы стремимся создать максимально комфортную и безопасную среду для наших игроков, где каждый может наслаждаться игрой, не беспокоясь о каких-либо рисках. Dragon Money – это не просто игра. Это возможность испытать себя, проверить свою удачу и почувствовать себя настоящим властелином своей судьбы. Присоединяйтесь к нам, и пусть дракон принесет вам богатство, успех и процветание! Да пребудет с вами удача!

Daviddub

29 Jul 25 at 9:38 pm
В Ростове-На-Дону решение есть — наркологическая клиника. Здесь помогают людям выйти из запоя без страха и осуждения. Всё анонимно, грамотно и с заботой о каждом пациенте.
Узнать больше – [url=https://vyvod-iz-zapoya-rostov15.ru/]вывод из запоя на дому в ростове-на-дону[/url]

AaronSnazy

29 Jul 25 at 9:42 pm
Сопутствующие патологии печени, почек, сердца или ЖКТ усугубляют последствия запоя. Без коррекции электролитного баланса и поддержки органов пациент рискует получить необратимые осложнения.
Углубиться в тему – [url=https://vivod-iz-zapoya-chelyabinsk13.ru/]нарколог на дом вывод из запоя челябинск[/url]

Jasontus

29 Jul 25 at 9:43 pm
Wow, this paragraph is nice, my younger sister is analyzing such things,
therefore I am going to convey her.

Feel free to surf to my site :: Oahu Photographers

Oahu Photographers

29 Jul 25 at 9:46 pm
Драгон Мани Dragon Money – это не просто название, это врата в мир безграничных возможностей и захватывающих азартных приключений. Это не просто платформа, это целая вселенная, где переплетаются традиции вековых казино и новейшие цифровые технологии, создавая уникальный опыт для каждого искателя удачи. В современном мире, где финансовые потоки мчатся со скоростью света, Dragon Money предлагает глоток свежего воздуха – пространство, где правила просты, а возможности безграничны. Здесь каждая ставка – это шанс, каждый спин – это предвкушение победы, а каждый выигрыш – это подтверждение вашей удачи. Но Dragon Money – это не только про выигрыши и джекпоты. Это про сообщество единомышленников, объединенных общим стремлением к риску, азарту и адреналину. Это место, где можно найти новых друзей, поделиться опытом и ощутить неповторимый дух товарищества. Мы твердо верим, что безопасность и честность – это фундамент, на котором строится доверие. Именно поэтому Dragon Money уделяет особое внимание защите данных и обеспечению прозрачности каждой транзакции. Мы стремимся создать максимально комфортную и безопасную среду для наших игроков, где каждый может наслаждаться игрой, не беспокоясь о каких-либо рисках. Dragon Money – это не просто игра. Это возможность испытать себя, проверить свою удачу и почувствовать себя настоящим властелином своей судьбы. Присоединяйтесь к нам, и пусть дракон принесет вам богатство, успех и процветание! Да пребудет с вами удача!

Daviddub

29 Jul 25 at 9:48 pm
This read was worth every second give it a try https://www.deviantart.com/tanaqa/journal/Product-promotion-on-Ozon-1222914386

MichaelCax

29 Jul 25 at 9:49 pm
рубин шинник прогноз [url=prognoz-na-segodnya-na-sport10.ru]prognoz-na-segodnya-na-sport10.ru[/url] .

prognoz na segodnya na sport_yxEn

29 Jul 25 at 9:50 pm
WakeMedsRX: wakefulness medication online no Rx – order Provigil without prescription

Ralphpek

29 Jul 25 at 9:51 pm
Innovative AI platform http://lumiabitai.com for crypto trading — passive income without stress. Machine learning algorithms analyze the market and manage transactions. Simple registration, clear interface, stable profit.

lumiabitai-882

29 Jul 25 at 9:52 pm
Если вы ищете вывод из запоя в стационаре в Балашихе, ознакомьтесь с предложением Частного Медика 24 на сайте.
Расширить кругозор по теме – [url=https://vyvod-iz-zapoya-v-stacionare-balashiha13.ru/]вывод из запоя клиника[/url]

BrandonHep

29 Jul 25 at 9:53 pm
обучение кайтсёрфингу Кайтсёрфинг – это не просто спорт, это стиль жизни, где ветер и вода становятся вашими союзниками. Ощутите свободу полета, скользя по волнам под куполом кайта, и забудьте обо всех проблемах, оставив их на берегу.

RamonLiata

29 Jul 25 at 9:55 pm
AI platform https://bullbittrade.com/ for passive crypto trading. Robots trade 24/7, you earn. Without deep knowledge, without constant control. High speed, security and automatic strategy.

bullbittrade-630

29 Jul 25 at 9:55 pm
точные ставки на спорт футбол [url=https://kompyuternye-prognozy-na-futbol8.ru/]https://kompyuternye-prognozy-na-futbol8.ru/[/url] .

komputernie prognozi na fytbol_ccsi

29 Jul 25 at 9:55 pm
Innovative AI platform https://lumiabitai.com/ for crypto trading — passive income without stress. Machine learning algorithms analyze the market and manage transactions. Simple registration, clear interface, stable profit.

lumiabitai-592

29 Jul 25 at 9:59 pm
Наши специалисты регулярно проходят обучение и сертификацию по последним международным протоколам лечения алкогольной интоксикации. В арсенале «ЧелябДоктор» — передовое оборудование для инфузий, портативные насосы и тест-системы для контроля электролитов, глюкозы и функции печени прямо на дому.
Детальнее – http://

FrankRhymn

29 Jul 25 at 10:02 pm
Близкий человек в запое? Не ждите ухудшения. Обратитесь в клинику — здесь проведут профессиональный вывод из запоя с последующим восстановлением организма.
Подробнее тут – [url=https://kapelnica-ot-zapoya-kolomna14.ru/]капельница от запоя выезд в коломне[/url]

Hermantox

29 Jul 25 at 10:02 pm
AI platform https://bullbittrade.com/ for passive crypto trading. Robots trade 24/7, you earn. Without deep knowledge, without constant control. High speed, security and automatic strategy.

bullbittrade-772

29 Jul 25 at 10:05 pm
кайт лагерь Безопасность – это приоритет номер один в кайтсёрфинге. Всегда проверяйте оборудование, следите за прогнозом погоды и не рискуйте в сложных условиях.

RamonLiata

29 Jul 25 at 10:08 pm
авто из сша купить в минске наличие авто

StevenRuirl

29 Jul 25 at 10:08 pm
1с купить программу [url=https://www.kupit-1s23.ru]1с купить программу[/url] .

kypit 1s_keSa

29 Jul 25 at 10:10 pm
https://arenafan.com/

BrentVex

29 Jul 25 at 10:11 pm
gabapentin verilme ilkeleri [url=https://neuroreliefrx.com/#]predominant adverse effect associated with gabapentin[/url] gabapentin 300mg

JamesAmola

29 Jul 25 at 10:12 pm
Innovative AI platform lumiabitai.com for crypto trading — passive income without stress. Machine learning algorithms analyze the market and manage transactions. Simple registration, clear interface, stable profit.

lumiabitai-92

29 Jul 25 at 10:12 pm
Hi there, its good article about media print, we all be familiar with media is a wonderful source of information.

does java burn work

29 Jul 25 at 10:13 pm
Когда организм на пределе, важна срочная помощь в Коломне — это команда опытных наркологов, которые помогут быстро и мягко выйти из запоя без вреда для здоровья.
Углубиться в тему – [url=https://kapelnica-ot-zapoya-kolomna16.ru/]врача капельницу от запоя коломна[/url]

TimothyNomia

29 Jul 25 at 10:16 pm
прогноз на теннис на сегодня от профессионалов [url=www.prognoz-na-segodnya-na-sport10.ru]www.prognoz-na-segodnya-na-sport10.ru[/url] .

prognoz na segodnya na sport_wyEn

29 Jul 25 at 10:18 pm
кракен ссылка onion

RichardPep

29 Jul 25 at 10:20 pm
AI platform http://bullbittrade.com for passive crypto trading. Robots trade 24/7, you earn. Without deep knowledge, without constant control. High speed, security and automatic strategy.

bullbittrade-767

29 Jul 25 at 10:25 pm
Когда организм на пределе, важна срочная помощь в Коломне — это команда опытных наркологов, которые помогут быстро и мягко выйти из запоя без вреда для здоровья.
Исследовать вопрос подробнее – [url=https://kapelnica-ot-zapoya-kolomna.ru/]капельница от запоя[/url]

Jamescolla

29 Jul 25 at 10:25 pm
Innovative AI platform lumiabitai.com for crypto trading — passive income without stress. Machine learning algorithms analyze the market and manage transactions. Simple registration, clear interface, stable profit.

lumiabitai-590

29 Jul 25 at 10:25 pm
https://www.oaza.pl/

BrentVex

29 Jul 25 at 10:28 pm
amoxicillin 500mg no prescription: order amoxicillin without prescription – order amoxicillin without prescription

Ralphpek

29 Jul 25 at 10:28 pm
https://grecco.com/

BrentVex

29 Jul 25 at 10:29 pm
https://wakemedsrx.com/# buy Modafinil online USA

PatrickNeelp

29 Jul 25 at 10:30 pm
https://legaldocumentseu.com/

BrentVex

29 Jul 25 at 10:31 pm
Метод лечения
Детальнее – [url=https://narkologicheskaya-klinika-rostov-na-donu13.ru/]наркологическая клиника цены ростов-на-дону[/url]

Michaellap

29 Jul 25 at 10:32 pm
We’re a bunch of volunteers and starting a new scheme in our community.

Your site offered us with useful info to work on. You’ve performed a formidable activity and our
entire group will be thankful to you.

www.talkandheal.org

29 Jul 25 at 10:32 pm
Hello there! This blog post could not be written any better!
Reading through this post reminds me of my previous
roommate! He always kept preaching about this. I am going to forward this information to him.
Pretty sure he’s going to have a good read. Thank you for sharing!

Here is my web blog … Australia’s Largest Partnerships Agency

Australia's Largest Partnerships Agency

29 Jul 25 at 10:33 pm
Ch? c?n tham gia nhom new88, b?n s? ti?p c?n du?c thong tin th?t m?i ngay

new88-932

29 Jul 25 at 10:35 pm
Theo doi new88 tren Facebook d? nh?n n?i dung ch?t lu?ng va an toan

new88-467

29 Jul 25 at 10:37 pm
рубин шинник прогноз [url=https://prognoz-na-segodnya-na-sport10.ru]https://prognoz-na-segodnya-na-sport10.ru[/url] .

prognoz na segodnya na sport_igEn

29 Jul 25 at 10:37 pm
Hi there mates, how is the whole thing, and what you wish for to say on the topic of this article,
in my view its in fact awesome designed for me.

Here is my web page; expat internet Hongarije

expat internet Hongarije

29 Jul 25 at 10:40 pm
онлайн фільм 2025 українське кіно онлайн 2025

ua-bay-53

29 Jul 25 at 10:45 pm
Your method of explaining everything in this post is actually fastidious,
every one can without difficulty be aware of it, Thanks a lot.

Tonic Greens

29 Jul 25 at 10:48 pm
Zarejestruj się i graj online w najlepszym kasynie w Polsce na magic 365 casino

DavidSliRe

29 Jul 25 at 10:48 pm
кайтинг Обучение кайтсёрфингу требует профессионального подхода. Не экономьте на инструкторе, который научит вас основам безопасности и поможет быстро прогрессировать.

RamonLiata

29 Jul 25 at 10:49 pm

Winkans bij loterijen

Pokersites voor Enschedeers

Sjoerd Maessen blog

PHP hook, building hooks in your application

7,465 Responses to 'PHP hook, building hooks in your application'

Leave a Reply

Archive

Recent Comments

Tags

Meta