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!
A fascinating discussion is worth comment. I believe that you ought to write more on this
topic, it may not be a taboo subject but usually people don’t discuss such issues.
To the next! Cheers!!
1win jetx https://www.1win3002.com
Hi, I think your website could be having internet browser compatibility problems.
When I take a look at your blog in Safari, it looks fine however when opening
in IE, it has some overlapping issues. I merely wanted to provide you with a
quick heads up! Other than that, great website!
автоломбард авто
zaimpod-pts91.ru/nsk.html
займ под залог авто в новосибирске
Just wish to say your article is as astounding. The clarity in your post is simply spectacular and i could assume you
are an expert on this subject. Fine with your permission allow me to grab your
feed to keep up to date with forthcoming post. Thanks a million and please continue the enjoyable work.
номер наркологии наркологическая клиника телефон
Hello there! I could have sworn I’ve been to this site before
but after checking through some of the post I realized it’s new to me.
Anyways, I’m definitely glad I found it and I’ll be
bookmarking and checking back often!
пансионат для пожилых недорого https://pansionat-dlya-pozhilyh1.ru
Hey There. I found your blog the usage of msn.
This is a very neatly written article. I will be
sure to bookmark it and return to read extra of your helpful info.
Thanks for the post. I’ll certainly return.
Wassup guys, I’m Alex from Romania. I wanna tell you about my
insane experience with this trending online casino I stumbled on this spring.
To be honest, I was barely affording rent, and now I can’t believe it myself — I won $1,500,000
playing mostly live roulette!
Now I’m thinking of getting a new car here
in Warsaw, and investing a serious chunk of my winnings into Bitcoin.
Later I’ll probably move to a better neighborhood and start a small business.
Now I’m going by Luka from Croatia 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 thinking “damn!” right now?
For real, I never thought I’d be able to help my family.
It’s all happening so fast!
Let’s talk crypto too!
It’s really a cool and helpful piece of info.
I’m satisfied tat you shared this helpful info with us. Please keep us informed like this.
Thank you for sharing.
кредит под залог авто документы
zaimpod-pts90.ru/nsk.html
кредит по залог авто
наркология запои https://narkologiya-nn.ru
mostbet official https://www.mostbet11014.ru
купить в чите диплом http://www.arus-diplom4.ru .
Thanks for sharing such a fastidious thinking, article is fastidious,
thats why i have read it completely
пансионат для пожилых цена пансионат для пожилых людей
These are actually fantastic ideas in about blogging. You have touched some
pleasant factors here. Any way keep up wrinting.
купить диплом об окончании училища купить диплом об окончании училища .
Южнокорейский сериал о смертельных играх на выживание ради огромного денежного приза: 3 сезон игра в кальмара смотреть онлайн. Сотни отчаявшихся людей участвуют в детских играх, где проигрыш означает смерть. Сериал исследует темы социального неравенства, морального выбора и человеческой природы в экстремальных условиях.
Loved the deep dive into Purple Peel Exploit!
The science around anthocyanins from mangosteen peel activating metabolism, supporting mitochondrial function, and suppressing appetite is fascinating.
https://bestforum.forum-top.ru/viewtopic.php?id=2819#p5397
диплом купить фельдшера [url=http://www.arus-diplom4.ru]диплом купить фельдшера[/url] .
1win официальный сайт мобильная http://1win11003.ru
наркология запои https://narkologiya-nn.ru
наркологическая клиника сайт номер наркологии
автоломбард займ птс
zaimpod-pts92.ru/ekb.html
взять займ под залог авто
Does your site have a contact page? I’m having trouble locating it but, I’d like to send you an e-mail.
I’ve got some creative ideas for your blog you might be interested in hearing.
Either way, great site and I look forward to seeing it improve over time.
дом пансионат для пожилых пансионат для пожилых цена
частный пансионат для пожилых людей пансионат для пожилых и инвалидов
Thanks in support of sharing such a nice thought, post is pleasant, thats why i
have read it entirely
1win букмекерская приложение 1win букмекерская приложение
мостбкт [url=www.mostbet11001.ru]www.mostbet11001.ru[/url]
мостбет букмекерская https://mostbet11001.ru/
http://wmking.ru/t82761.html
Thanks very nice blog!
mostbet скачат mostbet скачат
мостбеи http://mostbet11001.ru
мостбет вход официальный сайт https://mostbet11015.ru
When someone writes an post he/she maintains the image of
a user in his/her brain that how a user can be aware of
it. Therefore that’s why this piece of writing is outstdanding.
Thanks!
mostbet indir mostbet indir .
мостбет скачать андроид мостбет скачать андроид .
новости дня http://dorogi34.ru .
Wow, this post is fastidious, my younger sister is analyzing
these things, so I am going to inform her.
мост бет бетгеймс https://mostbet11001.ru/
Link exchange is nothing else except it is simply placing the other person’s website link
on your page at suitable place and other person will also do similar for you.
Гороскоп http://www.dorogi34.ru .
mostbet online app [url=http://mostbet-download-app-apk.com]mostbet online app[/url] .
Гороскоп [url=https://www.dorogi34.ru]https://www.dorogi34.ru[/url] .
Ahaa, its nice conversation on the topic of this post at
this place at this web site, I have read all that,
so at this time me also commenting here.