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!
bonus 1win [url=1win1109.ru]1win1109.ru[/url]
справка для секции или кружка
недорогая справка от врача
Мы предлагаем документы институтов, расположенных на территории всей Российской Федерации. Купить диплом ВУЗа:
babygirls014.copiny.com/question/details/id/1113519
dragonslot http://www.casinosdragonslots.eu/ .
https://a-bsme.at/bs2best_at.html
The Pokies net Australia https://pokies11.com .
1win.m 1win.m
справка для спортивных соревнований
справка для бассейна
The Pokies Australia pokies11.com .
оформление заявки на продление
справка для детского сада
1win официальный войти http://1win1109.ru/
Мы готовы предложить документы любых учебных заведений, которые находятся в любом регионе РФ. Приобрести диплом о высшем образовании:
[url=http://peticao.online/488012/]peticao.online/488012[/url]
медкнижка для трудоустройства
https://2bs-2best.at/darknetmarket.html
1win bet aviator http://1win1109.ru/
New AI generator free nsfw ai of the new generation: artificial intelligence turns text into stylish and realistic image and videos.
Good article! We are linking to this great content on our website.
Keep up the great writing.
New AI generator nsfw ai image generator of the new generation: artificial intelligence turns text into stylish and realistic image and videos.
ремонт стиральных машин вызов на дом ремонт стиральных машин индезит
Hi! Would you mind if I share your blog with my zynga group?
There’s a lot of folks that I think would really appreciate your content.
Please let me know. Cheers
Hey There. I discovered your blog the usage
of msn. That is a very neatly written article. I’ll make sure to
bookmark it and come back to learn extra of your useful information. Thank you for the post.
I’ll definitely return.
Mountain Topper https://www.lnrprecision.com transceivers from the official supplier. Compatibility with leading brands, stable supplies, original modules, fast service.
pokies net 250 http://pokiesnet250.com/ .
Hindi News https://tfipost.in latest news from India and the world. Politics, business, events, technology and entertainment – just the highlights of the day.
1win apk android https://1win11001.com
apk 1win http://www.1win-in1.com .
aviator 1win aviator 1win
1 win official app http://1win-in1.com .
New AI generator free nsfw ai chat of the new generation: artificial intelligence turns text into stylish and realistic image and videos.
New AI generator free nsfw ai of the new generation: artificial intelligence turns text into stylish and realistic image and videos.
1 win betting app [url=www.1win-in1.com]www.1win-in1.com[/url] .
오늘, 저는 아이들들과 해변가에
갔습니다. 조개껍데기를 발견해서 제 4살
딸에게 주며 “이걸 귀에 대면 바다 소리를 들을 수 있어”라고 했습니다.
그녀가 조개껍데기를 귀에 대자 비명을 질렀습니다.
안에 소라게가 있어서 그녀의 귀를 집었거든요.
그녀는 다시는 돌아가고 싶어하지 않습니다!
LoL 이건 전적으로 주제에서 벗어났지만 누군가에게 말하고
싶었어요!
I’m not sure where you are getting your info, but great topic.
I needs to spend some time learning more or understanding
more. Thanks for fantastic info I was looking
for this information for my mission.
thepokies net thepokies net .
1win казино регистрация [url=https://www.1win1110.ru]https://www.1win1110.ru[/url]
Greetings! This is my 1st comment here so I just wanted to give a quick shout out and tell
you I truly enjoy reading your articles. Can you suggest any other blogs/websites/forums
that cover the same subjects? Thanks for your time!
the pokies net 250 login http://thepokiesnet250.com/ .
I got this web site from my friend who told me regarding
this website and now this time I am browsing this website and reading very informative articles or reviews at this place.
New AI generator character ai nsfw of the new generation: artificial intelligence turns text into stylish and realistic image and videos.
Бездепозитный бонус в казино Принимая бездепозитный бонус, важно внимательно изучить условия его отыгрыша. Вейджер, сроки действия и ограничения по играм – все эти факторы могут существенно повлиять на возможность вывода выигрыша. Тщательное изучение правил поможет избежать разочарований и максимально эффективно использовать бонус. Бездепозитные бонусы казино без пополнения с отыгрышем
New AI generator nsfw ai image generator of the new generation: artificial intelligence turns text into stylish and realistic image and videos.
New AI generator ai nsfw of the new generation: artificial intelligence turns text into stylish and realistic image and videos.
гардина с электроприводом http://elektrokarnizy50.ru/ .
ремонт стиральной машины горенье ремонт стиральных машин вызов на дом
Hindi News https://tfipost.in latest news from India and the world. Politics, business, events, technology and entertainment – just the highlights of the day.
https://1-bs2best.art/index.html
Mountain Topper https://www.lnrprecision.com transceivers from the official supplier. Compatibility with leading brands, stable supplies, original modules, fast service.
1win india https://1win11002.com