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!
компания потолочкин натяжные потолки [url=https://natyazhnye-potolki-samara-2.ru]https://natyazhnye-potolki-samara-2.ru[/url] .
natyajnie potolki samara_kzPi
15 Oct 25 at 9:25 am
Эта информационная статья охватывает широкий спектр актуальных тем и вопросов. Мы стремимся осветить ключевые факты и события с ясностью и простотой, чтобы каждый читатель мог извлечь из нее полезные знания и полезные инсайты.
Продолжить чтение – https://salonparadiso.ro/ce-produse-include-categoria-de-orteza-corectoare-de-statica-a-piciorului
Stephencruib
15 Oct 25 at 9:25 am
visit the following page
PHP hook, building hooks in your application – Sjoerd Maessen blog at Sjoerd Maessen blog
visit the following page
15 Oct 25 at 9:26 am
купить диплом о высшем образовании с занесением в реестр владивосток [url=www.frei-diplom2.ru/]www.frei-diplom2.ru/[/url] .
Diplomi_xnEa
15 Oct 25 at 9:27 am
купить диплом матроса [url=https://rudik-diplom8.ru]купить диплом матроса[/url] .
Diplomi_hgMt
15 Oct 25 at 9:27 am
купить диплом с занесением в реестр цена [url=http://frei-diplom3.ru]купить диплом с занесением в реестр цена[/url] .
Diplomi_knKt
15 Oct 25 at 9:27 am
Secondary school math tuition іs important
fօr ʏour child, aligning post-PSLE skills ᴡith secondary demands.
Eh lor, Singapore ranks fіrst in math aroսnd thе ѡorld
lah!
Parents, objective visionary ᴡith Singapore math
tuition’s positioning. Secondary math tuition success envisions.
Enlist іn secondary 1 math tuition for patterns pattern.
Secondary 2 math tuition checks օut math in art history.
Secondary 2 math tuition decodes viewpoints. Cultural secondary 2
math tuition improves knowledge. Secondary 2 math tuition appreciates heritage.
Secondary 3 math exams ɑre essential, prior
tо О-Levels, underscoring diligence. Strong outcomes enable measurement conversions.
Іn Singapore, it supports analytical expertise.
Thｅ pivotal secondary 4 exams assist іn expat ease in Singapore.
Secondary 4 math tuition bridges differences. Ƭhis welcome help O-Level
integration. Secondary 4 math tuition adapts.
Ԝhile exams arе key, math οffers mоｒe as a vital competency іn the ΑI
era, driving advancements іn drone delivery.
Excelling іn math hinges օn developing а love fоr it and usіng mathematical principles in real-life everyday contexts.
Օne benefit is that it familiarizes students ᴡith the vocabulary սsed in secondary math questions aϲross Singapore
schools.
Utilizing online math tuition е-learning platforms ɑllows Singapore kids tо
join live webinars ᧐n exam strategies.
Cɑn sіa, Singapore dads chill аһ, secondary school builds character, no undue stress.
By linking mathematics t᧐ creative tasks, OMT stirs up a passion іn students,
motivating tһem tо embrace tһe subject and strive fоr examination mastery.
Ꮯhange mathematics obstacles іnto victories with OMT Math Tuition’s mix ⲟf online and on-site options, backeԁ bby
а track record ߋf trainee excellence.
Singapore’ѕ world-renowned mathematics curriculum emphasizes
conceptual understanding оver mere calculation, mɑking math tuition essential fߋr students tо comprehend deep concepts and master
national exams ⅼike PSLE and O-Levels.
Math tuition іn primary school bridges gaps іn class knowing, ensuring students grasp complicated subjects ѕuch as geometry and data
analysis Ьefore the PSLE.
Presеnting heuristic ɑpproaches early in secondary tuition prepares students f᧐r the non-routine
issues tһat frequently appear іn O Level evaluations.
Personalized junior college tuition assists connect tһe
space from O Level to A Level math, guaranteeing trainees adjust t᧐ the enhanced rigor and depth required.
Ƭhe originality ⲟf OMT hinges оn іtѕ customized educational
program tһat lines uρ flawlessly with MOE requirements wһile prеsenting innovative ρroblem-solving
strategies not commonly stressed іn classrooms.
Gamified aspects mɑke alteration enjoyable lor, motivating ｅven morе technique and гesulting
in grade improvements.
With evolving MOE guidelines, math tuition қeeps Singapore pupils
upgraded оn curriculum cһanges fⲟr examination readiness.
Αlso visit my web blog :: sec 2 maths paper
sec 2 maths paper
15 Oct 25 at 9:27 am
Wow, incredible blog layout! How long have you been blogging for?
you make blogging look easy. The overall look of your site is excellent, let
alone the content!
dewascatter login
15 Oct 25 at 9:28 am
Selamat datang ke E28BET Malaysia – Kemenangan Anda, Dibayar Sepenuhnya.
Sertai sekarang untuk bonus menarik, koleksi permainan terlengkap, dan pengalaman pertaruhan yang adil,
selamat, serta pantas.
E28BET Malaysia – Kemenangan Anda
15 Oct 25 at 9:29 am
диплом техникума купить в украине [url=https://frei-diplom11.ru]диплом техникума купить в украине[/url] .
Diplomi_jwsa
15 Oct 25 at 9:29 am
So long as the coffin is in the house,セックス ドールit must be watched overcontinually.
リアルドール
15 Oct 25 at 9:30 am
купить диплом по реестру [url=https://www.frei-diplom2.ru]купить диплом по реестру[/url] .
Diplomi_rsEa
15 Oct 25 at 9:31 am
купить диплом с реестром спб [url=http://www.frei-diplom3.ru]купить диплом с реестром спб[/url] .
Diplomi_taKt
15 Oct 25 at 9:32 am
Hello, i think that i saw you visited my web site thus i came to “return the favor”.I am trying to find things to enhance my
website!I suppose its ok to use some of your ideas!!
shower remodeling services
15 Oct 25 at 9:32 am
купить диплом с проводкой моего [url=www.frei-diplom5.ru]купить диплом с проводкой моего[/url] .
Diplomi_yhPa
15 Oct 25 at 9:32 am
Link few
fncamfhtz
15 Oct 25 at 9:33 am
купить диплом с внесением в реестр [url=http://rudik-diplom7.ru/]купить диплом с внесением в реестр[/url] .
Diplomi_luPl
15 Oct 25 at 9:33 am
エロ ロボットNeitherspoke; both looked quite “calm and firm,” and both felt desperatelyuncomfortable.
リアルドール
15 Oct 25 at 9:34 am
купить диплом занесением реестр отзывы [url=https://frei-diplom1.ru]купить диплом занесением реестр отзывы[/url] .
Diplomi_cuOi
15 Oct 25 at 9:34 am
натяжные потолки потолочкин отзывы [url=https://natyazhnye-potolki-samara-2.ru]https://natyazhnye-potolki-samara-2.ru[/url] .
natyajnie potolki samara_crPi
15 Oct 25 at 9:35 am
https://telegra.ph/Kupit-kollimator-na-ozone-10-12-3
RonaldZer
15 Oct 25 at 9:35 am
купить диплом в губкине [url=https://rudik-diplom6.ru]https://rudik-diplom6.ru[/url] .
Diplomi_hkKr
15 Oct 25 at 9:35 am
buy amoxil: order medicine discreetly USA – ZenCareMeds
Andresstold
15 Oct 25 at 9:35 am
купить диплом техникума в тамбове [url=https://www.frei-diplom9.ru]купить диплом техникума в тамбове[/url] .
Diplomi_ioea
15 Oct 25 at 9:35 am
купить диплом в челябинске [url=rudik-diplom2.ru]купить диплом в челябинске[/url] .
Diplomi_rbpi
15 Oct 25 at 9:36 am
купить диплом медсестры [url=www.frei-diplom13.ru]купить диплом медсестры[/url] .
Diplomi_ivkt
15 Oct 25 at 9:36 am
1win virtual idman [url=www.1win5005.com]www.1win5005.com[/url]
1win_osml
15 Oct 25 at 9:37 am
and bundles; and I am morallycertain that the spandy-new kitchen never _could_ have looked so coseyand neat if Hannah had not arranged every pot and pan a dozen timesover,リアル ラブドールand laid the fire all ready for lighting,
リアルドール
15 Oct 25 at 9:37 am
Эта публикация погружает вас в мир увлекательных фактов и удивительных открытий. Мы расскажем о ключевых событиях, которые изменили ход истории, и приоткроем завесу над научными достижениями, которые вдохновили миллионы. Узнайте, чему может научить нас прошлое и как применить эти знания в будущем.
Обратиться к источнику – https://eventos502.com/hello-world
Howardordef
15 Oct 25 at 9:40 am
Great article, totally what I needed.
독학기숙학원
15 Oct 25 at 9:41 am
купить диплом техникума в украине пять плюс [url=https://www.frei-diplom8.ru]купить диплом техникума в украине пять плюс[/url] .
Diplomi_ocsr
15 Oct 25 at 9:41 am
ラブドール アニメTANNE [opening it] I rather think Rhoda is heading for a row with As a rule there is only one person an English girl hates more than shehates her mother; and that’s her eldest sister.But Rhoda positivelyprefers her mother to She–[indignantly] I say! What’s the matter?TANNE Rhoda was to have come with me for a ride in the motor car.
リアルドール
15 Oct 25 at 9:41 am
купить диплом массажиста [url=http://www.rudik-diplom7.ru]купить диплом массажиста[/url] .
Diplomi_kjPl
15 Oct 25 at 9:42 am
https://www.slideshare.net/slideshow/1xbet-in-bonus-promo-code-bonus-up-to-33-000-pdf/283781712
ikzvhge
15 Oct 25 at 9:42 am
купить диплом техникума отзывы [url=http://www.frei-diplom9.ru]купить диплом техникума отзывы[/url] .
Diplomi_whea
15 Oct 25 at 9:43 am
купить диплом в новошахтинске [url=http://www.rudik-diplom2.ru]http://www.rudik-diplom2.ru[/url] .
Diplomi_kupi
15 Oct 25 at 9:43 am
купить диплом техникума с занесением пять плюс [url=www.frei-diplom11.ru/]купить диплом техникума с занесением пять плюс[/url] .
Diplomi_hpsa
15 Oct 25 at 9:43 am
медсестра которая купила диплом врача [url=frei-diplom13.ru]frei-diplom13.ru[/url] .
Diplomi_qfkt
15 Oct 25 at 9:43 am
купить диплом в батайске [url=https://rudik-diplom6.ru]https://rudik-diplom6.ru[/url] .
Diplomi_ssKr
15 Oct 25 at 9:44 am
купить диплом в рязани [url=www.rudik-diplom13.ru/]купить диплом в рязани[/url] .
Diplomi_ston
15 Oct 25 at 9:44 am
Эта информационная статья охватывает широкий спектр актуальных тем и вопросов. Мы стремимся осветить ключевые факты и события с ясностью и простотой, чтобы каждый читатель мог извлечь из нее полезные знания и полезные инсайты.
Проверенные методы — узнай сейчас – https://blackrosecomicspr.com/quod-asperiores-dolores-oignissimos
Richardnep
15 Oct 25 at 9:45 am
купить диплом в соликамске [url=https://rudik-diplom10.ru]купить диплом в соликамске[/url] .
Diplomi_eoSa
15 Oct 25 at 9:46 am
можно купить легальный диплом [url=https://frei-diplom1.ru/]https://frei-diplom1.ru/[/url] .
Diplomi_ymOi
15 Oct 25 at 9:46 am
купить диплом провизора [url=http://rudik-diplom7.ru/]купить диплом провизора[/url] .
Diplomi_kcPl
15 Oct 25 at 9:48 am
You could certainly see your expertise in the work you write.
The arena hopes for more passionate writers such as you who are not afraid to mention how they believe.
At all times go after your heart.
発電した以上を家計の消費電力から節約する
15 Oct 25 at 9:48 am
натяжной потолок потолочкин отзывы [url=https://natyazhnye-potolki-samara-2.ru/]natyazhnye-potolki-samara-2.ru[/url] .
natyajnie potolki samara_nwPi
15 Oct 25 at 9:49 am
купить диплом мед колледжа в красноярске [url=http://frei-diplom9.ru/]http://frei-diplom9.ru/[/url] .
Diplomi_zhea
15 Oct 25 at 9:49 am
купить медицинский диплом медсестры [url=https://www.frei-diplom13.ru]купить медицинский диплом медсестры[/url] .
Diplomi_xukt
15 Oct 25 at 9:49 am
диплом внесенный в реестр купить [url=www.frei-diplom2.ru]диплом внесенный в реестр купить[/url] .
Diplomi_viEa
15 Oct 25 at 9:50 am
купить диплом реестр [url=http://www.frei-diplom3.ru]купить диплом реестр[/url] .
Diplomi_jwKt
15 Oct 25 at 9:50 am