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

43,667 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://narkologicheskaya-klinika-balashiha5.ru/]наркологическая клиника клиника помощь[/url]

Jamesdug

12 Sep 25 at 7:37 am
Amazing! This blog looks just like my old one! It’s on a entirely different subject but
it has pretty much the same page layout and design. Great choice of colors!

Here is my web site holistic healing retreats in mexico

holistic healing retreats in mexico

12 Sep 25 at 7:38 am
https://www.5280.com/32-no-fail-home-decor-gift-ideas/

LeonardMed

12 Sep 25 at 7:38 am
Публикация приглашает вас исследовать неизведанное — от древних тайн до современных достижений науки. Вы узнаете, как случайные находки превращались в революции, а смелые мысли — в новые эры человеческого прогресса.
Смотри, что ещё есть – https://www.alfo.co.jp/topics-news/20170630

WilliamPoera

12 Sep 25 at 7:40 am
1win как использовать бонусы [url=www.1win12005.ru]1win как использовать бонусы[/url]

1win_rvol

12 Sep 25 at 7:40 am
купить диплом младшего специалиста в украине [url=http://educ-ua18.ru/]купить диплом младшего специалиста в украине[/url] .

Diplomi_zuPi

12 Sep 25 at 7:42 am
Мы предлагаем вам подробное руководство, основанное на проверенных источниках и реальных примерах. Каждая часть публикации направлена на то, чтобы помочь вам разобраться в сложных вопросах и применить знания на практике.
Обратиться к источнику – https://jacobengineers.in/different-types-of-flat-slab-construction

ArthurteX

12 Sep 25 at 7:44 am
В этой статье собраны факты, которые освещают целый ряд важных вопросов. Мы стремимся предложить читателям четкую, достоверную информацию, которая поможет сформировать собственное мнение и лучше понять сложные аспекты рассматриваемой темы.
Изучить материалы по теме – https://savaherbals.in/liver-detox

CaseyWoope

12 Sep 25 at 7:44 am
game aviator [url=aviator-igra-3.ru]game aviator[/url] .

aviator igra_qmmi

12 Sep 25 at 7:45 am
РџСЂРѕСЃСЊР±Р° РїРѕРґРєРѕСЂСЂРµРєС‚РёСЂРѕРІР°С‚СЊ СЃР°РјРёРј Р±СЂРµРґРѕРІС‹Рµ СЃРѕРѕР±С‰РµРЅРёСЏ.
https://mekaroj.ru
РўРѕРІР°СЂ РЅРѕСЂРјР°Р»СЊРЅС‹Р№. Р’ СЌС‚РѕС‚ РїРѕРЅРµРґРµР»СЊРЅРёРє РѕРїР»Р°С‚РёР» РµС‰С‘, Р¶РґСѓ)

RobertBlide

12 Sep 25 at 7:49 am
как зайти на сайт mostbet [url=mostbet12003.ru]mostbet12003.ru[/url]

mostbet_zdet

12 Sep 25 at 7:49 am
nexus official link onion dark website dark markets [url=https://darkmarketsgate.com/ ]nexus url [/url]

Jamespem

12 Sep 25 at 7:51 am
mostbet приложение [url=mostbet12007.ru]mostbet12007.ru[/url]

mostbet_pppt

12 Sep 25 at 7:53 am
Этот текст сочетает в себе элементы познавательного рассказа и аналитической подачи информации. Читатель получает доступ к уникальным данным, которые соединяют прошлое с настоящим и открывают двери в будущее.
Нажмите, чтобы узнать больше – https://www.jiabangcnc.cn/new727

TerryHig

12 Sep 25 at 7:57 am
перепланировка услуги [url=http://www.soglasovanie-pereplanirovki-kvartiry17.ru]http://www.soglasovanie-pereplanirovki-kvartiry17.ru[/url] .

soglasovanie pereplanirovki kvartiri _ftol

12 Sep 25 at 7:57 am
диплом с занесением в реестр купить [url=www.arus-diplom31.ru/]диплом с занесением в реестр купить[/url] .

Zakazat diplom ob obrazovanii!_tpOl

12 Sep 25 at 7:57 am
Узнайте всё об автопортале АвтоГрузГрупп — информативные статьи, лайфхаки и свежие материалы! Зайдите на [url=https://avtogruzgroup.ru]https://avtogruzgroup.ru[/url] и изучите статьи по автозвуку. Ищешь объективная оценка — этот портал дает материалы, технические данные и обратную связь. Подыскиваешь устройство — здесь найдёшь качественную технику и точные оценки.

Spravkijru

12 Sep 25 at 7:58 am
Quality articles is the crucial to interest the viewers to pay a quick visit the
website, that’s what this web page is providing.

turkey visa for australian

12 Sep 25 at 7:59 am
купить диплом высшее сколько [url=www.educ-ua18.ru]купить диплом высшее сколько[/url] .

Diplomi_xpPi

12 Sep 25 at 8:03 am
Этот информативный текст выделяется своими захватывающими аспектами, которые делают сложные темы доступными и понятными. Мы стремимся предложить читателям глубину знаний вместе с разнообразием интересных фактов. Откройте новые горизонты и развивайте свои способности познавать мир!
Погрузиться в детали – https://surval.mx/boutique_04?unapproved=257834

Larryhic

12 Sep 25 at 8:06 am
как играть на бонусы казино в 1win [url=http://1win12005.ru/]http://1win12005.ru/[/url]

1win_dbol

12 Sep 25 at 8:07 am
В этом обзорном материале представлены увлекательные детали, которые находят отражение в различных аспектах жизни. Мы исследуем непонятные и интересные моменты, позволяя читателю увидеть картину целиком. Погрузитесь в мир знаний и удивительных открытий!
Нажми и узнай всё – https://www.hefame.es/el-reto-ahora-es-integrar-el-potencial-tecnologico-y-logistico-de-las-farmacias-en-el-sistema-nacional-de-salud

BryantKer

12 Sep 25 at 8:07 am
где найти игру авиатор на деньги [url=http://aviator-igra-3.ru]http://aviator-igra-3.ru[/url] .

aviator igra_xlmi

12 Sep 25 at 8:08 am
10 Topp Internet Marketing Webb A Pair Of.0 Forums And Blog Resources blog
(https://ezmarkbookmarks.com/story20278789/â-Žmajor-iphone-on-line-on-line-casino-movie-game-titles-within-the-applicationÂ-retailer)

https://ezmarkbookmarks.com/story20278789/â-Žmajor-iphone-on-line-on-line-casino-movie-game-titles-within-the-applicationÂ-retailer

12 Sep 25 at 8:10 am
1win как отыграть бонус [url=1win12008.ru]1win12008.ru[/url]

1win_cnsn

12 Sep 25 at 8:10 am
You could definitely see your skills within the article you write.

The sector hopes for even more passionate writers like you who are not afraid to say how they believe.

At all times go after your heart.

artikel menarik

12 Sep 25 at 8:12 am
играть в авиатор на деньги [url=https://aviator-igra-3.ru]играть в авиатор на деньги[/url] .

aviator igra_vnmi

12 Sep 25 at 8:12 am
Эта статья для ознакомления предлагает читателям общее представление об актуальной теме. Мы стремимся представить ключевые факты и идеи, которые помогут читателям получить представление о предмете и решить, стоит ли углубляться в изучение.
Смотри, что ещё есть – https://katebschool.edu.af/teachers

KennethAtord

12 Sep 25 at 8:12 am
Р’ РѕР±С‰РµРј РїРѕРґРѕР¶РґСѓ РїРѕРєР° С‚С‹ РїРѕР»СѓС‡РёС€СЊ Рё РѕС‚РїРёС€РµС€СЊ :))))
РњР°РіР°Р·РёРЅ С‚СѓС‚! kokain mefedron gash alfa-pvp amf
РЎРєРёРЅСЊС‚Рµ СЃР°Р№С‚ РІР°С€ РїРѕР¶Р°Р»СѓР№СЃС‚Р°.

RobertBlide

12 Sep 25 at 8:13 am
Эта статья для ознакомления предлагает читателям общее представление об актуальной теме. Мы стремимся представить ключевые факты и идеи, которые помогут читателям получить представление о предмете и решить, стоит ли углубляться в изучение.
Ознакомьтесь с аналитикой – https://ucicissaquah.org/events/teacher-appreciation-week

Alfredduh

12 Sep 25 at 8:15 am
If some one needs expert view about blogging then i suggest him/her to pay a visit this weblog,
Keep up the fastidious work.

crypto asset recovery

12 Sep 25 at 8:15 am
Zeemo AI, %72.0 oranında düşüşle 2.98M ziyarete geriledi.

zeemo ai

12 Sep 25 at 8:19 am
Post writing is also a fun, if you know then you can write otherwise it is difficult to
write.

Here is my page: slot gacor

slot gacor

12 Sep 25 at 8:20 am
Thanks for finally writing about > PHP hook, building hooks in your application – Sjoerd Maessen blog at Sjoerd Maessen blog < Loved it!

inspirasi

12 Sep 25 at 8:21 am
aviator игра [url=aviator-igra-3.ru]aviator игра[/url] .

aviator igra_ifmi

12 Sep 25 at 8:21 am
Hey there! I’ve been reading your website for some
time now and finally got the courage to go ahead and give you a shout out from
Atascocita Tx! Just wanted to tell you keep up the fantastic
work!

my blog ACL tear treatment Florida

ACL tear treatment Florida

12 Sep 25 at 8:22 am
Эта информационная заметка содержит увлекательные сведения, которые могут вас удивить! Мы собрали интересные факты, которые сделают вашу жизнь ярче и полнее. Узнайте нечто новое о привычных аспектах повседневности и откройте для себя удивительный мир информации.
Смотри, что ещё есть – https://altin.co.in/2018/09/13/ganpati-bappa-morya

ElliotTot

12 Sep 25 at 8:22 am
Казино Cat

Robertcok

12 Sep 25 at 8:23 am
где купить диплом среднем [url=educ-ua18.ru]где купить диплом среднем[/url] .

Diplomi_zgPi

12 Sep 25 at 8:23 am
Хотите быстро и безопасно обменять криптовалюту на наличные в Нижнем Новгороде? NNOV.DIGITAL фиксирует курс, работает по AML и проводит большинство сделок за 5 минут. Пять офисов по городу, выдача наличными или по СБП. Узнайте детали и оставьте заявку на https://nnov.digital/ — менеджер свяжется, зафиксирует курс и проведёт сделку. Premium-условия для крупных сумм от $70 000. Надёжно, прозрачно, удобно. NNOV.DIGITAL — ваш офлайн обмен с “чистой” криптой.

Xujeltfum

12 Sep 25 at 8:23 am
Geo-gdz.ru – ваш бесплатный портал в мир знаний! Ищете школьные учебники, атласы или контурные карты? У нас все это отыщите! Мы полезную и актуальную информацию предлагаем, решебники включая (к примеру, для 7 класса по геометрии Атанасяна). Ищете 10 класс география? Geo-gdz.ru – ваш в учебе помощник. На сайте представлены контурные карты для печати. Все картинки отменного качества. Представляем вашему вниманию пособия по русскому языку для 1-4 классов. Учебники по истории онлайн можете читать. Посетите сайт geo-gdz.ru. С удовольствием учитесь!

vunugHor

12 Sep 25 at 8:25 am
мостбет официальный сайт вход [url=http://mostbet12003.ru/]http://mostbet12003.ru/[/url]

mostbet_guet

12 Sep 25 at 8:25 am
aviator игра сайт [url=http://aviator-igra-3.ru/]aviator игра сайт[/url] .

aviator igra_gomi

12 Sep 25 at 8:28 am
What a data of un-ambiguity and preserveness of precious familiarity regarding unpredicted emotions.

color protocol

12 Sep 25 at 8:29 am
купить дипломы о высшем образовании срочно [url=https://www.educ-ua18.ru]купить дипломы о высшем образовании срочно[/url] .

Diplomi_gqPi

12 Sep 25 at 8:30 am
самолет игра на деньги [url=https://aviator-igra-3.ru/]самолет игра на деньги[/url] .

aviator igra_zsmi

12 Sep 25 at 8:31 am
Эта информационная заметка содержит увлекательные сведения, которые могут вас удивить! Мы собрали интересные факты, которые сделают вашу жизнь ярче и полнее. Узнайте нечто новое о привычных аспектах повседневности и откройте для себя удивительный мир информации.
Только для своих – https://parsacode.com/%D8%B3%D8%A6%D9%88-%DA%A9%D9%84%D8%A7%D9%87-%D8%B3%DB%8C%D8%A7%D9%87-%D8%B3%D9%81%DB%8C%D8%AF-%D8%AA%D9%81%D8%A7%D9%88%D8%AA-%D8%A2%D9%86%D9%87%D8%A7

TerryHig

12 Sep 25 at 8:31 am
dark web market urls dark web market urls darknet markets onion [url=https://darkmarketlegion.com/ ]nexus darknet url [/url]

Robertalima

12 Sep 25 at 8:31 am
играть в авиатор на деньги [url=www.aviator-igra-3.ru/]играть в авиатор на деньги[/url] .

aviator igra_rnmi

12 Sep 25 at 8:35 am
This design is spectacular! You certainly know how to keep
a reader amused. Between your wit and your videos, I was almost moved to start my own blog (well, almost…HaHa!) Fantastic job.
I really enjoyed what you had to say, and more than that, how
you presented it. Too cool!

My website sports injury treatment in Florida

sports injury treatment in Florida

12 Sep 25 at 8:36 am

Winkans bij loterijen

Pokersites voor Enschedeers

Sjoerd Maessen blog

PHP hook, building hooks in your application

43,667 Responses to 'PHP hook, building hooks in your application'

Leave a Reply

Archive

Recent Comments

Tags

Meta