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 дней
– Любая специальность
Уже более 4688 клиентов воспользовались услугой — теперь ваша очередь.
По ссылке — ответим быстро, без лишних формальностей.
аккаунты варфейс купить Желание ворваться в динамичный мир Warface, облаченным в крутую броню и с арсеналом новейшего оружия, вполне понятно. Покупка игры – это ваш пропуск в захватывающие PvP-сражения и кооперативные миссии, где командная работа и тактическое мышление – залог победы. Аккаунт Варфейс
Психотерапевт Киров. Психотерапевт Челны. 686 оценок
цена вакуумного водопонижения цена вакуумного водопонижения .
I do not know if it’s just me or if perhaps everybody
else encountering issues with your website.
It appears like some of the text in your posts are running
off the screen. Can somebody else please provide feedback and let me know if this is happening to them too?
This could be a issue with my web browser because I’ve had this happen previously.
Thanks
Оформиление дипломов ВУЗов по всей России и СНГ — с печатями, подписями, приложением и возможностью архивной записи (по запросу).
Документ максимально приближен к оригиналу и проходит визуальную проверку.
Мы гарантируем, что в случае проверки документа, подозрений не возникнет.
– Конфиденциально
– Доставка 3–7 дней
– Любая специальность
Уже более 923 клиентов воспользовались услугой — теперь ваша очередь.
[url=http://spbrcom9.ru/]На сайте[/url] — ответим быстро, без лишних формальностей.
строительное водопонижение строительное водопонижение .
автоломбард птс
zaimpod-pts89.ru/kazan.html
автомобиль под залог
смета на водопонижение иглофильтрами [url=http://aktivnoe.forum24.ru/?1-9-0-00001177-000-0-0-1750678964]смета на водопонижение иглофильтрами[/url] .
деньги под залог птс машины
zaimpod-pts89.ru/nsk.html
кредит под залог птс
I every time used to read paragraph in news papers but now as I am a user of net thus
from now I am using net for content, thanks to web.
Good day! I know this is kinda off topic but I’d figured I’d
ask. Would you be interested in exchanging links or maybe guest authoring a blog post
or vice-versa? My site goes over a lot of the same topics as yours and I believe
we could greatly benefit from each other. If you’re interested feel free to send me an email.
I look forward to hearing from you! Wonderful blog by the way!
If you would like to increase your familiarity simply keep visiting this web page and be updated with the most recent news update posted here.
of course like your web-site however you have to check the
spelling on several of your posts. Several of them are rife with spelling problems and I find it very bothersome to inform the truth nevertheless I
will certainly come back again.
I have been browsing on-line greater than 3 hours these days, yet I by no means
discovered any interesting article like yours.
It is pretty price sufficient for me. In my view, if all webmasters and bloggers
made just right content as you probably did, the web will probably be
a lot more useful than ever before.
Wow! At last I got a weblog from where I be able to really
take helpful data regarding my study and knowledge. queboi https://queboi.com
Бездепозитный бонус в казино Бездепозитные бонусы – это магнит для новых игроков в онлайн-казино, словно обещанный клад на необитаемом острове азарта. Они позволяют сделать первые шаги, не рискуя собственным кошельком, и окунуться в мир вращающихся барабанов, карточных комбинаций и головокружительных возможностей. Это шанс испытать удачу, не платя за билет, и, возможно, сорвать джекпот, о котором даже не мечтал. Бездепозитные бонусы в казино
мостбет вход через соцсети [url=https://mostbet11004.ru/]https://mostbet11004.ru/[/url]
мосвет казино [url=https://mostbet4020.ru]мосвет казино[/url]
Hello to all, the contents present at this web page are truly awesome for people knowledge, well, keep up the good work fellows.
Excellent website. A lot of useful information here.
I am sending it to some friends ans additionally sharing in delicious.
And of course, thanks to your sweat!
скачать официальное приложение мостбет скачать официальное приложение мостбет
Thanks for sharing your info. I truly appreciate your effortts and
I am waiting for your further write ups thank you once again.
888starz bet скачать на андроид 888starz bet скачать на андроид .
888 starz сайт 888 starz сайт .
888starz скачать на айфон бесплатно 888starz скачать на айфон бесплатно .
Just desire to say your article is as astounding. The clearness
in your post is just spectacular and i could assume you are an expert on this subject.
Well with your permission let me to grab your RSS feed to
keep up to date with forthcoming post. Thanks a million and please carry on the enjoyable work.
This is the perfect web site for anyone who really wants to
find out about this topic. You know so much its almost
tough to argue with you (not that I really would want to…HaHa).
You certainly put a brand new spin on a subject that has been discussed for years.
Excellent stuff, just wonderful!
мосвет казино [url=http://mostbet11008.ru/]мосвет казино[/url]
888 stars скачать на андроид [url=http://888starz-starz888.ru]http://888starz-starz888.ru[/url] .
888starz скачать на андроид телефон бесплатно 888starz скачать на андроид телефон бесплатно .
мостбет скачать бесплатно https://mostbet4020.ru/
mostbet.com что это https://mostbet11007.ru
изготовление значков из металла на заказ москва изготовление значков из металла на заказ москва .
казино беларусь казино беларусь .
изготовление значков из металла на заказ изготовление значков из металла на заказ .
Лучшие онлайн-курсы https://topkursi.ru по востребованным направлениям: от маркетинга до программирования. Учитесь в удобное время, получайте сертификаты и прокачивайте навыки с нуля.
Репетитор по физике https://repetitor-po-fizike-spb.ru СПб: школьникам и студентам, с нуля и для олимпиад. Четкие объяснения, практика, реальные результаты.
казино онлайн казино онлайн .
скачать приложения 888 starz [url=http://888starz-starz888.ru]http://888starz-starz888.ru[/url] .
Школа Саморазвития https://bznaniy.ru онлайн-база знаний для тех, кто хочет понять себя, улучшить мышление, прокачать навыки и выйти на новый уровень жизни.
памятные значки на заказ памятные значки на заказ .
пин на заказ [url=https://znacki-na-zakaz1.ru/]znacki-na-zakaz1.ru[/url] .
казино онлайн [url=http://kazino-online-rb.by/]казино онлайн[/url] .
памятные значки на заказ памятные значки на заказ .
займ под птс екатеринбург
zaimpod-pts90.ru/ekb.html
займ под птс екатеринбург
металлические значки [url=www.znacki-na-zakaz2.ru]металлические значки[/url] .
срочный кредит под залог птс
zaimpod-pts89.ru/kemerovo.html
займ под птс авто
заказать водопонижение иглофильтрами заказать водопонижение иглофильтрами .
mostbet.com вход http://mostbet4020.ru/