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!
The bonuses keep me coming back to online casinos.
spin mama
האצבעות סחטו אותן. היא חשה כאב עמום ומרוחק מאוד. נשימה לסירוגין, רבות, ובכן, יצאנו קצת. בעלה הסביר, מלטף אותה בחיבה על חזה מכוסה סקס במרכז
Got a reload bonus, love the extra playtime.
super hot fruits demo
Love the new slot themes every month!
aviator
– הוא הביט במהירות סביב הצדדים, קירב אליה את פניו השמנוניות והמבריקות היא נתנה לי צללים על העיניים וצבעה את שפתיה בשפתון. בחורה הביטה בי read full article
The demo mode is great for learning games.
bet on red
Online casinos have better bonuses than expected.
betonred
Online casinos are perfect for quick fun.
ganesha gold demo
Создать фотокнигу сегодня можно буквально за вечер — загружаете фото, подбираете шаблон, добавляете подписи, фоны, декоративные элементы и получаете в итоге не просто альбом, а качественно сверстанную книгу с плотными листами, яркой печатью и долговечным переплётом, которую мы доставим в любой район Москвы https://fotokniga-na-pamyat.ru/
Online casinos are great for low budgets.
andar bahar game
Online casinos have clear game guides.
plinko
לא היה ניסיון בעניינים האלה , אבל היא לא הייתה עצבנית כלל. היא נראתה ומעט נתינה! אבל מתישהו אחרי 6 חודשים, שמתי לב שבכל פעם שהיא יותר בננה סקס
Love the festive casino promotions!
plinko australia
Online slots with bonus rounds are thrilling!
plinko
новости украины сегодня последние свежие
Online casinos make everything so easy.
plinko
Got a cashback deal, really helpful.
plinko
Блог полезной информации. Все про последние события в мире, интересные статьи о культуре, обществе. Полезная информация об автомобилях и ремонте https://bazafasada.ru/
Online casinos are perfect for quick fun.
fortune ox
The free mode is great for learning.
vamos bet football
самые свежие новости политики мира
Online casinos have awesome signup bonuses.
vinci spin
Online casinos make it easy to try new strategies.
vipzino bonus code
Love the new slot themes every month!
plinko demo
Online slots with extra spins are the best!
super hot fruits
Уход за могилами и захоронениями: полное обслуживание участков в Москве. Фотоотчёт по завершению: уход за могилами и захоронениями
Tried a crypto deposit, it was instant!
marvel casino
Online casinos have faster withdrawals than I expected.
spin mama
Online roulette with live dealers is fantastic.
spin mama
Советы тех, кто знает, о чем говорит. Все о моде, кулинарии, женском здоворье. Также полезные советы из жизни и многое другое https://allaboutourladies.ru/
חבר נגע באולגה. ואדיק לקח את חברתו של אולגינה לשיח, שם ניסה להכות שהיא, לאחר ששפשפה את הפטמה שלה, נצמדה אליה בשתי שפתיה והתחילה למצוץ websites
The slot jackpots keep me coming back!
spinmama
Online casinos have great responsible gaming features.
aviator
новости россии читать онлайн
Got a cashback deal, really helpful.
joker jewels
The bonus terms are easy to understand.
betonred
Got a reload bonus, love the extra playtime.
bet on red
Вы можете купить справку о болезни с доставкой по Москве на сайте https://biomed-slv.ru/
The slot graphics make every spin fun!
andar bahar real cash
Online casinos have great responsible gaming features.
plinko
רוכסן על חצאיתה. החצאית שנפלה על הרצפה שחררה את המראה של הלבשה תחתונה ומאבדים אנשים, האלכוהוליסטים הגיעו לדירה של אולגינה. הוחלט לישון כאן. this post
переговоры украины и сша в аравии
My casino’s loyalty points system is really generous.
is plinko legit
The live baccarat table is so classy!
plinko
https://expertmiele.ru/
The live baccarat table is so stylish!
plinko
Online casinos are perfect for casual players.
plinko game
The game variety keeps it exciting every time.
plinko
Love the soundtracks in online slots!
razor returns
קטנה ולא לילדה בוגרת. אצל אניה שלי, ספוגים קטנים יוצאים מעט החוצה, שרפה את המחשבה שלה. ויטיאנה זרקה בפתאומיות את בדלתה והלכה למכונית. בית נערות ליווי