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!
online pharmacy: trusted online pharmacy UK – safe place to order meds UK
HaroldSHems
2 Nov 25 at 6:22 am
купить диплом в сарапуле [url=http://rudik-diplom13.ru/]купить диплом в сарапуле[/url] .
Diplomi_zjon
2 Nov 25 at 6:22 am
Guzellik ve kozmetikte her zaman gecmisten al?nacak dersler bulunur. 90’lar?n modas?ndan guzellik s?rlar?n? kesfetmeye haz?r olun.
По теме “Guzellik ve Kozmetik: 90’lar Modas?ndan Ipuclar?”, есть отличная статья.
Вот, делюсь ссылкой:
[url=https://aynakirildi.com]https://aynakirildi.com[/url]
Tarz?n?zda 90’lar?n esintilerini hissetmeye baslad?g?n?za eminim. Gecmisin izlerini tas?maktan korkmay?n!
Josephassof
2 Nov 25 at 6:22 am
บทความนี้เกี่ยวกับดอกไม้งานศพ มีสาระมาก
โดยส่วนตัวเพิ่งเจอเหตุการณ์สูญเสีย การเลือกช่อดอกไม้เลยเป็นเรื่องที่ต้องใส่ใจ
ใครที่กำลังเตรียมตัวจัดงานศพให้คนสำคัญควรอ่านจริงๆ
Allso visit my website :: จัดดอกไม้งานขาวดำ
จัดดอกไม้งานขาวดำ
2 Nov 25 at 6:23 am
best UK pharmacy websites [url=http://ukmedsguide.com/#]affordable medications UK[/url] best UK pharmacy websites
Hermanengam
2 Nov 25 at 6:24 am
купить диплом в ставрополе [url=www.rudik-diplom10.ru]купить диплом в ставрополе[/url] .
Diplomi_uiSa
2 Nov 25 at 6:28 am
At this time it sounds like Movable Type is the preferred blogging platform
available right now. (from what I’ve read) Is that what you’re using on your blog?
Fantastic a lot
2 Nov 25 at 6:28 am
купить диплом техникума или вуза [url=http://frei-diplom9.ru]купить диплом техникума или вуза[/url] .
Diplomi_rjea
2 Nov 25 at 6:28 am
Вызывали дезинфекция квартиры после умершего ночью, приехали быстро!
уничтожение клопов цена
Wernermog
2 Nov 25 at 6:28 am
вход мостбет [url=www.mostbet12033.ru]www.mostbet12033.ru[/url]
mostbet_kg_dbpa
2 Nov 25 at 6:29 am
verified pharmacy coupon sites Australia: pharmacy discount codes AU – verified online chemists in Australia
HaroldSHems
2 Nov 25 at 6:30 am
визитки шелкография [url=https://telegra.ph/Mir-korporativnoj-atributiki-polnyj-gid-po-uslugam-pechati-10-28/]telegra.ph/Mir-korporativnoj-atributiki-polnyj-gid-po-uslugam-pechati-10-28[/url] .
Tipografiya Print Salon_jfsr
2 Nov 25 at 6:30 am
компании по продвижению сайтов [url=reiting-kompanii-po-prodvizheniyu-sajtov.ru]компании по продвижению сайтов[/url] .
agentstvo poiskovogo prodvijeniya_acKt
2 Nov 25 at 6:30 am
Irish online pharmacy reviews [url=https://irishpharmafinder.com/#]affordable medication Ireland[/url] trusted online pharmacy Ireland
Hermanengam
2 Nov 25 at 6:30 am
https://ufo99.net/promocod-bonus-melbet-2025/
JustinAcecy
2 Nov 25 at 6:32 am
печать на футболках оптом [url=https://www.teletype.in/@alexd78/p7K3J4hm1Lc]https://www.teletype.in/@alexd78/p7K3J4hm1Lc[/url] .
pechat na fytbolkah_omKa
2 Nov 25 at 6:33 am
список seo агентств [url=www.reiting-seo-kompaniy.ru]www.reiting-seo-kompaniy.ru[/url] .
reiting seo kompanii_xkon
2 Nov 25 at 6:35 am
где можно купить диплом медсестры [url=www.frei-diplom14.ru]где можно купить диплом медсестры[/url] .
Diplomi_lvoi
2 Nov 25 at 6:36 am
купить диплом техникума в запорожье [url=https://www.frei-diplom10.ru]купить диплом техникума в запорожье[/url] .
Diplomi_oiEa
2 Nov 25 at 6:37 am
1xbet resmi giri? [url=https://1xbet-giris-2.com/]https://1xbet-giris-2.com/[/url] .
1xbet giris_vpPt
2 Nov 25 at 6:40 am
купить диплом в пятигорске [url=http://rudik-diplom13.ru/]купить диплом в пятигорске[/url] .
Diplomi_faon
2 Nov 25 at 6:40 am
mostbet вход [url=mostbet12033.ru]mostbet12033.ru[/url]
mostbet_kg_qypa
2 Nov 25 at 6:44 am
купить диплом в геленджике [url=https://www.rudik-diplom2.ru]https://www.rudik-diplom2.ru[/url] .
Diplomi_ibpi
2 Nov 25 at 6:45 am
купить проведенный диплом спб [url=www.frei-diplom2.ru]www.frei-diplom2.ru[/url] .
Diplomi_xmEa
2 Nov 25 at 6:45 am
https://t.me/s/Ud_GiZbo
MichaelPione
2 Nov 25 at 6:46 am
мостеб [url=mostbet12033.ru]mostbet12033.ru[/url]
mostbet_kg_sqpa
2 Nov 25 at 6:48 am
1xbet mobil giri? [url=https://1xbet-giris-4.com/]https://1xbet-giris-4.com/[/url] .
1xbet giris_muSa
2 Nov 25 at 6:50 am
Hello to every single one, it’s genuinely a good for me to pay a visit this website, it
consists of helpful Information.
My web page … компьютерная диагностика автомобиля москва
компьютерная диагностика автомобиля москва
2 Nov 25 at 6:51 am
купить диплом с занесением в реестр тюмень [url=http://www.frei-diplom2.ru]купить диплом с занесением в реестр тюмень[/url] .
Diplomi_swEa
2 Nov 25 at 6:52 am
купить диплом колледжа с занесением в реестр в [url=http://frei-diplom6.ru]купить диплом колледжа с занесением в реестр в[/url] .
Diplomi_xjOl
2 Nov 25 at 6:53 am
купить диплом медицинского колледжа [url=http://www.frei-diplom8.ru]купить диплом медицинского колледжа[/url] .
Diplomi_emsr
2 Nov 25 at 6:54 am
Купить диплом техникума в Запорожье [url=https://www.educ-ua7.ru]https://www.educ-ua7.ru[/url] .
Diplomi_vsea
2 Nov 25 at 6:54 am
обложка на паспорт со своим дизайном [url=telegra.ph/Mir-korporativnoj-atributiki-polnyj-gid-po-uslugam-pechati-10-28]telegra.ph/Mir-korporativnoj-atributiki-polnyj-gid-po-uslugam-pechati-10-28[/url] .
Tipografiya Print Salon_thsr
2 Nov 25 at 6:54 am
3 печать на футболках [url=www.teletype.in/@alexd78/p7K3J4hm1Lc]www.teletype.in/@alexd78/p7K3J4hm1Lc[/url] .
pechat na fytbolkah_xiKa
2 Nov 25 at 6:54 am
купить диплом с занесением в реестр самара [url=http://frei-diplom2.ru/]http://frei-diplom2.ru/[/url] .
Diplomi_uhEa
2 Nov 25 at 6:56 am
I know this site provides quality depending
articles and additional material, is there any other site which presents these kinds of stuff in quality?
1 year mba in malaysia
2 Nov 25 at 6:57 am
irishpharmafinder: buy medicine online legally Ireland – affordable medication Ireland
Johnnyfuede
2 Nov 25 at 6:57 am
принтсалон печать на футболках в спб [url=https://www.teletype.in/@alexd78/p7K3J4hm1Lc]https://www.teletype.in/@alexd78/p7K3J4hm1Lc[/url] .
pechat na fytbolkah_gyKa
2 Nov 25 at 6:57 am
Wow, math acts ⅼike the foundation stone fօr primary education,
helping youngsters іn spatial thinking tο design paths.
Ⲟһ dear, mіnus solid maths in Junior College, even prestigious establishment kids mɑy falter ɑt next-level calculations, so develop
tһiѕ immedіately leh.
Hwa Chong Institution Junior College іs renowned fⲟr its integrated program thаt perfectly
combines scholastic rigor ԝith character advancement, producing worldwide scholars ɑnd leaders.
Fiгst-rate facilities and professional faculty support quality іn rｅsearch, entrepreneurship, ɑnd bilingualism.
Trainees gain fгom substantial worldwide exchanges аnd competitors, widening ρoint of views and refining skills.
Ƭhｅ organization’ѕ concentrate оn innovation and service cultivates durability and ethical worths.
Alumni networks ߋpen doors tο top universities and prominent careers
worldwide.
Catholic Junior College оffers a transformative instructional experience
fixated ageless worths οf compassion, stability, andd pursuit ᧐f fact,
promoting a close-knit neighborhood ԝһere trainees
feel supported ɑnd motivated to grow both intellectually and spiritually іn a tranquil аnd inclusive setting.
Τhe college ⲟffers extensive scholastic programs in the
humanities, sciences, аnd social sciences, delivered Ьy passionate ɑnd experienced mentors ԝho utilize iinnovative mentor techniques
tо stimulate interest and encourage deep, meaningful learning that extends
fɑr beyond examinations. An dynamic range ߋf co-curricular activities, including competitive sports
ɡroups tһat promote physical health аnd sociability,
ɑѕ wｅll as creative societies that nurture imaginative expression tһrough drama and visual arts,
аllows students tߋ explore theiг intеrests ɑnd establish ԝell-rounded characters.
Opportunities f᧐r sіgnificant social wоrk, suⅽh as collaborations ᴡith regional charities and international humanitarian journeys,
assist construct compassion, leadership skills, ɑnd a genuine commitment tо making a distinction in the lives of ߋthers.
Alumni from Catholic Junior College regularly ƅecome caring ɑnd
ethical leaders іn different expert fields, equipped with tһe knowledge, durability, аnd ethical compass
to contribute positively and sustainably tօ society.
Wah lao, no matter tһough school proves atas, mathematics serves аs tһe critical discipline in cultivates confidence ԝith calculations.
Aiyah, primary maths teaches everyday ᥙses ѕuch ɑs
financial planning, so ensure yօur kid gets this properly
starting young.
Oh no, primary maths instructs real-ԝorld implementations ⅼike money management, tһerefore mɑke sᥙre уour kid masters it properly bеginning ｙoung.
Oh dear, minuѕ robust maths іn Junior College, еven prestigious school children mɑʏ struggle ԝith secondary
equations, tһerefore cultivate іt now leh.
Oi oi, Singapore folks, maths proves рrobably the highly impоrtant primary
subject, encouraging creativity fօr challenge-tackling іn groundbreaking professions.
Kiasu parents қnow tһat Math A-levels аre key to avoiding dead-end paths.
Dо not play play lah, combine a good Junior College
plus mathematics superiority fߋr assure superior Α Levels results aѕ well аѕ
seamless shifts.
Parents, worry аbout the disparity hor, math groundwork гemains
critical іn Junior College in comprehending data, crucial іn today’s digital market.
Ηere iѕ my site; Northbrooks Secondary School Singapore
Northbrooks Secondary School Singapore
2 Nov 25 at 6:57 am
Мы предлагаем различные программы лечения в Ростове-на-Дону, включая стационарное и амбулаторное, чтобы выбрать оптимальный вариант для вас.
Подробнее – [url=https://vyvod-iz-zapoya-rostov234.ru/]вывод из запоя клиника в ростове-на-дону[/url]
WilliamHar
2 Nov 25 at 6:58 am
рекламное агентство seo [url=reiting-kompanii-po-prodvizheniyu-sajtov.ru]рекламное агентство seo[/url] .
agentstvo poiskovogo prodvijeniya_plKt
2 Nov 25 at 7:00 am
mostbet com вход [url=http://mostbet12033.ru]http://mostbet12033.ru[/url]
mostbet_kg_atpa
2 Nov 25 at 7:01 am
prednisone
lozol
2 Nov 25 at 7:03 am
mostbet скачать на андроид [url=https://mostbet12033.ru/]mostbet скачать на андроид[/url]
mostbet_kg_yvpa
2 Nov 25 at 7:04 am
https://ukmedsguide.com/# cheap medicines online UK
Haroldovaph
2 Nov 25 at 7:05 am
диплом купить колледжа искусств [url=http://frei-diplom9.ru/]http://frei-diplom9.ru/[/url] .
Diplomi_kpea
2 Nov 25 at 7:06 am
https://safemedsguide.shop/# trusted online pharmacy USA
Haroldovaph
2 Nov 25 at 7:06 am
диплом медсестры с аккредитацией купить [url=http://frei-diplom14.ru]диплом медсестры с аккредитацией купить[/url] .
Diplomi_mhoi
2 Nov 25 at 7:06 am
казахстан купить диплом техникума [url=http://frei-diplom10.ru]казахстан купить диплом техникума[/url] .
Diplomi_rhEa
2 Nov 25 at 7:07 am
Нужна дезинфекция квартир от клещей на участке.
дезинфекция после животного
Wernermog
2 Nov 25 at 7:09 am