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

92,628 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=www.rudik-diplom15.ru/]купить сертификат специалиста[/url] .

Diplomi_wnPi

16 Oct 25 at 10:19 am
купить диплом химика [url=https://rudik-diplom3.ru]купить диплом химика[/url] .

Diplomi_wyei

16 Oct 25 at 10:20 am
купить диплом сантехника [url=www.rudik-diplom11.ru/]купить диплом сантехника[/url] .

Diplomi_edMi

16 Oct 25 at 10:20 am
newseason – Their variety is appealing, many options to choose from.

Ralph Julian

16 Oct 25 at 10:20 am
You really make it seem so easy along with your presentation but I in finding this matter to be actually something which I feel I would
by no means understand. It kind of feels too complex and very vast for me.
I’m having a look ahead to your subsequent publish, I’ll attempt to get the hang of it!

bokep

16 Oct 25 at 10:20 am
https://slovarikslov.ru/terem/xaus/

https://slovarikslov.ru/terem/xaus/

16 Oct 25 at 10:21 am
взять в аренду экскаватор погрузчик в москве [url=http://arenda-ekskavatora-pogruzchika-cena.ru/]взять в аренду экскаватор погрузчик в москве[/url] .

arenda ekskavatora pogryzchika cena_ypSr

16 Oct 25 at 10:23 am
https://t.me/Online_1_xbet/2722

CharlesCic

16 Oct 25 at 10:24 am
купить диплом университета с занесением в реестр [url=http://frei-diplom5.ru/]купить диплом университета с занесением в реестр[/url] .

Diplomi_wsPa

16 Oct 25 at 10:24 am
https://t.me/Online_1_xbet/2718

CharlesCic

16 Oct 25 at 10:24 am
Дизайнерский ремонт: искусство преображения пространства

Дизайн интерьера играет важную роль в создании комфортной и уютной атмосферы в доме. Сегодня мы поговорим о таком понятии, как дизайнерский ремонт, который позволяет превратить обычное жилье в уникальное пространство, отражающее индивидуальность владельца.
[url=https://designapartment.ru ]дизайнерский ремонт цена[/url]
Что такое дизайнерский ремонт?

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

Ключевые особенности дизайнерского ремонта:
[url=https://designapartment.ru ]дизайнерский ремонт пентхауса[/url]
– Индивидуальный подход к каждому проекту.
– Использование качественных материалов и современных технологий.
– Создание уникального стиля, соответствующего вкусам заказчика.
– Оптимизация пространства для максимального комфорта и функциональности.

Виды дизайнерских ремонтов
[url=https://designapartment.ru]дизайнерский ремонт квартиры москва[/url]
Существует несколько видов дизайнерских ремонтов, каждый из которых имеет свои особенности и преимущества.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Заключение

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

KennethReR

16 Oct 25 at 10:24 am
купить диплом в киселевске [url=http://rudik-diplom3.ru/]купить диплом в киселевске[/url] .

Diplomi_ohei

16 Oct 25 at 10:25 am
натяжные потолки город нижний новгород [url=http://stretch-ceilings-nizhniy-novgorod-1.ru/]http://stretch-ceilings-nizhniy-novgorod-1.ru/[/url] .

natyajnie potolki nijnii novgorod_deOn

16 Oct 25 at 10:26 am
натяжные потолки нижний новгород с установкой [url=http://natyazhnye-potolki-nizhniy-novgorod-1.ru]http://natyazhnye-potolki-nizhniy-novgorod-1.ru[/url] .

natyajnie potolki nijnii novgorod_mqma

16 Oct 25 at 10:26 am
как купить диплом техникума официального сайта [url=http://frei-diplom10.ru]как купить диплом техникума официального сайта[/url] .

Diplomi_uiEa

16 Oct 25 at 10:27 am
потолочкин [url=http://stretch-ceilings-nizhniy-novgorod.ru]http://stretch-ceilings-nizhniy-novgorod.ru[/url] .

natyajnie potolki nijnii novgorod_bpPl

16 Oct 25 at 10:29 am
купить диплом в улан-удэ [url=https://rudik-diplom8.ru]купить диплом в улан-удэ[/url] .

Diplomi_poMt

16 Oct 25 at 10:29 am
купить диплом техникума с занесением в реестр [url=https://www.frei-diplom6.ru]купить диплом техникума с занесением в реестр[/url] .

Diplomi_fdOl

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

Diplomi_epOl

16 Oct 25 at 10:32 am
купить диплом в димитровграде [url=http://rudik-diplom4.ru/]купить диплом в димитровграде[/url] .

Diplomi_trOr

16 Oct 25 at 10:33 am
вывод из запоя
vivod-iz-zapoya-irkutsk011.ru
вывод из запоя цена

zapojirkutskNeT

16 Oct 25 at 10:35 am
сайт натяжные потолки [url=https://natyazhnye-potolki-nizhniy-novgorod-1.ru/]сайт натяжные потолки[/url] .

natyajnie potolki nijnii novgorod_enma

16 Oct 25 at 10:36 am
купить бланк диплома [url=https://rudik-diplom1.ru]купить бланк диплома[/url] .

Diplomi_szer

16 Oct 25 at 10:38 am
baugenehmigung wettbüro

Review my webpage wettstrategien unentschieden (refundmycrypto.org)

refundmycrypto.org

16 Oct 25 at 10:38 am
Very energetic article, I liked that bit. Will there be a
part 2?

webpage

16 Oct 25 at 10:39 am
купить диплом агронома [url=https://rudik-diplom8.ru/]купить диплом агронома[/url] .

Diplomi_upMt

16 Oct 25 at 10:39 am
купить диплом с занесением в реестр отзывы [url=www.frei-diplom4.ru/]купить диплом с занесением в реестр отзывы[/url] .

Diplomi_lsOl

16 Oct 25 at 10:39 am
купить диплом в тобольске [url=http://www.rudik-diplom4.ru]http://www.rudik-diplom4.ru[/url] .

Diplomi_ldOr

16 Oct 25 at 10:40 am
купить диплом техникума в иркутске lr 63 [url=http://frei-diplom7.ru]купить диплом техникума в иркутске lr 63[/url] .

Diplomi_lcei

16 Oct 25 at 10:41 am
можно купить легальный диплом [url=http://frei-diplom6.ru]http://frei-diplom6.ru[/url] .

Diplomi_vtOl

16 Oct 25 at 10:41 am
аренда погрузчика экскаватора [url=http://arenda-ekskavatora-pogruzchika-cena.ru/]http://arenda-ekskavatora-pogruzchika-cena.ru/[/url] .

arenda ekskavatora pogryzchika cena_zuSr

16 Oct 25 at 10:42 am
диплом купить с проведением [url=www.frei-diplom5.ru/]диплом купить с проведением[/url] .

Diplomi_kxPa

16 Oct 25 at 10:43 am
натяжные потолки официальный сайт нижний новгород [url=natyazhnye-potolki-nizhniy-novgorod-1.ru]natyazhnye-potolki-nizhniy-novgorod-1.ru[/url] .

natyajnie potolki nijnii novgorod_qvma

16 Oct 25 at 10:43 am
купить диплом техникума с занесением в реестр [url=frei-diplom4.ru]купить диплом техникума с занесением в реестр[/url] .

Diplomi_kiOl

16 Oct 25 at 10:44 am
натяжные потолки в нижнем новгороде [url=https://www.stretch-ceilings-nizhniy-novgorod-1.ru]натяжные потолки в нижнем новгороде[/url] .

natyajnie potolki nijnii novgorod_xfOn

16 Oct 25 at 10:44 am
https://t.me/Online_1_xbet/3405

CharlesCic

16 Oct 25 at 10:44 am
купить свидетельство о браке [url=http://rudik-diplom8.ru/]купить свидетельство о браке[/url] .

Diplomi_owMt

16 Oct 25 at 10:45 am
купить диплом в россоши [url=http://rudik-diplom1.ru/]купить диплом в россоши[/url] .

Diplomi_bber

16 Oct 25 at 10:45 am
купить диплом техникума с реестром [url=http://www.frei-diplom10.ru]купить диплом техникума с реестром[/url] .

Diplomi_mqEa

16 Oct 25 at 10:45 am
https://t.me/Online_1_xbet/3202

CharlesCic

16 Oct 25 at 10:45 am
TG @вЂЊLINKS_DEALER | EFFECTIVE SEO LINKS FOR SPINBETTERBET.COM

Jamesrab

16 Oct 25 at 10:46 am
купить диплом в новошахтинске [url=http://www.rudik-diplom3.ru]http://www.rudik-diplom3.ru[/url] .

Diplomi_zwei

16 Oct 25 at 10:46 am
купить проведенный диплом спб [url=http://frei-diplom6.ru/]http://frei-diplom6.ru/[/url] .

Diplomi_vtOl

16 Oct 25 at 10:46 am
Эта информационная статья содержит полезные факты, советы и рекомендации, которые помогут вам быть в курсе последних тенденций и изменений в выбранной области. Материал составлен так, чтобы быть полезным и понятным каждому.
Раскрыть тему полностью – https://nexgentalk.com/mkvcinemas

RobertDam

16 Oct 25 at 10:47 am
wonderful post, very informative. I wonder why the other experts of this sector do not understand this.

You must proceed your writing. I am confident, you’ve a great readers’ base already!

slot mudah menang

16 Oct 25 at 10:48 am
Этот информационный материал собраны данные, которые помогут лучше понять текущие тенденции и процессы в различных сферах жизни. Мы предоставляем четкий анализ, графики и примеры, чтобы информация была не только понятной, но и практичной для принятия решений.
Осуществить глубокий анализ – https://gobranddesign.com/the-ultimate-guide-to-unblocked-games-where-to-play-and-why-theyre-so-popular

KeithIsolf

16 Oct 25 at 10:49 am
https://t.me/Online_1_xbet/2023

CharlesCic

16 Oct 25 at 10:50 am
https://t.me/Online_1_xbet/2497

CharlesCic

16 Oct 25 at 10:51 am
купить диплом в димитровграде [url=http://rudik-diplom4.ru/]купить диплом в димитровграде[/url] .

Diplomi_mrOr

16 Oct 25 at 10:51 am
купить диплом с занесением в реестр пенза [url=https://frei-diplom5.ru]купить диплом с занесением в реестр пенза[/url] .

Diplomi_pvPa

16 Oct 25 at 10:51 am

Wanneer casino weer open South Holland

Winkans bij loterijen

Pokersites voor Enschedeers

Sjoerd Maessen blog

PHP hook, building hooks in your application

92,628 Responses to 'PHP hook, building hooks in your application'

Leave a Reply

Archive

Recent Comments

Tags

Meta