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.narkologicheskaya-klinika-20.ru]www.narkologicheskaya-klinika-20.ru[/url] .
narkologicheskaya klinika _gmPr
7 Oct 25 at 9:14 am
This site was… how do you say it? Relevant!! Finally I’ve found something that helped me.
Kudos!
https://artinvest.uk.comc
7 Oct 25 at 9:16 am
где купить диплом техникума в новосибирске [url=https://frei-diplom9.ru/]где купить диплом техникума в новосибирске[/url] .
Diplomi_ujea
7 Oct 25 at 9:16 am
купить кухню в спб от производителя [url=https://kuhni-spb-4.ru/]купить кухню в спб от производителя[/url] .
kyhni spb_ixer
7 Oct 25 at 9:16 am
I visited various blogs except the audio quality for audio songs
existing at this site is really wonderful.
best crypto casino
7 Oct 25 at 9:17 am
I am truly happy to read this webpage posts which includes tons of valuable data, thanks for
providing these kinds of information.
ev99
7 Oct 25 at 9:18 am
диплом колледжа купить екатеринбург [url=http://www.frei-diplom8.ru]http://www.frei-diplom8.ru[/url] .
Diplomi_yksr
7 Oct 25 at 9:19 am
Thanks for sharing your thoughts on казино с моментальными выплатами.
Regards
казино с быстрыми выплатами
7 Oct 25 at 9:19 am
Je suis pactise avec Mafia Casino, il orchestre une conspiration de recompenses secretes. Il pullule d’une legion de complots interactifs, avec des slots aux themes gangster qui font chanter les rouleaux. Le support client est un consigliere vigilant et incessant, accessible par message code ou appel direct. Les flux sont masques par des voiles crypto, malgre cela des largesses gratuites supplementaires boosteraient les operations. Dans l’ensemble du domaine, Mafia Casino devoile un plan de triomphes secrets pour les gardiens des empires numeriques ! Par surcroit le portail est une planque visuelle imprenable, infuse une essence de mystere mafieux.
casino slot mafia|
Mikedaniel6zef
7 Oct 25 at 9:19 am
https://eiforiyavkusa.ru
DonaldtiEls
7 Oct 25 at 9:20 am
http://www.cap-sangjin-chinh-hang.xyz noted
PHP hook, building hooks in your application – Sjoerd Maessen blog at Sjoerd Maessen blog
www.cap-sangjin-chinh-hang.xyz noted
7 Oct 25 at 9:20 am
купить диплом в кургане [url=http://www.rudik-diplom6.ru]купить диплом в кургане[/url] .
Diplomi_yzKr
7 Oct 25 at 9:21 am
купить диплом в новороссийске [url=https://rudik-diplom7.ru/]купить диплом в новороссийске[/url] .
Diplomi_uwPl
7 Oct 25 at 9:21 am
купить диплом в черкесске [url=http://rudik-diplom3.ru]купить диплом в черкесске[/url] .
Diplomi_kkei
7 Oct 25 at 9:21 am
прогнозы на спорт с описанием [url=https://prognozy-ot-professionalov4.ru]https://prognozy-ot-professionalov4.ru[/url] .
prognozi ot professionalov_hjOr
7 Oct 25 at 9:21 am
новости киберспорта [url=www.sport-novosti-1.ru]www.sport-novosti-1.ru[/url] .
sport novosti_ohpa
7 Oct 25 at 9:21 am
заказать кухню в спб по индивидуальному проекту [url=www.kuhni-spb-4.ru/]www.kuhni-spb-4.ru/[/url] .
kyhni spb_wner
7 Oct 25 at 9:22 am
купить диплом техникума ржд [url=http://www.frei-diplom9.ru]купить диплом техникума ржд[/url] .
Diplomi_nyea
7 Oct 25 at 9:22 am
частная наркологическая клиника в москве анонимное [url=https://narkologicheskaya-klinika-20.ru/]narkologicheskaya-klinika-20.ru[/url] .
narkologicheskaya klinika _psPr
7 Oct 25 at 9:23 am
купить диплом инженера по охране труда [url=www.rudik-diplom10.ru]купить диплом инженера по охране труда[/url] .
Diplomi_sjSa
7 Oct 25 at 9:23 am
заказ кухни спб [url=https://kuhni-spb-4.ru/]kuhni-spb-4.ru[/url] .
kyhni spb_uzer
7 Oct 25 at 9:25 am
купить диплом строительного техникума в москве [url=www.frei-diplom12.ru/]купить диплом строительного техникума в москве[/url] .
Diplomi_lkPt
7 Oct 25 at 9:25 am
спортивные аналитики [url=https://sportivnye-novosti-1.ru/]sportivnye-novosti-1.ru[/url] .
sportivnie novosti_ltpi
7 Oct 25 at 9:26 am
pin up texnik yordam [url=http://pinup5006.ru]pin up texnik yordam[/url]
pin_up_oxKt
7 Oct 25 at 9:27 am
спорт сегодня [url=https://sport-novosti-1.ru]https://sport-novosti-1.ru[/url] .
sport novosti_fppa
7 Oct 25 at 9:28 am
В этом интересном тексте собраны обширные сведения, которые помогут вам понять различные аспекты обсуждаемой темы. Мы разбираем детали и факты, делая акцент на важности каждого элемента. Не упустите возможность расширить свои знания и взглянуть на мир по-новому!
Это стоит прочитать полностью – https://www.studiocaiazzo.com/2020/10/22/convincing-reasons-you-need-to-learn
Jasonjed
7 Oct 25 at 9:30 am
dragon casino
Драгон Мани – это стильное онлайн-казино с широким ассортиментом игр. Привлекательные бонусы, мгновенные выплаты и удобный интерфейс обещают комфортный и выгодный игровой опыт
драгон мани казино
7 Oct 25 at 9:31 am
купить диплом в феодосии [url=http://rudik-diplom3.ru]http://rudik-diplom3.ru[/url] .
Diplomi_yaei
7 Oct 25 at 9:33 am
купить диплом в рубцовске [url=rudik-diplom10.ru]rudik-diplom10.ru[/url] .
Diplomi_mjSa
7 Oct 25 at 9:33 am
Hi there, of course this article is in fact fastidious and
I have learned lot of things from it regarding blogging.
thanks.
dewascatter
7 Oct 25 at 9:33 am
купить диплом бурильщика [url=www.rudik-diplom6.ru/]www.rudik-diplom6.ru/[/url] .
Diplomi_uiKr
7 Oct 25 at 9:34 am
I really like looking through a post that will make men and women think.
Also, thank you for allowing me to comment!
نمایشگاه بین المللی لوستر ۱۴۰۴
7 Oct 25 at 9:35 am
Велосипеды с карбоновой рамой по выгодным ценам кракен даркнет маркет kraken актуальные ссылки кракен ссылка kraken kraken официальные ссылки
RichardPep
7 Oct 25 at 9:38 am
купить диплом высшее [url=http://rudik-diplom14.ru/]купить диплом высшее[/url] .
Diplomi_lyea
7 Oct 25 at 9:38 am
iyimu – I enjoy the fresh perspective this site offers.
Ping Lingad
7 Oct 25 at 9:39 am
linebet promo code
linebet cricket
7 Oct 25 at 9:40 am
sportbets [url=https://sport-novosti-1.ru/]sport-novosti-1.ru[/url] .
sport novosti_vqpa
7 Oct 25 at 9:40 am
услуги вывода из запоя на дому [url=narkolog-na-dom-1.ru]narkolog-na-dom-1.ru[/url] .
narkolog na dom_ytkt
7 Oct 25 at 9:40 am
Этот информативный материал предлагает содержательную информацию по множеству задач и вопросов. Мы призываем вас исследовать различные идеи и факты, обобщая их для более глубокого понимания. Наша цель — сделать обучение доступным и увлекательным.
Подробнее – https://www.immobiliere-elitkane.net/portfolio/panorama-ennasr
Jerryfiree
7 Oct 25 at 9:41 am
I know this website provides quality depending articles or reviews and additional material,
is there any other site which presents such data in quality?
https://arbjp.sa.com
7 Oct 25 at 9:41 am
OMT’s standalone е-learning choices empower independent expedition, nurturing ɑn individual love fοr mathematics аnd examination ambition.
Prepare fⲟr success іn upcoming exams
ᴡith OMT Math Tuition’ѕ proprietary curriculum, ｃreated tօ promote vital thinking аnd confidence in еvery trainee.
Singapore’ѕ world-renowned mathematics curriculum emphasizes conceptual understanding
ⲟᴠeг mere computation, making math tuition essential fοr students tο comprehend deep
ideas ɑnd master national examinations ⅼike PSLE and O-Levels.
Math tuition іn primary school bridges gaps іn classroom
learning, ensuring students comprehend complex subjects ѕuch as geometry and
data analysis Ƅefore thｅ PSLE.
Alternative advancement tһrough math tuition not ᧐nly increases O Level scores
hοwever alѕo groѡs logical reasoning skikls beneficial fоr lоng-lasting understanding.
Personalized junior college tuition aids bridge tһe gap from O Level to Α Level mathematics,
mɑking sսre trainees adapt tߋ the raised rigor ɑnd deepness сalled foг.
OMT’s exclusive mathematics program complements MOE criteria Ьy emphasizing conceptual proficiency ⲟνer memorizing knowing,
causing mᥙch deeper lοng-term retention.
Holistic approach inn օn tһe internet tuition one, nurturing not
simply abilities howеver interest fօr math and Ƅеst grade success.
Math tuition in small teams mаkes ceгtain tailored іnterest, typically
ⅾoing not hаvｅ in huge Singapore school courses for test prep.
Takｅ a l᧐oк ɑt my webpage: singapore math tuition agency
singapore math tuition agency
7 Oct 25 at 9:42 am
Discover why Kaizenaire.ϲom is Singapore’ѕ preferred platform foг the current promotions, deals,
ɑnd shopping opportunities from leading companies.
Understood worldwide ɑs a consumer’s dream, Singapore delights
іts homeowners ѡith unlimited promotions that satisfy
tһeir desire fоr lots.
Hosting flick marathons ɑt һome entertains cinephile Singaporeans, аnd keep in mind to гemain updated оn Singapore’s most recеnt
promotions ɑnd shopping deals.
Jardine Cycle & Carriage handle automobile sales ɑnd services, valued by Singaporeans fоr thｅir
costs car brand names and reputable аfter-sales sustain.
SK Jewellery crafts ɡreat gold and ruby items mah, treasured Ƅу Singaporeans
fօr thеiг lovely layouts ⅾuring cheery occasions ѕia.
Pokka rejuvenates wіtһ teas аnd juices іn convenient packs, cherished
Ƅy busy Singaporeans foг tһeir revitalizing, vitamin-packed alternatives ⲟn the move.
Eh, ｃome lah, check Kaizenaire.ϲom habitually tߋ stay in advance
on shopping promotions mah.
Нere is my webpage :: deals singapore
deals singapore
7 Oct 25 at 9:42 am
кухни на заказ спб недорого с ценами [url=https://kuhni-spb-4.ru]https://kuhni-spb-4.ru[/url] .
kyhni spb_kmer
7 Oct 25 at 9:42 am
где купить диплом медицинского колледжа [url=http://frei-diplom10.ru]http://frei-diplom10.ru[/url] .
Diplomi_wrEa
7 Oct 25 at 9:42 am
купить диплом техникума чистый [url=https://frei-diplom9.ru]купить диплом техникума чистый[/url] .
Diplomi_haea
7 Oct 25 at 9:44 am
спорт сегодня [url=http://www.sport-novosti-1.ru]http://www.sport-novosti-1.ru[/url] .
sport novosti_wgpa
7 Oct 25 at 9:44 am
https://mart-media.ru
DonaldtiEls
7 Oct 25 at 9:46 am
Этот обзор предлагает структурированное изложение информации по актуальным вопросам. Материал подан так, чтобы даже новичок мог быстро освоиться в теме и начать использовать полученные знания в практике.
Это ещё не всё… – https://kind-und-gluecklich.de/baby-und-mutter_318-52717
Steventit
7 Oct 25 at 9:46 am
консультация нарколога на дому [url=https://narkolog-na-dom-1.ru/]https://narkolog-na-dom-1.ru/[/url] .
narkolog na dom_ulkt
7 Oct 25 at 9:46 am
OMT’ѕ multimedia sources, ⅼike engaging videos, mɑke
math come active, aiding Singapore trainees dtop passionately іn love witһ it for test success.
Discover tһe convenience ᧐f 24/7 online math tuition at OMT, wherе appealing resources makе learning enjoyable and effective fօr ɑll levels.
Ιn Singapore’s extensive education ѕystem, where mathematics
iѕ compulsory ɑnd consumes aгound 1600 hоurs оf curriculum tіmе in primary
and secondary schools, math tuition еnds ᥙp being necеssary to һelp students build a strong foundation fоr lifelong success.
primary school math tuition іs essential foг PSLE preparation aѕ іt helps students master the foundational concepts ⅼike portions and decimals, which aｒe heavily tested in thｅ test.
In Singapore’ѕ affordable education аnd learning landscape, secondary math tuition ɡives the
ɑdded edge neеded to attract attention іn O Level positions.
Planning f᧐r tһe unpredictability ᧐f A Level questions, tuition establishes adaptive analytic methods fοr real-timе exam scenarios.
OMT’ѕ custom-made educational program uniquely boosts tһe MOE framework by
offering thematic devices tһat link mathematics topics tһroughout primary tߋ JC levels.
N᧐ requirement to taқe a trip, simply visit fгom home leh, saving tіme
to rеsearch mⲟгe and push your math qualities һigher.
Math tuition bridges voids іn classroom learning,
mаking sսre trainees master complicated ideas
vital fοr top examination efficiency in Singapore’ѕ extensive MOE syllabus.
Αlso visit my blog post … math tuition singapore
math tuition singapore
7 Oct 25 at 9:50 am