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!
https://t.me/s/Official_1xbet_1xbet/1720
Josephadvem
17 Oct 25 at 10:37 pm
https://t.me/Official_1xbet_1xbet/1629
Josephadvem
17 Oct 25 at 10:42 pm
https://t.me/Official_1xbet_1xbet/1673
Josephadvem
17 Oct 25 at 10:42 pm
перепланировка квартиры проектные организации [url=www.proekt-pereplanirovki-kvartiry16.ru]www.proekt-pereplanirovki-kvartiry16.ru[/url] .
proekt pereplanirovki kvartiri_fzMl
17 Oct 25 at 10:44 pm
https://www.mrclarksdesigns.builderspot.com/board/board_topic/690695/7296796.htm
https://www.mrclarksdesigns.builderspot.com/board/board_topic/690695/7296796.htm
17 Oct 25 at 10:44 pm
«Частный Медик 24» в стационаре помогает начать жизнь заново — с чистого листа, без последствий запоя.
Разобраться лучше – [url=https://vyvod-iz-zapoya-v-stacionare23.ru/]наркология вывод из запоя в стационаре в нижний новгороде[/url]
Francisitedo
17 Oct 25 at 10:48 pm
В Краснодаре клиника «Детокс» предоставляет услугу вызова нарколога на дом. Специалисты приедут к вам в течение 1–2 часов, проведут осмотр и назначат необходимое лечение. Все процедуры проводятся анонимно и с соблюдением конфиденциальности.
Ознакомиться с деталями – [url=https://narkolog-na-dom-krasnodar29.ru/]помощь нарколога на дому[/url]
StevenPrabY
17 Oct 25 at 10:49 pm
Мастер на час в Москве https://masternadom24.ru быстрое решение бытовых проблем. Мелкий ремонт, установка, сборка и подключение техники. Пунктуальность, качество и удобный вызов мастера.
masternadom 645
17 Oct 25 at 10:49 pm
seoanchor.click – On mobile it works nicely, no weird layout issues.
Estefana Dance
17 Oct 25 at 10:50 pm
Курсы подготовки к ЕГЭ по информатике https://courses-ege.ru
courses-ege-79
17 Oct 25 at 10:50 pm
netfusion.click – I like how fast pages load, no lag when switching sections.
Roseanna Khensamphanh
17 Oct 25 at 10:50 pm
куплю диплом [url=https://rudik-diplom12.ru]куплю диплом[/url] .
Diplomi_wuPi
17 Oct 25 at 10:51 pm
Wonderful beat ! I would like to apprentice while you amend your website,
how can i subscribe for a blog web site? The account aided me a acceptable deal.
I had been a little bit acquainted of this your broadcast offered bright clear idea
next page
17 Oct 25 at 10:52 pm
Joined $MTAUR token hunt—presale bonuses stacking. Maze treasures and creature fights immersive. This project’s viral potential high.
mtaur coin
WilliamPargy
17 Oct 25 at 10:54 pm
узаконивание перепланировки цена [url=https://zakazat-proekt-pereplanirovki-kvartiry11.ru]https://zakazat-proekt-pereplanirovki-kvartiry11.ru[/url] .
zakazat proekt pereplanirovki kvartiri_ehet
17 Oct 25 at 10:54 pm
букмекерская контора мелбет официальный сайт [url=https://www.melbetbonusy.ru]букмекерская контора мелбет официальный сайт[/url] .
melbet_kyOi
17 Oct 25 at 10:54 pm
partnershippowerhouse.shop – Layout is clean, easy to navigate without feeling overwhelming.
Les Latney
17 Oct 25 at 10:55 pm
mexico pharmacy [url=https://medicosur.com/#]mexican pharmacy[/url] mexican pharmacy
CareyMag
17 Oct 25 at 10:56 pm
I love what you guys are up too. This kind of clever work and exposure!
Keep up the amazing works guys I’ve incorporated you
guys to blogroll.
vreau sa cumpar permis de conducere original
17 Oct 25 at 10:57 pm
Kaizenaire.aibecomes аn efficient Singapore recruitment agency, helping businesses safe remote talent fгom thе Philippines empowered Ьy AI bots fօr task automation and
customer relationship building.
Ԝith Singapore’s premium labor fⲟrce charges and increasing expenditures,
hiring fгom the Philippines remotely is 100%
clever, cutting 70% from continuous expenses. ΑI empowers
efficiency akin tߋ domestic recruitment.
Ӏn tһe middle of the AI landscape tօԁay and challenging climate, business owners ѕhould quickly inspect thеir organizational designs ɑnd treatments, executing
АI automation аѕ qսickly aѕ posѕible.
AI advances at excessive speed.
Kaizenaire acts аs a trustworthy Singapore recruitment agency dedicated
tо assisting Singapore companies hire creative workers fгom thе Philippines, wheee
ΑI tools ɑllow remote designers tⲟ develop post and manage
social networks marketing.
Τhe mіnute is here to redefine future business practices
involving ΑI and teams of remote workers. Check оut Kaizenaire, a Singapore recruitment agency innovating іn remote staffing neеds.
My homepage … how does salary work recruitment agency singapore
how does salary work recruitment agency singapore
17 Oct 25 at 10:57 pm
The $MTAUR ICO partnerships boost visibility. Token conversions practical. Hype building.
minotaurus presale
WilliamPargy
17 Oct 25 at 10:57 pm
rankmotion.click – Already bookmarked this — seems like a site I’ll revisit.
Beryl Bleeck
17 Oct 25 at 10:58 pm
Задумываетесь о том, как эффективно вывести человека из запоя и вернуть ему здоровую жизнь? В статье «Вывод из запоя: эффективные методы и профессиональная помощь» рассказываются ключевые подходы к безопасному и ответственному решению проблемы.
Подробнее можно узнать тут – http://www.kpilib.ru/forum.php?tema=12229
Heathergak
17 Oct 25 at 11:00 pm
globalunity.bond – Found several parts inspiring; feels like a community I’d like to join.
Isabel Lahn
17 Oct 25 at 11:00 pm
smartpartnership.bond – Clean design, easy to understand what they offer without overcomplication.
Lavonne Baulch
17 Oct 25 at 11:00 pm
pagevector.click – Overall experience is positive, feels like a solid, trustworthy site.
Cuc Stoddart
17 Oct 25 at 11:00 pm
clicksignal.click – The navigation is intuitive, found what I needed without trouble.
Samual Heiro
17 Oct 25 at 11:00 pm
shopwithpurpose.shop – Feels like shopping here actually contributes to something meaningful.
Harold Ansell
17 Oct 25 at 11:01 pm
проектная организация москва перепланировка [url=https://proekt-pereplanirovki-kvartiry16.ru/]proekt-pereplanirovki-kvartiry16.ru[/url] .
proekt pereplanirovki kvartiri_lxMl
17 Oct 25 at 11:04 pm
https://t.me/Official_1xbet_1xbet/1805
Josephadvem
17 Oct 25 at 11:05 pm
trustinyou.bond – Photos are well chosen; text is clear and reassuring.
Cherry Nodurft
17 Oct 25 at 11:05 pm
Have you ever ever completed 1 semesters price after all in 8 days
before? What was dangerous about it is that a few of Craig’s mates left without paying (by
chance after all).
viagra manufacturer
17 Oct 25 at 11:05 pm
купить диплом [url=http://rudik-diplom12.ru/]купить диплом[/url] .
Diplomi_pvPi
17 Oct 25 at 11:05 pm
Стационар клиники — это безопасное место, где врачи помогают восстановить силы после тяжелого запоя.
Получить дополнительные сведения – [url=https://vyvod-iz-zapoya-v-stacionare23.ru/]быстрый вывод из запоя в стационаре[/url]
Francisitedo
17 Oct 25 at 11:05 pm
https://www.yogizogi.kr/bbs/board.php?bo_table=free&wr_id=1484605
https://www.yogizogi.kr/bbs/board.php?bo_table=free&wr_id=1484605
17 Oct 25 at 11:06 pm
Joy Palace India offers a premier online casino experience with thousands of slot
games, live dealer tables, and competitive cricket betting odds.
Claim your welcome bonus and start winning today!
Joy Palace India - Play Online Casino Games & Bet On Cricket
17 Oct 25 at 11:09 pm
купить права
JerryCouck
17 Oct 25 at 11:09 pm
https://t.me/Official_1xbet_1xbet/1642
Josephadvem
17 Oct 25 at 11:11 pm
mostbet rasmiy sayti [url=mostbet4185.ru]mostbet4185.ru[/url]
mostbet_uz_doer
17 Oct 25 at 11:12 pm
Выведение из запоя в стационаре Воронежа — помощь при острых состояниях и хронической зависимости. Наши опытные наркологи используют современные методы лечения для быстрого и безопасного вывода из запоя.
Подробнее тут – [url=https://vyvod-iz-zapoya-v-stacionare-voronezh22.ru/]vyvod-iz-zapoya-v-stacionare-voronezh22.ru/[/url]
RichardJuids
17 Oct 25 at 11:13 pm
https://telegra.ph/Kupit-v-tyumeni-monokulyar-10-12-4
JesseHow
17 Oct 25 at 11:14 pm
проект перепланировки квартиры цена москва [url=http://proekt-pereplanirovki-kvartiry16.ru/]http://proekt-pereplanirovki-kvartiry16.ru/[/url] .
proekt pereplanirovki kvartiri_bfMl
17 Oct 25 at 11:14 pm
Hello, after reading this remarkable paragraph i am as well cheerful to share my know-how here with colleagues.
roofers near me
17 Oct 25 at 11:16 pm
В «Частном Медике 24» в Самаре выход из запоя организуют поэтапно: диагностика, лечение, реабилитация.
Исследовать вопрос подробнее – [url=https://vyvod-iz-zapoya-v-stacionare-samara24.ru/]быстрый вывод из запоя в стационаре в самаре[/url]
Williamgaita
17 Oct 25 at 11:16 pm
Thanks for your personal marvelous posting! I genuinely enjoyed reading it,
you’re a great author.I will make sure to bookmark your blog and
will come back someday. I want to encourage you continue
your great writing, have a nice weekend!
sci fi book series
17 Oct 25 at 11:20 pm
The upcoming new physical space ɑt OMT guarantees immersive
mathematics experiences, stimulating ⅼong-lasting love fоr the subject and motivation fоr exam success.
Change mathematics challenges іnto victories wіth OMT Math Tuition’ѕ mix of online and on-site alternatives, ƅacked bｙ a track record of trainee excellence.
Αs mathematics underpins Singapore’s track record fߋr
excellence іn worldwide standards ⅼike PISA, math tuition іs crucial to оpening a
child’s prospective ɑnd protecting scholastic benefits іn thiѕ core subject.
Tuition іn primary mathematics іs crucial fօr
PSLE preparation, as it ⲣresents sophisticated strategies fοr managing
non-routine prоblems that stump many prospects.
Math tuition teaches efficient tіme management strategies,
helping secondary pupils ϲomplete O Level exams wіthіn the designated
period ѡithout rushing.
Ⅴia normal mock examinations аnd detailed responses, tuition aids junior college students recognize ɑnd fix weak pointѕ Ƅefore the actual A
Levels.
Distinctively, OMT enhances tһe MOE syllabus ѡith a customized program including diagnostic analyses tߋ customize web сontent to еach student’s toughness.
Parental accessibility tօ advance reports one, permitting advice іn thе house fⲟr continual grade enhancement.
Math tuition іn tiny teams mazkes sure customized interеst,
typically doing not һave in laгge Singapore school classes fօr examination preparation.
Ꮋere is my website: primary 1 math tuition Singapore
primary 1 math tuition Singapore
17 Oct 25 at 11:21 pm
Pretty section of content. I simply stumbled upon your
blog and in accession capital to say that I acquire actually enjoyed account
your weblog posts. Anyway I’ll be subscribing to your
feeds or even I achievement you get admission to consistently fast.
site here
17 Oct 25 at 11:22 pm
купить диплом в керчи [url=http://rudik-diplom12.ru/]http://rudik-diplom12.ru/[/url] .
Diplomi_jfPi
17 Oct 25 at 11:23 pm
I am extremely impressed with your writing skills and also with the layout on your
blog. Is this a paid theme or did you customize
it yourself? Either way keep up the excellent quality writing,
it is rare to see a great blog like this one nowadays.
jo orban
17 Oct 25 at 11:25 pm
Heya i am for the primary time here. I came across this board and I in finding It truly useful & it helped me out much.
I hope to give one thing again and help others such as you aided me.
https://uk.search.yahoo.com/mobile/s?ei=UTF-8&fl=39&p=site:www.telegramoom.com
17 Oct 25 at 11:26 pm