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

44,170 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.elektrokarnizy5.ru]https://www.elektrokarnizy5.ru[/url] .

elektrokarnizi_peol

12 Sep 25 at 5:58 pm
Actually no matter if someone doesn’t know afterward its up to other users that they
will help, so here it happens.

BlorBytAi

12 Sep 25 at 5:59 pm
РїРѕ РєСЂР°Р№РЅРµР№ РјРµСЂРµ Сѓ РјРµРЅСЏ Р±С‹Р»Рѕ , РІСЃРµ РіСѓРґ
https://www.brownbook.net/business/54245281/РєСѓРїРёС‚СЊ-РіР°С€РёС€-РІ-С‚РІРµСЂСЃРєРѕР№-РѕР±Р»Р°СЃС‚Рё-С‡РµСЂРµР·-РёРЅС‚РµСЂРЅРµС‚/
С‡С‚Рѕ С‚С‹ С…РѕС‡РµС€СЊ СЃРєР°Р·Р°С‚СЊ,С‡С‚Рѕ СЌС‚РѕС‚ СЂРµР°РєС‚РёРІ РїР»РѕС…Рѕ РїСЂРµС‚?

Rodneynub

12 Sep 25 at 6:01 pm
проект после перепланировки [url=www.proekt-pereplanirovki-kvartiry8.ru/]www.proekt-pereplanirovki-kvartiry8.ru/[/url] .

proekt pereplanirovki kvartiri_vbMl

12 Sep 25 at 6:03 pm
Важная деталь — отсутствие полипрагмазии. Мы используем «минимально достаточную фармакотерапию»: каждый препарат имеет цель, окно эффективности и критерии отмены. Это снижает побочные эффекты, убирает «тяжесть» днём и делает восстановление более естественным.
Углубиться в тему – [url=https://narkologicheskaya-klinika-v-spb14.ru/]наркологическая клиника вывод из запоя[/url]

Anthonygom

12 Sep 25 at 6:05 pm
перепланировка квартиры в москве [url=http://proekt-pereplanirovki-kvartiry8.ru]перепланировка квартиры в москве[/url] .

proekt pereplanirovki kvartiri_aeMl

12 Sep 25 at 6:06 pm
order medication from mexico: SaludFrontera – SaludFrontera

Charlesdyelm

12 Sep 25 at 6:09 pm
aviator игра [url=http://aviator-igra-4.ru]aviator игра[/url] .

aviator igra_gopr

12 Sep 25 at 6:11 pm
дизайн проект перепланировки квартиры [url=https://proekt-pereplanirovki-kvartiry8.ru/]дизайн проект перепланировки квартиры[/url] .

proekt pereplanirovki kvartiri_phMl

12 Sep 25 at 6:11 pm
На данном этапе врач уточняет, сколько времени продолжается запой, какой тип алкоголя употребляется и имеются ли сопутствующие заболевания. Тщательный анализ этих данных позволяет подобрать оптимальные методы детоксикации и снизить риск осложнений.
Выяснить больше – [url=https://narcolog-na-dom-mariupol0.ru/]врач нарколог выезд на дом[/url]

ChanceAbash

12 Sep 25 at 6:12 pm
заказ перепланировки квартиры [url=http://proekt-pereplanirovki-kvartiry9.ru]заказ перепланировки квартиры[/url] .

proekt pereplanirovki kvartiri_sxpa

12 Sep 25 at 6:13 pm
авиатор краш игра [url=aviator-igra-4.ru]aviator-igra-4.ru[/url] .

aviator igra_mmpr

12 Sep 25 at 6:15 pm
1win ставка [url=https://1win12008.ru/]https://1win12008.ru/[/url]

1win_busn

12 Sep 25 at 6:16 pm
мостбет [url=https://mostbet12006.ru]мостбет[/url]

mostbet_ilKl

12 Sep 25 at 6:17 pm
перепланировка квартиры москва [url=www.proekt-pereplanirovki-kvartiry9.ru]перепланировка квартиры москва[/url] .

proekt pereplanirovki kvartiri_qdpa

12 Sep 25 at 6:17 pm
aviator game promo code [url=https://aviator-igra-5.ru]https://aviator-igra-5.ru[/url] .

aviator igra_mgKt

12 Sep 25 at 6:18 pm
lucky jet игра [url=www.aviator-igra-4.ru/]www.aviator-igra-4.ru/[/url] .

aviator igra_wppr

12 Sep 25 at 6:18 pm
купить диплом о образовании недорого [url=https://educ-ua17.ru]купить диплом о образовании недорого[/url] .

Diplomi_bgSl

12 Sep 25 at 6:18 pm
сколько стоит проект перепланировки [url=https://proekt-pereplanirovki-kvartiry9.ru]сколько стоит проект перепланировки[/url] .

proekt pereplanirovki kvartiri_nwpa

12 Sep 25 at 6:20 pm
Р’СЃРµРј РїСЂРёРІРµС‚ РЅРё РєР°Рє РЅРµ РјРѕРіСѓ Р·Р°РєР°Р· РѕС„РѕСЂРјРёС‚СЊ, РїРѕРјРѕРіРёС‚Рµ,РїР»РёР·
https://www.betterplace.org/en/organisations/68405
Р”РІР° С‡Р°СЃР°, СЂРµР±СЏС‚Р° РІ РєР»СѓР±Рµ,

Rodneynub

12 Sep 25 at 6:25 pm
You actually make it appear really easy along with your presentation but I to find this topic
to be actually one thing that I feel I would never understand.
It kind of feels too complex and extremely large for me.
I am having a look ahead to your subsequent publish, I will attempt to get the grasp of
it!

Opulatrix

12 Sep 25 at 6:26 pm
Ahaa, its nice dialogue about this paragraph at this place at this website, I have read all
that, so now me also commenting here.

situs toto

12 Sep 25 at 6:26 pm
aviator игра на деньги официальный сайт [url=www.aviator-igra-4.ru]aviator игра на деньги официальный сайт[/url] .

aviator igra_ivpr

12 Sep 25 at 6:28 pm
карниз для штор электрический [url=http://elektrokarnizy5.ru]http://elektrokarnizy5.ru[/url] .

elektrokarnizi_egol

12 Sep 25 at 6:28 pm
Hi there, I desire to subscribe for this web site to take most up-to-date updates,
thus where can i do it please help out.

bespoke handbags

12 Sep 25 at 6:29 pm
где заказать проект перепланировки [url=https://proekt-pereplanirovki-kvartiry9.ru]https://proekt-pereplanirovki-kvartiry9.ru[/url] .

proekt pereplanirovki kvartiri_ofpa

12 Sep 25 at 6:29 pm
Кракен (kraken) – ты знаешь что это, уже годами проверенный
сервис российского даркнета.
Недавно мы запустили p2p обмены и теперь вы можете обменивать любую сумму для пополнения.

Всегда есть свежая ссылка кракен через ВПН:

kra35

web page

12 Sep 25 at 6:31 pm
SaludFrontera: SaludFrontera – SaludFrontera

Teddyroowl

12 Sep 25 at 6:31 pm
That is a great tip particularly to those fresh to the blogosphere.
Short but very precise info… Many thanks for sharing this one.
A must read article!

cheap accounting services

12 Sep 25 at 6:32 pm
Hi everyone, it’s my first visit at this web site, and article is genuinely fruitful in favor of me, keep up posting these content.
официальный сайт банда казино

IsmaelNek

12 Sep 25 at 6:35 pm
Онлайн-журнал https://presslook.com.ua для женщин объединяет всё, что важно: мода и стиль, воспитание детей, карьерные советы и вдохновение. Советы специалистов и реальные истории для поддержки и новых идей.

Georgeswavy

12 Sep 25 at 6:36 pm
aviator играть на деньги [url=http://aviator-igra-4.ru]http://aviator-igra-4.ru[/url] .

aviator igra_vupr

12 Sep 25 at 6:36 pm
Твой гид https://nicegirl.kyiv.ua по здоровому образу жизни! Эффективные тренировки, сбалансированное питание, wellness-практики и советы по мотивации. Обрети энергию, силу и гармонию в теле, которое ты любишь.

Geraldvat

12 Sep 25 at 6:37 pm
Актуальные тренды https://horoscope-web.com и вневременная классика. Подборки образов, советы по стилю, секреты гардероба и модные инсайты. Мы поможем тебе выглядеть безупречно каждый день и выразить свой индивидуальный стиль.

HoraceRet

12 Sep 25 at 6:37 pm
проект реконструкции квартиры [url=https://proekt-pereplanirovki-kvartiry9.ru/]https://proekt-pereplanirovki-kvartiry9.ru/[/url] .

proekt pereplanirovki kvartiri_pqpa

12 Sep 25 at 6:38 pm
kraken онион 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

12 Sep 25 at 6:39 pm
Онлайн-журнал https://presslook.com.ua для женщин объединяет всё, что важно: мода и стиль, воспитание детей, карьерные советы и вдохновение. Советы специалистов и реальные истории для поддержки и новых идей.

Georgeswavy

12 Sep 25 at 6:39 pm
Ресурс для амбициозных https://ramledlightings.com и целеустремленных. Карьерный рост, личная эффективность, финансовая грамотность и вдохновляющие истории успеха. Реализуй свой потенциал и добивайся всех поставленных целей!

CarlosDug

12 Sep 25 at 6:39 pm
Актуальные тренды https://horoscope-web.com и вневременная классика. Подборки образов, советы по стилю, секреты гардероба и модные инсайты. Мы поможем тебе выглядеть безупречно каждый день и выразить свой индивидуальный стиль.

HoraceRet

12 Sep 25 at 6:40 pm
Твой гид https://nicegirl.kyiv.ua по здоровому образу жизни! Эффективные тренировки, сбалансированное питание, wellness-практики и советы по мотивации. Обрети энергию, силу и гармонию в теле, которое ты любишь.

Geraldvat

12 Sep 25 at 6:40 pm
сайт mostbet [url=http://mostbet12003.ru]http://mostbet12003.ru[/url]

mostbet_hyet

12 Sep 25 at 6:40 pm
aviator game promo code [url=http://aviator-igra-4.ru]http://aviator-igra-4.ru[/url] .

aviator igra_zgpr

12 Sep 25 at 6:41 pm
Онлайн-журнал https://presslook.com.ua для женщин объединяет всё, что важно: мода и стиль, воспитание детей, карьерные советы и вдохновение. Советы специалистов и реальные истории для поддержки и новых идей.

Georgeswavy

12 Sep 25 at 6:41 pm
проект перепланировки квартиры для согласования [url=www.proekt-pereplanirovki-kvartiry9.ru/]проект перепланировки квартиры для согласования[/url] .

proekt pereplanirovki kvartiri_adpa

12 Sep 25 at 6:41 pm
купить аттестат об окончании 11 классов [url=www.educ-ua17.ru/]купить аттестат об окончании 11 классов[/url] .

Diplomi_quSl

12 Sep 25 at 6:42 pm
Актуальные тренды https://horoscope-web.com и вневременная классика. Подборки образов, советы по стилю, секреты гардероба и модные инсайты. Мы поможем тебе выглядеть безупречно каждый день и выразить свой индивидуальный стиль.

HoraceRet

12 Sep 25 at 6:42 pm
Твой гид https://nicegirl.kyiv.ua по здоровому образу жизни! Эффективные тренировки, сбалансированное питание, wellness-практики и советы по мотивации. Обрети энергию, силу и гармонию в теле, которое ты любишь.

Geraldvat

12 Sep 25 at 6:42 pm
Ресурс для амбициозных https://ramledlightings.com и целеустремленных. Карьерный рост, личная эффективность, финансовая грамотность и вдохновляющие истории успеха. Реализуй свой потенциал и добивайся всех поставленных целей!

CarlosDug

12 Sep 25 at 6:42 pm
Ресурс для амбициозных https://ramledlightings.com и целеустремленных. Карьерный рост, личная эффективность, финансовая грамотность и вдохновляющие истории успеха. Реализуй свой потенциал и добивайся всех поставленных целей!

CarlosDug

12 Sep 25 at 6:44 pm
airplane game money [url=http://aviator-igra-5.ru]http://aviator-igra-5.ru[/url] .

aviator igra_qgKt

12 Sep 25 at 6:45 pm

Winkans bij loterijen

Pokersites voor Enschedeers

Sjoerd Maessen blog

PHP hook, building hooks in your application

44,170 Responses to 'PHP hook, building hooks in your application'

Leave a Reply

Archive

Recent Comments

Tags

Meta