PHP hook, building hooks in your application
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!
кафет нет торрент Фильмы 2023 скачать торрент Переживите заново эмоции от просмотра лучших фильмов 2023 года! На нашем сайте вы найдете широкий выбор кинокартин, которые покорили сердца зрителей в прошлом году. Мы предлагаем скачать фильмы 2023 торрент в высоком качестве, чтобы вы могли наслаждаться просмотром любимых фильмов в отличном качестве. У нас вы найдете фильмы различных жанров: от захватывающих экшенов и фантастических саг до трогательных мелодрам и комедийных историй. Наша коллекция постоянно пополняется, поэтому вы всегда сможете найти что-то интересное для себя. Благодаря удобной системе поиска и фильтрации вы легко сможете найти нужный фильм по названию, жанру, году выпуска, рейтингу и другим критериям. Скачивайте фильмы 2023 торрент быстро и безопасно с нашего сайта! Мы гарантируем высокое качество файлов и отсутствие вирусов. Наслаждайтесь просмотром лучших фильмов 2023 года в любое время и в любом месте!
Raymondcoedo
14 Oct 25 at 11:21 pm
купить диплом в кемерово [url=www.rudik-diplom14.ru]купить диплом в кемерово[/url] .
Diplomi_zqea
14 Oct 25 at 11:21 pm
Appreciate this post. Let me try it out.
data sydney paito lengkap
14 Oct 25 at 11:21 pm
Hello just wanted to give you a quick heads up.
The text in your content seem to be running off the screen in Firefox.
I’m not sure if this is a format issue or something to
do with web browser compatibility but I figured I’d post to let you know.
The design and style look great though! Hope you get the problem
solved soon. Cheers
fairly well
14 Oct 25 at 11:21 pm
натяжной потолок в самаре [url=www.stretch-ceilings-samara.ru/]www.stretch-ceilings-samara.ru/[/url] .
natyajnie potolki samara_fxkl
14 Oct 25 at 11:22 pm
самара натяжные потолки [url=https://natyazhnye-potolki-samara-2.ru]самара натяжные потолки[/url] .
natyajnie potolki samara_ohPi
14 Oct 25 at 11:23 pm
купить медицинский диплом с занесением в реестр [url=frei-diplom3.ru]купить медицинский диплом с занесением в реестр[/url] .
Diplomi_fgKt
14 Oct 25 at 11:25 pm
Для оказания полноценной помощи вне стен клиники специалисты «ТверьМед» используют портативные устройства: инфузоматы, ЭКГ-мониторы, глюкометры, пульсоксиметры, небулайзеры и наборы медикаментов. Все врачи обучены работе в полевых условиях и готовы к экстренным ситуациям. Отдельное внимание уделяется стерильности и безопасности: используются одноразовые расходники, врач носит маску, перчатки и защитный халат. При необходимости на выезд направляется параллельно медсестра или ассистент с расширенным функционалом.
Узнать больше – [url=https://narkologicheskaya-pomoshh-tver0.ru/]оказание наркологической помощи тверь[/url]
DavidTop
14 Oct 25 at 11:25 pm
Excellent article. I am facing a few of these issues as
well..
Dravexoly
14 Oct 25 at 11:26 pm
потолочник натяжные потолки [url=www.natyazhnye-potolki-samara-1.ru]www.natyazhnye-potolki-samara-1.ru[/url] .
natyajnie potolki samara_cuor
14 Oct 25 at 11:27 pm
купить диплом техникума с занесением в реестр форум [url=http://frei-diplom8.ru/]купить диплом техникума с занесением в реестр форум[/url] .
Diplomi_rwsr
14 Oct 25 at 11:28 pm
отзывы потолочкин натяжные потолки [url=https://stretch-ceilings-samara-1.ru/]stretch-ceilings-samara-1.ru[/url] .
natyajnie potolki samara_tksl
14 Oct 25 at 11:28 pm
купить диплом в балашихе [url=https://rudik-diplom15.ru/]купить диплом в балашихе[/url] .
Diplomi_xhPi
14 Oct 25 at 11:28 pm
натяжной потолок потолочкин отзывы [url=http://www.natyazhnye-potolki-samara-2.ru]http://www.natyazhnye-potolki-samara-2.ru[/url] .
natyajnie potolki samara_luPi
14 Oct 25 at 11:31 pm
диплом колледжа купить в липецке [url=www.frei-diplom11.ru/]www.frei-diplom11.ru/[/url] .
Diplomi_nwsa
14 Oct 25 at 11:32 pm
What’s up to all, how is all, I think every one is getting more from this
website, and your views are good for new users.
online casino norges
14 Oct 25 at 11:32 pm
цены на натяжные потолки в самаре [url=https://natyazhnye-potolki-samara-1.ru]https://natyazhnye-potolki-samara-1.ru[/url] .
natyajnie potolki samara_jhor
14 Oct 25 at 11:33 pm
потолочник натяжные потолки отзывы [url=https://www.stretch-ceilings-samara.ru]https://www.stretch-ceilings-samara.ru[/url] .
natyajnie potolki samara_xfkl
14 Oct 25 at 11:33 pm
купить диплом эколога [url=www.rudik-diplom14.ru/]www.rudik-diplom14.ru/[/url] .
Diplomi_mmea
14 Oct 25 at 11:35 pm
В клинике «СамарМед» доступно несколько форм лечения: стационарная программа, дневной стационар, амбулаторное наблюдение и гибридные схемы. Пациенты могут выбрать комфортный вариант в зависимости от степени зависимости, текущего состояния и занятости. Внутри стационара предусмотрены как стандартные палаты, так и индивидуальные блоки повышенной комфортности с возможностью проживания совместно с сопровождающим лицом.
Исследовать вопрос подробнее – [url=https://narkologicheskaya-klinika-samara0.ru/]вывод наркологическая клиника в самаре[/url]
WilliamDer
14 Oct 25 at 11:37 pm
цены на натяжные потолки в самаре [url=stretch-ceilings-samara-1.ru]цены на натяжные потолки в самаре[/url] .
natyajnie potolki samara_vvsl
14 Oct 25 at 11:37 pm
wetten com bonus bedingungen
My web site: online sportwetten schweiz [Ahmad]
Ahmad
14 Oct 25 at 11:38 pm
https://tecvolution.com/hola-mundo/
Marcella Lanphier
14 Oct 25 at 11:39 pm
Experience the latest Nuru massage techniques at Hiso Nuru Massage in Bangkok.
Enjoy sensual, body-to-body therapy in a clean, private, and
luxurious setting. Perfect for ultimate relaxation and an unforgettable erotic experience.
exclusive massage Bangkok
14 Oct 25 at 11:39 pm
где купить диплом техникума в екатеринбурге [url=https://frei-diplom10.ru/]где купить диплом техникума в екатеринбурге[/url] .
Diplomi_uaEa
14 Oct 25 at 11:39 pm
https://telegra.ph/Benzogenerator-yamaha-55-cena-kupit-10-13-2
RonaldZer
14 Oct 25 at 11:41 pm
Hey there would you mind stating which blog platform you’re working with?
I’m looking to start my own blog soon but I’m having a difficult time choosing between BlogEngine/Wordpress/B2evolution and
Drupal. The reason I ask is because your design seems different then most blogs and I’m looking for something completely unique.
P.S Apologies for being off-topic but I had to ask!
ZynerixPro
14 Oct 25 at 11:42 pm
потолочкин ру натяжные потолки отзывы [url=stretch-ceilings-samara.ru]stretch-ceilings-samara.ru[/url] .
natyajnie potolki samara_zvkl
14 Oct 25 at 11:43 pm
потолочкин потолки [url=www.stretch-ceilings-samara-1.ru]www.stretch-ceilings-samara-1.ru[/url] .
natyajnie potolki samara_eisl
14 Oct 25 at 11:43 pm
потолочкин отзывы самара [url=www.natyazhnye-potolki-samara-1.ru]www.natyazhnye-potolki-samara-1.ru[/url] .
natyajnie potolki samara_kdor
14 Oct 25 at 11:44 pm
что будет если купить диплом о высшем образовании с занесением в реестр [url=http://frei-diplom1.ru]что будет если купить диплом о высшем образовании с занесением в реестр[/url] .
Diplomi_lfOi
14 Oct 25 at 11:44 pm
где купить диплом [url=http://rudik-diplom2.ru/]где купить диплом[/url] .
Diplomi_lkpi
14 Oct 25 at 11:44 pm
натяжной потолок самара [url=http://natyazhnye-potolki-samara-2.ru]натяжной потолок самара[/url] .
natyajnie potolki samara_dnPi
14 Oct 25 at 11:48 pm
Do you have a spam problem on this site; I also am a blogger, and I was wondering your situation; we have developed some nice procedures and we are looking to exchange
techniques with others, please shoot me an e-mail if interested.
Numerous
14 Oct 25 at 11:48 pm
потолочкин натяжные потолки самара отзывы клиентов [url=https://www.stretch-ceilings-samara-1.ru]https://www.stretch-ceilings-samara-1.ru[/url] .
natyajnie potolki samara_vfsl
14 Oct 25 at 11:50 pm
потолочкин натяжные потолки отзывы [url=https://natyazhnye-potolki-samara-1.ru/]natyazhnye-potolki-samara-1.ru[/url] .
natyajnie potolki samara_apor
14 Oct 25 at 11:52 pm
I’m gone to tell my little brother, that he should also pay
a visit this weblog on regular basis to take updated from newest information.
Lucent Markbit
14 Oct 25 at 11:52 pm
купить диплом ссср [url=http://www.rudik-diplom9.ru]купить диплом ссср[/url] .
Diplomi_bvei
14 Oct 25 at 11:52 pm
потолочкин отзывы самара [url=www.stretch-ceilings-samara.ru]www.stretch-ceilings-samara.ru[/url] .
natyajnie potolki samara_rwkl
14 Oct 25 at 11:53 pm