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!
Wah, maths acts like thｅ groundwork pillar
of primary learning, assisting children іn spatial thinking tⲟ architecture careers.
Alas, ᴡithout robust maths Ԁuring Junior College,
гegardless toρ establishment youngsters may struggle in next-level
calculations, terefore build tһat now leh.
Anglo-Chinese Junior College stands аs a beacon of
balanced education, mixing strenuous academics wіth a nurturing Christian principles
tһаt inspires ethical stability ɑnd individual development.
Тhe college’s cutting edge facilities ɑnd skilled professors assistance impressive performance іn both arts ɑnd sciences,
wit students frequently achieving leading accolades.Ƭhrough іtѕ emphasis on sports
and performing arts, trainees establissh discipline, friendship, аnd an enthusiasm for excellence Ьeyond the classroom.
International partnerships ɑnd exchange chances enhance the learning experience,promoting
worldwide awareness аnd cultural appreciation. Alumni thrive іn diverse fields, testimony tο the college’ѕ role іn forming principled leaders ready tօ contribute favorably t᧐ society.
Jurong Pioneer Junior College, established tһrough thｅ thoughtful merger օf Jurong Junior College аnd Pioneer
Junior College, delivers а progressive аnd future-oriented education tһɑt positions a unique
emphasis οn China preparedness, worldwide organization acumen, and cross-cultural
engagement tо prepare students fߋr thriving іn Asia’ѕ vibrant financial landscape.
Τһе college’ѕ dual campuses аre equipped witһ modern-ⅾay, flexible
centers including specialized commerce simulation гooms,
science innovation laboratories, аnd arts ateliers, ɑll creɑted to foster ᥙseful skills, creative thinking, ɑnd
interdisciplinary learning. Improving academic programs ɑгｅ complemented Ьy global collaborations, ѕuch as joint jobs ѡith Chinese universities ɑnd cultural immersion trips, ԝhich
improve students’ linguistic efficiency and internationaql outlook.
Α supportive аnd inclusive neighborhood atmosphere motivates strength аnd leadership development tһrough a wide
variety ⲟf ϲ᧐-curricular activities, fгom entrepreneurship ｃlubs tߋ sports teams that promote team effort and perseverance.
Graduates οf Jurong Pioneer Junior College are exceptionally
ԝell-prepared f᧐r competitive professions, emmbodying tһе values
оf care, continuous improvement, аnd innovation tһat define the organization’ѕ forward-looҝing
values.
Oh, mathematics acts ⅼike tһe foundation block fоr primary learning, assisting youngsters ԝith geometric
analysis fߋr design paths.
Don’t tаke lightly lah, pair ɑ ɡood Junior College
wіtһ maths excellence tо ensure superior Ꭺ Levels scores
pluѕ effortless chаnges.
Ꭺvoid play play lah, link ɑ excellent Junior College plսs mathematics proficiency to guarantee elevated
ALevels marks аnd seamless shifts.
Mums ɑnd Dads, worry ɑbout the disparity
hor, mathematics groundwork іs vital during Junior College in comprehending
data, crucial f᧐r current online economy.
Ꮤithout solid A-levels, alternative paths аre lοnger and harder.
Alas, primary mathematics teaches real-ᴡorld implementations ѕuch as
financial planning, tһus guarantee youг child grasps
this properly beginning eaгly.
my web site … online math tuition singapore
online math tuition singapore
19 Sep 25 at 7:34 am
раздвижной карниз [url=razdvizhnoj-elektrokarniz.ru]razdvizhnoj-elektrokarniz.ru[/url] .
razdvijnoi elektrokarniz_gqei
19 Sep 25 at 7:34 am
все займы онлайн на карту [url=http://zaimy-15.ru/]все займы онлайн на карту[/url] .
zaimi_napn
19 Sep 25 at 7:34 am
все микрозаймы [url=zaimy-14.ru]все микрозаймы[/url] .
zaimi_ckSr
19 Sep 25 at 7:35 am
за1мы онлайн [url=https://zaimy-11.ru/]https://zaimy-11.ru/[/url] .
zaimi_ytPt
19 Sep 25 at 7:36 am
Website VW108 resmi adalah situs login slot gacor terbaik dengan link alternatif
anti blokir. Memiliki lisensi resmi sehingga terjamin aman dan siap diakses 24 jam.
vw 108
19 Sep 25 at 7:36 am
https://community.wongcw.com/blogs/1151723/%D0%9A%D1%83%D0%BF%D0%B8%D1%82%D1%8C-%D0%B7%D0%B0%D0%BA%D0%BB%D0%B0%D0%B4%D0%BA%D1%83-%D0%9A%D0%BE%D0%BA%D0%B0%D0%B8%D0%BD-%D0%A5%D1%83%D1%80%D0%B3%D0%B0%D0%B4%D0%B0
RonaldWep
19 Sep 25 at 7:36 am
займы россии [url=https://www.zaimy-15.ru]https://www.zaimy-15.ru[/url] .
zaimi_ohpn
19 Sep 25 at 7:36 am
микрозаймы онлайн [url=http://zaimy-11.ru/]http://zaimy-11.ru/[/url] .
zaimi_vxPt
19 Sep 25 at 7:38 am
кинопоиск смотреть онлайн [url=kinogo-15.top]кинопоиск смотреть онлайн[/url] .
kinogo_jvsa
19 Sep 25 at 7:39 am
всезаймы [url=https://zaimy-13.ru/]https://zaimy-13.ru/[/url] .
zaimi_joKt
19 Sep 25 at 7:39 am
My brother recommended I might like this blog. He was entirely right.
This submit actually made my day. You cann’t imagine just how a lot time I had spent for this info!
Thanks!
AI Arbitrage Legit Or Not
19 Sep 25 at 7:41 am
сайт микрозаймов [url=www.zaimy-14.ru/]www.zaimy-14.ru/[/url] .
zaimi_kzSr
19 Sep 25 at 7:42 am
накрутка живых подписчиков в тг дешево
GustavoRiz
19 Sep 25 at 7:43 am
займ всем [url=https://zaimy-13.ru/]https://zaimy-13.ru/[/url] .
zaimi_qbKt
19 Sep 25 at 7:43 am
смотреть комедии онлайн [url=www.kinogo-15.top]смотреть комедии онлайн[/url] .
kinogo_vjsa
19 Sep 25 at 7:43 am
электрокарниз цена [url=www.razdvizhnoj-elektrokarniz.ru/]www.razdvizhnoj-elektrokarniz.ru/[/url] .
razdvijnoi elektrokarniz_kbei
19 Sep 25 at 7:44 am
все займы [url=https://www.zaimy-15.ru]все займы[/url] .
zaimi_lipn
19 Sep 25 at 7:45 am
кино онлайн [url=https://kinogo-15.top]кино онлайн[/url] .
kinogo_avsa
19 Sep 25 at 7:46 am
В этом информативном обзоре собраны самые интересные статистические данные и факты, которые помогут лучше понять текущие тренды. Мы представим вам цифры и графики, которые иллюстрируют, как развиваются различные сферы жизни. Эта информация станет отличной основой для глубокого анализа и принятия обоснованных решений.
Как это работает — подробно – https://yuuji-miyahara.com/uncategorized/hello-world
ThomasNuh
19 Sep 25 at 7:48 am
фильмы про войну смотреть онлайн [url=http://kinogo-14.top/]http://kinogo-14.top/[/url] .
kinogo_qrEl
19 Sep 25 at 7:49 am
список займов онлайн на карту [url=http://zaimy-12.ru]http://zaimy-12.ru[/url] .
zaimi_uwSt
19 Sep 25 at 7:52 am
все микрозаймы [url=https://zaimy-14.ru/]все микрозаймы[/url] .
zaimi_jhSr
19 Sep 25 at 7:52 am
турецкие сериалы на русском языке [url=http://kinogo-14.top/]турецкие сериалы на русском языке[/url] .
kinogo_kmEl
19 Sep 25 at 7:53 am
мфо займ онлайн [url=zaimy-15.ru]мфо займ онлайн[/url] .
zaimi_mdpn
19 Sep 25 at 7:53 am
фильмы в хорошем качестве [url=http://www.kinogo-14.top]http://www.kinogo-14.top[/url] .
kinogo_zrEl
19 Sep 25 at 7:55 am
смотреть русские сериалы [url=www.kinogo-15.top/]смотреть русские сериалы[/url] .
kinogo_vwsa
19 Sep 25 at 7:56 am
микро займы онлайн [url=zaimy-14.ru]микро займы онлайн[/url] .
zaimi_lbSr
19 Sep 25 at 7:56 am
все микрозаймы [url=www.zaimy-15.ru/]все микрозаймы[/url] .
zaimi_rapn
19 Sep 25 at 7:57 am
накрутка активных подписчиков в тг
GustavoRiz
19 Sep 25 at 7:57 am
все займ [url=http://zaimy-12.ru]http://zaimy-12.ru[/url] .
zaimi_dbSt
19 Sep 25 at 7:58 am
электрокарниз двухрядный [url=www.razdvizhnoj-elektrokarniz.ru]www.razdvizhnoj-elektrokarniz.ru[/url] .
razdvijnoi elektrokarniz_kpei
19 Sep 25 at 8:00 am
https://rant.li/edrohedudy/ekstazi-lsd-25-kupit-zakladkoi
RonaldWep
19 Sep 25 at 8:01 am
Hi there Dear, are you in fact visiting this site on a regular basis, if so afterward you will absolutely obtain nice knowledge.
kha99
19 Sep 25 at 8:02 am
взо [url=www.zaimy-13.ru/]www.zaimy-13.ru/[/url] .
zaimi_scKt
19 Sep 25 at 8:04 am
электрокарнизы цена [url=https://razdvizhnoj-elektrokarniz.ru]https://razdvizhnoj-elektrokarniz.ru[/url] .
razdvijnoi elektrokarniz_wrei
19 Sep 25 at 8:04 am
все займы онлайн [url=https://zaimy-12.ru]https://zaimy-12.ru[/url] .
zaimi_rwSt
19 Sep 25 at 8:04 am
you are actually a just right webmaster. The web site loading speed is incredible.
It sort of feels that you’re doing any distinctive trick.
Also, The contents are masterwork. you’ve done a excellent job on this topic!
официальный сайт Вован казино
19 Sep 25 at 8:06 am
фильмы ужасов смотреть онлайн [url=kinogo-15.top]фильмы ужасов смотреть онлайн[/url] .
kinogo_aqsa
19 Sep 25 at 8:06 am
фильмы про войну смотреть онлайн [url=http://www.kinogo-14.top]http://www.kinogo-14.top[/url] .
kinogo_vsEl
19 Sep 25 at 8:06 am
займы онлайн все [url=www.zaimy-11.ru/]www.zaimy-11.ru/[/url] .
zaimi_nkPt
19 Sep 25 at 8:07 am
best online ed meds [url=https://vitaledgepharma.com/#]VitalEdge Pharma[/url] where to buy ed pills
Michealstilm
19 Sep 25 at 8:09 am
все микрозаймы на карту [url=zaimy-13.ru]zaimy-13.ru[/url] .
zaimi_zcKt
19 Sep 25 at 8:10 am
кино онлайн [url=http://www.kinogo-15.top]кино онлайн[/url] .
kinogo_qbsa
19 Sep 25 at 8:10 am
Great blog right here! Additionally your
site so much up fast! What web host are you the usage of?
Can I am getting your affiliate hyperlink to your host?
I wish my site loaded up as fast as yours lol
situs slot online
19 Sep 25 at 8:12 am
турецкие сериалы на русском языке [url=https://www.kinogo-14.top]турецкие сериалы на русском языке[/url] .
kinogo_auEl
19 Sep 25 at 8:15 am
купить диплом в орле [url=https://rudik-diplom7.ru/]https://rudik-diplom7.ru/[/url] .
Diplomi_xcPl
19 Sep 25 at 8:15 am
займы онлайн все [url=https://zaimy-13.ru/]https://zaimy-13.ru/[/url] .
zaimi_vwKt
19 Sep 25 at 8:15 am
займы всем [url=https://www.zaimy-15.ru]займы всем[/url] .
zaimi_xqpn
19 Sep 25 at 8:15 am
бот для накрутки подписчиков в тг бесплатно
GustavoRiz
19 Sep 25 at 8:18 am