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=http://rudik-diplom14.ru/]http://rudik-diplom14.ru/[/url] .
Diplomi_ywea
2 Nov 25 at 7:09 am
диплом медсестры с аккредитацией купить [url=http://www.frei-diplom13.ru]диплом медсестры с аккредитацией купить[/url] .
Diplomi_xxkt
2 Nov 25 at 7:09 am
UkMedsGuide [url=https://ukmedsguide.com/#]UkMedsGuide[/url] UK online pharmacies list
Hermanengam
2 Nov 25 at 7:10 am
best pharmacy sites with discounts [url=https://safemedsguide.shop/#]best online pharmacy[/url] Safe Meds Guide
Hermanengam
2 Nov 25 at 7:11 am
уф печать принтсалон [url=http://teletype.in/@alexd78/p7K3J4hm1Lc]http://teletype.in/@alexd78/p7K3J4hm1Lc[/url] .
pechat na fytbolkah_irKa
2 Nov 25 at 7:11 am
диплом техникума купить в челябинске [url=http://www.frei-diplom9.ru]диплом техникума купить в челябинске[/url] .
Diplomi_pjea
2 Nov 25 at 7:12 am
buy medicine online legally Ireland: Irish Pharma Finder – top-rated pharmacies in Ireland
HaroldSHems
2 Nov 25 at 7:12 am
online pharmacy reviews and ratings: online pharmacy reviews and ratings – promo codes for online drugstores
Johnnyfuede
2 Nov 25 at 7:13 am
купить свидетельство о браке [url=rudik-diplom8.ru]купить свидетельство о браке[/url] .
Diplomi_unMt
2 Nov 25 at 7:13 am
купить диплом в сосновом бору [url=https://rudik-diplom11.ru]https://rudik-diplom11.ru[/url] .
Diplomi_wcMi
2 Nov 25 at 7:14 am
купить диплом с занесением в реестр челябинск [url=www.frei-diplom5.ru]купить диплом с занесением в реестр челябинск[/url] .
Diplomi_jxPa
2 Nov 25 at 7:15 am
купить диплом с проводкой одно [url=www.frei-diplom2.ru]купить диплом с проводкой одно[/url] .
Diplomi_rjEa
2 Nov 25 at 7:15 am
OMT’ѕ standalone e-learning choices equip inxependent expedition, supporting а personal love
fߋr math and test ambition.
Opｅn your child’s fᥙll capacity іn mathematics with
OMT Math Tuition’ѕ expert-led classes, customized tо Singapore’s MOE syllabus for
primary, secondary, ɑnd JC trainees.
Ꮃith students in Singapore starting formal math education fгom tһе firѕt
day and facing һigh-stakes assessments, math tuition ρrovides thе additional edge neeԁed to achieve leading efficiency in thiѕ essential topic.
Enrolling іn primary school school math tuition earlу fosters sеlf-confidence,
reducing anxiety fⲟr PSLE takers who deal wіth hіgh-stakes concerns ߋn speed, distance, аnd time.
Secondary math tuition conquers tһe limitations of big classroom sizes, providing concentrated іnterest that improves understanding f᧐r O Level preparation.
Junior college math tuition іs essential fоr A Levels aѕ іt gгows understanding of innovative calculus topics ⅼike assimilation strategies аnd differential equations, wһiｃһ are central
to tһe test curriculum.
OMT establishes itѕｅlf apаrt with аn educational program that improves MOE curriculum ᥙsing collaborative
ⲟn-ⅼine discussion forums f᧐r discussing proprietary mathematics difficulties.
OMT’ѕ cost effective online option lah, ցiving high quality tuition ѡithout damaging
thе bank for better mathematics еnd гesults.
Singapore’ѕ focus on problem-solving in math exams mаkes tuiton crucial f᧐r developing crucial thinking abilities Ьeyond school hоurs.
My webpage … primary school maths tuition
primary school maths tuition
2 Nov 25 at 7:16 am
купить диплом колледжа с занесением [url=http://frei-diplom9.ru/]купить диплом колледжа с занесением[/url] .
Diplomi_jlea
2 Nov 25 at 7:16 am
promo codes for online drugstores [url=https://safemedsguide.com/#]buy medications online safely[/url] trusted online pharmacy USA
Hermanengam
2 Nov 25 at 7:17 am
В Ростове-на-Дону клиника «ЧСП№1» предоставляет услуги по выводу из запоя. Вы можете заказать выезд нарколога на дом или пройти лечение в стационаре. Все процедуры проводятся анонимно и с соблюдением конфиденциальности.
Получить дополнительные сведения – [url=https://vyvod-iz-zapoya-rostov27.ru/]вывод из запоя цена ростов-на-дону[/url]
ArronvaG
2 Nov 25 at 7:17 am
купить диплом в тобольске [url=https://www.rudik-diplom6.ru]https://www.rudik-diplom6.ru[/url] .
Diplomi_imKr
2 Nov 25 at 7:19 am
печать на текстиле спб [url=http://telegra.ph/Mir-korporativnoj-atributiki-polnyj-gid-po-uslugam-pechati-10-28]http://telegra.ph/Mir-korporativnoj-atributiki-polnyj-gid-po-uslugam-pechati-10-28[/url] .
Tipografiya Print Salon_szsr
2 Nov 25 at 7:20 am
купить диплом в кирове [url=https://rudik-diplom4.ru/]купить диплом в кирове[/url] .
Diplomi_ldOr
2 Nov 25 at 7:20 am
медсестра которая купила диплом врача [url=frei-diplom14.ru]frei-diplom14.ru[/url] .
Diplomi_awoi
2 Nov 25 at 7:20 am
купить диплом техникума 1996 года [url=www.frei-diplom10.ru]купить диплом техникума 1996 года[/url] .
Diplomi_ydEa
2 Nov 25 at 7:20 am
купить диплом в нижним тагиле [url=rudik-diplom14.ru]купить диплом в нижним тагиле[/url] .
Diplomi_jqea
2 Nov 25 at 7:21 am
pharmacy discount codes AU: Australian pharmacy reviews – compare pharmacy websites
Johnnyfuede
2 Nov 25 at 7:21 am
печать на футболках спб [url=www.teletype.in/@alexd78/p7K3J4hm1Lc]www.teletype.in/@alexd78/p7K3J4hm1Lc[/url] .
pechat na fytbolkah_stKa
2 Nov 25 at 7:22 am
купить диплом колледжа с занесением в реестр [url=http://frei-diplom4.ru/]купить диплом колледжа с занесением в реестр[/url] .
Diplomi_evOl
2 Nov 25 at 7:22 am
Food-chem.ru — это живой, ежедневно обновляемый портал о здоровом образе жизни, где советы по питанию подкреплены исследованиями и проверенными практиками. Здесь вы найдёте разбор ошибок подсчёта калорий, понятные гиды по продуктам и вдохновляющие материалы о здоровье без лишних догм. В подборках «Полезная информация» — от МРТ орбит до промышленных LED-светильников — всё изложено простым языком. Загляните на https://food-chem.ru/ и соберите персональную систему питания, которая работает на результат, а не на краткосрочный эффект.
kylevnPlafe
2 Nov 25 at 7:22 am
click the following website
PHP hook, building hooks in your application – Sjoerd Maessen blog at Sjoerd Maessen blog
click the following website
2 Nov 25 at 7:24 am
seo компании [url=http://reiting-kompanii-po-prodvizheniyu-sajtov.ru]seo компании[/url] .
agentstvo poiskovogo prodvijeniya_crKt
2 Nov 25 at 7:26 am
I savor, result in I found exactly what I used to be having a look
for. You have ended my 4 day lengthy hunt! God Bless you man. Have a great day.
Bye
fk22
2 Nov 25 at 7:26 am
купить диплом колледжа с занесением в реестр [url=www.frei-diplom10.ru]купить диплом колледжа с занесением в реестр[/url] .
Diplomi_tmEa
2 Nov 25 at 7:28 am
Israel’s attack in Doha was not entirely surprising, given Israel’s vow to eliminate Hamas — but some aspects of it are still shocking.
[url=https://megasbmegadarknetmarketonionhydrashopomgomgrutor555cnyid.com]mega2ooyov5nrf42ld7gnbsurg2rgmxn2xkxj5datwzv3qy5pk3p57qd onion[/url]
Here are three main reasons:
[url=https://mega2onq5nskz5ib5cg3a2aqkcprqnm3lojxtik2zeou6au6mno7d4ad.com]mega2ousbpnmmput4tiyu4oa4mjck2icier52ud6lmgrhzlikrxmysid onion[/url]
Israel claimed credit immediately – in contrast to the last time the Israelis targeted a Hamas leader outside Gaza.
The US and Israel had asked Qatar to host Hamas leaders. Hamas’ location was not a secret. There was an unstated understanding that while Israel could assassinate the leaders, they would not do so, given Qatar’s mediation role.
The strike makes a hostage deal less likely, since any agreement requires negotiating with Hamas leadership in Doha.
Subscribers can read the full analysis here.
https://mega555kf7lsmb54yd6etzginolhxxi4ytdoma2rf77ngq55fhfcnyid.ltd
mega2ooyov5nrf42ld7gnbsurg2rgmxn2xkxj5datwzv3qy5pk3p57qd.onion
Michaelfuelp
2 Nov 25 at 7:28 am
купить диплом в набережных челнах [url=www.rudik-diplom14.ru/]купить диплом в набережных челнах[/url] .
Diplomi_zmea
2 Nov 25 at 7:28 am
диплом медсестры с занесением в реестр купить [url=https://www.frei-diplom2.ru]диплом медсестры с занесением в реестр купить[/url] .
Diplomi_heEa
2 Nov 25 at 7:28 am
Aussie Meds Hub: online pharmacy australia – verified online chemists in Australia
Johnnyfuede
2 Nov 25 at 7:31 am
OMT’s enrichment tasks past the syllabus introduce mathematics’ѕ unlimited opportunities, sparking іnterest and exam passion.
Join ߋur small-grⲟup ⲟn-site classes іn Singapore for individualized
assistance іn a nurturing environmenjt tһat builds strong fundamental math abilities.
Ꭺs math forms tһe bedrock of abstract thought and vital problem-solving in Singapore’ѕ education system, expert math tuition suipplies tһｅ customized guidance neｃessary to
turn obstacles іnto victories.
Ϝor PSLE achievers, tuition supplies mock exams аnd feedback, assisting refine responses
fⲟr optimum marks іn ƅoth multiple-choice ɑnd
оpen-ended arｅas.
Math tuition teaches efficient time management techniques, assisting secondary students fսll O Level tests
ԝithin the allocated duration ѡithout rushing.
Math tuition аt the junior college degree highlights
conceptual quality οver memorizing memorization, vital fⲟr taking on application-based A
Level questions.
Τhe originality of OMT exists іn its custom-maⅾе curriculum tһat
bridges MOE curriculum gaps with auxiliary resources ⅼike proprietary worksheets ɑnd solutions.
OMT’s ѕystem enbcourages goal-setting ѕia, tracking milestones іn the direction of attaining һigher qualities.
Tuition exposes pupils tօ varied concern types, expanding tһeir readiness for unpredictable Singapore math tests.
Αlso visit my site … A levels math tuition
A levels math tuition
2 Nov 25 at 7:31 am
online pharmacy [url=https://safemedsguide.shop/#]promo codes for online drugstores[/url] buy medications online safely
Hermanengam
2 Nov 25 at 7:33 am
Если запой стал проблемой, обращайтесь в клинику «ЧСП№1» в Ростове-на-Дону. Помощь анонимна и круглосуточна.
Исследовать вопрос подробнее – [url=https://vyvod-iz-zapoya-rostov15.ru/]скорая вывод из запоя ростов-на-дону[/url]
Robertodes
2 Nov 25 at 7:34 am
купить диплом о средне специальном образовании реестр [url=frei-diplom2.ru]купить диплом о средне специальном образовании реестр[/url] .
Diplomi_sbEa
2 Nov 25 at 7:34 am
купить диплом об окончании техникума спб [url=http://frei-diplom9.ru]купить диплом об окончании техникума спб[/url] .
Diplomi_pxea
2 Nov 25 at 7:35 am
Israel’s attack in Doha was not entirely surprising, given Israel’s vow to eliminate Hamas — but some aspects of it are still shocking.
[url=https://megadmeovbj6ahqw3reuqu5gbg4meixha2js2in3ukymwkwjqqib6tqd.net]mega2onq5nskz5ib5cg3a2aqkcprqnm3lojxtik2zeou6au6mno7d4ad.onion[/url]
Here are three main reasons:
[url=https://mega555kf7lsmb54yd6etzginolhxxi4ytdoma2rf77ngq55fhfcnyid-mg2.com]mega2onq5nskz5ib5cg3a2aqkcprqnm3lojxtik2zeou6au6mno7d4ad.onion[/url]
Israel claimed credit immediately – in contrast to the last time the Israelis targeted a Hamas leader outside Gaza.
The US and Israel had asked Qatar to host Hamas leaders. Hamas’ location was not a secret. There was an unstated understanding that while Israel could assassinate the leaders, they would not do so, given Qatar’s mediation role.
The strike makes a hostage deal less likely, since any agreement requires negotiating with Hamas leadership in Doha.
Subscribers can read the full analysis here.
https://mega555kf7lsmb54yd6etzginolhxxi4ytdoma2rf77ngq55fhfcnyid-at.com
mega2onq5nskz5ib5cg3a2aqkcprqnm3lojxtik2zeou6au6mno7d4ad onion
Michaelfuelp
2 Nov 25 at 7:35 am
I think the admin of this web site is really working hard in favor of his web site, since here every information is quality
based stuff.
au88
2 Nov 25 at 7:36 am
buy medicine online legally Ireland
Edmundexpon
2 Nov 25 at 7:37 am
купить диплом в абакане [url=https://www.rudik-diplom3.ru]купить диплом в абакане[/url] .
Diplomi_edei
2 Nov 25 at 7:37 am
купить диплом в чапаевске [url=rudik-diplom5.ru]купить диплом в чапаевске[/url] .
Diplomi_afma
2 Nov 25 at 7:37 am
online pharmacy [url=https://ukmedsguide.shop/#]legitimate pharmacy sites UK[/url] safe place to order meds UK
Hermanengam
2 Nov 25 at 7:37 am
купить диплом врача с занесением в реестр [url=www.frei-diplom2.ru/]купить диплом врача с занесением в реестр[/url] .
Diplomi_ieEa
2 Nov 25 at 7:38 am
Компания ЮМД ГРУПП https://umdgroup.ru/ занимается поставкой и сервисом медицинского оборудования по всей России. Предлагает широкий ассортимент лабораторного и медицинского оборудования, осуществляет техническое обслуживание и консультирование специалистов. Является официальным дистрибьютором продукции WONDFO в ПФО.
wiwamwtwilS
2 Nov 25 at 7:39 am
В своё время работали по опту! Набережные Челны купить кокаин, мефедрон, гашиш, бошки, скорость, меф, закладку, заказать онлайн самое норм) я думаю лучше лс нет) а сайт это вы о нас заботетесь) комфорта только себе и клиентам больше) а это GUD!
ThomasronsE
2 Nov 25 at 7:39 am
Если вы или ваши близкие нуждаетесь в выводе из запоя в Ростове-на-Дону, клиника «ЧСП№1» предлагает квалифицированную помощь. Врачи приедут на дом или вы сможете пройти лечение в стационаре. Цены на услуги начинаются от 3500 рублей.
Детальнее – [url=https://vyvod-iz-zapoya-rostov16.ru/]помощь вывод из запоя ростов-на-дону[/url]
Donaldcer
2 Nov 25 at 7:40 am
Does your site have a contact page? I’m having trouble locating it but, I’d like
to send you an email. I’ve got some suggestions for
your blog you might be interested in hearing. Either way,
great blog and I look forward to seeing it improve over time.
88XX
2 Nov 25 at 7:40 am