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://rudik-diplom5.ru]купить диплом в туапсе[/url] .
Diplomi_uxma
19 Oct 25 at 3:02 am
Клиника «Детокс» в Краснодаре предлагает услугу вызова нарколога на дом. Врачи приедут к вам в течение 1–2 часов, проведут осмотр и назначат необходимое лечение. Услуга доступна круглосуточно и анонимно.
Подробнее – [url=https://narkolog-na-dom-krasnodar27.ru/]вызов врача нарколога на дом в краснодаре[/url]
DanielNus
19 Oct 25 at 3:02 am
купить легальный диплом колледжа [url=frei-diplom4.ru]купить легальный диплом колледжа[/url] .
Diplomi_gpOl
19 Oct 25 at 3:03 am
старые дипломы купить [url=http://www.rudik-diplom3.ru]старые дипломы купить[/url] .
Diplomi_iuei
19 Oct 25 at 3:03 am
диплом медсестры с занесением в реестр купить [url=http://frei-diplom3.ru]диплом медсестры с занесением в реестр купить[/url] .
Diplomi_ntKt
19 Oct 25 at 3:04 am
перепланировка и согласование [url=soglasovanie-pereplanirovki-kvartiry4.ru]soglasovanie-pereplanirovki-kvartiry4.ru[/url] .
soglasovanie pereplanirovki kvartiri _pmOr
19 Oct 25 at 3:05 am
узаконивание перепланировки квартиры цена [url=https://zakazat-proekt-pereplanirovki-kvartiry11.ru/]zakazat-proekt-pereplanirovki-kvartiry11.ru[/url] .
zakazat proekt pereplanirovki kvartiri_vnet
19 Oct 25 at 3:05 am
купить диплом швеи [url=www.rudik-diplom5.ru]купить диплом швеи[/url] .
Diplomi_pmma
19 Oct 25 at 3:07 am
купить диплом внесенный в реестр [url=https://frei-diplom4.ru]купить диплом внесенный в реестр[/url] .
Diplomi_faOl
19 Oct 25 at 3:07 am
согласование перепланировки квартиры в москве цена [url=www.stoimost-soglasovaniya-pereplanirovki-kvartiry.ru/]www.stoimost-soglasovaniya-pereplanirovki-kvartiry.ru/[/url] .
stoimost soglasovaniya pereplanirovki kvartiri_adPt
19 Oct 25 at 3:07 am
изготовление проекта перепланировки [url=proekt-pereplanirovki-kvartiry17.ru]изготовление проекта перепланировки[/url] .
proekt pereplanirovki kvartiri_ktml
19 Oct 25 at 3:08 am
купить диплом в иваново [url=https://rudik-diplom4.ru]купить диплом в иваново[/url] .
Diplomi_xdOr
19 Oct 25 at 3:08 am
купить диплом в майкопе [url=www.rudik-diplom8.ru/]www.rudik-diplom8.ru/[/url] .
Diplomi_tiMt
19 Oct 25 at 3:08 am
согласование проекта перепланировки [url=https://soglasovanie-pereplanirovki-kvartiry14.ru/]https://soglasovanie-pereplanirovki-kvartiry14.ru/[/url] .
soglasovanie pereplanirovki kvartiri _mzEl
19 Oct 25 at 3:08 am
купить диплом в назрани [url=http://rudik-diplom11.ru]купить диплом в назрани[/url] .
Diplomi_xcMi
19 Oct 25 at 3:08 am
перепланировка офиса [url=http://www.soglasovanie-pereplanirovki-kvartiry4.ru]перепланировка офиса[/url] .
soglasovanie pereplanirovki kvartiri _bsOr
19 Oct 25 at 3:09 am
хоккей прогнозы на сегодня [url=www.prognozy-na-khokkej5.ru]хоккей прогнозы на сегодня[/url] .
prognozi na hokkei_ohEa
19 Oct 25 at 3:10 am
можно ли купить диплом медсестры [url=frei-diplom13.ru]можно ли купить диплом медсестры[/url] .
Diplomi_zakt
19 Oct 25 at 3:10 am
помощь в согласовании перепланировки квартиры [url=https://soglasovanie-pereplanirovki-kvartiry3.ru/]https://soglasovanie-pereplanirovki-kvartiry3.ru/[/url] .
soglasovanie pereplanirovki kvartiri _kjPi
19 Oct 25 at 3:11 am
В момент вызова важно сообщить:
Исследовать вопрос подробнее – https://narkologicheskaya-klinika-rostov13.ru/chastnaya-narkologicheskaya-klinika-v-rostove
JosephNoirl
19 Oct 25 at 3:12 am
купить диплом медсестры [url=http://frei-diplom14.ru]купить диплом медсестры[/url] .
Diplomi_mcoi
19 Oct 25 at 3:13 am
купить диплом занесением реестр украины [url=http://frei-diplom5.ru/]http://frei-diplom5.ru/[/url] .
Diplomi_xoPa
19 Oct 25 at 3:13 am
cuttingthered – Sharp branding, message delivers confidence and determination effectively.
MichaelLar
19 Oct 25 at 3:14 am
купить диплом учителя физической культуры [url=http://rudik-diplom1.ru]купить диплом учителя физической культуры[/url] .
Diplomi_bder
19 Oct 25 at 3:14 am
Ukrainian President Volodymyr Zelensky condemned Russian attacks on the Ukrainian regions of Kharkiv, Zaporizhzhia and Sumy on Monday, saying that the Kremlin intends to “humiliate diplomatic efforts” just hours before European leaders visit the White House.
[url=https://kra41.net]kra35[/url]
“The Russian war machine continues to destroy lives despite everything,” Zelensky said in a statement, hours before he’s due to meet US President Donald Trump in the Oval Office. “That is precisely why we are seeking assistance to put an end to the killings. That is why reliable security guarantees are required. That is why Russia should not be rewarded for its participation in this war.”
[url=https://kra42c.cc]kra39[/url]
“Everyone seeks dignified peace and true security,” the Ukrainian president said. “And at this very moment, the Russians are attacking Kharkiv, Zaporizhzhia, the Sumy region, and Odesa, destroying residential buildings and our civilian infrastructure.”
At least seven people were killed in Russia’s attack? on Kharkiv and a further three killed in the ballistic missile strike on the city of Zaporizhzhia, with scores more injured, according to Ukrainian authorities.
“This was a demonstrative and cynical Russian strike,” Zelensky added.
kra40 сс
https://kra-42cc.net
Danieljeove
19 Oct 25 at 3:14 am
кто купил диплом с занесением в реестр [url=https://frei-diplom6.ru/]кто купил диплом с занесением в реестр[/url] .
Diplomi_htOl
19 Oct 25 at 3:14 am
купить диплом в владикавказе [url=http://www.rudik-diplom4.ru]http://www.rudik-diplom4.ru[/url] .
Diplomi_qxOr
19 Oct 25 at 3:15 am
купить диплом в рязани [url=http://www.rudik-diplom11.ru]купить диплом в рязани[/url] .
Diplomi_feMi
19 Oct 25 at 3:16 am
согласование. [url=soglasovanie-pereplanirovki-kvartiry3.ru]soglasovanie-pereplanirovki-kvartiry3.ru[/url] .
soglasovanie pereplanirovki kvartiri _mpPi
19 Oct 25 at 3:17 am
купить диплом в красноярске [url=https://www.rudik-diplom10.ru]купить диплом в красноярске[/url] .
Diplomi_fmSa
19 Oct 25 at 3:19 am
The Minotaurus presale vesting is flexible genius. Token’s DAO influence key. Gaming market ripe.
minotaurus ico
WilliamPargy
19 Oct 25 at 3:19 am
перепланировка помещения [url=http://soglasovanie-pereplanirovki-kvartiry4.ru]перепланировка помещения[/url] .
soglasovanie pereplanirovki kvartiri _ebOr
19 Oct 25 at 3:20 am
купить диплом бурильщика [url=rudik-diplom1.ru]rudik-diplom1.ru[/url] .
Diplomi_rqer
19 Oct 25 at 3:20 am
купить диплом в петрозаводске [url=https://www.rudik-diplom4.ru]купить диплом в петрозаводске[/url] .
Diplomi_uiOr
19 Oct 25 at 3:20 am
купить диплом бакалавра [url=https://www.rudik-diplom11.ru]купить диплом бакалавра[/url] .
Diplomi_heMi
19 Oct 25 at 3:21 am
стоимость перепланировки квартиры в бти [url=http://stoimost-soglasovaniya-pereplanirovki-kvartiry.ru/]http://stoimost-soglasovaniya-pereplanirovki-kvartiry.ru/[/url] .
stoimost soglasovaniya pereplanirovki kvartiri_jpPt
19 Oct 25 at 3:21 am
прогноз футбол на сегодня [url=prognozy-na-futbol-10.ru]прогноз футбол на сегодня[/url] .
prognozi na fytbol_pyOi
19 Oct 25 at 3:22 am
Your style is very unique compared to other folks I’ve read stuff from.
Thanks for posting when you’ve got the opportunity, Guess I’ll just bookmark this web site.
Roof inspection services near me
19 Oct 25 at 3:22 am
Quality articles is the crucial to interest the viewers to pay
a visit the website, that’s what this web site
is providing.
ee88
19 Oct 25 at 3:22 am
Minotaurus ICO’s market research shines in concept. $MTAUR holders get DAO say. Presale hype justified.
mtaur coin
WilliamPargy
19 Oct 25 at 3:22 am
купить диплом в екатеринбург реестр [url=http://www.frei-diplom3.ru]купить диплом в екатеринбург реестр[/url] .
Diplomi_zgKt
19 Oct 25 at 3:23 am
Если вы ищете надежную клинику для вывода из запоя, обратитесь в «Детокс» в Краснодаре. Услуга вызова нарколога на дом доступна круглосуточно. Врачи приедут к вам в течение 1–2 часов и окажут необходимую помощь.
Подробнее тут – [url=https://narkolog-na-dom-krasnodar26.ru/]вызвать нарколога на дом в краснодаре[/url]
DanielCaupe
19 Oct 25 at 3:24 am
купить диплом в нижнем новгороде [url=https://rudik-diplom13.ru/]купить диплом в нижнем новгороде[/url] .
Diplomi_xoon
19 Oct 25 at 3:25 am
купить диплом без занесения в реестр [url=https://www.frei-diplom4.ru]купить диплом без занесения в реестр[/url] .
Diplomi_wiOl
19 Oct 25 at 3:25 am
купить диплом в кузнецке [url=rudik-diplom5.ru]rudik-diplom5.ru[/url] .
Diplomi_mrma
19 Oct 25 at 3:26 am
соглосование [url=www.soglasovanie-pereplanirovki-kvartiry14.ru]www.soglasovanie-pereplanirovki-kvartiry14.ru[/url] .
soglasovanie pereplanirovki kvartiri _dgEl
19 Oct 25 at 3:26 am
купить диплом в магнитогорске [url=https://rudik-diplom8.ru]https://rudik-diplom8.ru[/url] .
Diplomi_teMt
19 Oct 25 at 3:26 am
куплю диплом младшей медсестры [url=https://frei-diplom14.ru]https://frei-diplom14.ru[/url] .
Diplomi_jmoi
19 Oct 25 at 3:26 am
сделать проект перепланировки [url=http://proekt-pereplanirovki-kvartiry17.ru/]сделать проект перепланировки[/url] .
proekt pereplanirovki kvartiri_qpml
19 Oct 25 at 3:28 am
By including real-ԝorld applications іn lessons, OMT reveals Singapore pupils eҳactly how mathematics powers daily developments, sparking
passion аnd drive for exam quality.
Join οur smaⅼl-grօup on-site classes
in Singapore foor individualized guidance іn a nurturing
environment tһаt builds strong fundamental mathematics abilities.
Ƭһe holistic Singapore Math approach, ѡhich constructs multilayered ρroblem-solving abilities, highlights ѡhy math
tuition іs indispensable for mastering the curriculum
and preparing fօr future careers.
Ԝith PSLE math contributing ѕubstantially to tоtal ratings, tuition provideѕ additional resources ⅼike design answers f᧐r pattern acknowledgment ɑnd algebraic thinking.
Holistic growth ｖia math tuition not јust boosts
Ⲟ Level scores bսt ⅼikewise cultivates sеnsible reasoning abilities ᥙseful for lifelong discovering.
Ꮃith A Levels requiring proficiency іn vectors and complex numƅers, math tuition supplies targeted practice tߋ
handle these abstract ideas sucⅽessfully.
OMT’ѕ special mathematics program matches tһe MOE curriculum ƅy consisting of proprietary study tһat apply math
to genuine Singaporean contexts.
OMT’ѕ online system matches MOE syllabus οne, assisting yⲟu tаke on PSLE mathematics effortlessly аnd muсh
bettеr ratings.
Singapore’ѕ affordable streaming at young ages mаkes ѵery
еarly math tuition vital fоr securing advantageous courses tⲟ examination success.
Αlso visit mｙ page :: singapore math tuition
singapore math tuition
19 Oct 25 at 3:28 am