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!
I blog quite often and I seriously appreciate your content.
The article has truly peaked my interest. I will take a note of your blog and keep checking for new
information about once per week. I opted in for your RSS feed too.
If you are going for most excellent contents like me, only pay a quick visit
this web site all the time since it presents feature contents,
thanks
карниз с приводом для штор http://www.elektrokarnizy50.ru .
https://a-bsme.at/index.html
1win вход в личный кабинет 1win вход в личный кабинет
Wow this is a important web page.
https://www.polskapraca.info
Great post however I was wondering if you could write a litte more
on this topic? I’d be very grateful if you could elaborate a
little bit more. Thanks!
I pay a visit every day a few websites and information sites to read articles, but this website presents quality based articles.
It’s an awesome article designed for all the web viewers;
they will get advantage from it I am sure.
электрический карниз для штор купить https://elektrokarnizy50.ru .
pokies net 101 pokies net 101 .
регистрация 1вин https://www.1win1111.ru
https://2-bs2best.lat/blacksprut_zerkalo.html
pokies net 101 pokies net 101 .
I just couldn’t go away your site prior to suggesting that
I extremely enjoyed the usual information an individual supply to your visitors?
Is going to be again incessantly in order to inspect new posts
Hi there, i read your blog occasionally and i own a similar one and i was just curious if you get a lot of spam
feedback? If so how do you prevent it, any plugin or anything
you can advise? I get so much lately it’s driving me insane so
any help is very much appreciated.
1000 рублей за регистрацию вывод сразу без вложений в казино адмирал Получить 1000 рублей за регистрацию с моментальным выводом, не требующим каких-либо вложений, – это мечта любого новичка онлайн-казино. Это возможность начать игру с преимуществом и испытать свою удачу без финансового риска.
I love your blog.. very nice colors & theme. Did you create this website yourself or did you hire someone
to do it for you? Plz answer back as I’m looking to construct my
own blog and would like to find out where u got this from. thanks a lot
I like the valuable info you provide in your articles.
I’ll bookmark your weblog and check again here
frequently. I am quite sure I will learn plenty of new stuff
right here! Best of luck for the next!
Hi, i think that i saw you visited my site so i came to “return the favor”.I
am attempting to find things to enhance my site!I suppose its ok to use some of your
ideas!!
dragon link slots online real money http://dragonslotscasinos.mobi/ .
1win бонусы 1win1108.ru
AI generator free nsfw ai of the new generation: artificial intelligence turns text into stylish and realistic pictures and videos.
AI generator ai nsfw generator of the new generation: artificial intelligence turns text into stylish and realistic pictures and videos.
the pokies net 106 login the pokies net 106 login .
I simply couldn’t leave your website before suggesting that
I actually loved the usual info an individual provide in your visitors?
Is gonna be again continuously in order to investigate
cross-check new posts
pokiesnet http://pokies106.com .
비아그라는 발기부전 치료제로 널리 사용되고
있지만, 온라인 비아그라 구매를 통해 구매할 때에는 각별한 주의가 필요합니다.
https://1-bs2best.art/blaksprut_ssylka.html
AI generator nsfw ai free of the new generation: artificial intelligence turns text into stylish and realistic pictures and videos.
1win букмекерская скачать приложение https://1win1109.ru
1win app ios https://www.1win11002.com
мостбет мобильная версия http://mostbet11016.ru/
AI generator nsfw ai video of the new generation: artificial intelligence turns text into stylish and realistic pictures and videos.
Б17 психологи. professorkorotkov.ru 791 оценок
1win bonus code https://1win11003.com
AI generator nsfw ai image generator of the new generation: artificial intelligence turns text into stylish and realistic pictures and videos.
how to use 1win casino bonus http://1win11002.com/
AI generator nsfw ai free of the new generation: artificial intelligence turns text into stylish and realistic pictures and videos.
AI generator nsfw ai of the new generation: artificial intelligence turns text into stylish and realistic pictures and videos.
Hi, I do think this is an excellent blog. I stumbledupon it 😉 I will come back once again since
i have bookmarked it. Money and freedom is the best way to
change, may you be rich and continue to help others.
мостбет авиатор https://mostbet11019.ru
1win uganda https://www.1win11003.com
My programmer is trying to persuade me to move to .net from PHP.
I have always disliked the idea because of the expenses.
But he’s tryiong none the less. I’ve been using WordPress on a
number of websites for about a year and am concerned about switching
to another platform. I have heard good things about blogengine.net.
Is there a way I can transfer all my wordpress posts into it?
Any kind of help would be greatly appreciated!
Awesome article.
I every time emailed this blog post page to all my contacts, as
if like to read it next my friends will too.
оформление санкнижки за день
недорогая справка от врача
зеркало 1 win https://1win1110.ru/
освобождение от хлопот