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!
Оформиление дипломов ВУЗов по всей России и СНГ — с печатями, подписями, приложением и возможностью архивной записи (по запросу).
Документ максимально приближен к оригиналу и проходит визуальную проверку.
Мы даем гарантию, что в случае проверки документа, подозрений не возникнет.
– Конфиденциально
– Доставка 3–7 дней
– Любая специальность
Уже более 2780 клиентов воспользовались услугой — теперь ваша очередь.
Пишите — ответим быстро, без лишних формальностей.
What’s up, for all time i used to check website posts here in the early hours in the break of day, as i like to find out more and more.
tadalafil mylan 5 mg 14 compresse prezzo
Hey folks, I’m Marko from Serbia. I wanna tell you about my insane experience with
this new online casino I stumbled on last month.
To be honest, I was totally broke, and now I can’t believe it
myself — I crushed it and made £590,000 playing mostly
slots!
Now I’m thinking of finally owning an apartment here in Zagreb, and investing a serious chunk
of my winnings into Bitcoin.
Later I’ll probably move to a better neighborhood and retire early.
Now I’m going by Nikola from Serbia because I honestly feel like a new person. My life is flipping
upside down in the best way.
Let’s be honest, what would you guys do if you had this kinda luck?
Are you feeling curious right now?
For real, I never thought I’d be living this dream.
It’s all happening so fast!
Ask me anything!
Оформиление дипломов ВУЗов в Москве — с печатями, подписями, приложением и возможностью архивной записи (по запросу).
Документ максимально приближен к оригиналу и проходит визуальную проверку.
Мы даем гарантию, что в случае проверки документа, подозрений не возникнет.
– Конфиденциально
– Доставка 3–7 дней
– Любая специальность
Уже более 4048 клиентов воспользовались услугой — теперь ваша очередь.
[url=http://poligraf1.ru/]Купить диплом недорого[/url] — ответим быстро, без лишних формальностей.
Приобрести диплом о высшем образовании!
Мы готовы предложить дипломы любых профессий по приятным тарифам— 99diplomov.ru
аттестат за 9 класс купить [url=https://www.arus-diplom2.ru]аттестат за 9 класс купить[/url] .
Заказать диплом о высшем образовании!
Мы готовы предложить дипломы любой профессии по приятным ценам— diplomers.com
Искал ночью в Яндексе, кто может привезти алкоголь за час. Первым выпал http://alt1.toolbarqueries.google.co.vi/url?q=https://alcoclub25.ru/ . Сайт удобный, выбор хороший. Заказал бутылку рома — привезли за 47 минут. Алкоголь оригинальный, никаких сомнений. Цены честные. Теперь добавил в закладки, чтобы больше не искать.
What’s up colleagues, its great piece of writing
regarding educationand entirely defined, keep it up all the time.
Заказать диплом об образовании!
Мы изготавливаем дипломы психологов, юристов, экономистов и других профессий по доступным ценам— [url=http://medialike.org/]medialike.org[/url]
For newest information you have to go to see world wide web and on internet I found this web site as a best web site for most up-to-date updates.
tadalafil mylan 5 mg prezzo
What’s up everyone, it’s my first pay a visit at this site, and article is really fruitful in support of me,
keep up posting these types of posts.
скачать мосбет скачать мосбет
Muy claro todo, excelente. Te dejo mi blog: chusmeando.com https://www.chusmeando.com
You ought to be a part of a contest for one of the finest blogs on the net.
I’m going to recommend this site!
вход в мостбет https://www.mostbet11011.ru
мостбет оригинал скачать мостбет оригинал скачать
мостбеи https://www.mostbet11009.ru
Заказать диплом университета по невысокой стоимости возможно, обратившись к надежной специализированной компании. Мы оказываем услуги по продаже документов об окончании любых университетов России. Приобрести диплом о высшем образовании– kids-news.ru/diplomyi-dlya-teh-kto-tsenit-vremya
Useful info. Lucky me I discovered your web site unintentionally, and I’m shocked why this accident didn’t happened earlier!
I bookmarked it.
зайти в мостбет http://www.mostbet11009.ru
мостбет ком https://www.mostbet11012.ru
Hello there! Would you mind if I share your blog with
my zynga group? There’s a lot of folks that I think would really appreciate
your content. Please let me know. Thank you
Very great post. I simply stumbled upon your blog and wished to mention that I’ve really enjoyed surfing around your weblog
posts. After all I will be subscribing for your feed and I hope you write once more soon!
mostbet.com skachat [url=www.mostbet11006.ru]mostbet.com skachat[/url]
mostbetapk [url=http://mostbet11005.ru]http://mostbet11005.ru[/url]
Психотерапевт Оренбург. Психотерапевт Белгород. 674 оценок
Thanks for finally writing about > PHP hook, building hooks in your application – Sjoerd Maessen blog < Liked it!
It’s the best time to make some plans for the long run and it is time to be happy.
I’ve learn this submit and if I may just I wish to recommend you few attention-grabbing issues
or advice. Maybe you can write next articles relating to this article.
I want to read even more things about it!
At this time it seems like WordPress is the preferred blogging platform available right now.
(from what I’ve read) Is that what you are using on your
blog?
Приобрести диплом университета по невысокой цене возможно, обратившись к проверенной специализированной фирме. Мы оказываем услуги по продаже документов об окончании любых ВУЗов РФ. Купить диплом о высшем образовании– gae.flybb.ru/viewtopic.php?f=2&t=598
Hey! I could have sworn I’ve been to this blog before but after checking through some of the post I
realized it’s new to me. Anyhow, I’m definitely happy I found it and I’ll be bookmarking and checking back frequently!
мостбет ставки на спорт скачать http://mostbet11008.ru/
Сукааа казино официальный сайт Sykaaa Casino – это надежное и проверенное онлайн-казино с широким выбором игр, щедрыми бонусами и высоким уровнем безопасности. Sykaaa Casino Официальный Сайт Рабочее
mostbet официальный сайт [url=https://mostbet11012.ru/]https://mostbet11012.ru/[/url]
I’m amazed, I must say. Seldom do I encounter a blog that’s both
equally educative and amusing, and let me tell you, you’ve hit the nail on the head.
The problem is something that too few folks are speaking intelligently about.
Now i’m very happy I stumbled across this during my search for something concerning this.
Психотерапевт Киров. Кпт курган. 432 оценок
I simply couldn’t go away your site prior to suggesting that I extremely enjoyed the standard
info an individual provide in your visitors? Is going to be back
frequently to check out new posts
mostbet skacat mostbet skacat
mostbet skachat mostbet skachat
скачать мостбет на андроид бесплатно старая версия https://mostbet11009.ru
Useful information. Lucky me I found your web site accidentally,
and I am shocked why this coincidence didn’t happened earlier!
I bookmarked it.
Мы можем предложить дипломы психологов, юристов, экономистов и любых других профессий по приятным ценам. Купить диплом в Новомосковске — kyc-diplom.com/geography/novomoskovsk.html
Greetings! Very helpful advice in this particular article!
It is the little changes that will make the biggest changes.
Many thanks for sharing!
I’m gone to tell my little brother, that he should also go
to see this weblog on regular basis to obtain updated from
latest reports.
www. mostbet. com https://www.mostbet11005.ru
Наши специалисты предлагают выгодно и быстро приобрести диплом, который выполнен на бланке ГОЗНАКа и заверен печатями, штампами, подписями. Наш документ пройдет лубую проверку, даже с использованием специальных приборов. gofleeks.com/read-blog/5149_kak-kupit-attestat.html
Have you ever considered publishing an ebook or guest authoring on other blogs?
I have a blog centered on the same subjects you discuss and would love to have you share some stories/information. I know my
visitors would enjoy your work. If you are even remotely
interested, feel free to shoot me an email.
My web-site click resources
Need best DEX aggregator? Jupiter leads Solana with composite liquidity.
jupiter Solana USA
Наша компания предлагает выгодно заказать диплом, который выполнен на оригинальном бланке и заверен мокрыми печатями, водяными знаками, подписями. Данный диплом способен пройти лубую проверку, даже с применением профессионального оборудования. vagyonor.hu/employer/diplomirovans