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

99,970 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://www.frei-diplom13.ru]можно купить диплом медсестры[/url] .

Diplomi_mkkt

19 Oct 25 at 8:17 am
Лечение алкоголизма в Саратове: полный путеводитель с пояснениями по стадиям, методам и ценам — всё собрали в статье на Delodom.com. Подробнее тут – http://volcodav.borda.ru/?1-13-0-00000078-000-0-0-1757530543

Crystaldum

19 Oct 25 at 8:20 am
купить диплом в ангарске [url=www.rudik-diplom13.ru]купить диплом в ангарске[/url] .

Diplomi_qxon

19 Oct 25 at 8:21 am
Пациентам в Самаре предлагается анонимное лечение в стационаре с круглосуточным уходом и безопасными условиями.
Узнать больше – [url=https://vyvod-iz-zapoya-v-stacionare-samara25.ru/]вывод из запоя в стационаре[/url]

GilbertCoeby

19 Oct 25 at 8:22 am
купить дипломы техникума цена [url=http://educ-ua7.ru/]http://educ-ua7.ru/[/url] .

Diplomi_uqea

19 Oct 25 at 8:23 am
НЕ ВЕРЬТЕ.НИЧЕГО БОМБОВОГО ТАМ НЕТ.ТАК СЕБЕ НА 3.
более пятнадцати лет на рынке позволили сайт спеллсмелл накопить значительный опыт и выстроить результативную систему работы. Гарантия подлинности всех товаров – главное конкурентное преимущество спел спел [url=https://www.google.com/search?q=About+https://www.spellsmell.ru/&tbm=ilp&ctx=atr&sa=X&ved=2ahUKEwiNx9XNtp6QAxX_GxAIHRIAGaoQv5AHegQIABAR]https://www.google.com/search?q=About+https://www.spellsmell.ru/&tbm=ilp&ctx=atr&sa=X&ved=2ahUKEwiNx9XNtp6QAxX_GxAIHRIAGaoQv5AHegQIABAR[/url] интерактивный магазин.

MonaElila

19 Oct 25 at 8:24 am
можно купить диплом медсестры [url=frei-diplom13.ru]можно купить диплом медсестры[/url] .

Diplomi_thkt

19 Oct 25 at 8:25 am
купить диплом в спб [url=http://rudik-diplom9.ru]купить диплом в спб[/url] .

Diplomi_xyei

19 Oct 25 at 8:25 am
This text is invaluable. How can I find out more?

bandar togel online

19 Oct 25 at 8:25 am
Hola! I’ve been following your website for some time now and finally got the bravery to go ahead and give you a shout
out from New Caney Texas! Just wanted to mention keep up the excellent
job!

https://xxhamster8.za.com/

19 Oct 25 at 8:26 am
купить диплом университета [url=www.rudik-diplom11.ru]купить диплом университета[/url] .

Diplomi_mnMi

19 Oct 25 at 8:26 am
Вызов нарколога на дом в Челябинске обеспечивает возможность проведения полного обследования и первичной терапии в условиях, привычных для пациента. Специалисты оказывают услуги круглосуточно, что позволяет своевременно купировать острые состояния, связанные с алкогольной интоксикацией, абстинентным синдромом или осложнениями наркозависимости.
Подробнее тут – [url=https://narkolog-na-dom-chelyabinsk13.ru/]нарколог на дом вывод челябинск[/url]

Charlesnak

19 Oct 25 at 8:30 am
купить диплом в заречном [url=www.rudik-diplom3.ru]купить диплом в заречном[/url] .

Diplomi_wiei

19 Oct 25 at 8:30 am
купить диплом в ульяновске [url=rudik-diplom11.ru]купить диплом в ульяновске[/url] .

Diplomi_nkMi

19 Oct 25 at 8:35 am
Стационарное лечение запоя в Воронеже — гарантированная анонимность и комфортные условия. Мы предлагаем индивидуальный подход к каждому пациенту, обеспечивая полное восстановление организма и предотвращение рецидивов.
Подробнее тут – [url=https://vyvod-iz-zapoya-v-stacionare-voronezh23.ru/]вывод из запоя в стационаре клиника в воронеже[/url]

Anthonyvom

19 Oct 25 at 8:36 am
Госпитализация в стационар помогает быстрее и надежнее справиться с последствиями запоя.
Ознакомиться с деталями – [url=https://vyvod-iz-zapoya-v-stacionare23.ru/]нарколог вывод из запоя в стационаре нижний новгород[/url]

Francisitedo

19 Oct 25 at 8:36 am
I am extremely impressed with your writing skills and also with the
layout on your blog. Is this a paid theme or did you customize it
yourself? Either way keep up the excellent quality
writing, it’s rare to see a great blog like this one today.

BETFLIK 789

19 Oct 25 at 8:36 am
можно купить диплом медсестры [url=http://frei-diplom13.ru]можно купить диплом медсестры[/url] .

Diplomi_hrkt

19 Oct 25 at 8:37 am
before performed with these big names as Darius Rucker from Hootie and the blowfish, foreigner, Loretta Lynn, Lady Antebellum, [url=https://shad.com.sa/index.php/2025/10/07/agen-betting-sbobet-online-panduan-lengkap-untuk-51/]https://shad.com.sa/index.php/2025/10/07/agen-betting-sbobet-online-panduan-lengkap-untuk-51/[/url] and reo speedwagon.

Nicoledow

19 Oct 25 at 8:37 am
پروژه های ال اس اف – ساختمان پیش ساخته

سپهر کلباسیان

19 Oct 25 at 8:38 am
купить диплом техникум официальный [url=www.educ-ua7.ru/]www.educ-ua7.ru/[/url] .

Diplomi_gaea

19 Oct 25 at 8:38 am
купить диплом о высшем образовании с занесением в реестр владивосток [url=https://www.frei-diplom5.ru]https://www.frei-diplom5.ru[/url] .

Diplomi_ndPa

19 Oct 25 at 8:39 am
Хотите узнать больше о природе нашей страны? Присоединяйтесь к обсуждению.

Зацепил материал про Изучение ООПТ России: парки, заповедники, водоемы.

Смотрите сами:

[url=https://alloopt.ru]https://alloopt.ru[/url]

Надеюсь, вы нашли это путешествие по природе познавательным.

fixRow

19 Oct 25 at 8:42 am
В Сочи клиника «Детокс» проводит вывод из запоя в стационаре с круглосуточным контролем врачей. Процедуры безопасны, эффективны и анонимны.
Подробнее тут – [url=https://vyvod-iz-zapoya-sochi24.ru/]наркологический вывод из запоя[/url]

Bryankax

19 Oct 25 at 8:42 am
купить диплом в находке [url=https://rudik-diplom13.ru]купить диплом в находке[/url] .

Diplomi_axon

19 Oct 25 at 8:42 am
Если пациент не может приехать в клинику, в Краснодаре нарколог приедет к нему домой. Помощь оказывает «Детокс» круглосуточно.
Исследовать вопрос подробнее – [url=https://narkolog-na-dom-krasnodar25.ru/]нарколог на дом срочно в краснодаре[/url]

JamieOvedy

19 Oct 25 at 8:45 am
https://2bs-2best.at

Hermannalia

19 Oct 25 at 8:45 am
диплом о высшем образовании с занесением в реестр купить [url=http://frei-diplom4.ru]диплом о высшем образовании с занесением в реестр купить[/url] .

Diplomi_uaOl

19 Oct 25 at 8:46 am
диплом об окончании техникума купить в [url=educ-ua7.ru]educ-ua7.ru[/url] .

Diplomi_oqea

19 Oct 25 at 8:46 am
купить диплом магистра [url=http://www.rudik-diplom11.ru]купить диплом магистра[/url] .

Diplomi_mtMi

19 Oct 25 at 8:47 am
купить диплом в мытищах [url=www.rudik-diplom3.ru]купить диплом в мытищах[/url] .

Diplomi_yyei

19 Oct 25 at 8:48 am
I have been surfing online more than 3 hours today,
yet I never found any interesting article like yours.

It’s pretty worth enough for me. Personally, if all web owners and bloggers made good content as you did,
the internet will be a lot more useful than ever before.

mv66a

19 Oct 25 at 8:49 am
купить диплом в архангельске с занесением в реестр [url=frei-diplom5.ru]купить диплом в архангельске с занесением в реестр[/url] .

Diplomi_raPa

19 Oct 25 at 8:50 am
Hi, of course this piece of writing is genuijely nice and I have learned lot oof things from itt about blogging.

thanks.

vapeeliquids

19 Oct 25 at 8:52 am
Amazing blog! Do you have any helpful hints for aspiring writers?
I’m planning to start my own site soon but I’m a little lost on everything.
Would you suggest starting with a free platform
like WordPress or go for a paid option? There are so many options out there that I’m completely
overwhelmed .. Any ideas? Kudos!

13win

19 Oct 25 at 8:54 am
купить диплом в твери [url=https://rudik-diplom3.ru]купить диплом в твери[/url] .

Diplomi_plei

19 Oct 25 at 8:56 am
где купить диплом техникума мочь [url=https://www.frei-diplom11.ru]где купить диплом техникума мочь[/url] .

Diplomi_rdsa

19 Oct 25 at 8:56 am
купить диплом с занесением в реестр новосибирск [url=https://www.frei-diplom4.ru]купить диплом с занесением в реестр новосибирск[/url] .

Diplomi_vqOl

19 Oct 25 at 8:56 am
Современная наркологическая клиника в Мариуполе ориентирована на комплексное и индивидуальное лечение алкогольной и наркотической зависимости, обеспечивая пациентам высококвалифицированную помощь с использованием доказанных медицинских протоколов и новейших технологий. Зависимость — это хроническое заболевание, требующее профессионального подхода, основанного на научных данных и многолетнем опыте специалистов.
Выяснить больше – http://narkologicheskaya-klinika-mariupol13.ru/chastnaya-narkologicheskaya-klinika-mariupol/

Gilbertnup

19 Oct 25 at 8:56 am
купить диплом медсестры [url=www.frei-diplom13.ru/]купить диплом медсестры[/url] .

Diplomi_qjkt

19 Oct 25 at 8:57 am
купить диплом в белово [url=http://www.rudik-diplom10.ru]http://www.rudik-diplom10.ru[/url] .

Diplomi_qoSa

19 Oct 25 at 8:58 am
диплом техникума купить дешево [url=http://www.educ-ua7.ru]http://www.educ-ua7.ru[/url] .

Diplomi_wrea

19 Oct 25 at 8:58 am
Bullish on Minotaurus ICO’s viral referrals. $MTAUR utility strong. Sector expansion aids.
minotaurus ico

WilliamPargy

19 Oct 25 at 9:01 am
If you want to take much from this paragraph then you have to apply these strategies to your won web
site.

mm99

19 Oct 25 at 9:03 am
Нарколог прибывает в назначенное время, проводит замеры артериального давления, пульса, сатурации кислорода и температуры. Выполняется экспресс-анализ на содержание алкоголя в крови и оценка водно-электролитного баланса.
Ознакомиться с деталями – http://narkologicheskaya-klinika-rostov13.ru/

JosephNoirl

19 Oct 25 at 9:04 am
The $MTAUR token presale draws with referrals. Maze navigation rewarding. Project’s team ace.
minotaurus presale

WilliamPargy

19 Oct 25 at 9:04 am
Hey there would you mind letting me know which hosting company you’re working with?

I’ve loaded your blog in 3 completely different web browsers and I must say this blog loads a
lot faster then most. Can you suggest a good internet hosting
provider at a reasonable price? Many thanks, I appreciate it!

BETFLIK68

19 Oct 25 at 9:05 am
купить диплом в губкине [url=https://www.rudik-diplom4.ru]https://www.rudik-diplom4.ru[/url] .

Diplomi_rkOr

19 Oct 25 at 9:05 am
just click for source

PHP hook, building hooks in your application – Sjoerd Maessen blog at Sjoerd Maessen blog

just click for source

19 Oct 25 at 9:06 am
urbanstylehub – Customer service was responsive when I had a query, appreciated that.

Mellissa Haury

19 Oct 25 at 9:06 am

Wanneer casino weer open South Holland

Winkans bij loterijen

Pokersites voor Enschedeers

Sjoerd Maessen blog

PHP hook, building hooks in your application

99,970 Responses to 'PHP hook, building hooks in your application'

Leave a Reply

Archive

Recent Comments

Tags

Meta