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!
It’s actually a nice and useful piece of info. I’m glad
that you shared this helpful information with us.
Please stay us informed like this. Thank you for sharing.
типография санкт петербург типография спб дешево
Приобрести диплом университета. Приобретение официального диплома через качественную и надежную компанию дарит ряд преимуществ для покупателя. Это решение позволяет сэкономить время и серьезные средства. orikdok-v-gorode-lipetsk-48.online
типография цены типография спб
металлический значок пин значки металлические купить
спросить юриста онлайн юридическая консультация онлайн круглосуточно
It is appropriate time to make a few plans for the future and it’s time to be
happy. I’ve read this publish and if I could I desire to suggest you few attention-grabbing things or suggestions.
Maybe you can write next articles referring to
this article. I want to learn more things approximately it!
вавада казино официальный рабочее зеркало на сегодняшний день Вавада Казино Официальный Сайт Вход
вопрос юристу с ответом юристы в Москве бесплатно круглосуточно
Заказать диплом университета. Приобретение документа о высшем образовании через качественную и надежную фирму дарит ряд плюсов для покупателя. Такое решение дает возможность сберечь время и существенные финансовые средства. [url=http://orikdok-5v-gorode-samara-63.online/]orikdok-5v-gorode-samara-63.online[/url]
excellent post, very informative. I’m wondering why the opposite specialists of this sector
don’t notice this. You should continue your writing.
I’m sure, you’ve a great readers’ base already!
Когда я увидел эту платформу, чувство было таким, будто я нашёл что-то особенное. Здесь каждая игра — это не просто азарт, а история, которую ты ощущаешь с каждым движением.
Дизайн интуитивен, словно ветер судьбы направляет тебя от игры к игре. Транзакции, будь то депозиты или вывод средств, проходят быстро, как поток воды, и это удивляет. А служба помощи всегда отвечает мгновенно, как друг, который никогда не подведёт.
Для меня Казино селектор стал пространством, где игра и вдохновение соединяются. Здесь каждый момент — это часть истории, которую хочется переживать снова и снова.
Суши на дом Челябинск
Гороскоп topoland.ru .
типография петербург типография спб
“I’ve tried a few binaural beat apps before, but The Memory Wave feels way
more intentional and focused. After just a week, I’m already noticing
better concentration during work. The science behind it
is fascinating—great breakdown in the video!”
печать спб типография типография
Когда я увидел этот мир, впечатление было таким, будто я нашёл что-то особенное. Здесь каждая игра — это не просто азарт, а эмоция, которую ты ощущаешь с каждым движением.
Интерфейс удобен, словно невидимый проводник направляет тебя от выбора к выбору. Финансовые движения, будь то депозиты или выплаты, проходят быстро, как поток воды, и это удивляет. А служба помощи всегда рядом, как верный помощник, который никогда не разочарует.
Для меня Селектор онлайн стал местом, где удовольствие и смысл соединяются. Здесь каждая минута — это часть пути, которую хочется переживать снова и снова.
металлический значок пин производство металлических значков
Пронедра https://topoland.ru .
Stream live Cricket events online. Stay updated with upcoming matches,
highlights, and schedules. Join the excitement with
E2BET today!
rent a car
Сервис по подбору психолога batmanapollo.ru 485 оценок
What i do not understood is actually how you are not actually a lot more well-favored than you might
be now. You are so intelligent. You understand therefore considerably with regards
to this matter, produced me for my part believe
it from a lot of numerous angles. Its like men and women don’t
seem to be involved unless it is something to do with
Lady gaga! Your individual stuffs outstanding. At all
times handle it up!
мостбет официальный сайт скачать http://mostbet11027.ru
Wow! Finally I got a web site from where I be capable of really obtain useful
data regarding my study and knowledge.
займ под птс автомобиля новосибирск
zaimpod-pts91.ru/nsk.html
деньги под птс новосибирск
Muy bueno este artículo, me atrapó. En mi blog hay
más curiosidades: chusmeando.com https://www.chusmeando.com
войти мостбет войти мостбет
Когда я впервые открыл этот мир, чувство было таким, будто я нашёл что-то особенное. Здесь каждая ставка — это не просто волнение, а эмоция, которую ты открываешь с каждым движением.
Дизайн создан для комфорта, словно ветер судьбы направляет тебя от момента к моменту. Операции, будь то пополнения или выплаты, проходят быстро, как поток воды, и это удивляет. А техподдержка всегда отвечает мгновенно, как друг, который никогда не оставит.
Для меня Селектор стал местом, где азарт и искусство переплетаются. Здесь каждый момент — это часть пути, которую хочется создавать снова и снова.
http://shiba-akita.ru/ – разбор физиологии и эмоций при головокружении в необычных местах
car rental
заказать суши запеченные роллы
mostbwt https://mostbet11025.ru/
бк мост бет http://mostbet11027.ru
Do you have any video of that? I’d care to find out some additional information.
быстрая регистрация на мостбет https://mostbet11025.ru/
мостбет официальный сайт http://mostbet11028.ru/
Когда я зашёл на этот мир, чувство было таким, будто я переступил грань реальности. Здесь каждая игра — это не просто шанс, а история, которую ты открываешь с каждым движением.
Интерфейс интуитивен, словно невидимый проводник направляет тебя от игры к игре. Транзакции, будь то депозиты или вывод средств, проходят легко, как поток воды, и это завораживает. А служба помощи всегда готова подхватить, как верный помощник, который никогда не оставит.
Для меня Селектор онлайн стал пространством, где игра и вдохновение переплетаются. Здесь каждая минута — это часть картины, которую хочется переживать снова и снова.
Hi! I could have sworn I’ve been to this site before but
after browsing through many of the articles I realized
it’s new to me. Anyways, I’m definitely delighted I found it and I’ll be bookmarking it and checking back often!
Народные приметы https://istoriamashin.ru .
Hello, There’s no doubt that your web site
could possibly be having web browser compatibility issues.
When I take a look at your blog in Safari, it looks fine however, if opening
in IE, it has some overlapping issues. I merely wanted to give you a quick
heads up! Apart from that, excellent site!
печать спб типография типография спб дешево
Hello to all, it’s really a fastidious for me to go to see this
web site, it consists of valuable Information.
mostbet скачат http://mostbet11028.ru/
מביטה בי בזמן שהוא מנשק את בטנה, ובעיניה יש תערובת של אתגר והנאה. קטיה כבר התפשטה לגמרי, יעבור. זהו זה. הייתי רוצה לדעת ממה זה יכול לנבוע. לא מצאת את זה בספרים? הבחור חשב. ואיכשהו שירותי סקס
типография заказать типография официальный сайт
Приобрести диплом института по доступной цене вы можете, обращаясь к проверенной специализированной фирме. Приобрести документ ВУЗа вы можете у нас. orikdok-1v-gorode-yoshkar-ola-12.ru
Лунный календарь http://www.inforigin.ru .
Календарь стрижек http://www.inforigin.ru .