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

91,412 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=kuhni-spb-2.ru]kuhni-spb-2.ru[/url] .

kyhni spb_dlmn

15 Oct 25 at 7:54 pm
потолочкин натяжные потолки нижний новгород официальный сайт [url=https://natyazhnye-potolki-nizhniy-novgorod-1.ru]https://natyazhnye-potolki-nizhniy-novgorod-1.ru[/url] .

natyajnie potolki nijnii novgorod_lsma

15 Oct 25 at 7:55 pm
потолки натяжные в нижнем новгороде [url=www.stretch-ceilings-nizhniy-novgorod.ru]www.stretch-ceilings-nizhniy-novgorod.ru[/url] .

natyajnie potolki nijnii novgorod_cmPl

15 Oct 25 at 7:56 pm
Строительный портал https://v-stroit.ru всё о строительстве, ремонте и архитектуре. Полезные советы, технологии, материалы, новости отрасли и практические инструкции для мастеров и новичков.

Rogerzok

15 Oct 25 at 7:57 pm
купить права категории б

AndrewKam

15 Oct 25 at 7:59 pm
организация трансляций [url=zakazat-onlayn-translyaciyu.ru]организация трансляций[/url] .

zakazat onlain translyaciu _emka

15 Oct 25 at 8:01 pm
verapamil for sale

verapamil for sale

15 Oct 25 at 8:02 pm
вывод из запоя круглосуточно краснодар
narkolog-krasnodar016.ru
вывод из запоя

izzapoyakrasnodarNeT

15 Oct 25 at 8:06 pm
Modern Purair
201, 1475 Ellis Street, Kelowna
BC Ꮩ1Y 2A3, Canada
1-800-996-3878
Social programs

Social programs

15 Oct 25 at 8:06 pm
mexico pharmacy [url=https://medicosur.shop/#]mexican pharmacy[/url] mexican pharmacy

CareyMag

15 Oct 25 at 8:07 pm
организация трансляции [url=www.zakazat-onlayn-translyaciyu1.ru]организация трансляции[/url] .

zakazat onlain translyaciu _trmt

15 Oct 25 at 8:08 pm
Heya i’m for the first time here. I found this board and I find It really
useful & it helped me out a lot. I hope to give something back and help others like you helped me.

Éclat Gainetra Erfahrungen

15 Oct 25 at 8:10 pm
потолочкин натяжные потолки нижний новгород официальный сайт [url=stretch-ceilings-nizhniy-novgorod.ru]stretch-ceilings-nizhniy-novgorod.ru[/url] .

natyajnie potolki nijnii novgorod_ryPl

15 Oct 25 at 8:11 pm
What’s up to all, the contents present at this site are in fact awesome for people experience,
well, keep up the good work fellows.

MGB file viewer software

15 Oct 25 at 8:14 pm
Выданные бесплатные вращения работают в конкретном автомате.

казино пинко зеркало

15 Oct 25 at 8:15 pm
buy amoxil [url=http://zencaremeds.com/#]ZenCare Meds com[/url] buy amoxil

CareyMag

15 Oct 25 at 8:17 pm
netmatrix.click – I’m impressed with load times, images pop in very quickly.

Tequila Janoski

15 Oct 25 at 8:19 pm
глория мебель [url=kuhni-spb-2.ru]kuhni-spb-2.ru[/url] .

kyhni spb_mdmn

15 Oct 25 at 8:20 pm
организация онлайн трансляции конференции [url=http://zakazat-onlayn-translyaciyu.ru]http://zakazat-onlayn-translyaciyu.ru[/url] .

zakazat onlain translyaciu _sjka

15 Oct 25 at 8:22 pm
кухни на заказ в спб [url=https://kuhni-spb-1.ru/]https://kuhni-spb-1.ru/[/url] .

kyhni spb_cgmi

15 Oct 25 at 8:22 pm
Thanks for finally writing about > PHP hook, building hooks in your
application – Sjoerd Maessen blog at Sjoerd Maessen blog < Loved it!

Mevryon Platform Ervaringen

15 Oct 25 at 8:24 pm
https://wakelet.com/wake/8LIX3iO5Bjmq6uQvglPJ-

Steventib

15 Oct 25 at 8:24 pm
купить кухню на заказ в спб [url=www.kuhni-spb-2.ru]www.kuhni-spb-2.ru[/url] .

kyhni spb_zjmn

15 Oct 25 at 8:25 pm
Hi, yeah this post is truly fastidious and I have learned lot
of things from it about blogging. thanks.

dewascatter link alternatif

15 Oct 25 at 8:25 pm
rankflow.click – The typography is sharp and easy on the eyes throughout.

Rayford Hammet

15 Oct 25 at 8:25 pm
1win bonus kodu [url=http://1win5004.com/]http://1win5004.com/[/url]

1win_ajoi

15 Oct 25 at 8:26 pm
webpulse.click – The visuals are crisp and the load speed is pretty solid.

Marion Lagrant

15 Oct 25 at 8:26 pm
Так вот, прошло все как всегда отлично, дошло за три дня, маскировка надежная. Так же отдельное спасибо магазину за проявление немыслимой заботы о безопасности клиента. Что имел ввиду писать не буду, но факт есть факт.
https://telegra.ph/Dji-osmo-action-kupit-v-moskve-10-13-2
пацаны магаз ровный пишу это уже не раз всегда списываюсь с менеджером все делает ровно и качество и оперативность , всегда заказываю и буду заказывать тут т.к. не париться за качество продукта как в других магазах!!!

MichaelViess

15 Oct 25 at 8:27 pm
Приобрести диплом университета поможем. Купить диплом в России, предлагает наша компания – [url=http://diplomybox.com//]diplomybox.com/[/url]

Cazrvpp

15 Oct 25 at 8:28 pm
заказать трансляцию [url=zakazat-onlayn-translyaciyu1.ru]заказать трансляцию[/url] .

zakazat onlain translyaciu _womt

15 Oct 25 at 8:28 pm
натяжные потолки ру [url=https://natyazhnye-potolki-nizhniy-novgorod-1.ru]натяжные потолки ру[/url] .

natyajnie potolki nijnii novgorod_snma

15 Oct 25 at 8:29 pm
потолочкин потолки [url=https://stretch-ceilings-nizhniy-novgorod.ru/]https://stretch-ceilings-nizhniy-novgorod.ru/[/url] .

natyajnie potolki nijnii novgorod_gvPl

15 Oct 25 at 8:30 pm
You’ve made some really good points there. I looked on the internet for additional
information about the issue and found most people will go along with your views on this site.

index

15 Oct 25 at 8:30 pm
Excited about $MTAUR’s potential in the $14.78B gaming sector. Presale perks like value appreciation are drawing me. Game’s minotaur hero is iconic.
minotaurus coin

WilliamPargy

15 Oct 25 at 8:31 pm
https://tadalifepharmacy.com/# TadaLife Pharmacy

Hermandug

15 Oct 25 at 8:33 pm
Врач уточняет, как долго продолжается запой, какой алкоголь употребляется, а также наличие сопутствующих заболеваний. Этот тщательный анализ позволяет оперативно подобрать оптимальные методы детоксикации и снизить риск осложнений.
Разобраться лучше – [url=https://vyvod-iz-zapoya-tula0.ru/]вывод из запоя на дому тула[/url]

JeffreyBoync

15 Oct 25 at 8:33 pm
When some one searches for his necessary thing, thus he/she
needs to be available that in detail, so that thing is maintained over here.

https://888p-app.com/

15 Oct 25 at 8:34 pm
Дизайнерский ремонт: искусство преображения пространства

Дизайн интерьера играет важную роль в создании комфортной и уютной атмосферы в доме. Сегодня мы поговорим о таком понятии, как дизайнерский ремонт, который позволяет превратить обычное жилье в уникальное пространство, отражающее индивидуальность владельца.
[url=https://designapartment.ru ]РґРёР·Р°Р№РЅРµСЂСЃРєРёР№ СЂРµРјРѕРЅС‚ РєРѕС‚С‚РµРґР¶Р° РјРѕСЃРєРІР°[/url]
Что такое дизайнерский ремонт?

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

Ключевые особенности дизайнерского ремонта:

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

Виды дизайнерских ремонтов
[url=https://designapartment.ru ]РґРёР·Р°Р№РЅРµСЂСЃРєРёР№ РєР»СЋС‡ СЂРµРјРѕРЅС‚[/url]
Существует несколько видов дизайнерских ремонтов, каждый из которых имеет свои особенности и преимущества.

#1 Дизайнерский ремонт квартиры

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

Пример дизайна: светлая гостиная с панорамными окнами, минималистичный дизайн кухни и спальни в стиле лофт.

#2 Дизайнерский ремонт дома

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

Пример дизайна: просторный холл с камином, стеклянная веранда с видом на сад, спальня в пастельных тонах.
[url=https://designapartment.ru]РґРёР·Р°Р№РЅРµСЂСЃРєРёР№ СЂРµРјРѕРЅС‚ РїРѕРґ РєР»СЋС‡[/url]
#3 Дизайнерский ремонт виллы

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

Пример дизайна: роскошная вилла с бассейном, открытая терраса с видами на море, спальная зона в тропическом стиле.

#4 Дизайнерский ремонт коттеджа

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

Пример дизайна: двухэтажный коттедж с мансардой, гостиная-столовая в скандинавском стиле, детская комната с игровой зоной.

#5 Дизайнерский ремонт пентхауса

Пентхаус — это элитное жилье, расположенное на верхних этажах зданий с панорамными видами. Для такого типа недвижимости характерны высокие потолки, большие окна и эксклюзивные элементы декора. Проектирование пентхауса требует учета особенностей конструкции здания и пожеланий клиентов относительно приватности и удобства.

Пример дизайна: современный пентхаус с открытой планировкой, кабинет с видом на город, зона отдыха с джакузи.

Заключение

Дизайнерский ремонт — это возможность создать идеальное пространство для жизни и отдыха. Независимо от того, хотите ли вы обновить квартиру, дом, виллу, коттедж или пентхаус, профессиональный подход гарантирует вам комфорт и эстетическое удовольствие на долгие годы.

https://designapartment.ru
РґРёР·Р°Р№РЅРµСЂСЃРєРёР№ СЂРµРјРѕРЅС‚ РєРѕРјРЅР°С‚РЅРѕР№ РєРІР°СЂС‚РёСЂС‹ РјРѕСЃРєРІР°

WayneTut

15 Oct 25 at 8:35 pm
pixelpush.click – Really enjoying the visual style, it gives a fresh and clean impression.

Guillermo Trenkle

15 Oct 25 at 8:35 pm
аренда студии для записи подкаста [url=https://studiya-podkastov-spb.ru]аренда студии для записи подкаста[/url] .

stydiya podkastov spb_vmka

15 Oct 25 at 8:36 pm
sitefoundry.click – Just browsed this site, it’s clean and the layout feels intuitive.

Antonia Paulshock

15 Oct 25 at 8:39 pm
sport bild wetten

Also visit my website … neue wettanbieter (Deanna)

Deanna

15 Oct 25 at 8:40 pm
discreet ED pills delivery in the US: discreet ED pills delivery in the US – tadalafil tablets without prescription

AndrewPal

15 Oct 25 at 8:41 pm
потолочкин натяжные [url=http://www.stretch-ceilings-nizhniy-novgorod.ru]http://www.stretch-ceilings-nizhniy-novgorod.ru[/url] .

natyajnie potolki nijnii novgorod_opPl

15 Oct 25 at 8:42 pm
May I simply say what a relief to discover somebody that truly understands what
they are discussing over the internet. You certainly know how to bring an issue
to light and make it important. More people must check
this out and understand this side of the story. I was surprised that you
are not more popular since you most certainly have the gift.

Lumetrix AI Erfahrungen

15 Oct 25 at 8:42 pm
https://drive.google.com/file/d/1cBPt7T5Za6XejF_HQ_uBGYwNbdaqtJIt/view?usp=sharing

Kennethhep

15 Oct 25 at 8:44 pm
кухни на заказ в спб от производителя [url=http://kuhni-spb-1.ru/]http://kuhni-spb-1.ru/[/url] .

kyhni spb_yimi

15 Oct 25 at 8:46 pm
Link kln

fgsifidld

15 Oct 25 at 8:47 pm
потолочник потолки [url=https://natyazhnye-potolki-nizhniy-novgorod-1.ru]https://natyazhnye-potolki-nizhniy-novgorod-1.ru[/url] .

natyajnie potolki nijnii novgorod_ynma

15 Oct 25 at 8:47 pm
It’s remarkable to go to see this website and reading the views of all friends concerning this paragraph, while I am also keen of getting familiarity.

slut

15 Oct 25 at 8:47 pm

Wanneer casino weer open South Holland

Winkans bij loterijen

Pokersites voor Enschedeers

Sjoerd Maessen blog

PHP hook, building hooks in your application

91,412 Responses to 'PHP hook, building hooks in your application'

Leave a Reply

Archive

Recent Comments

Tags

Meta