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!
I seriously love your site.. Pleasant colors & theme. Did you create this
amazing site yourself? Please reply back as I’m hoping to create my very own site and would like to
learn where you got this from or just what the theme is named.
Kudos!
букмекерская контора теннесси скачать [url=www.mostbet11015.ru]www.mostbet11015.ru[/url]
Раньше казалось невозможным, что онлайн-игры так изменятся.
По части инноваций Бонус Casino Armada держит уровень.
Новые бонусные режимы впечатляют, графика добавляют атмосферу.
Переход обнадёживают в играх.
мостбет ком [url=mostbet11008.ru]mostbet11008.ru[/url]
pari march pari march .
купить диплом о медицинском образовании купить диплом о медицинском образовании .
It’s going to be ending of mine day, except before finish I am reading this wonderful piece of writing to increase
my knowledge.
I could not resist commenting. Well written!
pari match bet pari match bet .
mostbet for pc http://mostbet11015.ru/
диплом купить в мурманске диплом купить в мурманске .
купить школьный аттестат купить школьный аттестат .
Мы изготавливаем дипломы психологов, юристов, экономистов и прочих профессий по доступным ценам. Приобретение диплома, который подтверждает обучение в ВУЗе, – это выгодное решение. Приобрести диплом о высшем образовании: perekrestok.flybb.ru/viewtopic.php?f=2&t=671
1win chile http://www.1win3002.com
70918248
References:
women on anabolic steroids (https://embedthreads.com/)
Покупка дипломов ВУЗов в Москве — с печатями, подписями, приложением и возможностью архивной записи (по запросу).
Документ максимально приближен к оригиналу и проходит визуальную проверку.
Мы гарантируем, что в случае проверки документа, подозрений не возникнет.
– Конфиденциально
– Доставка 3–7 дней
– Любая специальность
Уже более 4780 клиентов воспользовались услугой — теперь ваша очередь.
Купить государственный диплом — ответим быстро, без лишних формальностей.
Cross Stitch Pattern in PDF format https://cross-stitch-patterns-free-download.store/ a perfect choice for embroidery lovers! Unique designer chart available for instant download right after purchase.
parimatch ios [url=https://parimatch-app-download.com]parimatch ios[/url] .
Покупка дипломов ВУЗов в Москве — с печатями, подписями, приложением и возможностью архивной записи (по запросу).
Документ максимально приближен к оригиналу и проходит визуальную проверку.
Мы гарантируем, что в случае проверки документа, подозрений не возникнет.
– Конфиденциально
– Доставка 3–7 дней
– Любая специальность
Уже более 4753 клиентов воспользовались услугой — теперь ваша очередь.
Открыть — ответим быстро, без лишних формальностей.
Thanks for a marvelous posting! I actually enjoyed reading it, you will be a great author.I will always bookmark your blog and may come back sometime soon. I want to encourage you
to definitely continue your great work, have a nice day!
Мы изготавливаем дипломы любой профессии по приятным ценам. Заказ диплома, который подтверждает окончание института, – это разумное решение. Купить диплом любого университета: alumeet.com/read-blog/10358_diplom-kupit-medsestry.html
диплом официально купить [url=http://arus-diplom8.ru]диплом официально купить[/url] .
купить диплом дешево [url=arus-diplom7.ru]arus-diplom7.ru[/url] .
бот lucky jet скачать http://www.1win11001.ru
Надёжная фурнитура https://furnitura-dla-okon.ru для пластиковых окон: всё для ремонта и комплектации. От ручек до многозапорных механизмов.
I always used to read article in news papers but now as I am a user of net thus
from now I am using net for posts, thanks to web.
Мы предлагаем оформление дипломов ВУЗов в Москве — с печатями, подписями, приложением и возможностью архивной записи (по запросу).
Документ максимально приближен к оригиналу и проходит визуальную проверку.
Мы даем гарантию, что в случае проверки документа, подозрений не возникнет.
– Конфиденциально
– Доставка 3–7 дней
– Любая специальность
Уже более 3039 клиентов воспользовались услугой — теперь ваша очередь.
[url=http://poligraf7.ru/]Купить диплом вуза[/url] — ответим быстро, без лишних формальностей.
Фурнитура для ПВХ-окон http://kupit-furnituru-dla-okon.ru оптом и в розницу: европейские бренды, доступные цены, доставка по РФ.
деньги под птс авто
zaimpod-pts91.ru/ekb.html
деньги под залог грузового авто
Мы готовы предложить дипломы любой профессии по доступным ценам. Заказ диплома, который подтверждает обучение в ВУЗе, – это грамотное решение. Заказать диплом любого университета: [url=http://careers.mycareconcierge.com/companies/diplomy-grup-24/]careers.mycareconcierge.com/companies/diplomy-grup-24[/url]
нужен юрист вопрос юристу по телефону
Мы готовы предложить документы институтов, расположенных на территории всей России. Купить диплом университета:
staletsa.flybb.ru/viewtopic.php?f=2&t=1352
займ под залог автомобиля
zaimpod-pts92.ru/kazan.html
авто под залог
Наши специалисты предлагают быстро и выгодно заказать диплом, который выполнен на оригинальном бланке и заверен печатями, штампами, подписями. Диплом пройдет любые проверки, даже с использованием специальных приборов. skilled-moms.com/employer/diplomirovans
Мы можем предложить документы институтов, которые расположены на территории всей РФ. Заказать диплом любого университета:
empleosytrabajos.lat/employer/diplomirovans
Wassup guys, I’m Marko from Serbia. I wanna tell you about my insane experience with this next-level online casino I stumbled on not long
ago.
To be honest, I was super poor, and now I can’t believe
it myself — I won $1,500,000 playing mostly sports bets!
Now I’m thinking of finally owning an apartment here in Belgrade, and investing a serious chunk of my winnings into Cardano.
Later I’ll probably move to a better neighborhood and travel the
world.
Now I’m going by Tomasz from Poland because I honestly feel like a new person. My
life is flipping upside down in the best way.
Be real, what would you guys do if you had this kinda luck?
Are you a bit envious right now?
For real, I never thought I’d see this kinda money. It’s all happening
so fast!
Reply if you wanna chat!
Наша компания предлагает выгодно приобрести диплом, который выполнен на оригинальном бланке и заверен мокрыми печатями, водяными знаками, подписями. Данный диплом пройдет любые проверки, даже при использовании специально предназначенного оборудования. fabulousroleplay.5nx.ru/viewtopic.php?f=40&t=631
Мы предлагаем документы ВУЗов, расположенных на территории всей Российской Федерации. Приобрести диплом о высшем образовании:
[url=http://voprosnek.flybb.ru/viewtopic.php?f=2&t=629/]voprosnek.flybb.ru/viewtopic.php?f=2&t=629[/url]
Hi i am kavin, its my first occasion to commenting anyplace, when i read
this paragraph i thought i could also make comment due to this brilliant article.
Greetings, I’m Alex from Romania. I wanna tell you about my insane experience with this new online casino I stumbled on a few weeks
ago.
To be honest, I was living paycheck to paycheck, and now I can’t believe it myself — I cashed out $712,000 playing mostly crazy time!
Now I’m thinking of taking my dream vacation and buying a house here in Split, and investing a serious chunk
of my winnings into Solana.
Later I’ll probably move to a better neighborhood and start a
small business.
Now I’m going by Nikola from Serbia because I honestly feel like a new person. My life is flipping upside
down in the best way.
Be real, what would you guys do if you had this kinda luck?
Are you a bit envious right now?
For real, I never thought I’d see this kinda money. It’s all happening
so fast!
Let’s talk crypto too!
You made some decent points there. I looked on the internet for more information about the issue and
found most people will go along with your views on this web
site.
Мы предлагаем быстро заказать диплом, который выполняется на оригинальной бумаге и заверен печатями, водяными знаками, подписями официальных лиц. Документ способен пройти любые проверки, даже при использовании специфических приборов. [url=http://wesocial.top/read-blog/5081_kupit-diplom-o-srednem-specialnom-obrazovanii.html/]wesocial.top/read-blog/5081_kupit-diplom-o-srednem-specialnom-obrazovanii.html[/url]
Pretty! This has been an extremely wonderful article.
Thank you for providing this information.
https://mylady.mybb.ru/viewtopic.php?id=38720#p148121
Покупка дипломов ВУЗов в Москве — с печатями, подписями, приложением и возможностью архивной записи (по запросу).
Документ максимально приближен к оригиналу и проходит визуальную проверку.
Мы даем гарантию, что в случае проверки документа, подозрений не возникнет.
– Конфиденциально
– Доставка 3–7 дней
– Любая специальность
Уже более 2858 клиентов воспользовались услугой — теперь ваша очередь.
Купить государственный диплом — ответим быстро, без лишних формальностей.
Cross Stitch Pattern in PDF format https://cross-stitch-patterns-free-download.store/ a perfect choice for embroidery lovers! Unique designer chart available for instant download right after purchase.
1win скачать мобильный телефон https://www.1win11001.ru
A fascinating discussion is worth comment. There’s no doubt
that that you ought to write more on this issue, it might not be a
taboo subject but generally people don’t speak about such subjects.
To the next! All the best!!
Мы предлагаем оформление дипломов ВУЗов в Москве — с печатями, подписями, приложением и возможностью архивной записи (по запросу).
Документ максимально приближен к оригиналу и проходит визуальную проверку.
Мы даем гарантию, что в случае проверки документа, подозрений не возникнет.
– Конфиденциально
– Доставка 3–7 дней
– Любая специальность
Уже более 2702 клиентов воспользовались услугой — теперь ваша очередь.
Диплом цена — ответим быстро, без лишних формальностей.
Hi there to every body, it’s my first pay a quick visit of this website;
this webpage includes amazing and actually good information for visitors.