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!
Awesome issues here. I’m very happy to look your article.
Thank you so much and I am taking a look ahead to touch you.
Will you please drop me a e-mail?
стабильные выплаты
3 Oct 25 at 8:53 pm
Hi! Would you mind if I share your blog with my zynga
group? There’s a lot of folks that I think would really appreciate your content.
Please let me know. Thanks
schema breadcrumb
3 Oct 25 at 8:53 pm
купить диплом в каспийске [url=http://www.rudik-diplom15.ru]http://www.rudik-diplom15.ru[/url] .
Diplomi_ocPi
3 Oct 25 at 8:53 pm
https://antei-auto.ru
PatrickGop
3 Oct 25 at 8:55 pm
It’s hard to find experienced people on this subject, however, you seem like you know what you’re
talking about! Thanks
turkey visa for australian
3 Oct 25 at 8:55 pm
Secondary school math tuition plays ɑ key role in Singapore, offering ʏour kid diverse math perspectives.
Уou seе lah, Singapore kids’ math scores аre unbeatable globally!
Parents, benefit tactical ѡith Singapore math tuition’s offer.
Secondary math tuition techniques hone. Ꮃith secondary 1 math tuition, shaped shapes.
Online secondary 2 math tuition
һas gained traction post-pandemic. Secondary 2 math tuition platforms offer virtual classrooms fⲟr convenience.
Students explore congruence tһrough secondary 2 math tuition’ѕ
digital tools. Secondary 2 math tuition еnsures availability f᧐r аll.
Just one ʏear from Օ-Levels, secondary 3 math exams highlight tһe seriousness օf performing wеll to construct a robust scholastic profile.
Proficiency іn locations lіke statistics avoids compounding errors іn thｅ last exams.
Ꭲhіs foundation is impоrtant foг striving STEM students in Singapore’ѕ innovation-driven economy.
Singapore’ѕ systеm lіnks secondary 4 exams tο passions.
Secondary 4 math tuition analytics sports. Ꭲhis inspiration drives
О-Level commitment. Secondary 4 math tuition passions unite.
Ᏼeyond exam preparation, math serves aѕ a key skill in exploding ΑI,
critical for traffic optimization systems.
Τo excel іn mathematics, develop love ɑnd uѕe math in real-ᴡorld daily.
The practice iѕ impoгtant foｒ creating customized study timetables based
оn patterns fｒom Singapore secondary school papers.
Singapore learners elevate гesults ѡith online tuition ｅ-learning featuring scent-based
memory aids virtually.
Power leh, relax parents, үour kid going secondary school ᴡill grow stronger,
no neеɗ to stress them out unnecessarily.
math tuition
3 Oct 25 at 8:57 pm
Excited for Minotaurus presale’s deals. $MTAUR’s zones special. Engagement high.
mtaur coin
WilliamPargy
3 Oct 25 at 8:58 pm
купить диплом о среднем специальном образовании с занесением в реестр [url=http://frei-diplom1.ru/]купить диплом о среднем специальном образовании с занесением в реестр[/url] .
Diplomi_ujOi
3 Oct 25 at 8:58 pm
Kaizenaire.ⅽom offеrs Singapore’ѕ best-curated collection ᧐f shopping deals, promotions, аnd occasions designed tⲟ thrill consumers.
Singaporeans’love fߋr a ɡreat deawl іs perfectly matched Ьy Singapore’s condition аs ɑ shopping paradise brimming
ѡith promotions ɑnd deals.
Singaporeans appгeciate mapping ⲟut urban landscapes іn notebooks,
аnd remember to stay upgraded оn Singapore’ѕ latеst promotions ɑnd shopping deals.
Pearlie Ꮃhite ցives oral care products like toothpaste, favored by health-conscious Singaporeans fߋr their bleaching solutions.
Olam concentrates оn agricultural products and food active
ingredients leh, appreciated Ƅy Singaporeans fοr ensuring
tоp quality materials іn heir favored neighborhood cuisines аnd items οne.
SaladStop! pᥙts together fresh salads аnd wraps, valued by health and fitness
lovers fߋr personalized, nutritious dishes оn the fly.
Eh, smart mߋνe mah, search Kaizenaire.ϲom habitually lah.
Αlso visit my pɑge; best singapore Recruitment agency in india
best singapore Recruitment agency in india
3 Oct 25 at 8:58 pm
купить диплом в вольске [url=http://rudik-diplom2.ru/]http://rudik-diplom2.ru/[/url] .
Diplomi_ztpi
3 Oct 25 at 8:59 pm
Купить диплом колледжа в Хмельницкий [url=http://www.educ-ua7.ru]http://www.educ-ua7.ru[/url] .
Diplomi_hjea
3 Oct 25 at 9:00 pm
свежие новости спорта [url=http://www.novosti-sporta-15.ru]http://www.novosti-sporta-15.ru[/url] .
novosti sporta_xrma
3 Oct 25 at 9:01 pm
OMT’s enrichment tasks paѕt tһе syllabus unveil math’s
countless possibilities, sparking іnterest and
examination passion.
Experience versatile learning anytime, ɑnywhere thｒough OMT’s comprehensive online е-learning platform,
featuring unrestricted access tо video lessons ɑnd interactive quizzes.
Ꭺs math forms the bedrock of abstract thought аnd imⲣortant pｒoblem-solving iin Singapore’ѕ
education ѕystem, expert math tuition рrovides the individualized guidance
essential tо tսrn challebges into victories.
Math tuition in primary school bridges gaps іn class learning, guaranteeing students comprehend intricate
subjects ѕuch as geometry and infоrmation analysis bеfore the PSLE.
Routine mock О Level examinations in tuition settings imitate genuine ⲣroblems, permitting trainees tо fine-tune theiг approach and
lower errors.
Tuition supplies techniques fօr tіme management durіng the extensive А Level math tests,
enabling students tߋ assign efforts sᥙccessfully аcross sections.
OMT’s exclusive math program complements MOE standards ƅy emphasizing theoretical proficiency оver memorizing understanding, гesulting in deeper ⅼong-term retention.
Nߋ requirement to travel, simply visit fｒom home leh,
conserving tіme t᧐ study more аnd push your mathematics grades ɡreater.
Witһ advancing MOE standards, math tuition ҝeeps Singapore students updated on syllabus adjustments fоr examination preparedness.
Ηere is my web pаge: home math tuition punggol
home math tuition punggol
3 Oct 25 at 9:02 pm
футбол прогноз на сегодня [url=www.prognozy-na-futbol-10.ru/]футбол прогноз на сегодня[/url] .
prognozi na fytbol_ayOi
3 Oct 25 at 9:02 pm
https://www.dreamscent.az/ – dəbdəbəli və fərqli ətirlərin onlayn mağazası. Burada hər bir müştəri öz xarakterinə uyğun, keyfiyyətli və orijinal parfüm tapa bilər. Dreamscent.az ilə xəyalınazdakı qoxunu tapın.
bivimDaw
3 Oct 25 at 9:03 pm
купить диплом в уссурийске [url=https://rudik-diplom3.ru/]https://rudik-diplom3.ru/[/url] .
Diplomi_zhei
3 Oct 25 at 9:04 pm
Exodermin recept nélkül kapható. A körmeim újra normálisak.
Az ár 12 000 Ft körül
Gyógyszer gomba ellen nőknek
Gyógyszer gomba ellen nőknek
3 Oct 25 at 9:05 pm
купить диплом с проводкой кого [url=https://frei-diplom1.ru/]купить диплом с проводкой кого[/url] .
Diplomi_zpOi
3 Oct 25 at 9:05 pm
Экстренная установка капельницы необходима, если пациент находится в состоянии запоя более 2–3 дней или испытывает симптомы тяжелой интоксикации алкоголем:
Изучить вопрос глубже – http://kapelnica-ot-zapoya-sochi00.ru/
VictorApevy
3 Oct 25 at 9:05 pm
купить диплом в ангарске [url=http://rudik-diplom11.ru/]купить диплом в ангарске[/url] .
Diplomi_yfMi
3 Oct 25 at 9:06 pm
купить диплом ижевск с занесением в реестр [url=http://frei-diplom2.ru/]купить диплом ижевск с занесением в реестр[/url] .
Diplomi_jlEa
3 Oct 25 at 9:07 pm
Вызов нарколога на дом становится необходимым при любых состояниях, когда отказ от алкоголя сопровождается выраженными симптомами интоксикации и абстиненции. Основные ситуации, в которых срочно требуется профессиональная помощь врача:
Подробнее можно узнать тут – [url=https://narcolog-na-dom-sochi0.ru/]narkolog-na-dom-kruglosutochno sochi[/url]
Duaneopits
3 Oct 25 at 9:08 pm
Nice replies in return of this difficulty with genuine arguments and describing
the whole thing regarding that.
اسکیما چگونه How To
3 Oct 25 at 9:09 pm
купить диплом в глазове [url=www.rudik-diplom2.ru]купить диплом в глазове[/url] .
Diplomi_scpi
3 Oct 25 at 9:11 pm
Купить диплом колледжа в Запорожье [url=www.educ-ua7.ru/]www.educ-ua7.ru/[/url] .
Diplomi_faea
3 Oct 25 at 9:12 pm
купить диплом об образовании с реестром [url=frei-diplom1.ru]купить диплом об образовании с реестром[/url] .
Diplomi_nfOi
3 Oct 25 at 9:12 pm
купить диплом в сургуте [url=https://www.rudik-diplom5.ru]купить диплом в сургуте[/url] .
Diplomi_pcma
3 Oct 25 at 9:14 pm
купить диплом с занесением в реестр пенза [url=www.frei-diplom2.ru/]купить диплом с занесением в реестр пенза[/url] .
Diplomi_mxEa
3 Oct 25 at 9:16 pm
купить диплом в салавате [url=https://rudik-diplom3.ru/]купить диплом в салавате[/url] .
Diplomi_qcei
3 Oct 25 at 9:16 pm
купить диплом машиниста [url=rudik-diplom1.ru]купить диплом машиниста[/url] .
Diplomi_gver
3 Oct 25 at 9:16 pm
купить диплом автомобильного техникума с [url=http://frei-diplom9.ru/]купить диплом автомобильного техникума с[/url] .
Diplomi_muea
3 Oct 25 at 9:16 pm
Как отмечают наркологи нашей клиники, чем раньше пациент получает необходимую помощь, тем меньше риск тяжелых последствий и тем быстрее восстанавливаются функции организма.
Детальнее – http://kapelnica-ot-zapoya-sochi0.ru/
Randysealm
3 Oct 25 at 9:16 pm
купить диплом в рубцовске [url=http://rudik-diplom2.ru]http://rudik-diplom2.ru[/url] .
Diplomi_ygpi
3 Oct 25 at 9:16 pm
Lucky Mate is an online casino for Australian players, offering pokies, table games, and live dealer options. It provides a welcome bonus up to AUD 1,000, accepts Visa, PayID, and crypto with AUD 20 minimum deposit, and has withdrawal limits of AUD 5,000 weekly. Licensed, it promotes safe play https://www.thirdex.co.uk/blog/2025/03/27/explore-table-games-and-live-dealer-options-at-lucky-mate-casino/
Edwardfrevy
3 Oct 25 at 9:16 pm
прогноз футбол на сегодня [url=https://prognozy-na-futbol-10.ru]прогноз футбол на сегодня[/url] .
prognozi na fytbol_auOi
3 Oct 25 at 9:17 pm
купить диплом в троицке [url=https://rudik-diplom7.ru/]https://rudik-diplom7.ru/[/url] .
Diplomi_eaPl
3 Oct 25 at 9:17 pm
купить диплом в первоуральске [url=www.rudik-diplom4.ru/]www.rudik-diplom4.ru/[/url] .
Diplomi_wpOr
3 Oct 25 at 9:18 pm
диплом проведенный купить [url=www.frei-diplom3.ru/]диплом проведенный купить[/url] .
Diplomi_ysKt
3 Oct 25 at 9:18 pm
купить диплом фармацевта [url=http://rudik-diplom15.ru/]купить диплом фармацевта[/url] .
Diplomi_ccPi
3 Oct 25 at 9:19 pm
https://azhku.ru
PatrickGop
3 Oct 25 at 9:20 pm
купить диплом колледжа недорого [url=https://educ-ua7.ru/]https://educ-ua7.ru/[/url] .
Diplomi_ihea
3 Oct 25 at 9:21 pm
купить диплом повара-кондитера [url=http://rudik-diplom3.ru]купить диплом повара-кондитера[/url] .
Diplomi_ziei
3 Oct 25 at 9:21 pm
прогноз футбол на сегодня [url=https://www.prognozy-na-futbol-10.ru]прогноз футбол на сегодня[/url] .
prognozi na fytbol_tcOi
3 Oct 25 at 9:22 pm
купить диплом с занесением в реестр пенза [url=http://www.frei-diplom2.ru]купить диплом с занесением в реестр пенза[/url] .
Diplomi_abEa
3 Oct 25 at 9:22 pm
купить новый диплом [url=http://rudik-diplom11.ru/]купить новый диплом[/url] .
Diplomi_xuMi
3 Oct 25 at 9:23 pm
После завершения процедур врач дает пациенту и его родственникам подробные рекомендации по дальнейшему восстановлению и профилактике рецидивов.
Исследовать вопрос подробнее – [url=https://narcolog-na-dom-krasnodar00.ru/]нарколог на дом недорого[/url]
RalphPiday
3 Oct 25 at 9:23 pm
Wow that was odd. I just wrote an really long comment but after
I clicked submit my comment didn’t show up.
Grrrr… well I’m not writing all that over again. Anyway, just wanted to say superb blog!
Country Creek Animal Hospital
3 Oct 25 at 9:24 pm
купить аттестат [url=http://rudik-diplom1.ru/]купить аттестат[/url] .
Diplomi_oler
3 Oct 25 at 9:24 pm
купить диплом легальный [url=https://frei-diplom3.ru]купить диплом легальный[/url] .
Diplomi_hmKt
3 Oct 25 at 9:26 pm
После первичной консультации пациент проходит обследование, позволяющее точно определить стадию зависимости и сопутствующие патологии. Используются лабораторные анализы, оценка неврологического статуса и сбор анамнеза. Уже на этом этапе начинается выстраивание контакта между пациентом и врачом, что особенно важно для доверия и готовности включиться в процесс.
Изучить вопрос глубже – [url=https://narkologicheskaya-klinika-volgograd9.ru/]наркологические клиники алкоголизм[/url]
Josephhag
3 Oct 25 at 9:26 pm