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://mrkresearch.com
Лунный календарь http://www.n2000.ru .
купить игровой пк купить игровой пк .
сколько стоит игровой компьютер http://kupit-igrovoj-kompyuter1.ru/ .
Календарь стрижек n2000.ru .
сколько стоит игровой компьютер https://kupit-igrovoj-kompyuter.ru .
сколько стоит игровой компьютер http://www.kupit-igrovoj-kompyuter1.ru .
Hola! I’ve been reading your blog for a long time now and finally got the bravery to go ahead and give you
a shout out from Humble Tx! Just wanted to tell you keep
up the great work!
Предлагаем вашему вниманию интересную справочную статью, в которой собраны ключевые моменты и нюансы по актуальным вопросам. Эта информация будет полезна как для профессионалов, так и для тех, кто только начинает изучать тему. Узнайте ответы на важные вопросы и расширьте свои знания!
Подробнее – https://artoflivingshop.com/product-tag/best-weight-loss-diet
Гороскоп [url=http://www.n2000.ru]http://www.n2000.ru[/url] .
игровые пк [url=http://www.kupit-igrovoj-kompyuter.ru]игровые пк[/url] .
сколько стоит игровой компьютер [url=www.kupit-igrovoj-kompyuter1.ru/]www.kupit-igrovoj-kompyuter1.ru/[/url] .
It is the berst tome to make some plwns for the future
and it is time to be happy. I’ve read this post
and if I could I desirre to suggest you few interesting things or tips.
Perhaps you could write next articles referring to this article.
I wish to read even more things about it!
I’ve been using E2Bet for a while now, and it’s the best platform for cricket exchange in Pakistan! The
live odds are accurate, and the user interface is seamless.
Highly recommend it to everyone!
Этот увлекательный информационный материал подарит вам массу новых знаний и ярких эмоций. Мы собрали для вас интересные факты и сведения, которые обогатят ваш опыт. Откройте для себя увлекательный мир информации и насладитесь процессом изучения!
Подробнее – https://www.peakrealestatenc.com/the-peak-report-peak-real-estate-nc-news-updates/the-peak-report-choosing-your-closing-attorney
кредит под залог автомобиля кемерово
24avtolombard-pts65.ru/kemerovo.html
кредит под залог птс автомобиля
Портал Львів https://u-misti.lviv.ua останні новини Львова и области.
Эта информационная заметка содержит увлекательные сведения, которые могут вас удивить! Мы собрали интересные факты, которые сделают вашу жизнь ярче и полнее. Узнайте нечто новое о привычных аспектах повседневности и откройте для себя удивительный мир информации.
Подробнее – https://mybestbox.shop/index.php/2023/04/09/boost-your-online-presence-our-top-digital-marketing
Magnificent goods from you, man. I’ve ujderstand your stuff previous to and you’re
just too great. I actually like what you’ve acquired
here, really like what you aree stating and the way in which
you say it. You make iit entertaining and you still care for to keep it smart.
I can’t wait too read much more from you. This is really a terrific
web site.
Feeel free to visit my homepage – socks5 proxies
сколько стоит игровой компьютер http://kupit-igrovoj-kompyuter2.ru .
В этой статье вы найдете познавательную и занимательную информацию, которая поможет вам лучше понять мир вокруг. Мы собрали интересные данные, которые вдохновляют на размышления и побуждают к действиям. Открывайте новую информацию и получайте удовольствие от чтения!
Исследовать вопрос подробнее – https://mallorcasustainablesummit.com/we-denounce-with-of-righteous-one-indignation-and-dislike-men
игровой компьютер цена в москве http://www.kupit-igrovoj-kompyuter2.ru .
Эта статья предлагает захватывающий и полезный контент, который привлечет внимание широкого круга читателей. Мы постараемся представить тебе идеи, которые вдохновят вас на изменения в жизни и предоставят практические решения для повседневных вопросов. Читайте и вдохновляйтесь!
Ознакомиться с деталями – https://www.eurospedizionivillasan.it/what-is-the-progressive-web-app-pwa-and-how-it-works
Этот интересный отчет представляет собой сборник полезных фактов, касающихся актуальных тем. Мы проанализируем данные, чтобы вы могли сделать обоснованные выводы. Читайте, чтобы узнать больше о последних трендах и значимых событиях!
Подробнее тут – https://brighthill.com.tw/?project=tote-bag-design-for-orange-land
купить игровой пк в рассрочку [url=kupit-igrovoj-kompyuter2.ru]kupit-igrovoj-kompyuter2.ru[/url] .
Эта статья предлагает уникальную подборку занимательных фактов и необычных историй, которые вы, возможно, не знали. Мы постараемся вдохновить ваше воображение и разнообразить ваш кругозор, погружая вас в мир, полный интересных открытий. Читайте и открывайте для себя новое!
Получить больше информации – http://platformafond.ru/2022/08/01/v-suhume-vo-vremja-raskopok-najdeny-pushki-xix-veka-vremen-russko-tureckoj-vojny
Логические типы указывают на разрыв между классом и его членами. Центрироваться и удерживать убеждения в более обширном поле ресурсов. Разработан Робертом Дилтсом в 1990-х годах. Пирамида Дилтса-Короткова. Логические уровни 2.0
Do you have a spam problem on this site; I also am a blogger, and I was wondering your situation; we
have created some nice practices and we are looking to trade solutions with other folks, please shoot me
an email if interested.
Howdy superb blog! Does running a blog similar to this take a large
amount of work? I have virtually no understanding of computer programming but I was hoping to start my own blog in the near future.
Anyway, if you have any suggestions or tips for new blog owners please share.
I know this is off topic but I just wanted to ask.
Cheers!
Сайт о строительстве https://solution-ltd.com.ua и дизайне: как построить, отремонтировать и оформить дом со вкусом.
Свежие новости https://ktm.org.ua Украины и мира: политика, экономика, происшествия, культура, спорт. Оперативно, объективно, без фейков.
Hi there, I read your new stuff on a regular basis. Your writing style is witty, keep
it up!
Эта информационная статья охватывает широкий спектр актуальных тем и вопросов. Мы стремимся осветить ключевые факты и события с ясностью и простотой, чтобы каждый читатель мог извлечь из нее полезные знания и полезные инсайты.
Углубиться в тему – https://deeplyzen.pt/logosite-2
Читайте авто блог https://autoblog.kyiv.ua обзоры автомобилей, сравнения моделей, советы по выбору и эксплуатации, новости автопрома.
Greetings, I’m Ivan from Croatia. I wanna tell you about my insane experience with
this unreal online casino I stumbled on recently.
To be honest, I was living paycheck to paycheck, and now I can’t believe
it myself — I crushed it and made $712,000 playing mostly crazy time!
Now I’m thinking of buying a boat here in Zagreb,
and investing a serious chunk of my winnings into Bitcoin.
Later I’ll probably move to a better neighborhood
and support my family.
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.
Tell me honestly, what would you guys do if you had this kinda luck?
Are you thinking “damn!” right now?
For real, I never thought I’d have a shot at investing.
It’s all happening so fast!
Let’s talk crypto too!
Авто портал https://real-voice.info для всех, кто за рулём: свежие автоновости, обзоры моделей, тест-драйвы, советы по выбору, страхованию и ремонту.
There’s certainly a great deal to learn about this subject.
I love all the points you have made.
Календарь стрижек https://n2000.ru .
купить игровой компьютер в москве http://kupit-igrovoj-kompyuter.ru .
История дня http://www.n2000.ru .
купить игровой компьютер купить игровой компьютер .
Today, I went to the beach front with my kids. I found a sea shell and
gave it to my 4 year old daughter and said “You can hear the ocean if you put this to your ear.” She put the shell
to her ear and screamed. There was a hermit crab inside and it pinched
her ear. She never wants to go back! LoL I know this is totally off topic but I had to tell someone!
Погода [url=http://www.n2000.ru]http://www.n2000.ru[/url] .
компьютеры в рассрочку [url=http://kupit-igrovoj-kompyuter.ru]http://kupit-igrovoj-kompyuter.ru[/url] .
В этой публикации мы обсуждаем современные методы лечения различных заболеваний. Читатели узнают о новых медикаментах, терапиях и исследованиях, которые активно применяются для лечения. Мы нацелены на то, чтобы предоставить практические знания, которые могут помочь в борьбе с недугами.
Выяснить больше – narkolog-na-dom
купить игровой компьютер в рассрочку http://www.kupit-igrovoj-kompyuter1.ru .
пк игровой http://kupit-igrovoj-kompyuter1.ru .
I am in fact grateful to the owner of this site
who has shared this fantastic paragraph at at this time.
займ под залог машины
24avtolombard-pts65.ru
автоломбард займ птс
I all the time used to study article in news papers but now as I am a
user of web thus from now I am using net for articles or reviews, thanks
to web.