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!
An outstanding share! I’ve just forwarded this onto a coworker who
has been doing a little research on this. And he in fact ordered
me lunch simply because I found it for him…
lol. So let me reword this…. Thank YOU for the meal!!
But yeah, thanx for spending the time to talk about this matter here on your web site.
займ под птс машины
24avtolombard-pts65.ru/ekb.html
деньги под птс екатеринбург
casino 1win [url=https://1win3002.com]casino 1win[/url]
кредит под залог кредитного авто
zaimpod-pts92.ru
деньги под залог птс срочно
You really make it seem so easy with your presentation but
I find this topic to be actually something which I think I would never understand.
It seems too complex and extremely broad for me. I’m looking forward for your next
post, I’ll try to get the hang of it!
This piece of writing is actually a nice one it assists new the web users, who are wishing in favor of blogging.
париматч скачать на андроид париматч скачать на андроид .
автоломбард в кемерово под залог
zaimpod-pts91.ru/kemerovo.html
кредит под залог автомобиля кемерово
parimatch скачать на андроид parimatch скачать на андроид .
Saya sudah lama mencari situs slot 4D terpercaya, dan akhirnya ketemu
OVJTOTO. Permainannya lengkap, transaksi cepat, dan customer service-nya
sangat membantu. Recommended!
Hi there, I discovered your website by way of Google while
searching for a related subject, your website got here up, it looks great.
I have bookmarked it in my google bookmarks.
Hi there, just became alert to your weblog via Google, and found that it is really informative.
I am gonna be careful for brussels. I’ll appreciate if you proceed this in future.
Numerous folks shall be benefited out of your writing.
Cheers!
I have learn several excellent stuff here. Definitely value bookmarking
for revisiting. I wonder how much attempt you set to create one
of these fantastic informative site.
мостбет вход мостбет вход
Приобрести диплом о высшем образовании. Приобретение официального диплома через надежную фирму дарит ряд преимуществ. Это решение позволяет сберечь как личное время, так и значительные финансовые средства. orikdok-v-gorode-penza-58.ru
Заказать диплом возможно через сайт компании. orikdok-1v-gorode-mahachkala-5.online
диплом купить в белгороде диплом купить в белгороде .
pari match download app [url=http://www.parimatch-app-download.com]http://www.parimatch-app-download.com[/url] .
диплом в калуге купить https://arus-diplom8.ru/ .
This is my first time visit at here and i am really
happy to read all at single place.
Приобрести диплом университета. Покупка документа о высшем образовании через надежную компанию дарит много достоинств для покупателя. Это решение дает возможность сберечь как дорогое время, так и существенные финансовые средства. orikdok-v-gorode-syktyvkar-11.online
Заказать диплом под заказ в Москве возможно используя сайт компании. orikdok-1v-gorode-smolensk-67.online
диплом купить ргсу диплом купить ргсу .
История дня inforigin.ru .
купить диплом фельдшера купить диплом фельдшера .
70918248
References:
tren steroid Results (https://www.ahrs.al/)
Приобрести диплом под заказ вы имеете возможность через сайт компании. [url=http://orikdok-2v-gorode-yaroslavl-76.ru/]orikdok-2v-gorode-yaroslavl-76.ru[/url]
skachat mostbet [url=http://mostbet11027.ru/]http://mostbet11027.ru/[/url]
Гороскоп inforigin.ru .
купить диплом в твери [url=www.arus-diplom7.ru]купить диплом в твери[/url] .
купить аттестат настоящий [url=arus-diplom8.ru]купить аттестат настоящий[/url] .
Wow, awesome weblog format! How long have you been running a blog for?
you make blogging glance easy. The whole glance of your site is
magnificent, as smartly as the content!
мостбет бк вход мостбет бк вход
Your mode of telling all in this article
is really nice, all can simply know it, Thanks a lot.
мостбет ставки на исход мостбет ставки на исход
нужен адвокат онлайн нужен юрист по телефону
Hi there, just became aware of your blog through Google,
and found that it is truly informative. I’m gonna watch out
for brussels. I will be grateful if you continue this in future.
Numerous people will be benefited from your writing.
Cheers!
мостбет личный кабинет http://mostbet11025.ru/
мост бет бетгеймс http://mostbet11023.ru
I visited various websites however the audio quality
for audio songs current at this web site is actually excellent.
типография печать типография заказать
типографии спб недорого типография официальный сайт
металлические значки москва металлические значки москва
Hi there, I enjoy reading through your article post.
I wanted to write a little comment to support you.
Лунные день сегодня http://www.topoland.ru .
Мы предлагаем оформление дипломов ВУЗов в Москве — с печатями, подписями, приложением и возможностью архивной записи (по запросу).
Документ максимально приближен к оригиналу и проходит визуальную проверку.
Мы даем гарантию, что в случае проверки документа, подозрений не возникнет.
– Конфиденциально
– Доставка 3–7 дней
– Любая специальность
Уже более 1740 клиентов воспользовались услугой — теперь ваша очередь.
Купить диплом Россия — ответим быстро, без лишних формальностей.
займ залог авто
zaimpod-pts92.ru/nsk.html
деньги под птс
Need swap convenience? Jupiter in-wallet quick swap tool saves time.
jupiter Dex USA
вопрос юристу онлайн задать вопрос юристу анонимно онлайн
Оформиление дипломов ВУЗов по всей России и СНГ — с печатями, подписями, приложением и возможностью архивной записи (по запросу).
Документ максимально приближен к оригиналу и проходит визуальную проверку.
Мы даем гарантию, что в случае проверки документа, подозрений не возникнет.
– Конфиденциально
– Доставка 3–7 дней
– Любая специальность
Уже более 2765 клиентов воспользовались услугой — теперь ваша очередь.
Купить диплом вуза — ответим быстро, без лишних формальностей.
Магнитные бури https://topoland.ru/ .