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://x.com/SvetlnaKr2/status/1914979083215143220
Внимание желающим совершить хадж! Саудовская Аравия вводит новые требования
https://x.com/VladimirKorlv/status/1914981813371420891
Prada replica designer bags
Брак по миллиардерски: 10 богатейших людей, которые были женаты минимум дважды https://x.com/VladimirKorlv/status/1914987016590184894
Искусственный интеллект против рака: новый алгоритм выявляет слабости опухолей https://x.com/VladimirKorlv/status/1915000921911607661
fake Chanel bag
fake prada bag
Bottega Veneta fake designer bags
Louis Vuitton bag replica
The Real Reason Brad Pitt Didn’t Propose to Ines de Ramon
https://x.com/DeyanetKrmv/status/1915105660921925817
Археологи впервые нашли прямое доказательство боя гладиатора со львом
https://x.com/NargisEhme94100/status/1915117771332989198
Гороскоп профессий будущего: кем ты станешь через 10 лет
https://x.com/SebiBilalova/status/1915121426014601624
Chanel replica designer bags
fake Louis Vuitton bag
Prada replica designer bags
Louis Vuitton bag replica
Celine replica designer bags
Gucci replica designer bags
Земля перегревается: катастрофическая жара уже начинается https://x.com/VladimirKorlv/status/1915325170564124811
Какие болезни подстерегают знаков зодиака? https://x.com/VladimirKorlv/status/1915332303091310617
Стало известно, почему нельзя жарить яичницу на подсолнечном масле https://x.com/SvetlnaKr2/status/1915332897734639863
Эти фрукты и овощи нельзя хранить вместе, и вот почему https://x.com/SvetlnaKr2/status/1915339502568026245
Земля «уходит в себя»: в США обнаружено редкое геофизическое явление https://x.com/VladimirKorlv/status/1915351914910196019
Деми Мур о родах дочери: «Я не знала, выживет ли она» https://x.com/SvetlnaKr2/status/1915363178596192760
Звезда фильмов для взрослых умер в 32 года из-за бычьего сердца https://x.com/VladimirKorlv/status/1915377307272851738
Звёздный прогноз на выходные 26–27 апреля: какие знаки зодиака окажутся на волне успеха? https://x.com/VladimirKorlv/status/1915394801903579597
Найден вирус, помогающий в борьбе с раком кожи https://x.com/SvetlnaKr2/status/1915424574017081650
купить права
На какие болезни указывает сухость губ? https://x.com/SvetlnaKr2/status/1915671255912517786
Звезда эротического кино Эрих Томек умер на 95-м году жизни https://x.com/SvetlnaKr2/status/1915676657123221900
NWL: Загадочная субстанция в кишечнике дельфина привела к его гибели у берегов Великобритании https://x.com/VladimirKorlv/status/1915683063213760707
В Японии растет число заразившихся этой инфекцией https://x.com/VladimirKorlv/status/1915692533310513246
Менингит: чем опасна болезнь и кто в группе риска https://x.com/YuliaGrigoreva_/status/1915697311188996349
Врач рассказала, как шашлыки могут провоцировать рак https://x.com/YuliaGrigoreva_/status/1915700704858996772
Найдена экзопланета в девять раз тяжелее Земли https://x.com/YuliaGrigoreva_/status/1915718179151642835
В пещере Веревкина обнаружили неизвестную форму жизни в подземном озере https://x.com/YuliaGrigoreva_/status/1915745229845524828
Назван предвестник инфаркта у мужчин
https://x.com/SebiBilalova/status/1915850902616891400
Почему человечество до сих пор не встретило внеземную жизнь: мнение учёных
https://x.com/NargisEhme94100/status/1915856834822316303
В России успешно испытали биоаналог препарата против 11 видов рака
https://x.com/DeyanetKrmv/status/1915858811593646236
Ешь и Худей: 10 Лёгких Рецептов для Красивого Тела
https://x.com/SebiBilalova/status/1915869218303524932
Самый опасный напиток для здоровья — и это не алкоголь
https://x.com/NargisEhme94100/status/1915872132766064887
https://warehousenews.co.uk/2/
https://www.domestika.org/pt/projects/1749593-my-project-for-course-cursive-lettering-for-logos
https://iohanes.com/blog/remedios-caseros/te-de-cascara-de-mandarina/
http://www.rtinetwork.org/rti-blog/entry/1/135
Российский музыкант признан иноагентом
https://x.com/SebiBilalova/status/1916016188536000877
рейтинг казино
Первое, что необходимо сделать игроку создать учетную запись. Удобная навигация возможность быстро и точно находить видеоигры по интересам. Деньги или фриспины без отыгрыша за регистрацию с выводом. Совершая ставки на сумму 10 рублей и более (независимо от выбранной игры) гемблер участвует в розыгрыше крупного приза. Olympian Gods. Фpиcпины бeз дeпoзитa. Впечатляет, которая поможет читателю лучше понять бонусы: как они работают и как их можно использовать в полной мере. 000 рублей. Макс. Если вы выиграете, став клиентом 1xSlots.
Source:
рейтинг казино
Илон Маск чипировал первого в мире человека с БАС https://x.com/YuliaGrigoreva_/status/1916771449928356286
Здоровье глаз молодых людей оказалось под угрозой https://x.com/YuliaGrigoreva_/status/1916772498558865547
Тип белка не влияет на рост мышц: ученые опровергли популярный миф https://x.com/YuliaGrigoreva_/status/1916786790796562854