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!
Б17 психологи. Психолог онлайн 596 оценок
Мы изготавливаем дипломы психологов, юристов, экономистов и любых других профессий по разумным ценам. Заказ документа, который подтверждает обучение в университете, – это выгодное решение. Приобрести диплом любого университета: [url=http://hireblitz.com/employer/diplomy-grup-24/]hireblitz.com/employer/diplomy-grup-24[/url]
888starz bet официальный сайт 888starz bet официальный сайт .
скачать 888 starz на андроид бесплатно скачать 888 starz на андроид бесплатно .
скачать 888starz зеркало http://https://888starzz.site/ .
888 starz apk 888 starz apk .
изготовление металлических значков изготовление металлических значков .
sportbets https://www.sportbets17.ru .
Мы изготавливаем дипломы любой профессии по выгодным ценам. Мы предлагаем документы ВУЗов, расположенных в любом регионе РФ. Документы выпускаются на бумаге самого высшего качества. Это позволяет делать настоящие дипломы, не отличимые от оригиналов. [url=http://orikdok-v-gorode-voronezh-36.ru/]orikdok-v-gorode-voronezh-36.ru[/url]
888 starz somalia 888 starz somalia .
888старз скачать на андроид 888старз скачать на андроид .
Somebody necessarily lend a hand to make severely articles I’d state.
That is the very first time I frequented your website page and so far?
I surprised with the research you made to make this particular post amazing.
Great process!
купить аттестат за 11 класс в москве [url=http://arus-diplom6.ru/]http://arus-diplom6.ru/[/url] .
диплом купить гознак http://www.arus-diplom9.ru – диплом купить гознак .
Купить диплом о высшем образовании!
Мы предлагаем дипломы любых профессий по доступным ценам— diplomyplus.ru
прогнозы на баскетбол го спорт http://prognoz-na-segodnya-na-sport1.ru/ .
Stream live Cricket events online. Stay updated with upcoming matches, highlights,
and schedules. Join the excitement with E2BET today!
Заказать диплом об образовании!
Мы можем предложить дипломы любой профессии по приятным ценам— kupit-diplom24.com
прогнозы на баскетбол го спорт prognoz-na-segodnya-na-sport1.ru .
Hello every one, here every person is sharing such know-how, thus
it’s pleasant to read this web site, and I used to visit
this blog everyday.
интернет провайдеры по адресу дома
domashij-internet-kazan006.ru
интернет провайдеры по адресу дома
Специалист по зависимостям Тула: Профессиональная помощь при зависимостях Если вы или ваши близкие имеете проблемы с психоактивными веществами‚ важно обратиться к специалисту. Нарколог Тула предоставляет квалифицированную медицинскую помощь‚ включая диагностику зависимости и консультацию нарколога. В наркологической клинике предлагаются различные услуги‚ такие как медикаментозное лечение и психотерапия. Лечение зависимости – это сложный и многоступенчатый процесс‚ который требует индивидуального подхода. Программа реабилитации включает в себя этапы‚ направленные на восстановление физического и психологического состояния пациента. Реабилитация наркозависимых также включает поддержку семьи‚ что является ключевой ролью в успешном лечении. Анонимное лечение даёт возможность пациентам ощущать себя защищенными и свободными от осуждения. Предотвращение зависимостей и помощь при алкоголизме – важные аспекты работы наркологов. Обратитесь на narkolog-tula004.ru для получения подробностей и записи на консультацию. Помните‚ что раннее обращение – залог успешного выздоровления!
constantly i used to read smaller content that as well clear their motive, and that is
also happening with this post which I am reading at this place.
Can I simply just say what a relief to find a person that truly understands what they are discussing online.
You actually understand how to bring an issue to light
and make it important. More people must check this out and understand this side of your story.
I was surprised you aren’t more popular because you certainly
possess the gift.
купить диплом купить диплом .
Купить диплом любого университета!
Мы изготавливаем дипломы любой профессии по выгодным тарифам— [url=http://tyumenpages.ru/]tyumenpages.ru[/url]
прогноз на сегодня на спорт прогноз на сегодня на спорт .
прогноз на сегодня на спорт прогноз на сегодня на спорт .
Hi there, after reading this awesome piece of writing i am too cheerful to share my
experience here with mates.
With havin so much content and articles do you ever run into any issues of plagorism or copyright violation? My
website has a lot of unique content I’ve either authored myself or outsourced but it appears a lot of
it is popping it up all over the internet without my
agreement. Do you know any ways to help protect against content from being ripped off?
I’d truly appreciate it.
sportbets http://sportbets16.ru .
Hi there Dear, are you actually visiting this web page daily, if so then you will definitely get good knowledge.
Купить документ о получении высшего образования вы можете в нашей компании. Мы оказываем услуги по производству и продаже документов об окончании любых университетов Российской Федерации. Даем 100% гарантию, что в случае проверки документа работодателями, подозрений не возникнет. [url=http://ignitionadvertising.com/employer/eonline-diploma/]ignitionadvertising.com/employer/eonline-diploma[/url]
диплом массажиста купить http://www.arus-diplom9.ru – диплом массажиста купить .
sportbets sportbets16.ru .
спортивный прогноз на сегодня спортивный прогноз на сегодня .
прогноз на спорт футбол на сегодня точный http://www.kompyuternye-prognozy-na-futbol1.ru .
футбол аналитика прогнозы спорт https://www.kompyuternye-prognozy-na-futbol1.ru .
прогнозы на футбол от экспертов https://kompyuternye-prognozy-na-futbol.ru .
I’m amazed, I have to admit. Seldom do I come across
a blog that’s equally educative and engaging, and without a doubt, you’ve hit the nail
on the head. The issue is something that not enough men and women are speaking
intelligently about. I am very happy that I stumbled across this during
my hunt for something relating to this.
купить настоящий диплом купить настоящий диплом .
точные прогнозы на футбол сегодня http://kompyuternye-prognozy-na-futbol.ru/ .
Hello friends, its great piece of writing about teachingand
entirely explained, keep it up all the time.
металлические пины http://www.znacki-na-zakaz.ru/ .
изготовление металлических значков изготовление металлических значков .
sportbets https://sportbets17.ru/ .
sportbets http://sportbets17.ru .
значки из металла на заказ http://znacki-na-zakaz.ru/ .
sportbets http://www.sportbets17.ru .
Great site you have here but I was wondering if you knew of any community forums
that cover the same topics discussed here? I’d really love to be a part of online community where
I can get suggestions from other knowledgeable individuals
that share the same interest. If you have any recommendations, please let me know.
Many thanks!