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!
Репетитор по физике https://repetitor-po-fizike-spb.ru СПб: школьникам и студентам, с нуля и для олимпиад. Четкие объяснения, практика, реальные результаты.
цена глубинное водопонижение цена глубинное водопонижение .
скачать мостбет на андроид бесплатно старая версия http://mostbet11005.ru/
Заказать строительное водопонижение [url=http://4dkp.forum24.ru/?1-18-0-00005163-000-0-0-1750670206/]Заказать строительное водопонижение[/url] .
Лучшие онлайн-курсы https://topkursi.ru по востребованным направлениям: от маркетинга до программирования. Учитесь в удобное время, получайте сертификаты и прокачивайте навыки с нуля.
Se você está procurando a melhor experiência de cassino online com slots emocionantes, não pode deixar de baixar Big Bass Bonanza agora mesmo! Este caça-níquel da Pragmatic Play, conhecido como Big Bass Bonanza, conquistou os jogadores com seu visual divertido e prêmios incríveis: big bass bonanza slots
Школа Саморазвития https://bznaniy.ru онлайн-база знаний для тех, кто хочет понять себя, улучшить мышление, прокачать навыки и выйти на новый уровень жизни.
Психотерапевты Самара. Б17 психологи. 724 оценок
мостбет казино https://mostbet11007.ru/
бк. мостбет. https://mostbet11004.ru
Hi there, of course this article is really pleasant and I have learned lot of things
from it about blogging. thanks.
Психотерапевт Челны. Кпт курган. 531 оценок
Купить документ о получении высшего образования вы можете у нас в столице. Купить диплом университета по невысокой стоимости возможно, обращаясь к надежной специализированной компании. msobl.flybb.ru/viewtopic.phpf=2&t=1020
займ под залог птс автомобиля
zaimpod-pts90.ru/kazan.html
автоломбард под залог
букмекерские конторы кыргызстана http://mostbet11007.ru
что такое мостбет http://mostbet11008.ru
Приобрести документ о получении высшего образования вы сможете в нашей компании в Москве. Заказать диплом института по доступной цене возможно, обращаясь к надежной специализированной фирме. podrabotke.flybb.ru/viewtopic.phpf=2&t=771
Получить диплом любого ВУЗа поспособствуем. Заказать аттестат – diplomybox.com/zakazat-attestat
бездепозитные бонусы за регистрацию в казино с выводом без пополнения Бездепозитный бонус – это шанс сорвать куш, не вкладывая ни копейки. Он позволяет испытать азарт, риск и радость победы, не испытывая страха потери собственных средств. Это особенно ценно для начинающих игроков, которые еще не готовы рисковать большими суммами. Бездепозитный бонус в казино
кредиты под залог машины с правом вождения
zaimpod-pts89.ru
взять займ под залог птс
казино мостбет казино мостбет
бк теннесси скачать на андроид [url=http://mostbet11007.ru]http://mostbet11007.ru[/url]
Wonderful beat ! I wish to apprentice whilst you amend your web site,
how can i subscribe for a weblog website? The account aided me a acceptable deal.
I had been tiny bit familiar of this your broadcast offered vivid clear concept
My homepage; DJ Breakbeat Viral
смета на водопонижение иглофильтрами смета на водопонижение иглофильтрами .
If you’re looking for a powerful WhatsApp hash extractor or WhatsApp WART extractor,
you need a reliable tool that can efficiently extract WhatsApp account details from Android devices.
Whether you’re a digital marketer, researcher, or developer, our WhatsApp account extractor
software provides seamless extraction of WhatsApp protocol numbers, hash keys, and
more.
водопонижение для строительства водопонижение для строительства .
водопонижение для строительства [url=4dkp.forum24.ru/?1-18-0-00005163-000-0-0-1750670206]водопонижение для строительства[/url] .
Бездепозитные бонусы в казино Казино, предлагающие бездепозитные бонусы, демонстрируют свою уверенность в качестве предоставляемых услуг. Это своего рода маркетинговый ход, направленный на привлечение новых игроков и формирование лояльности. Игроки, получившие положительный опыт, с большей вероятностью вернутся и станут постоянными клиентами. Бездепозитный бонус
Приобрести документ университета вы можете у нас. Мы оказываем услуги по продаже документов об окончании любых ВУЗов РФ. Даем гарантию, что в случае проверки документа работодателями, подозрений не возникнет. ubereducation.co.uk/companies/eonline-diploma
1mostbet https://www.mostbet11006.ru
I think that is among the most vital information for me.
And i’m satisfied studying your article. However want to statement on few common issues, The website style is great, the articles is in point of fact excellent :
D. Excellent activity, cheers
Приобрести диплом института по доступной стоимости возможно, обратившись к надежной специализированной компании. Приобрести диплом о высшем образовании: californiarpn2.listbb.ru/viewtopic.php?f=1&t=2086
займ под залог авто кемерово
zaimpod-pts90.ru/kemerovo.html
деньги под залог автомобиля
Amazing blog! Is your theme custom made or did you download it from somewhere?
A theme like yours with a few simple adjustements would really make my blog shine.
Please let me know where you got your theme.
Many thanks
I enjoy what you guys are up too. This type of
clever work and exposure! Keep up the terrific works guys I’ve added you guys to my personal blogroll.
Here is my site :: kkpoker Payday
Покупка дипломов ВУЗов по всей России и СНГ — с печатями, подписями, приложением и возможностью архивной записи (по запросу).
Документ максимально приближен к оригиналу и проходит визуальную проверку.
Мы даем гарантию, что в случае проверки документа, подозрений не возникнет.
– Конфиденциально
– Доставка 3–7 дней
– Любая специальность
Уже более 3470 клиентов воспользовались услугой — теперь ваша очередь.
Дипломы о высшем образовании купить — ответим быстро, без лишних формальностей.
Заказать диплом университета мы поможем. Куплю диплом: цены на документы – diplomybox.com/tseny-na-dokumenty
Good day! This is kind of off topic but I need some help from an established blog.
Is it very difficult to set up your own blog? I’m not very techincal but I can figure things out pretty fast.
I’m thinking about creating my own but I’m
not sure where to start. Do you have any tips or suggestions?
With thanks
Мы предлагаем оформление дипломов ВУЗов по всей России и СНГ — с печатями, подписями, приложением и возможностью архивной записи (по запросу).
Документ максимально приближен к оригиналу и проходит визуальную проверку.
Мы гарантируем, что в случае проверки документа, подозрений не возникнет.
– Конфиденциально
– Доставка 3–7 дней
– Любая специальность
Уже более 3947 клиентов воспользовались услугой — теперь ваша очередь.
Купить диплом вуза — ответим быстро, без лишних формальностей.
Купить документ о получении высшего образования вы имеете возможность у нас в Москве. Мы предлагаем документы об окончании любых университетов РФ. Даем гарантию, что при проверке документа работодателем, каких-либо подозрений не появится. pharmakendra.in/employer/eonline-diploma
mostbet. mostbet.
Заказать диплом института по невысокой цене вы сможете, обращаясь к надежной специализированной компании. Быстро заказать диплом о высшем образовании: talkline.co.in/read-blog/59451_diplom-inzhenera-stroitelya-kupit.html
фонтан казино бездепозитный бонус 1000 рублей за регистрацию без депозита с выводом денег Многие казино, стремясь привлечь новых клиентов, предлагают 1000 рублей за регистрацию с моментальным выводом, не требующим никаких вложений. Это привлекательная возможность для тех, кто хочет испытать свою удачу без риска для собственного бюджета. 1000 рублей за регистрацию в казино без депозита вывод сразу
Покупка дипломов ВУЗов по всей России и СНГ — с печатями, подписями, приложением и возможностью архивной записи (по запросу).
Документ максимально приближен к оригиналу и проходит визуальную проверку.
Мы гарантируем, что в случае проверки документа, подозрений не возникнет.
– Конфиденциально
– Доставка 3–7 дней
– Любая специальность
Уже более 4091 клиентов воспользовались услугой — теперь ваша очередь.
[url=http://poligraf1.ru/]Купить диплом Москва[/url] — ответим быстро, без лишних формальностей.
Мы можем предложить документы университетов, расположенных в любом регионе Российской Федерации. Дипломы и аттестаты выпускаются на “правильной” бумаге высшего качества: theavtar.in/read-blog/56417_kupit-diplom-o-vysshem-obrazovanii.html
Психотерапевт Белгород. Кпт курган. 261 оценок
Купить диплом любого университета!
Мы изготавливаем дипломы любых профессий по приятным ценам— diplom-bez-problem.com
This is really interesting, You’re a very professional blogger.
I’ve joined your feed and stay up for searching for extra of
your fantastic post. Additionally, I have shared your site in my social networks
сайт мостбет сайт мостбет
Купить диплом института!
Мы изготавливаем дипломы любых профессий по разумным ценам— internetdiplom.ru