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!
Гороскоп http://tti-sfedu.ru/ .
строительное водопонижение [url=https://eisberg.forum24.ru/?1-5-0-00002952-000-0-0-1750669244/]строительное водопонижение[/url] .
диплом медицинский купить arus-diplom3.ru .
Лунный календарь https://www.tti-sfedu.ru .
Лунные день сегодня https://allizmalkovo.ru/ .
мостбет вход официальный сайт мостбет вход официальный сайт
Мы готовы предложить документы университетов, расположенных на территории всей России. Приобрести диплом любого ВУЗа:
credit.rx22.ru/viewtopic.php?f=2&t=2065
Запреты дня https://allizmalkovo.ru .
Магнитные бури [url=https://www.tti-sfedu.ru]https://www.tti-sfedu.ru[/url] .
новости дня http://www.congress-st.ru .
купить диплом кандидата наук https://arus-diplom3.ru/ .
мелбет кыргызстан [url=http://mostbet11010.ru/]мелбет кыргызстан[/url]
автоломбард казань
zaimpod-pts90.ru/kazan.html
кредит под птс казань
Гороскоп https://congress-st.ru .
История дня [url=allizmalkovo.ru]allizmalkovo.ru[/url] .
Мы готовы предложить документы учебных заведений, которые расположены в любом регионе РФ. Купить диплом университета:
saigonwood.vn/kachestvennye-diplomy-dlja-vashego-uspeha-209
Howdy! This post couldn’t be written much better! Reading through this article
reminds me of my previous roommate! He constantly kept talking about this.
I’ll forward this post to him. Fairly certain he will have a great read.
I appreciate you for sharing!
best cargo company in uae China to UAE Shipping: Managing Reverse Logistics Effectively
https://dettka.com/piony-s-dostavkoj-po-moskve-krasota-i-udobstvo-v-vashem-dome/ Заказать пионы в Москве: Легкость выбора, безупречное качество, оперативная доставка. Наш онлайн-сервис предоставляет удобный и быстрый способ заказать пионы в Москве, не выходя из дома. Выберите идеальный букет, оформите заказ, и мы позаботимся о том, чтобы свежие и ароматные пионы были доставлены вовремя и в безупречном состоянии. Мы гарантируем высокое качество цветов и профессиональный сервис, чтобы ваш подарок стал незабываемым сюрпризом.
Магнитные бури [url=congress-st.ru]congress-st.ru[/url] .
купить аттестат 9 классов [url=http://www.arus-diplom3.ru]http://www.arus-diplom3.ru[/url] .
Мы предлагаем документы институтов, которые расположены в любом регионе Российской Федерации. Купить диплом университета:
[url=http://dominion.listbb.ru/viewtopic.php?f=11&t=1631/]dominion.listbb.ru/viewtopic.php?f=11&t=1631[/url]
I loved as much as you will receive carried out right here.
The sketch is tasteful, your authored material stylish. nonetheless,
you command get got an nervousness over that you wish be delivering the following.
unwell unquestionably come more formerly again since exactly the same nearly a lot often inside case you shield
this hike.
автоломбард под птс в казани
zaimpod-pts91.ru/kazan.html
автоломбард под залог птс
No matter if some one searches for his required thing,
thus he/she wishes to be available that in detail, therefore that thing is maintained over here.
I needed to thank you for this very good read!! I absolutely loved every little bit of it.
I have you book-marked to check out new stuff you post…
букет пионов с доставкой в москве Пионы Москва: Симфония красок и ароматов в сердце столицы. Пионы – это не просто цветы, это настоящая магия, способная преобразить любой интерьер и подарить хорошее настроение. Москва, как мегаполис, требующий элегантности и изыска, нуждается в такой красоте. Наши пионы выращены с особой заботой, чтобы каждый бутон был наполнен жизненной силой и энергией. Мы предлагаем широкий выбор сортов и оттенков, чтобы удовлетворить самые взыскательные вкусы. Создайте неповторимую атмосферу уюта и роскоши в своем доме или офисе с помощью этих великолепных цветов. Пионы – это идеальный способ выразить свои чувства и подарить незабываемые эмоции.
What’s up, always i used to check weblog posts here in the early hours in the break of day, because
i love to gain knowledge of more and more.
I’m now not sure the place you are getting your information,
but good topic. I must spend a while finding out more or working
out more. Thanks for excellent info I used to be searching
for this information for my mission. https://vovan-gameecho.website/
скачать игры с облака mail Скачать игры с Яндекс Диска: Удобство и надежность в одном месте. Яндекс Диск – это не только удобное облачное хранилище, но и отличный способ скачивать игры. Получите доступ к огромной коллекции игр, загруженных на Яндекс Диск, и наслаждайтесь быстрой и безопасной загрузкой. Просто скачайте нужный файл и начинайте играть. Этот метод гарантирует надежность и безопасность, так как все файлы проходят проверку на вирусы.
Мы предлагаем дипломы любой профессии по выгодным тарифам. Отличительные черты типографии и ГОЗНАКа — [url=http://kyc-diplom.com/podlinnost-diploma.html/]kyc-diplom.com/podlinnost-diploma.html[/url]
ван вин фрибет https://www.1win11001.ru
Лунный календарь https://actprom.ru/ .
Календарь стрижек 85goelro.ru .
Лунный календарь https://www.actprom.ru .
Магнитные бури 85goelro.ru .
Магнитные бури [url=https://actprom.ru/]https://actprom.ru/[/url] .
Народные приметы [url=https://85goelro.ru/]https://85goelro.ru/[/url] .
If you are going for best contents like me, only pay a quick visit this
site every day for the reason that it provides feature
contents, thanks
1win букмекерская на андроид [url=http://1win11003.ru/]http://1win11003.ru/[/url]
Undeniably believe that which you stated. Your favorite justification appeared to be on the net the simplest
thing to be aware of. I say to you, I definitely get annoyed while people think
about worries that they plainly don’t know about.
You managed to hit the nail upon the top as
well as defined out the whole thing without having side effect , people
could take a signal. Will likely be back to get more.
Thanks
кредит под залог автомобиля
zaimpod-pts90.ru/kemerovo.html
займ под птс
china to uae shipping Shipping China to UAE: Navigating the Intricacies of Incoterms
Гороскоп https://tti-sfedu.ru .
Календарь огородника http://www.allizmalkovo.ru .
скачать игры с яндекс диска Скачать игры с облака Mail: Играйте где угодно, когда угодно. Облако Mail – это ваша мобильная библиотека игр, всегда под рукой. Загружайте, скачивайте и запускайте игры на любом устройстве, имеющем доступ к интернету. Насладитесь свободой и гибкостью, выбирая из постоянно пополняющегося каталога.
новости дня tti-sfedu.ru .
Магнитные бури allizmalkovo.ru .
It’s very effortless to find out any matter on web as compared to books, as I found
this post at this web page.
Календарь стрижек [url=https://tti-sfedu.ru]https://tti-sfedu.ru[/url] .