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=www.frei-diplom12.ru]диплом техникума старого образца купить в[/url] .
Diplomi_xwPt
1 Nov 25 at 9:18 am
Me encantó este contenido sobre las casino tragamonedas
más destacadas en Pin-Up México. Es impresionante cómo juegos como Gates of Olympus, Sweet Bonanza
y Book of Dead continúan siendo los preferidos. Se nota que
el artículo está pensado para quienes realmente disfrutan de
los juegos de casino online.
Para quienes buscan conocer los slots más populares de Pin Up México, este texto es una lectura obligada.
Se agradece ver una mezcla entre títulos nostálgicos y
nuevas propuestas en el mercado mexicano de apuestas.
Puedes leer el artículo completo aquí y descubrir todos los detalles sobre
los juegos más jugados en Pin Up México.
press release
1 Nov 25 at 9:20 am
купить диплом в миассе [url=https://rudik-diplom3.ru/]купить диплом в миассе[/url] .
Diplomi_bpei
1 Nov 25 at 9:21 am
купить диплом в димитровграде [url=https://www.rudik-diplom11.ru]купить диплом в димитровграде[/url] .
Diplomi_hhMi
1 Nov 25 at 9:21 am
куплю диплом высшего образования [url=www.rudik-diplom10.ru]куплю диплом высшего образования[/url] .
Diplomi_xqSa
1 Nov 25 at 9:22 am
купить диплом с занесением в реестр краснодар [url=frei-diplom1.ru]frei-diplom1.ru[/url] .
Diplomi_ugOi
1 Nov 25 at 9:23 am
купить диплом в димитровграде [url=http://rudik-diplom2.ru]купить диплом в димитровграде[/url] .
Diplomi_aspi
1 Nov 25 at 9:24 am
купить диплом в казани [url=https://www.rudik-diplom1.ru]купить диплом в казани[/url] .
Diplomi_jmer
1 Nov 25 at 9:24 am
online pharmacy ireland
Edmundexpon
1 Nov 25 at 9:24 am
online pharmacy
Edmundexpon
1 Nov 25 at 9:25 am
диплом о высшем образовании с занесением в реестр купить [url=frei-diplom5.ru]диплом о высшем образовании с занесением в реестр купить[/url] .
Diplomi_wfPa
1 Nov 25 at 9:25 am
купить диплом в балашове [url=www.rudik-diplom5.ru/]купить диплом в балашове[/url] .
Diplomi_ixma
1 Nov 25 at 9:26 am
Quality content is the important to invite
the viewers to go to see the website, that’s what this site is providing.
online casino paypal
1 Nov 25 at 9:27 am
купить диплом регистрацией [url=http://frei-diplom1.ru/]купить диплом регистрацией[/url] .
Diplomi_zxOi
1 Nov 25 at 9:27 am
mostbet история компании [url=https://www.mostbet12033.ru]https://www.mostbet12033.ru[/url]
mostbet_kg_cnpa
1 Nov 25 at 9:28 am
I am not certain the place you’re getting your info,
but great topic. I must spend a while learning more or figuring out more.
Thanks for great information I was looking for this info
for my mission.
نمایندگی سولاردام ال جی
1 Nov 25 at 9:29 am
What’s up, this weekend is good in support of me, for
the reason that this point in time i am reading this fantastic informative
piece of writing here at my home.
Honesto Finlorex
1 Nov 25 at 9:29 am
I think this is among the most important info for me.
And i am glad reading your article. But wanna remark on few general things, The
web site style is wonderful, the articles is really
nice : D. Good job, cheers
schwimmbecken online bestellen
1 Nov 25 at 9:29 am
Купить диплом колледжа в Одесса [url=http://www.educ-ua7.ru]http://www.educ-ua7.ru[/url] .
Diplomi_otea
1 Nov 25 at 9:30 am
https://xn--j1adp.xn--80aejmgchrc3b6cf4gsa.xn--p1ai/ Точка включения
MathewLit
1 Nov 25 at 9:31 am
купить диплом с занесением в реестр казань [url=http://frei-diplom4.ru/]http://frei-diplom4.ru/[/url] .
Diplomi_tgOl
1 Nov 25 at 9:31 am
купить диплом вуза с проводкой [url=www.frei-diplom5.ru/]www.frei-diplom5.ru/[/url] .
Diplomi_dsPa
1 Nov 25 at 9:31 am
Seo Backlinks
Backlinks for promotion are a very good tool.
Backlinks are important to Google’s crawlers, the more backlinks the better!
Robots see many links as links to your resource
and your site’s ranking goes up.
I have extensive experience in posting backlinks,
The forum database is always up to date as I have an efficient server and I do not rent remote servers, so my capabilities allow me to collect the forum database around the clock.
Seo Backlinks
1 Nov 25 at 9:31 am
купить диплом в волжском [url=https://rudik-diplom4.ru]купить диплом в волжском[/url] .
Diplomi_obOr
1 Nov 25 at 9:33 am
купить аттестат за 9 класс [url=http://www.rudik-diplom2.ru]купить аттестат за 9 класс[/url] .
Diplomi_fupi
1 Nov 25 at 9:33 am
My partner and I absolutely love your blog and find the majority of your post’s to be what precisely I’m looking for.
can you offer guest writers to write content in your case?
I wouldn’t mind publishing a post or elaborating on a few of the subjects you write related to
here. Again, awesome web log!
My homepage ниссан автосервис
ниссан автосервис
1 Nov 25 at 9:33 am
кинешемский педагогический колледж диплом 1998 года купить [url=http://frei-diplom11.ru]http://frei-diplom11.ru[/url] .
Diplomi_ifsa
1 Nov 25 at 9:34 am
Вy commemorating ⅼittle victories іn progress monitoring,
OMT nurtures а favorable connection ѡith math, motivating pupils fⲟr
examination excellence.
Expand уour horizons ᴡith OMT’ѕ upcoming brand-neԝ physical areɑ opening in Septеmber 2025, uѕing
even more opportunities fօr hands-οn math exploration.
Offered tһat mathematics plays an essential function іn Singapore’s economic advancement ɑnd progress, investing іn specialized math tuition equips students ᴡith the analytical skills
required tߋ thrive in a competitive landscape.
primary school math tuition develops examination endurance tһrough timed drills, imitating the PSLE’ѕ
two-paper format and helping trainees manage time
effectively.
Ꮃith the O Level math syllabus occasionally progressing, tuition кeeps pupils updated οn adjustments, guaranteeing tһey are wеll-prepared for current formats.
Planning for the unpredictability οf A Level questions, tuition develops adaptive рroblem-solving аpproaches f᧐r real-timｅ test scenarios.
OMT’ѕ one-of-a-kind curriculum, crafted tο support the MOE syllabus, consists of tailored components tһat
adjust tߋ private learning designs f᧐r more reliable
mathematics proficiency.
Comprehensive coverage οf topics sia, leaving no spaces in knowledge fⲟr leading math accomplishments.
Math tuition cultivates determination, helping Singapore pupils tackle marathon exam sessions ѡith
continual focus.
My web-site … private math tuition singapore
private math tuition singapore
1 Nov 25 at 9:34 am
купить диплом жд техникума [url=http://frei-diplom12.ru/]купить диплом жд техникума[/url] .
Diplomi_kfPt
1 Nov 25 at 9:35 am
Good write-up. I certainly love this site. Stick with it!
FeltoriXan
1 Nov 25 at 9:35 am
купить диплом повара-кондитера [url=http://rudik-diplom1.ru/]купить диплом повара-кондитера[/url] .
Diplomi_nler
1 Nov 25 at 9:37 am
купить бланк диплома [url=rudik-diplom11.ru]купить бланк диплома[/url] .
Diplomi_neMi
1 Nov 25 at 9:38 am
купить диплом в ейске [url=www.rudik-diplom3.ru]www.rudik-diplom3.ru[/url] .
Diplomi_utei
1 Nov 25 at 9:38 am
купить диплом о высшем образовании с занесением в реестр цена [url=http://frei-diplom5.ru]купить диплом о высшем образовании с занесением в реестр цена[/url] .
Diplomi_idPa
1 Nov 25 at 9:38 am
E2BET Singapore: Trusted Online Casino SG | Live
Casino, Slots & Sports Betting
E2Bet
1 Nov 25 at 9:39 am
купить диплом логиста [url=http://rudik-diplom2.ru/]купить диплом логиста[/url] .
Diplomi_kgpi
1 Nov 25 at 9:39 am
Kent Casino is a licensed online platform that has been operating since the end of 2023 https://voyag-tour.ru
Robinkanty
1 Nov 25 at 9:40 am
Читатель отправляется в интеллектуальное путешествие по самым ярким событиям истории и важнейшим научным открытиям. Мы раскроем тайны эпох, покажем, как идеи меняли миры, и объясним, почему эти знания остаются актуальными сегодня.
Подробнее тут – https://halfstep123.wpxblog.jp/3dprint001
Timothymow
1 Nov 25 at 9:40 am
compare online pharmacy prices [url=https://safemedsguide.shop/#]best online pharmacy[/url] Safe Meds Guide
Hermanengam
1 Nov 25 at 9:40 am
диплом колледжа купить в екатеринбурге [url=https://www.frei-diplom12.ru]https://www.frei-diplom12.ru[/url] .
Diplomi_hoPt
1 Nov 25 at 9:41 am
https://t.me/ud_Lex/57
MichaelPione
1 Nov 25 at 9:42 am
купить диплом педагога [url=www.rudik-diplom5.ru]купить диплом педагога[/url] .
Diplomi_yyma
1 Nov 25 at 9:42 am
диплом купить с внесением в реестр [url=http://www.frei-diplom4.ru]диплом купить с внесением в реестр[/url] .
Diplomi_xeOl
1 Nov 25 at 9:44 am
Hi friends, its enormous piece of writing about teachingand completely
explained, keep it up all the time.
family rv
1 Nov 25 at 9:45 am
купить диплом технолога [url=http://www.rudik-diplom7.ru]купить диплом технолога[/url] .
Diplomi_viPl
1 Nov 25 at 9:45 am
купить диплом в липецке [url=https://www.rudik-diplom4.ru]купить диплом в липецке[/url] .
Diplomi_uqOr
1 Nov 25 at 9:45 am
Pretty component to content. I just stumbled upon your web site and in accession capital to say that I get actually enjoyed account
your blog posts. Anyway I’ll be subscribing on your feeds and even I success you access persistently
fast.
vajina dış dudak estetiği
1 Nov 25 at 9:47 am
top-rated pharmacies in Ireland
Edmundexpon
1 Nov 25 at 9:48 am
В этом информативном тексте представлены захватывающие события и факты, которые заставят вас задуматься. Мы обращаем внимание на важные моменты, которые часто остаются незамеченными, и предлагаем новые перспективы на привычные вещи. Подготовьтесь к тому, чтобы быть поглощенным увлекательными рассказами!
Смотри, что ещё есть – https://apzp.cz/obecna-vychodiska-poradenstvi-ozp/evropska-strategie-pro-pomoc-osobam-se-zdravotnim-postizenim-2010_2020
BrettPeemi
1 Nov 25 at 9:49 am
pharmacy online: AussieMedsHubAu – online pharmacy australia
Johnnyfuede
1 Nov 25 at 9:49 am