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://medic-dpo.ru]https://medic-dpo.ru[/url] предлагается услуга быстрого получения медкнижки — просто оформите заказ и приготовьте паспорт и фотографию. Для сотрудников коммунальных служб, сферы обслуживания и прочих категорий всё проходит быстро и удобно, без очередей. Получите документ легально и легально — с доставкой по вашему адресу или до ближайшей станции. Узнайте подробности — медкнижка срочно, оформление онлайн, курьерская доставка.
Spravkizaw
8 Sep 25 at 5:18 pm
Thanks in support of sharing such a nice idea, article is pleasant, thats
why i have read it completely
עט אידוי שמן קנאביס
8 Sep 25 at 5:19 pm
помощь нарколога [url=http://www.narkologicheskaya-klinika-14.ru]http://www.narkologicheskaya-klinika-14.ru[/url] .
narkologicheskaya klinika_qzsn
8 Sep 25 at 5:21 pm
Ich bin suchtig nach JokerStar Casino, es verstromt eine Spielstimmung, die verzaubert. Der Katalog des Casinos ist eine Galaxie voller Spa?, mit Live-Casino-Sessions, die wie Zauberei knistern. Das Casino-Team bietet Unterstutzung, die wie ein Stern glanzt, liefert klare und schnelle Losungen. Casino-Gewinne kommen wie ein Blitz, ab und zu mehr Freispiele im Casino waren ein Volltreffer. Alles in allem ist JokerStar Casino ein Casino mit einem Spielspa?, der wie Magie funkelt fur Abenteurer im Casino! Zusatzlich die Casino-Plattform hat einen Look, der wie ein Sternenstaub funkelt, das Casino-Erlebnis total verzaubert.
jokerstar download|
wackomole7zef
8 Sep 25 at 5:21 pm
Hello! I recently came across this fantastic article on casino entertainment and simply miss the chance to share it.
If you’re someone who’s curious to explore more about
the industry of online casinos, this is definitely.
I’ve always been interested in online gaming, and after reading this, I learned so much about how online casinos work.
This post does a great job of explaining everything from
game strategies. If you’re new to the whole scene,
or even if you’ve been playing for years,
this article is an essential read. I highly recommend
it for anyone who wants to get more familiar with casino game dynamics.
Not only, the article covers some great advice about selecting a reliable online casino, which I think is extremely important.
Many people overlook this aspect, but this post really shows you the best ways
to ensure you’re playing at a legit site.
What I liked most was the section on bonuses and promotions, which I
think is crucial when choosing a site to play on. The insights here are priceless for anyone looking to take advantage of bonus
offers.
In addition, the tips about managing your bankroll were very helpful.
The advice is clear and actionable, making it easy for players to take control of their gambling habits and avoid pitfalls.
The advantages and disadvantages of online gambling were also thoroughly discussed.
If you’re thinking about trying your luck at an online
casino, this article is a great starting point to grasp both the excitement and the risks involved.
If you’re into poker, you’ll find tons of valuable tips here.
The article really covers all the popular games in detail, giving
you the tools you need to boost your skill
level. Whether you’re into competitive games like poker or just enjoy a casual round of slots, this article has plenty for everyone.
I also appreciated the discussion about payment options.
It’s crucial to know that you’re using a platform
that’s safe and secure. It’s really helps you make sure your personal information is in good hands
when you play online.
In case you’re wondering where to start, I would recommend
reading this guide. It’s clear, informative, and packed with
valuable insights. Without a doubt, one of the best articles I’ve come across
in a while on this topic.
If you haven’t yet, I strongly suggest checking it
out and giving it a read. You won’t regret it! Believe me,
you’ll finish reading feeling like a better prepared player in the online
casino world.
If you’re an experienced gambler, this article is an excellent
resource. It helps you navigate the world of online
casinos and teaches you how to maximize your experience.
Definitely worth checking out!
I really liked how well-researched and thorough this article is.
I’ll definitely be coming back to it whenever I need advice on casino games.
Has anyone else read it yet? What do you think?
Feel free to share!
webpage
8 Sep 25 at 5:28 pm
play Black Lotus in best casinos
EdwardTop
8 Sep 25 at 5:28 pm
Je suis accro a LeoVegas Casino, il propose une aventure de casino digne d’une couronne. La selection du casino est une veritable cour de plaisirs, offrant des sessions de casino en direct qui eblouissent. Le personnel du casino offre un accompagnement majestueux, proposant des solutions claires et immediates. Le processus du casino est transparent et sans intrigues, quand meme les offres du casino pourraient etre plus genereuses. Dans l’ensemble, LeoVegas Casino offre une experience de casino princiere pour les amoureux des slots modernes de casino ! De surcroit l’interface du casino est fluide et somptueuse comme un trone, facilite une experience de casino grandiose.
leovegas blackjack website|
zanyquail5zef
8 Sep 25 at 5:28 pm
вывод из запоя москва клиника [url=www.narkologicheskaya-klinika-14.ru/]www.narkologicheskaya-klinika-14.ru/[/url] .
narkologicheskaya klinika_dcsn
8 Sep 25 at 5:32 pm
mostbet az müsbət rəylər [url=www.mostbet4140.ru]www.mostbet4140.ru[/url]
mostbet_rgKr
8 Sep 25 at 5:33 pm
This post will help the internet people for setting up new blog or even a blog from start to end.
비아그라판매
8 Sep 25 at 5:34 pm
I was suggested this blog by my cousin. I’m not sure whether this post
is written by him as nobody else know such detailed
about my difficulty. You are incredible! Thanks!
vovan casino зеркало
8 Sep 25 at 5:34 pm
I couldn’t resist commenting. Exceptionally well written!
Best Roofing Company
8 Sep 25 at 5:41 pm
лечение зависимостей в москве [url=narkologicheskaya-klinika-14.ru]narkologicheskaya-klinika-14.ru[/url] .
narkologicheskaya klinika_gvsn
8 Sep 25 at 5:42 pm
https://allmynursejobs.com/author/richardmeyer895352/
Joshuapep
8 Sep 25 at 5:42 pm
dark markets nexus market darkmarket link [url=https://darknetmarketsgate.com/ ]onion dark website [/url]
Donaldfup
8 Sep 25 at 5:42 pm
darkmarket link dark market darknet market links [url=https://darknetmarketgate.com/ ]onion dark website [/url]
DwayneAricE
8 Sep 25 at 5:43 pm
Работа в команде: Специалисты нашего центра взаимодействуют между собой, включая наркологов, психотерапевтов и социальных работников, что позволяет учесть все аспекты состояния пациента и обеспечить комплексный подход к лечению.
Получить дополнительную информацию – [url=https://alko-lechebnica.ru/]наркология вывод из запоя санкт-петербург[/url]
Anthonyaperb
8 Sep 25 at 5:45 pm
mostbet aviator [url=http://mostbet4143.ru/]http://mostbet4143.ru/[/url]
mostbet_hfkt
8 Sep 25 at 5:47 pm
Hey just wanted to give you a quick heads up. The words in your post seem to be running off the screen in Safari.
I’m not sure if this is a format issue or something to do with internet browser compatibility
but I figured I’d post to let you know. The layout look
great though! Hope you get the issue resolved soon. Thanks
đăng ký 28bet
8 Sep 25 at 5:48 pm
EverGreenRx USA: EverGreenRx USA – EverGreenRx USA
Jamespycle
8 Sep 25 at 5:48 pm
mostbet uz сом [url=https://www.mostbet4172.ru]https://www.mostbet4172.ru[/url]
mostbet_dbKa
8 Sep 25 at 5:48 pm
Link exchange is nothing else but it is just placing the
other person’s webpage link on your page at suitable place and other person will also do similar for
you.
https://koitoto.co.in/
8 Sep 25 at 5:53 pm
This paragraph is genuinely a pleasant one
it assists new internet visitors, who are wishing in favor of blogging.
fake ProZenith reviews
8 Sep 25 at 5:54 pm
https://lesafriques.com/2022/09/code-promo-1xbet-freebonus130-bonus-jusqua-130-e/
sqimwtl
8 Sep 25 at 5:56 pm
I quite like reading a post that can make men and women think.
Also, thank you for allowing me to comment!
Mevryon Platform
8 Sep 25 at 5:58 pm
I blog often and I truly thank you for your content.
Your article has really peaked my interest. I’m going to take a note of
your site and keep checking for new information about once per week.
I subscribed to your Feed too.
buôn bán nội tạng
8 Sep 25 at 5:58 pm
mostbet app qeydiyyat [url=http://mostbet4141.ru]mostbet app qeydiyyat[/url]
mostbet_bzPn
8 Sep 25 at 5:59 pm
mostbet tətbiqi [url=http://mostbet4144.ru]mostbet tətbiqi[/url]
mostbet_qzKa
8 Sep 25 at 6:00 pm
анонимный наркологический центр [url=www.narkologicheskaya-klinika-13.ru/]www.narkologicheskaya-klinika-13.ru/[/url] .
narkologicheskaya klinika_ayMt
8 Sep 25 at 6:00 pm
Pretty! This has been an extremely wonderful post. Thank you for providing
this info.
that it quite clearly
8 Sep 25 at 6:02 pm
наркологическая клиника в москве [url=https://narkologicheskaya-klinika-14.ru/]наркологическая клиника в москве[/url] .
narkologicheskaya klinika_bjsn
8 Sep 25 at 6:02 pm
наркологическая клиника анонимно [url=https://narkologicheskaya-klinika-14.ru/]https://narkologicheskaya-klinika-14.ru/[/url] .
narkologicheskaya klinika_yosn
8 Sep 25 at 6:06 pm
блог о маркетинге [url=www.blog-o-marketinge1.ru]блог о маркетинге[/url] .
blog o marketinge_vasa
8 Sep 25 at 6:08 pm
частная клиника наркологическая [url=http://narkologicheskaya-klinika-14.ru]http://narkologicheskaya-klinika-14.ru[/url] .
narkologicheskaya klinika_rssn
8 Sep 25 at 6:08 pm
Great post. I was checking constantly this blog and I’m impressed!
Very helpful information specially the last part 🙂 I care for
such info a lot. I was looking for this particular info for a very long time.
Thank you and best of luck.
Lori
8 Sep 25 at 6:11 pm
https://wirtube.de/a/korryefie/video-channels
Joshuapep
8 Sep 25 at 6:11 pm
dragon money официальный сайт
https://hospital41.ru/
8 Sep 25 at 6:11 pm
An impressive share! I’ve just forwarded this onto a friend who has been conducting a little research on this.
And he in fact bought me breakfast because I stumbled
upon it for him… lol. So allow me to reword this….
Thank YOU for the meal!! But yeah, thanks for spending time to
discuss this subject here on your web site.
VisporaSeek
8 Sep 25 at 6:14 pm
mostbet uz сом [url=https://mostbet4172.ru]mostbet uz сом[/url]
mostbet_rqKa
8 Sep 25 at 6:18 pm
наркологическая помощь [url=http://narkologicheskaya-klinika-14.ru/]наркологическая помощь[/url] .
narkologicheskaya klinika_rqsn
8 Sep 25 at 6:18 pm
Сайт о семи чудесах света, где
к каждому произведению древних
мастеров есть два подраздела – картинки, в той или иной степени относящиеся к постройке, и рисунки Чуда различных авторов.
http://sportfit-volga.ru
8 Sep 25 at 6:19 pm
Wow, a gօod Junior College іs ցreat, үet mathematics serves as the king subject within, developing logical reasoning ѡhɑt prepares
уour kid primed for Օ-Level success as welⅼ ɑs ahead.
Dunman Hіgh School Junior College stands out іn multilingual education, blending Eastern аnd Western point of views
to cultivate culturally astute ɑnd innovative thinkers.
The incorporated program deals smooth progression ѡith enriched curricula in STEM аnd
humanities,supported Ьy sophisticated centers ⅼike research study labs.
Students prosper іn а harmonious environment tһat stresses imagination, management,
аnd community involvement tһrough varied activities.
International immersion programs enhance cross-cultural understanding аnd prepare
students fоr worldwide success. Graduates regularly achieve leading гesults, reflecting tһｅ school’ѕ commitment to academic rigor ɑnd personal excellence.
National Junior College, holding tһe differende aѕ Singapore’ѕ
vеry fіrst junior college, supplies unrivaled opportunities fⲟr intellectual exploration ɑnd management cultivation ѡithin а
historic aand motivating campus tһаt mixes
custom wіth contemporary academic quality. Ꭲhe unique boarding program promotes ѕelf-reliance and a sense of community, ѡhile cutting
edge гesearch centers аnd specialized laboratories enable students ftom diverse backgrounds tⲟ
pursue advanced rеsearch studies іn arts, sciences, ɑnd
liberal arts ԝith elective choices for tailored learning
paths. Innovative programs encourage deep scholastic immersion, ѕuch аs project-based ｒesearch and interdisciplinary workshops tһаt sharpen analytical skills аnd foster creativity
ɑmongst aspiring scholars. Ꭲhrough substantial
worldwide partnerships, consisting ⲟf student exchanges,
worldwide symposiums, аnd collaborative initiatives ԝith overseas universities, students develop broad networks аnd a nuanced understanding of worldwide
ρroblems. The college’ѕ alumni, who regularly assume popular roles іn federal government, academic community, аnd industry, exemplify National Junior College’s
lߋng lasting contribution tо nation-building and the
advancement of visionary, impactful leaders.
Ɗon’t play play lah, combine а excellent Junior College plus
mathematics superiority tо guarantee high A Levels marks as wｅll aѕ smooth transitions.
Parents, worry аbout the disparity hor, mathematics groundwork proves essential ɗuring Junior College tо grasping figures,
essential fⲟr current tech-driven market.
Listen up, composed pom ρi pi, math is one in the һighest topics аt Junior College, building base
іn A-Level һigher calculations.
Besidеs to institution resources, focus upon mathematics tо stop frequent mistakes sսch as careless errors іn exams.
Oh dear, lacking robust math іn Junior College, regɑrdless prestigious institution kids mіght struggle аt secondary
calculations, tһus develop tһis now leh.
Hіgh A-level performance leads to alumni networks wіtһ influence.
Oh dear, withoսt solid math ԁuring Junior College, гegardless
leading school youngsters miɡht stumble at next-level algebra, thսs cultivate it immｅdiately leh.
Feel free to visit mу web-site; maths and physics tutor solution bank (https://Shorturl.ru/pro-a-tuition-maths-t-Assignment-12087)
https://Shorturl.ru/pro-a-tuition-maths-t-Assignment-12087
8 Sep 25 at 6:19 pm
mostbet az apk yüklə [url=mostbet4141.ru]mostbet az apk yüklə[/url]
mostbet_jlPn
8 Sep 25 at 6:20 pm
https://disqus.com/by/codespromo1xbet/about/
Chesterses
8 Sep 25 at 6:23 pm
darknet markets url darknet market lists darkmarket [url=https://darknetmarketgate.com/ ]nexus onion mirror [/url]
DwayneAricE
8 Sep 25 at 6:23 pm
провайдеры интернета по адресу
inernetvkvartiru-krasnoyarsk004.ru
провайдеры в красноярске по адресу проверить
inernetadreselini
8 Sep 25 at 6:24 pm
частная наркологическая клиника [url=www.narkologicheskaya-klinika-14.ru/]частная наркологическая клиника[/url] .
narkologicheskaya klinika_fasn
8 Sep 25 at 6:25 pm
Включение в реестр Минпромторга https://minprom-info.ru официальный путь для подтверждения отечественного производства. Подготовка и подача документов, юридическое сопровождение и консультации для производителей.
minprom-info-308
8 Sep 25 at 6:25 pm
Very rapidly this site will be famous among all blogging and
site-building users, due to it’s fastidious posts
dewa scatter
8 Sep 25 at 6:26 pm
mostbet hesabı bərpa etmək [url=http://mostbet4142.ru]http://mostbet4142.ru[/url]
mostbet_vySi
8 Sep 25 at 6:27 pm