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

81,730 Responses to 'PHP hook, building hooks in your application'

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

для дрессировки собак Мясо для собак – это важный источник белка, необходимого для роста и развития мышц, поддержания иммунитета и общего здоровья. Мясо может быть представлено в различных формах, таких как кусочки, фарш или готовые консервы. При выборе мяса для собаки следует отдавать предпочтение нежирным сортам, таким как курица, индейка, говядина или ягненок. Важно убедиться, что мясо свежее и не содержит костей.

DannyBow

7 Oct 25 at 8:25 pm
купить диплом инженера по охране труда [url=www.rudik-diplom10.ru/]купить диплом инженера по охране труда[/url] .

Diplomi_szSa

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

Diplomi_mjkt

7 Oct 25 at 8:26 pm
Важность сайта рейтингов для развития вашего бизнеса

Сегодня конкуренция среди компаний значительно возросла, и каждый бизнес стремится выделиться среди конкурентов. Одним из наиболее эффективных инструментов привлечения клиентов является создание качественного и удобного веб-сайта. Однако недостаточно просто создать сайт — важно также отслеживать его эффективность и понимать, насколько он соответствует ожиданиям пользователей. Именно здесь приходят на помощь сайты рейтингов.
[url=https://cis-awards.ru/consult2026]РўРѕРї-9 РєРѕРЅСЃР°Р»С‚РёРЅРіРѕРІС‹С… РєРѕРјРїР°РЅРёР№ РІ 2026 РіРѕРґСѓ[/url]
¦ Что такое сайты рейтингов?

Сайт рейтинга представляет собой онлайн-платформу, где пользователи оставляют отзывы и оценки о товарах, услугах или компаниях. Эти площадки позволяют потенциальным клиентам ознакомиться с мнением реальных покупателей перед принятием решения о покупке. Для бизнеса же наличие положительных отзывов и высоких оценок повышает доверие потребителей и увеличивает вероятность выбора именно вашей компании.

¦ Как сайты рейтингов помогают бизнесу?
[url=https://cis-awards.ru]https://cis-awards.ru[/url]
1. Повышение доверия: Положительные отзывы и высокие рейтинги создают позитивный имидж компании, что привлекает новых клиентов.

2. Анализ конкурентоспособности: Рейтинги позволяют сравнивать свою компанию с аналогичными предприятиями отрасли, выявлять сильные и слабые стороны продукта или услуги.

3. Обратная связь: Отзывы пользователей предоставляют ценный источник информации о качестве товаров и услуг, позволяя оперативно реагировать на жалобы и улучшать качество обслуживания.

4. SEO-продвижение: Сайты рейтингов часто индексируются поисковиками, что способствует повышению видимости сайта компании в поисковых системах.
РЎР°Р№С‚ СЂРµР№С‚РёРЅРіРё РґР»СЏ Р±РёР·РЅРµСЃР°
https://cis-awards.ru/consult2026
¦ Какие факторы влияют на позицию в рейтинге?

Для успешного продвижения своего бренда на сайтах рейтингов необходимо учитывать ряд факторов:

– Качество предоставляемых услуг или продукции.
– Уровень удовлетворенности клиентов.
– Активность компании в социальных сетях и маркетинге.
– Скорость реагирования на отрицательные отзывы.

¦ Заключение

Использование сайтов рейтингов становится неотъемлемой частью стратегии развития любого современного бизнеса. Они обеспечивают объективную оценку качества ваших продуктов и услуг, способствуют привлечению новых клиентов и укреплению позиций компании на рынке. Инвестируя в улучшение своей репутации на таких площадках, вы инвестируете в долгосрочный успех своего дела.

Williamgeani

7 Oct 25 at 8:28 pm
сколько стоит купить диплом техникума [url=https://www.frei-diplom8.ru]сколько стоит купить диплом техникума[/url] .

Diplomi_jfsr

7 Oct 25 at 8:29 pm
спорт сегодня [url=www.novosti-sporta-8.ru/]спорт сегодня[/url] .

novosti sporta_noMa

7 Oct 25 at 8:30 pm
купить диплом автомобильного техникума [url=http://frei-diplom12.ru]купить диплом автомобильного техникума[/url] .

Diplomi_cnPt

7 Oct 25 at 8:32 pm
свежие прогнозы на спорт [url=http://prognozy-ot-professionalov4.ru/]http://prognozy-ot-professionalov4.ru/[/url] .

prognozi ot professionalov_suOr

7 Oct 25 at 8:33 pm
manchunyuan8 – Images load well, and overall experience is pleasant so far.

Tony Volckmann

7 Oct 25 at 8:34 pm
купить диплом в евпатории [url=http://www.rudik-diplom11.ru]купить диплом в евпатории[/url] .

Diplomi_ixMi

7 Oct 25 at 8:34 pm
TESLATOTO adalah website slot online gacor
terbaru 2025 dengan kemudahan deposit via QRIS 5K tanpa akun bank.

Main slot online modal goceng dengan peluang menang tinggi, penyedia game terlengkap, hadiah berlimpah, dan kemungkinan tinggi untuk meraih maxwin setiap
hari secara nyaman serta aman.

teslatoto link alternatif

7 Oct 25 at 8:35 pm
купить диплом железнодорожного техникума [url=http://frei-diplom8.ru/]купить диплом железнодорожного техникума[/url] .

Diplomi_agsr

7 Oct 25 at 8:36 pm
прогноз на сегодня на спорт [url=www.prognozy-ot-professionalov4.ru/]www.prognozy-ot-professionalov4.ru/[/url] .

prognozi ot professionalov_zhOr

7 Oct 25 at 8:37 pm
куплю диплом младшей медсестры [url=http://frei-diplom13.ru/]http://frei-diplom13.ru/[/url] .

Diplomi_nfkt

7 Oct 25 at 8:39 pm
https://krasavchikbro.ru

DonaldtiEls

7 Oct 25 at 8:40 pm
I think this is one of the most vital information for me.
And i am glad reading your article. But wanna remark
on some general things, The site style is perfect, the articles
is really nice : D. Good job, cheers

طراحی سایت کاریابی

7 Oct 25 at 8:40 pm
вывод из запоя москва недорого [url=http://vyvod-iz-zapoya-9.ru]http://vyvod-iz-zapoya-9.ru[/url] .

vivod iz zapoya_byEl

7 Oct 25 at 8:41 pm
купить диплом внесенный в реестр [url=www.frei-diplom2.ru]купить диплом внесенный в реестр[/url] .

Diplomi_teEa

7 Oct 25 at 8:41 pm
прогнозы на спорт с описанием [url=prognozy-ot-professionalov4.ru]prognozy-ot-professionalov4.ru[/url] .

prognozi ot professionalov_evOr

7 Oct 25 at 8:42 pm
Если вы или ваш близкий нуждаетесь в профессиональной помощи при запое, клиника «Детокс» в Краснодаре предлагает услугу вызова нарколога на дом. Врач приедет в течение 1–2 часов, проведёт необходимое обследование и назначит лечение. Услуга доступна круглосуточно и анонимно.
Подробнее тут – [url=https://narkolog-na-dom-krasnodar27.ru/]нарколог капельница на дом в краснодаре[/url]

JulioBLome

7 Oct 25 at 8:42 pm
Hello i am kavin, its my first occasion to commenting anywhere, when i read this post i
thought i could also create comment due to this sensible piece of writing.

LC88

7 Oct 25 at 8:43 pm
купить диплом техникума легкой промышленности [url=http://www.frei-diplom9.ru]купить диплом техникума легкой промышленности[/url] .

Diplomi_gzea

7 Oct 25 at 8:43 pm
https://everlastrx.shop/# safe online pharmacy for ED pills

Kennethtut

7 Oct 25 at 8:43 pm
Клиника «Похмельная служба» в Нижнем Новгороде предлагает капельницу от запоя с выездом на дом. Наши специалисты обеспечат вам комфортное и безопасное лечение в привычной обстановке.
Подробнее тут – https://vyvod-iz-zapoya-nizhnij-novgorod11.ru

Georgefaw

7 Oct 25 at 8:43 pm
Thanks for every other great article. Where else may anybody get that type of info in such an ideal method of writing? I’ve a presentation subsequent week, and I am at the look for such information.
https://atelierdesdelices.com.ua/yak-nalashtuvaty-bi-led-optyku-dlya-maksymalnoyi-e.html

ShaneDrync

7 Oct 25 at 8:43 pm
how to buy ivermectin [url=http://medivermonline.com/#]generic ivermectin online pharmacy[/url] low-cost ivermectin for Americans

Michaelriz

7 Oct 25 at 8:44 pm
анонимный. вывод. из. запоя. москва. [url=https://www.vyvod-iz-zapoya-9.ru]https://www.vyvod-iz-zapoya-9.ru[/url] .

vivod iz zapoya_gqEl

7 Oct 25 at 8:45 pm
пансионат для пожилых людей
pansionat-tula011.ru
пансионат для людей с деменцией в туле

pansionattulaNeT

7 Oct 25 at 8:45 pm
купить диплом в пензе [url=rudik-diplom10.ru]rudik-diplom10.ru[/url] .

Diplomi_dtSa

7 Oct 25 at 8:46 pm
купить диплом в череповце [url=http://www.rudik-diplom7.ru]http://www.rudik-diplom7.ru[/url] .

Diplomi_rwPl

7 Oct 25 at 8:46 pm
capsaqiu – I saw a few pages, design’s simple and straightforward.

Donny Brim

7 Oct 25 at 8:47 pm
новости мирового спорта [url=https://www.sport-novosti-2.ru]https://www.sport-novosti-2.ru[/url] .

sport novosti_pkmn

7 Oct 25 at 8:49 pm
купить медицинский диплом медсестры [url=www.frei-diplom13.ru]купить медицинский диплом медсестры[/url] .

Diplomi_ltkt

7 Oct 25 at 8:50 pm
купить проведенный диплом весь [url=https://frei-diplom2.ru/]купить проведенный диплом весь[/url] .

Diplomi_ieEa

7 Oct 25 at 8:50 pm
The $MTAUR token presale is a steal at current rates. Audited contracts and vesting smart. Minotaur adventures await.
mtaur token

WilliamPargy

7 Oct 25 at 8:51 pm
для дрессировки собак для собак крупных пород – То же самое, что и предыдущий запрос: поиск товаров и услуг, предназначенных для крупных пород собак.

Ronaldpef

7 Oct 25 at 8:53 pm
купить проведенный диплом спб [url=www.frei-diplom3.ru/]www.frei-diplom3.ru/[/url] .

Diplomi_foKt

7 Oct 25 at 8:53 pm
купить диплом в архангельске с занесением в реестр [url=www.frei-diplom1.ru/]купить диплом в архангельске с занесением в реестр[/url] .

Diplomi_toOi

7 Oct 25 at 8:53 pm
диплом техникума с отличием купить [url=frei-diplom12.ru]диплом техникума с отличием купить[/url] .

Diplomi_ksPt

7 Oct 25 at 8:54 pm
где купить диплом техникума лучше [url=http://frei-diplom9.ru/]где купить диплом техникума лучше[/url] .

Diplomi_aiea

7 Oct 25 at 8:54 pm
купить диплом в железногорске [url=www.rudik-diplom10.ru/]www.rudik-diplom10.ru/[/url] .

Diplomi_vsSa

7 Oct 25 at 8:55 pm
вывод из запоя на дому [url=vyvod-iz-zapoya-9.ru]vyvod-iz-zapoya-9.ru[/url] .

vivod iz zapoya_gnEl

7 Oct 25 at 8:55 pm
купить диплом с занесением в реестр в спб [url=https://frei-diplom2.ru]https://frei-diplom2.ru[/url] .

Diplomi_vaEa

7 Oct 25 at 8:56 pm
новости тенниса [url=www.novosti-sporta-8.ru]новости тенниса[/url] .

novosti sporta_qjMa

7 Oct 25 at 8:57 pm
Howdy! Would you mind if I share your blog with my facebook group? There’s a lot of people that I think would really enjoy your content. Please let me know. Thank you
http://bagit.com.ua/yak-steklo-fary-mozhe-znyzyty-ryzyk-polomok-avtomo.html

IsmaelNek

7 Oct 25 at 8:57 pm
xyadmin – I checked out the site and found it surprisingly smooth to browse.

Myrl Alwardt

7 Oct 25 at 8:57 pm
купить диплом в сосновом бору [url=https://rudik-diplom7.ru]https://rudik-diplom7.ru[/url] .

Diplomi_ddPl

7 Oct 25 at 8:57 pm
https://everlastrx.com/# Tadalafil tablets

Kennethtut

7 Oct 25 at 8:57 pm
купить диплом физика [url=https://rudik-diplom11.ru]купить диплом физика[/url] .

Diplomi_gxMi

7 Oct 25 at 8:58 pm
I’m amazed, I must say. Rarely do I encounter a blog that’s both
educative and entertaining, and let me tell you,
you’ve hit the nail on the head. The problem is something that too few people are
speaking intelligently about. I am very happy I stumbled across this during my hunt for
something concerning this.

Billera Schweiz

7 Oct 25 at 8:58 pm

Winkans bij loterijen

Pokersites voor Enschedeers

Sjoerd Maessen blog

PHP hook, building hooks in your application

81,730 Responses to 'PHP hook, building hooks in your application'

Leave a Reply

Archive

Recent Comments

Tags

Meta