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!
Приобрести диплом университета по доступной цене вы можете, обратившись к надежной специализированной фирме. Заказать документ о получении высшего образования вы имеете возможность у нас в столице. orikdok-2v-gorode-vladikavkaz-15.online
Этот информационный обзор станет отличным путеводителем по актуальным темам, объединяющим важные факты и мнения экспертов. Мы исследуем ключевые идеи и представляем их в доступной форме для более глубокого понимания. Читайте, чтобы оставаться в курсе событий!
Углубиться в тему – https://eineweltsafaris.com/2022/07/01/5-most-beautiful-islands-in-asia
защитный кейс большой plastcase.ru
Приобрести диплом любого института. Заказ документа о высшем образовании через качественную и надежную компанию дарит множество плюсов. Такое решение дает возможность сэкономить время и серьезные финансовые средства. orikdok-5v-gorode-volgograd-34.ru
Купить диплом под заказ в Москве возможно через официальный сайт компании. orikdok-5v-gorode-vladikavkaz-15.ru
Быстро заказать диплом любого института!
Мы предлагаем дипломы психологов, юристов, экономистов и любых других профессий по приятным тарифам— diplom-astrakhan.ru
купить диплом как http://www.arus-diplom4.ru/ .
защитные кейсы pelican https://plastcase.ru
купить диплом в москве о высшем образовании купить диплом в москве о высшем образовании .
диплом в казани купить диплом в казани купить .
login 1win [url=www.1win3008.com]login 1win[/url]
Купить документ института можно в нашей компании в столице. Заказать диплом университета по невысокой цене возможно, обратившись к надежной специализированной компании. [url=http://abroad.ekafe.ru/viewtopic.phpf=5&t=4553/]abroad.ekafe.ru/viewtopic.phpf=5&t=4553[/url]
Мы предлагаем дипломы любой профессии по приятным ценам. Мы можем предложить документы ВУЗов, расположенных в любом регионе России. Дипломы и аттестаты печатаются на “правильной” бумаге самого высокого качества. Это дает возможности делать настоящие дипломы, не отличимые от оригиналов. [url=http://orikdok-v-gorode-rostov-na-donu-61.ru/]orikdok-v-gorode-rostov-na-donu-61.ru[/url]
Мы предлагаем документы институтов, расположенных в любом регионе России. Купить диплом любого ВУЗа:
[url=http://unmeinaroom.copiny.com/question/details/id/1113560/]unmeinaroom.copiny.com/question/details/id/1113560[/url]
Этот документ охватывает важные аспекты медицинской науки, сосредотачиваясь на ключевых вопросах, касающихся здоровья населения. Мы рассматриваем свежие исследования, клинические рекомендации и лучшие практики, которые помогут улучшить качество лечения и профилактики заболеваний. Читатели получат возможность углубиться в различные медицинские дисциплины.
Подробнее можно узнать тут – https://vitalady.ru/novoe/preimushhestva-vyzova-vracha-narkologa-na-dom.html
Купить диплом ВУЗа по выгодной цене можно, обратившись к надежной специализированной компании. Купить документ о получении высшего образования вы можете у нас в Москве. orikdok-2v-gorode-kostroma-44.online
купить аттестат в уфе купить аттестат в уфе .
Эта познавательная публикация погружает вас в море интересного контента, который быстро захватит ваше внимание. Мы рассмотрим важные аспекты темы и предоставим вам уникальныеInsights и полезные сведения для дальнейшего изучения.
Получить дополнительную информацию – https://sarptorun.pl/spotkanie-noworoczna-sarp-o-torun/spotkanie-noworoczne-sarp-5
Приобрести диплом о высшем образовании. Покупка диплома ВУЗа через надежную компанию дарит множество плюсов для покупателя. Данное решение позволяет сберечь время и серьезные денежные средства. orikdok-5v-gorode-tolyatti-63.ru
Приобрести диплом под заказ в столице вы можете через официальный сайт компании. orikdok-3v-gorode-kostroma-44.online
настоящий диплом купить http://arus-diplom4.ru/ .
Заказать диплом ВУЗа!
Мы предлагаем дипломы психологов, юристов, экономистов и других профессий по приятным ценам— diplomnie.com
аттестат купить цена http://arus-diplom8.ru/ .
купить диплом о среднем купить диплом о среднем .
купить аттестат цена купить аттестат цена .
pin up tennis tikish https://pinup3014.ru/
В обзорной статье вы найдете собрание важных фактов и аналитики по самым разнообразным темам. Мы рассматриваем как современные исследования, так и исторические контексты, чтобы вы могли получить полное представление о предмете. Погрузитесь в мир знаний и сделайте шаг к пониманию!
Получить больше информации – https://bpoint-th.com/hello-world
Приобрести диплом института по выгодной стоимости можно, обратившись к надежной специализированной компании. Купить документ университета вы сможете у нас. [url=http://orikdok-3v-gorode-irkutsk-38.ru/]orikdok-3v-gorode-irkutsk-38.ru[/url]
It’s a shame you don’t have a donate button! I’d definitely donate to this superb blog!
I guess for now i’ll settle for book-marking and adding your RSS feed to my
Google account. I look forward to fresh updates and will talk about this blog with my Facebook group.
Chat soon!
red sea kite Кайт сафари Египет – это приключение, которое позволит вам сочетать кайтсёрфинг с незабываемым отдыхом на яхте.
Приобрести диплом об образовании. Покупка документа о высшем образовании через надежную фирму дарит немало достоинств для покупателя. Это решение позволяет сэкономить как личное время, так и значительные средства. [url=http://orikdok-2v-gorode-orenburg-56.online/]orikdok-2v-gorode-orenburg-56.online[/url]
купить диплом в курске [url=https://www.arus-diplom4.ru]купить диплом в курске[/url] .
Заказать диплом на заказ вы можете используя официальный сайт компании. [url=http://orikdok-4v-gorode-irkutsk-38.ru/]orikdok-4v-gorode-irkutsk-38.ru[/url]
купить диплом в туле [url=http://arus-diplom8.ru]купить диплом в туле[/url] .
купить аттестат в брянске [url=https://arus-diplom7.ru]купить аттестат в брянске[/url] .
Этот обзорный материал предоставляет информационно насыщенные данные, касающиеся актуальных тем. Мы стремимся сделать информацию доступной и структурированной, чтобы читатели могли легко ориентироваться в наших выводах. Познайте новое с нашим обзором!
Ознакомиться с деталями – https://www.atelierkameleon.nl/favicon
Excellent post. I was checking constantly this blog and I’m impressed!
Very useful information particularly the last part :
) I care for such information much. I was seeking this
particular info for a long time. Thank you
and best of luck.
Приобрести диплом любого ВУЗа!
Мы предлагаем дипломы любой профессии по приятным тарифам— [url=http://shopingplaces.ru/]shopingplaces.ru[/url]
Когда нужно срочно — важна скорость. Микрозайм без отказа, по паспорту и без проверки КИ вы можете получить на https://mfo-zaim.com/. Сайт подбирает надёжные МФО с мгновенным перечислением на карту. Это удобно, безопасно и реально работает даже ночью или в праздники. Проверьте сами.
мостбет приложение http://www.mostbet4015.ru
купить диплом о высшем [url=https://arus-diplom3.ru]купить диплом о высшем[/url] .
Крайне советую https://www.dambros.com/2012/08/24/this-is-a-post-with-post-type-link/
В этой статье представлен занимательный и актуальный контент, который заставит вас задуматься. Мы обсуждаем насущные вопросы и проблемы, а также освещаем истории, которые вдохновляют на действия и изменения. Узнайте, что стоит за событиями нашего времени!
Узнать больше – https://tcomlp.com/aerostat-system-integration
В этом информативном тексте представлены захватывающие события и факты, которые заставят вас задуматься. Мы обращаем внимание на важные моменты, которые часто остаются незамеченными, и предлагаем новые перспективы на привычные вещи. Подготовьтесь к тому, чтобы быть поглощенным увлекательными рассказами!
Получить дополнительную информацию – https://www.needageneralcontractor.com/building-with-precision-our-commitment-to-excellence-in-construction
Does your website have a contact page? I’m having problems locating it but, I’d like to send you an email.
I’ve got some ideas for your blog you might be interested
in hearing. Either way, great blog and I look forward to seeing it expand over time.
В этой статье мы рассматриваем разные способы борьбы с алкогольной зависимостью. Обсуждаются методы лечения, программы реабилитации и советы для поддержки близких. Читатели получат информацию о том, как преодолеть зависимость и добиться успешного выздоровления.
Разобраться лучше – https://fm-saveli.ru/lechenie-zapoev-i-zavisimostej
mostbet uz ro‘yxatdan o‘tish bonusi https://mostbet4005.ru
В этой статье-обзоре мы соберем актуальную информацию и интересные факты, которые освещают важные темы. Читатели смогут ознакомиться с различными мнениями и подходами, что позволит им расширить кругозор и глубже понять обсуждаемые вопросы.
Получить дополнительную информацию – https://www.hotel-sugano.com/bbs/sugano.cgi/www.skitour.su/datasphere.ru/club/user/12/blog/2477/www.skitour.su/sinopipefittings.com/e_Feedback/www.tovery.net/www.hip-hop.ru/forum/sugano.cgi?page40=val
I could not refrain from commenting. Exceptionally well written!
кейс защитный байкал вз 12 plastcase