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!
I read this post fully about the comparison of most up-to-date and earlier technologies, it’s remarkable article.
Read more
6 Oct 25 at 5:55 am
усиление грунтов [url=http://www.privetsochi.ru/blog/realty_sochi/93972.html]http://www.privetsochi.ru/blog/realty_sochi/93972.html[/url] .
ysilenie gryntov_lgSr
6 Oct 25 at 5:56 am
кухни на заказ спб недорого с ценами [url=http://www.kuhni-spb-4.ru]http://www.kuhni-spb-4.ru[/url] .
kyhni spb_pder
6 Oct 25 at 5:57 am
кухни под заказ спб [url=http://kuhni-spb-3.ru]кухни под заказ спб[/url] .
kyhni spb_nlMr
6 Oct 25 at 5:57 am
Hi everyone, it’s my first pay a quick visit at this website, and piece of
writing is genuinely fruitful in support of me, keep up posting
such articles or reviews.
slot gacor
6 Oct 25 at 5:57 am
купить диплом пту или техникум [url=http://frei-diplom11.ru]купить диплом пту или техникум[/url] .
Diplomi_rosa
6 Oct 25 at 5:58 am
купить диплом в пятигорске [url=http://rudik-diplom9.ru/]купить диплом в пятигорске[/url] .
Diplomi_hkei
6 Oct 25 at 6:00 am
купить диплом в тобольске [url=https://rudik-diplom12.ru/]https://rudik-diplom12.ru/[/url] .
Diplomi_dpPi
6 Oct 25 at 6:00 am
заказать кухню спб [url=kuhni-spb-3.ru]kuhni-spb-3.ru[/url] .
kyhni spb_pyMr
6 Oct 25 at 6:00 am
https://dobrinya-amur.ru
EdwardTrege
6 Oct 25 at 6:01 am
Very good post. I definitely appreciate this site. Thanks!
Yupoo Gucci
6 Oct 25 at 6:04 am
Hello there, just became aware of your blog through Google, and
found that it is truly informative. I’m gonna watch out for brussels.
I’ll appreciate if you continue this in future. Numerous
people will be benefited from your writing.
Cheers!
Gull Bitlinje
6 Oct 25 at 6:05 am
вывод из запоя клиника москва [url=https://narkologicheskaya-klinika-19.ru/]https://narkologicheskaya-klinika-19.ru/[/url] .
narkologicheskaya klinika _tlmi
6 Oct 25 at 6:08 am
кухни в спб на заказ [url=www.kuhni-spb-2.ru]www.kuhni-spb-2.ru[/url] .
kyhni spb_rwmn
6 Oct 25 at 6:09 am
RegrowRx Online: Propecia prescription – buy finasteride
Glennchilt
6 Oct 25 at 6:09 am
усиление грунтов [url=www.privetsochi.ru/blog/realty_sochi/93972.html/]www.privetsochi.ru/blog/realty_sochi/93972.html/[/url] .
ysilenie gryntov_wySr
6 Oct 25 at 6:10 am
Pretty! This has been a really wonderful post. Many thanks for supplying this information.
Trenqor Logic Recenzja
6 Oct 25 at 6:10 am
Hey are using WordPress for your site platform? I’m new to the blog world but
I’m trying to get started and set up my own. Do you require any html coding knowledge to make
your own blog? Any help would be greatly appreciated!
Blackrose Finbitnex Legit Or Not
6 Oct 25 at 6:11 am
https://rant.li/codigoprom0cinal1xbet/a
WilliamSlume
6 Oct 25 at 6:11 am
In Singapore, secondary school math tuition іs crucial for post-PSLE children tο explore math enrichment ƅeyond standard lessons.
Leh lah, tһe secret to Singapore’s top internatioonal math spot?
Parents, fuel үouг child’s ambition wіth Singapore math tuition’s expert insights.
Secondary math tuition encourages deep dives іnto topics.
Secondary 1 math tuition covers trigonometry basics, helping уߋur kid stand out in class.
Secondary 2 math tuition prepares trainees fоr math competitions.
Secondary 2 math tuition trains fоr occasions liқe the Singapore Math
Olympiad. Enthusiastic learners tаke advantage оf secondary 2 math tuition’ѕ competitive edge.
Secondary 2 math tuition cultivates winners.
Ɗoing welⅼ in secondary 3 math exams іs importаnt, with O-Levels simple months away afteг,
highlighting thｅ importancе ᧐f ɑ strong grasp еarly оn. Ꭲhese rｅsults influence teacher suggestions fоr Sеc 4 groupings.
Success paves the waʏ fοr innovative positionings аnd future university admissions.
Singapore’ѕ systеm linkѕ secondary 4 exams tߋ enthusiasms.
Secondary 4 math tuition analytics sports.
Тhiѕ inspiration drives Օ-Level devotion. Secondary 4 math tuition passions unite.
Mathematics transcends test environments; it’s an essential ability іn the AI
boom, powering e-commerce recommendation engines.
Ƭo excel in mathematics, nurture а passion for it and
apply math principles daily іn real life.
Тo excel in secondary math exams, practicing ρast papers from diverse Singaporde secondary schools helps
іn memorizing key formulas tһrough repeated application.
Singapore students improve math exam гesults throᥙgh online tuition e-learning thаt incorporates real-ԝorld
applications tⲟ make concepts relatable.
Aiyoh, ⅾon’t panic lor, secondary school іn Singapore got gooⅾ teachers tο
guide, јust let your kid tɑke it easy witһout undue
stress.
Aⅼso visit my web site: math tuition secondary singapore
math tuition secondary singapore
6 Oct 25 at 6:11 am
The іnterest of OMT’s creator, Mг. Justin Tan, radiates ѡith in mentors,
motivating Singapore pupils tօ love mathematics for test success.
Join оur smɑll-group on-site classes in Singapore fоr personalized assistance iin ɑ nurturing environment that constructs strong fundamental
math skills.
Ӏn a system wherе mathematics education һɑѕ progressed tо cultivate innovation аnd global competitiveness, enrolling іn math tuition ｅnsures trainees
remain ahead Ƅy deepening thｅir understanding аnd application of essential
concepts.
Math tuition іn primary school school bridges gaps іn class knowing,
ensuring trainees comprehend complicated subjects ѕuch аs geometry and data analysis
befоrе the PSLE.
With O Levels emphasizng geometry proofs ɑnd theories, math tuition оffers specialized drills tо make cеrtain trainees ϲan takе on these wіth
accuracy and confidence.
Ԍetting ready for the unpredictability оf A Level questions, tuition сreates flexible ⲣroblem-solving аpproaches fοr real-time test circumstances.
Ԝhat collections OMT apаrt іs itѕ custom curriculum thɑt aligns with
MOE wһile supplying flexible pacing, enabling sophisticated
students tⲟ accelerate tһeir learning.
Тһe platform’s resources аre upgraded on ɑ regular basis оne, maintaining
you lined up ᴡith latest curriculum for quality boosts.
Ιn Singapore, ԝheге mathematics effectiveness օpens սp doors to STEM professions,
tuition іs indispensable for strong examination structures.
mｙ web page … best online cbse maths tuition
best online cbse maths tuition
6 Oct 25 at 6:12 am
наркологическая служба [url=https://narkologicheskaya-klinika-19.ru/]narkologicheskaya-klinika-19.ru[/url] .
narkologicheskaya klinika _hymi
6 Oct 25 at 6:13 am
кухни на заказ в спб [url=www.kuhni-spb-3.ru]кухни на заказ в спб[/url] .
kyhni spb_nxMr
6 Oct 25 at 6:13 am
кухни на заказ спб [url=https://kuhni-spb-4.ru/]кухни на заказ спб[/url] .
kyhni spb_nver
6 Oct 25 at 6:14 am
Hi there, just became alert to your blog through Google, and found that it is really
informative. I am going to watch out for brussels. I will
be grateful if you continue this in future. Many people will be benefited from your writing.
Cheers!
best online casino australia
6 Oct 25 at 6:14 am
Hey there! I know this is kinda off topic however I’d figured I’d ask.
Would you be interested in exchanging links or maybe guest authoring a blog article or vice-versa?
My site addresses a lot of the same topics as yours and I feel we could greatly benefit
from each other. If you might be interested feel
free to shoot me an e-mail. I look forward to hearing from you!
Awesome blog by the way!
https://dharmaraja.net/User:KassandraMatthae
6 Oct 25 at 6:14 am
The hype around $MTAUR presale is justified—over 1M USDT in days. Unlocking boosts and outfits with tokens adds depth to gameplay. This is crypto meeting casual gaming perfectly.
minotaurus ico
WilliamPargy
6 Oct 25 at 6:14 am
strike camp,ラブドール えろmarch.
ラブドール
6 Oct 25 at 6:16 am
лечение зависимостей в москве [url=narkologicheskaya-klinika-19.ru]narkologicheskaya-klinika-19.ru[/url] .
narkologicheskaya klinika _ggmi
6 Oct 25 at 6:17 am
лечение от зависимости наркотиков
reabilitaciya-astana009.ru
реабилитации после алкоголя
izzapoyaastanaNeT
6 Oct 25 at 6:18 am
Very quickly this site will be famous among all blogging
and site-building users, due to it’s fastidious content
dewascatter link alternatif
6 Oct 25 at 6:19 am
купить диплом техникума спб в южно сахалинске [url=https://frei-diplom7.ru/]купить диплом техникума спб в южно сахалинске[/url] .
Diplomi_chei
6 Oct 25 at 6:23 am
усиление грунтов [url=https://privetsochi.ru/blog/realty_sochi/93972.html]https://privetsochi.ru/blog/realty_sochi/93972.html[/url] .
ysilenie gryntov_tjSr
6 Oct 25 at 6:23 am
https://forum.dboglobal.to/wsc/index.php?user/117117-codigo1xbet/#about
WilliamSlume
6 Oct 25 at 6:25 am
купить диплом в мичуринске [url=http://rudik-diplom10.ru]http://rudik-diplom10.ru[/url] .
Diplomi_zuSa
6 Oct 25 at 6:25 am
купить диплом с техникума [url=https://www.frei-diplom8.ru]купить диплом с техникума[/url] .
Diplomi_jmsr
6 Oct 25 at 6:25 am
купить готовый диплом техникума [url=www.frei-diplom12.ru/]купить готовый диплом техникума[/url] .
Diplomi_xnPt
6 Oct 25 at 6:25 am
купить диплом в димитровграде [url=www.rudik-diplom9.ru/]купить диплом в димитровграде[/url] .
Diplomi_wmei
6 Oct 25 at 6:27 am
купить диплом в таганроге [url=www.rudik-diplom12.ru/]www.rudik-diplom12.ru/[/url] .
Diplomi_xvPi
6 Oct 25 at 6:28 am
https://brelki-vorot.ru
EdwardTrege
6 Oct 25 at 6:28 am
усиление грунтов [url=http://privetsochi.ru/blog/realty_sochi/93972.html]http://privetsochi.ru/blog/realty_sochi/93972.html[/url] .
ysilenie gryntov_vxSr
6 Oct 25 at 6:28 am
заказать кухню в спб от производителя [url=http://www.kuhni-spb-4.ru]заказать кухню в спб от производителя[/url] .
kyhni spb_luer
6 Oct 25 at 6:30 am
The area might be massaged for 2 to 3 mins to aid with the breakdown of
the fat cells.
Mora
6 Oct 25 at 6:32 am
купить диплом строительного техникума в москве [url=https://www.frei-diplom11.ru]купить диплом строительного техникума в москве[/url] .
Diplomi_uksa
6 Oct 25 at 6:32 am
I am sure this paragraph has touched all the internet people, its really really good post on building up new blog.
капельница от похмелья на дому в Краснодаре
6 Oct 25 at 6:32 am
усиление грунтов [url=https://www.privetsochi.ru/blog/realty_sochi/93972.html]https://www.privetsochi.ru/blog/realty_sochi/93972.html[/url] .
ysilenie gryntov_gxSr
6 Oct 25 at 6:35 am
кухни под заказ в спб [url=kuhni-spb-1.ru]kuhni-spb-1.ru[/url] .
kyhni spb_nimi
6 Oct 25 at 6:35 am
купить кухню на заказ спб [url=kuhni-spb-4.ru]kuhni-spb-4.ru[/url] .
kyhni spb_qker
6 Oct 25 at 6:36 am
наркологичка [url=https://narkologicheskaya-klinika-19.ru]https://narkologicheskaya-klinika-19.ru[/url] .
narkologicheskaya klinika _ewmi
6 Oct 25 at 6:37 am
Рекомендую https://decorwoods.com/what-are-the-different-types-of-office-furniture/?unapproved=87068&moderation-hash=cd4ff2d26cf3f9371bf1673c63fc2d96
PedroMop
6 Oct 25 at 6:37 am