PHP hook, building hooks in your application

By Sjoerd Maessen / May 23, 2011

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!

11,798 thoughts on “PHP hook, building hooks in your application”

Jeffreyboirm
June 21, 2025 at 6:16 am

Выезд врача-нарколога из клиники «ТрезвоПрофи» на дом происходит в любое время суток, включая выходные и праздники. Перед началом детоксикации врач проводит осмотр, измеряет давление, частоту пульса, уровень кислорода в крови и подбирает индивидуальную схему лечения. Сама процедура обычно занимает от 1 до 2 часов и проводится под строгим контролем врача.
Подробнее – http://
IgnacioCheat
June 21, 2025 at 6:17 am

Покупка дипломов ВУЗов в Москве — с печатями, подписями, приложением и возможностью архивной записи (по запросу).
Документ максимально приближен к оригиналу и проходит визуальную проверку.
Мы даем гарантию, что в случае проверки документа, подозрений не возникнет.

– Конфиденциально
– Доставка 3–7 дней
– Любая специальность

Уже более 2117 клиентов воспользовались услугой — теперь ваша очередь.

Обращайтесь — ответим быстро, без лишних формальностей.
Emanuellurry
June 21, 2025 at 6:20 am

goobet
Thomasgaw
June 21, 2025 at 6:21 am

goobet
Danielbab
June 21, 2025 at 6:24 am

Чем дольше человек находится в состоянии запоя, тем больше накапливаются токсины в организме, что негативно сказывается на всех системах. Отказ от алкоголя без должного контроля может привести к серьезным последствиям, таким как:
Разобраться лучше – запой нарколог на дом краснодар
Emanuellurry
June 21, 2025 at 6:29 am

goobet
EverettPreor
June 21, 2025 at 6:32 am

заказать реферат цена заказать реферат недорого
IgnacioCheat
June 21, 2025 at 6:35 am

Мы предлагаем оформление дипломов ВУЗов по всей России и СНГ — с печатями, подписями, приложением и возможностью архивной записи (по запросу).
Документ максимально приближен к оригиналу и проходит визуальную проверку.
Мы гарантируем, что в случае проверки документа, подозрений не возникнет.

– Конфиденциально
– Доставка 3–7 дней
– Любая специальность

Уже более 2180 клиентов воспользовались услугой — теперь ваша очередь.

Купить диплом недорого — ответим быстро, без лишних формальностей.
Robertcitte
June 21, 2025 at 6:37 am

Наркологическое лечение на дому начинается с приезда врача в течение 30-60 минут после вызова. Специалист проводит первичную диагностику состояния пациента, включая измерение артериального давления, пульса и уровня кислорода в крови, а также общую оценку тяжести интоксикации. Затем врач подбирает оптимальный состав лекарств для детоксикационной капельницы, которая эффективно очищает организм от токсинов, восстанавливает водно-солевой баланс и нормализует работу внутренних органов.
Получить дополнительную информацию – нарколог на дом клиника сочи
Emanuellurry
June 21, 2025 at 6:38 am

goobet
JoyceSaimb
June 21, 2025 at 6:38 am

This supportive online community helps people dealing with addiction and mental health challenges.
Explore further – online support for alcoholism
Thomasgaw
June 21, 2025 at 6:41 am

goobet
Thomasgaw
June 21, 2025 at 6:43 am

goobet
WalterSnura
June 21, 2025 at 6:45 am

goobet
JoyceSaimb
June 21, 2025 at 6:49 am

Discover a non-judgmental environment to talk about relapse, recovery, and starting over.
Find out more – how to help a loved one with addiction
zaimpodptskemerovoswalp
June 21, 2025 at 6:53 am

кредит под залог птс
infoavtolombard-pts65.ru/kemerovo.html
кредит под залог автомобиля кемерово
Martinvam
June 21, 2025 at 6:59 am

Основное направление работы клиники – это комплексный подход, который включает медицинское лечение, психотерапию и социальную реабилитацию. Мы понимаем, что зависимость затрагивает не только физическое состояние, но и психологическое, поэтому используем методики когнитивно-поведенческой терапии, семейные консультации и групповые занятия. Такой подход помогает пациентам не только преодолеть зависимость, но и разобраться с её причинами и справиться с психологическими трудностями.
Подробнее можно узнать тут – https://быстро-вывод-из-запоя.рф/vyvod-iz-zapoya-cena-v-volgograde.xn--p1ai/
Sandrajurgy
June 21, 2025 at 7:01 am

AntiNarcoForum — форум помощи при зависимостях, обеспечивающий анонимность и поддержку каждому участнику. Здесь доступны проверенные методики лечения, реальные истории выздоровления и профессиональные рекомендации специалистов для эффективного преодоления зависимости.
Исследовать вопрос подробнее – как выбрать реабилитационный центр для наркозависимых
Patrickmax
June 21, 2025 at 7:02 am

Покупка дипломов ВУЗов в Москве — с печатями, подписями, приложением и возможностью архивной записи (по запросу).
Документ максимально приближен к оригиналу и проходит визуальную проверку.
Мы гарантируем, что в случае проверки документа, подозрений не возникнет.

– Конфиденциально
– Доставка 3–7 дней
– Любая специальность

Уже более 3050 клиентов воспользовались услугой — теперь ваша очередь.

[url=http://inforepetitor2.ru/]Купить диплом нового образца[/url] — ответим быстро, без лишних формальностей.
IgnacioCheat
June 21, 2025 at 7:02 am

Мы предлагаем оформление дипломов ВУЗов по всей России и СНГ — с печатями, подписями, приложением и возможностью архивной записи (по запросу).
Документ максимально приближен к оригиналу и проходит визуальную проверку.
Мы даем гарантию, что в случае проверки документа, подозрений не возникнет.

– Конфиденциально
– Доставка 3–7 дней
– Любая специальность

Уже более 4253 клиентов воспользовались услугой — теперь ваша очередь.

[url=http://inforepetitor3.ru/]Купить диплом вуза[/url] — ответим быстро, без лишних формальностей.
Michealpek
June 21, 2025 at 7:02 am

Когда запой приводит к критическому ухудшению состояния, оперативное лечение становится жизненно необходимым. В Тюмени доступна услуга капельничного вывода из запоя на дому, которая позволяет начать детоксикацию организма незамедлительно и в комфортной для пациента обстановке. Такой формат терапии помогает не только вывести токсины, но и значительно снизить риск осложнений, сохраняя при этом полную конфиденциальность.
Выяснить больше – http://kapelnica-ot-zapoya-tyumen0.ru
Robertolor
June 21, 2025 at 7:03 am

goobet
JamesItame
June 21, 2025 at 7:07 am

goobet
Thomasgaw
June 21, 2025 at 7:07 am

goobet
Thomasgaw
June 21, 2025 at 7:09 am

goobet
WalterSnura
June 21, 2025 at 7:14 am

goobet
Sazrtnh
June 21, 2025 at 7:15 am

Приобретение документа о высшем образовании через надежную компанию дарит массу плюсов. Приобрести диплом: [url=http://collie.fatbb.ru/posting.php?mode=post&f=18&sid=38adf58472d384d35c97cf987e58877f]collie.fatbb.ru/posting.php?mode=post&f=18&sid=38adf58472d384d35c97cf987e58877f[/url]
hoc spa
June 21, 2025 at 7:16 am

I am now not sure the place you are getting your information, however good topic.
I must spend some time studying more or figuring out more.
Thank you for fantastic information I was looking for this information for my mission.
Robertolor
June 21, 2025 at 7:18 am

goobet
Robertolor
June 21, 2025 at 7:20 am

goobet
ai assisted development
June 21, 2025 at 7:25 am

I was curious if you ever considered changing the layout
of your site? Its very well written; I love what youve got
to say. But maybe you could a little more in the way of content so people
could connect with it better. Youve got an awful lot of text for only having one or two images.

Maybe you could space it out better?
zaimpodptsnovosibswalp
June 21, 2025 at 7:26 am

автоломбард залог авто
infoavtolombard-pts65.ru/nsk.html
кредит под птс с плохой кредитной
سایت شرط بندی
June 21, 2025 at 7:27 am

My brother recommended I may like this website.
He was entirely right. This submit truly made my day.
You cann’t consider simply how much time I had spent for this info!
Thanks!
VickiWab
June 21, 2025 at 7:28 am

Мы предлагаем оформление дипломов ВУЗов по всей России и СНГ — с печатями, подписями, приложением и возможностью архивной записи (по запросу).
Документ максимально приближен к оригиналу и проходит визуальную проверку.
Мы даем гарантию, что в случае проверки документа, подозрений не возникнет.

– Конфиденциально
– Доставка 3–7 дней
– Любая специальность

Уже более 2749 клиентов воспользовались услугой — теперь ваша очередь.

Купить диплом Россия — ответим быстро, без лишних формальностей.
Josephliait
June 21, 2025 at 7:37 am

Наркологический центр “Здоровая Жизнь” — это надежный оплот для тех, кто оказался в плену зависимости. Наша команда опытных наркологов, психологов и психотерапевтов применяет современные методы лечения и реабилитации, чтобы помочь пациентам вернуться к трезвой и полноценной жизни. Мы стремимся не только устранить симптомы, но и выявить и устранить коренные причины заболевания, предоставляя пациентам инструменты для преодоления тяги к психоактивным веществам и формирования здоровых жизненных установок.
Выяснить больше – http://надежный-вывод-из-запоя.рф/vyvod-iz-zapoya-na-domu-v-voronezhe.xn--p1ai/
Bokep Indo
June 21, 2025 at 7:42 am

Remarkable issues here. I’m very glad to look
your post. Thank you so much and I’m looking ahead to
contact you. Will you kindly drop me a mail?
JosephPreop
June 21, 2025 at 7:45 am

Группа препаратов
Узнать больше – капельница от запоя анонимно в сочи
VickiWab
June 21, 2025 at 7:48 am

Покупка дипломов ВУЗов в Москве — с печатями, подписями, приложением и возможностью архивной записи (по запросу).
Документ максимально приближен к оригиналу и проходит визуальную проверку.
Мы гарантируем, что в случае проверки документа, подозрений не возникнет.

– Конфиденциально
– Доставка 3–7 дней
– Любая специальность

Уже более 3372 клиентов воспользовались услугой — теперь ваша очередь.

Купить диплом о среднем образовании — ответим быстро, без лишних формальностей.
Thomasgaw
June 21, 2025 at 7:50 am

goobet
JamesItame
June 21, 2025 at 7:55 am

goobet
Robertolor
June 21, 2025 at 7:55 am

goobet
JamesItame
June 21, 2025 at 7:57 am

goobet
Jamesfer
June 21, 2025 at 8:01 am

Каждому пациенту уделяется внимание в зависимости от его уникальных потребностей, что способствует достижению максимальных результатов.
Получить больше информации – вывод из запоя омская область
mostbet_fwor
June 21, 2025 at 8:03 am

mostbet skachat app https://www.mostbet4005.ru
JamesItame
June 21, 2025 at 8:09 am

goobet
Mazrkzg
June 21, 2025 at 8:11 am

Мы предлагаем дипломы любых профессий по выгодным ценам. Заказ диплома, подтверждающего окончание университета, – это грамотное решение. Купить диплом о высшем образовании: thathwamasijobs.com/companies/diplomy-grup-24
Robertolor
June 21, 2025 at 8:11 am

goobet
GradyJor
June 21, 2025 at 8:17 am

Лечение зависимости требует не только физической детоксикации, но и работы с психоэмоциональным состоянием пациента. Психотерапевтическая поддержка помогает выявить глубинные причины зависимости, снизить уровень стресса и сформировать устойчивые навыки самоконтроля, что существенно снижает риск рецидивов.
Детальнее – врач нарколог на дом платный уфа
Robertcitte
June 21, 2025 at 8:17 am

Наркологическое лечение на дому начинается с приезда врача в течение 30-60 минут после вызова. Специалист проводит первичную диагностику состояния пациента, включая измерение артериального давления, пульса и уровня кислорода в крови, а также общую оценку тяжести интоксикации. Затем врач подбирает оптимальный состав лекарств для детоксикационной капельницы, которая эффективно очищает организм от токсинов, восстанавливает водно-солевой баланс и нормализует работу внутренних органов.
Разобраться лучше – http://narcolog-na-dom-sochi00.ru/narkolog-na-dom-kruglosutochno-sochi/
Howardcut
June 21, 2025 at 8:19 am

Автогид https://avtogid.in.ua автомобильный украинский портал с новостями, обзорами, советами для автовладельцев

Winkans bij loterijen

Pokersites voor Enschedeers

PHP hook, building hooks in your application

11,798 thoughts on “PHP hook, building hooks in your application”

Leave a Comment