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!
Need TRON Energy? rent tron energy instantly and save on TRX transaction fees. Rent TRON Energy quickly, securely, and affordably using USDT, TRX, or smart contract transactions. No hidden fees—maximize the efficiency of your blockchain.
tronex-635
7 Oct 25 at 4:47 pm
свежие новости спорта [url=https://sportivnye-novosti-2.ru/]свежие новости спорта[/url] .
sportivnie novosti_pama
7 Oct 25 at 4:47 pm
спортивные события [url=http://www.sportivnye-novosti-1.ru]спортивные события[/url] .
sportivnie novosti_tkpi
7 Oct 25 at 4:48 pm
купить диплом тренера [url=http://www.rudik-diplom7.ru]купить диплом тренера[/url] .
Diplomi_yrPl
7 Oct 25 at 4:50 pm
Need TRON Energy? buy tron energy instantly and save on TRX transaction fees. Rent TRON Energy quickly, securely, and affordably using USDT, TRX, or smart contract transactions. No hidden fees—maximize the efficiency of your blockchain.
tronex-65
7 Oct 25 at 4:50 pm
Hey there! This is kind of off topic but I need
some guidance from an established blog. Is it difficult to set up your own blog?
I’m not very techincal but I can figure things out pretty quick.
I’m thinking about creating my own but I’m not sure where to start.
Do you have any tips or suggestions? Appreciate it
Stäbel Gainetra
7 Oct 25 at 4:50 pm
linebet live
linebet somalia
7 Oct 25 at 4:51 pm
Stimulant Supplys
best cocaine in australia
7 Oct 25 at 4:51 pm
прогнозы на спорт на сегодня бесплатно [url=www.prognozy-ot-professionalov4.ru]www.prognozy-ot-professionalov4.ru[/url] .
prognozi ot professionalov_trOr
7 Oct 25 at 4:51 pm
“What is your command?”“We wish to go to the Emerald City,ラブドール 激安” said the child,
ラブドール
7 Oct 25 at 4:52 pm
спортивные события [url=www.novosti-sporta-7.ru]www.novosti-sporta-7.ru[/url] .
novosti sporta_pcOt
7 Oct 25 at 4:52 pm
I like it when people get together and share opinions.
Great website, stick with it!
site
7 Oct 25 at 4:52 pm
купить диплом в нижневартовске [url=https://www.rudik-diplom1.ru]https://www.rudik-diplom1.ru[/url] .
Diplomi_jier
7 Oct 25 at 4:53 pm
мясо для собак для собак крупных пород – (Аналогично предыдущему запросу) Поиск товаров и информации, предназначенных для крупных пород собак.
Ronaldpef
7 Oct 25 at 4:53 pm
принудительный вывод из запоя москва [url=http://vyvod-iz-zapoya-9.ru]http://vyvod-iz-zapoya-9.ru[/url] .
vivod iz zapoya_xaEl
7 Oct 25 at 4:54 pm
прогнозы на спорт с описанием [url=https://prognozy-ot-professionalov4.ru/]prognozy-ot-professionalov4.ru[/url] .
prognozi ot professionalov_uwOr
7 Oct 25 at 4:56 pm
купить диплом в ростове-на-дону [url=https://rudik-diplom7.ru/]купить диплом в ростове-на-дону[/url] .
Diplomi_ztPl
7 Oct 25 at 4:58 pm
вывод из запоя в стационаре москва [url=vyvod-iz-zapoya-9.ru]vyvod-iz-zapoya-9.ru[/url] .
vivod iz zapoya_mkEl
7 Oct 25 at 4:59 pm
прогноз профессионалов на баскетбол на сегодня [url=www.prognozy-ot-professionalov4.ru]www.prognozy-ot-professionalov4.ru[/url] .
prognozi ot professionalov_esOr
7 Oct 25 at 5:00 pm
купить диплом врача [url=www.rudik-diplom3.ru/]купить диплом врача[/url] .
Diplomi_rmei
7 Oct 25 at 5:00 pm
купить диплом электромонтажника [url=http://rudik-diplom1.ru/]купить диплом электромонтажника[/url] .
Diplomi_yver
7 Oct 25 at 5:01 pm
Please let me know if you’re looking for a author for your blog.
You have some really great articles and I think I would be a good asset.
If you ever want to take some of the load off, I’d really
like to write some articles for your blog in exchange
for a link back to mine. Please shoot me an e-mail if interested.
Regards!
Stark Bargeno
7 Oct 25 at 5:04 pm
I for all time emailed this web site post page to all my friends, for the reason that if like to read it afterward my friends
will too.
seo
7 Oct 25 at 5:04 pm
вывод из запоя москва на дому [url=http://vyvod-iz-zapoya-9.ru]http://vyvod-iz-zapoya-9.ru[/url] .
vivod iz zapoya_cdEl
7 Oct 25 at 5:05 pm
новости тенниса [url=https://www.novosti-sporta-7.ru]новости тенниса[/url] .
novosti sporta_esOt
7 Oct 25 at 5:05 pm
sportbets [url=https://www.novosti-sporta-8.ru]sportbets[/url] .
novosti sporta_uqMa
7 Oct 25 at 5:05 pm
Aw, this was an extremely good post. Spending some time and actual effort to produce a really good article… but what
can I say… I procrastinate a whole lot and don’t seem to get anything done.
executive black car service
7 Oct 25 at 5:07 pm
бесплатные прогнозы на спорт [url=prognozy-ot-professionalov5.ru]бесплатные прогнозы на спорт[/url] .
prognozi ot professionalov_mpSt
7 Oct 25 at 5:09 pm
купить диплом в чебоксарах [url=http://rudik-diplom7.ru/]купить диплом в чебоксарах[/url] .
Diplomi_fvPl
7 Oct 25 at 5:09 pm
Good post but I was wanting to know if you could write a litte more on this topic?
I’d be very grateful if you could elaborate a little bit further.
Kudos!
bestchange ru обменник
7 Oct 25 at 5:10 pm
купить диплом в череповце [url=www.rudik-diplom3.ru/]www.rudik-diplom3.ru/[/url] .
Diplomi_ebei
7 Oct 25 at 5:11 pm
результаты матчей [url=www.novosti-sporta-7.ru/]результаты матчей[/url] .
novosti sporta_eoOt
7 Oct 25 at 5:11 pm
https://makeupcenter.ru
DonaldtiEls
7 Oct 25 at 5:11 pm
sportbets [url=http://novosti-sporta-8.ru]sportbets[/url] .
novosti sporta_bkMa
7 Oct 25 at 5:12 pm
купить диплом в артеме [url=rudik-diplom11.ru]rudik-diplom11.ru[/url] .
Diplomi_cuMi
7 Oct 25 at 5:13 pm
купить диплом в миассе [url=https://rudik-diplom4.ru/]купить диплом в миассе[/url] .
Diplomi_eeOr
7 Oct 25 at 5:13 pm
точные прогнозы на спорт [url=https://prognozy-ot-professionalov4.ru]https://prognozy-ot-professionalov4.ru[/url] .
prognozi ot professionalov_xfOr
7 Oct 25 at 5:13 pm
linebet somalia
download linebet
7 Oct 25 at 5:14 pm
Goodness, no matter tһough establishment is atas,
math is the critical subject tо developing confidence ѡith
calculations.
Alas, primary mathematics instructs practical սѕes such аs budgeting, ѕо guarantee уⲟur kid gets thіs properly fｒom young
age.
National Junior College, as Singapore’ѕ pioneering junior college, ᥙses unequaled opportunities fοr intellectual and leadership development іn a
historic setting. Ӏts boarding program ɑnd research centers foster self-reliance ɑnd
innovation ɑmong diverse students. Programs in arts, sciences, аnd humanities, including
electives, motivate deep expedition аnd excellence.
Worldwide collaborations аnd exchanges expand horizons
and build networks. Alumni lead іn different fields, reflecting
tһе college’senduring impact οn nation-building.
Hwa Chong Institution Junior College іs commemorated fߋr its seamless integrated program tһat masterfully combines strenuous scholastic challenges ԝith profound character advancement, cultivating ɑ brand-new generation ᧐f worldwide scholars and
ethical leaders ѡһo aгe equipped tо deal ᴡith complex
worldwide issues. Тhe organization boasts fіrst-rate infrastructure, including advanced ｒesearch centers, bilingual libraries, аnd innovation incubators, ᴡhеre highly
certified professors guide trainees tоward excellence іn fields liҝe scientific гesearch study, entrepreneurial endeavors, ɑnd cultural
researcһ studies. Trainees gain vital experiences tһrough substantial worldwide exchange programs, worldwide competitions іn mathematics and sciences, ɑnd collective projects tһat broaden tһeir horizons and refine their analytical and interpersonal skills.
Bү stressing development tһrough efforts like student-led startups аnd innovation workshops, ɑlong with service-oriented
activities tһat promote social duty, tһe college constructs durability, flexibility, and a strong
ethical structure іn its students. The vast alumni
network օf Hwa Chong Institution Junior College ⲟpens pathways to elite universities аnd influential professions аroսnd tһe woｒld,
highlighting tһe school’s withstanding legacy of fostering intellectual prowess аnd principled leadership.
Ɗon’ttake lightly lah, combine a reputable Junior College рlus maths excellence fⲟr
ensure hіgh A Levels гesults and smooth transitions.
Folks, fear tһe difference hor, maths base proves essential іn Junior College fоr
understanding informatiߋn, vital ᴡithin current digital ѕystem.
Folks, dread tһe disparity hor, math base іѕ essential at Junior College fоr grasping
infοrmation, vital ԝithin today’s online system.
Ιn ɑddition beyond institution amenities, emphasize on maths in ordeг to stop frequent errors ⅼike
sloppy mistakes at tests.
Folks, competitive style activated lah, robust primary mathematics гesults in superior science grasp аs
well aѕ engineering goals.
Oh, math serves аs the groundwork block in primary learning, helping children fοr spatial
analysis tо building paths.
Kiasu tuition centers specialize іn Math to
boost A-level scores.
Aiyo, lacking robust math іn Junior College, no matter top school children mіght falter at next-level equations, tһerefore develop іt ρromptly leh.
my web рage; junior college math tuition
junior college math tuition
7 Oct 25 at 5:14 pm
новости тенниса [url=http://novosti-sporta-8.ru]новости тенниса[/url] .
novosti sporta_inMa
7 Oct 25 at 5:15 pm
В Нижнем Новгороде «Частный Медик 24» предлагает доступные цены на вывод из запоя с полным курсом детоксикации.
Получить дополнительные сведения – [url=https://vyvod-iz-zapoya-v-stacionare22.ru/]быстрый вывод из запоя в стационаре в нижний новгороде[/url]
GordonGok
7 Oct 25 at 5:16 pm
Служба вывода из запоя на дому Stop-Alko в Екатеринбурге работает без перерывов, выезжает в любой район города, оказывает помощь с учётом всех медицинских стандартов.
Подробнее – [url=https://vyvod-iz-zapoya-ekaterinburg27.ru/]вывод из запоя клиника[/url]
Donaldawapy
7 Oct 25 at 5:16 pm
последние новости спорта [url=http://www.sportivnye-novosti-1.ru]последние новости спорта[/url] .
sportivnie novosti_fqpi
7 Oct 25 at 5:16 pm
sportbets [url=www.novosti-sporta-7.ru/]sportbets[/url] .
novosti sporta_swOt
7 Oct 25 at 5:17 pm
dhpb-smile – Loads fairly fast, no lag when switching between sections.
Dana Philbert
7 Oct 25 at 5:18 pm
купить диплом агронома [url=www.rudik-diplom10.ru]купить диплом агронома[/url] .
Diplomi_lnSa
7 Oct 25 at 5:18 pm
I got this web page from my friend who told me regarding this web site and now this time I
am visiting this website and reading very informative content
at this time.
omutogel
7 Oct 25 at 5:19 pm
купить диплом в ессентуках [url=https://rudik-diplom2.ru]купить диплом в ессентуках[/url] .
Diplomi_lapi
7 Oct 25 at 5:19 pm
Владельцы телефонов на Андроид или
iOS могут также скачать мобильное приложение.
вулкан
7 Oct 25 at 5:20 pm
купить старый диплом техникума [url=www.educ-ua7.ru]www.educ-ua7.ru[/url] .
Diplomi_hnea
7 Oct 25 at 5:20 pm