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!
диплом автомеханика купить диплом автомеханика купить .
Покупка дипломов ВУЗов по всей Украине — с печатями, подписями, приложением и возможностью архивной записи (по запросу).
Документ максимально приближен к оригиналу и проходит визуальную проверку.
Мы гарантируем, что в случае проверки документа, подозрений не возникнет.
– Конфиденциально
– Доставка 3–7 дней
– Любая специальность
Уже более 3051 клиентов воспользовались услугой — теперь ваша очередь.
Купить дипломы о высшем — ответим быстро, без лишних формальностей.
Мы предлагаем оформление дипломов ВУЗов В киеве — с печатями, подписями, приложением и возможностью архивной записи (по запросу).
Документ максимально приближен к оригиналу и проходит визуальную проверку.
Мы даем гарантию, что в случае проверки документа, подозрений не возникнет.
– Конфиденциально
– Доставка 3–7 дней
– Любая специальность
Уже более 1299 клиентов воспользовались услугой — теперь ваша очередь.
Обращайтесь — ответим быстро, без лишних формальностей.
аттестат за 11 класс купить в москве https://arus-diplom7.ru .
пансионат инсульт реабилитация
pansionat-msk001.ru
пансионат для лежачих после инсульта
sportbets sportbets16.ru .
Can I simply say what a relief to find someone who genuinely
knows what they’re discussing on the web. You definitely realize how to bring
an issue to light and make it important. A lot more people have to read this and understand this side of the story.
It’s surprising you’re not more popular because you most certainly possess the gift.
my web site ผักสลัด
Покупка дипломов ВУЗов по всей Украине — с печатями, подписями, приложением и возможностью архивной записи (по запросу).
Документ максимально приближен к оригиналу и проходит визуальную проверку.
Мы гарантируем, что в случае проверки документа, подозрений не возникнет.
– Конфиденциально
– Доставка 3–7 дней
– Любая специальность
Уже более 4965 клиентов воспользовались услугой — теперь ваша очередь.
Купить диплом Украины — ответим быстро, без лишних формальностей.
Покупка дипломов ВУЗов по всей Украине — с печатями, подписями, приложением и возможностью архивной записи (по запросу).
Документ максимально приближен к оригиналу и проходит визуальную проверку.
Мы гарантируем, что в случае проверки документа, подозрений не возникнет.
– Конфиденциально
– Доставка 3–7 дней
– Любая специальность
Уже более 3087 клиентов воспользовались услугой — теперь ваша очередь.
Купить диплом специалиста недорого — ответим быстро, без лишних формальностей.
купить диплом в ставрополе [url=http://www.arus-diplom7.ru]купить диплом в ставрополе[/url] .
прогноз на спорт на сегодня от профессионалов прогноз на спорт на сегодня от профессионалов .
Оформиление дипломов ВУЗов по всей Украине — с печатями, подписями, приложением и возможностью архивной записи (по запросу).
Документ максимально приближен к оригиналу и проходит визуальную проверку.
Мы даем гарантию, что в случае проверки документа, подозрений не возникнет.
– Конфиденциально
– Доставка 3–7 дней
– Любая специальность
Уже более 2388 клиентов воспользовались услугой — теперь ваша очередь.
[url=http://uadiplom2.su/]Купить дипломы[/url] — ответим быстро, без лишних формальностей.
интернет провайдеры по адресу
domashij-internet-krasnodar004.ru
провайдеры по адресу
спортивный прогноз на сегодня https://www.prognoz-na-segodnya-na-sport2.ru .
Hey! I could have sworn I’ve been to this website before but
after checking through some of the post I realized it’s new to me.
Anyhow, I’m definitely happy I found it and I’ll be
book-marking and checking back often!
высокие напольные горшки для комнатных растений http://www.kashpo-napolnoe-spb.ru/ – высокие напольные горшки для комнатных растений .
букмекерская контора 1 вин http://1win1142.ru/
Заказать диплом института по невысокой стоимости можно, обратившись к проверенной специализированной фирме. Приобрести документ ВУЗа вы можете у нас в столице. orikdok-1v-gorode-irkutsk-38.online
Куда сходить в Санкт-Петербурге Отзывы о целителях – важный источник информации при выборе специалиста. Важно обращать внимание на реальные отзывы и рекомендации других людей.
I was recommended this web site by my cousin. I am not sure whether this post is
written by him as nobody else know such detailed about my difficulty.
You are incredible! Thanks!
Attractive section of content. I just stumbled upon your
blog and in accession capital to assert that I acquire in fact enjoyed account your
blog posts. Any way I’ll be subscribing to
your feeds and even I achievement you access consistently fast.
Заказать диплом университета по доступной цене возможно, обращаясь к проверенной специализированной компании. Приобрести документ ВУЗа можно в нашей компании в столице. orikdok-3v-gorode-omsk-55.ru
888starz bet скачать 888starz bet скачать .
Приобретение документа о высшем образовании через надежную компанию дарит массу преимуществ для покупателя. Приобрести диплом о высшем образовании: finansi.5nx.ru/viewtopic.php?f=2&t=1945
металлообработка Металлообработка – это обширная сфера деятельности, охватывающая широкий спектр процессов, направленных на изменение формы, размеров и свойств металлов и сплавов. От простых ручных операций до высокотехнологичных автоматизированных производств, металлообработка играет ключевую роль во многих отраслях промышленности, обеспечивая создание деталей, инструментов и конструкций, необходимых для функционирования современного мира.
Undeniably believe that that you said. Your favourite
reason seemed to be at the internet the easiest thing to have in mind of.
I say to you, I certainly get annoyed whilst folks consider
concerns that they just don’t realize about. You managed to hit the nail upon the highest and also outlined out the entire thing without having side effect
, folks can take a signal. Will likely be again to get more.
Thanks
Stream live Football events online. Stay updated with upcoming matches, highlights,
and schedules. Join the excitement with E2BET today!
профессиональные прогнозы на футбол http://kompyuternye-prognozy-na-futbol.ru .
супер прогнозы на спорт http://www.kompyuternye-prognozy-na-futbol.ru .
1win скачать приложение http://1win1141.ru/
mostbet suallar və cavablar http://mostbet4042.ru/
Заказать диплом ВУЗа по невысокой стоимости возможно, обратившись к проверенной специализированной компании. Приобрести документ института можно у нас. [url=http://orikdok-5v-gorode-smolensk-67.online/]orikdok-5v-gorode-smolensk-67.online[/url]
напольные вазоны для комнатных цветов http://kashpo-napolnoe-spb.ru/ – напольные вазоны для комнатных цветов .
футбол аналитика прогнозы спорт http://www.kompyuternye-prognozy-na-futbol.ru .
прогноз на спорт на сегодня от профессионалов прогноз на спорт на сегодня от профессионалов .
значки на заказ срочно http://znacki-na-zakaz.ru .
Setting up a low cost business setup in uae in Dubai is streamlined for tech firms.
Hey There. I discovered your weblog using msn. This is a really well written article.
I’ll be sure to bookmark it and return to read more of your helpful
information. Thank you for the post. I will definitely comeback.
mostbet qeydiyyat olmadan giriş mostbet qeydiyyat olmadan giriş
Incredible quest there. What occurred after? Thanks!
прогнозы на баскетбол го спорт http://prognoz-na-segodnya-na-sport3.ru/ .
mostbet aviator az http://mostbet3041.ru/
прогнозы на баскетбол го спорт http://prognoz-na-segodnya-na-sport3.ru .
ставки на хоккей прогнозы от профессионалов https://prognoz-na-segodnya-na-sport.ru .
Покупка документа о высшем образовании через надежную компанию дарит ряд плюсов для покупателя. Быстро купить диплом о высшем образовании: alik.forumrpg.ru/viewtopic.php?id=12234#p287889
sportbets http://sportbets17.ru .
прогнозы на спорт бесплатно от профессионалов на сегодня прогнозы на спорт бесплатно от профессионалов на сегодня .
дом престарелых в москве
pansionat-msk002.ru
пансионат для лежачих пожилых
mostbet promo kod az http://mostbet4045.ru
mostbet promo qeydiyyat https://mostbet4042.ru