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!
How to care for clothes so they last longer and shed less microplastic https://ecofriendlystore.ru/
EcoFriendNeuct
23 Oct 25 at 5:23 am
1xbet turkiye [url=1xbet-giris-2.com]1xbet-giris-2.com[/url] .
1xbet giris_qrPt
23 Oct 25 at 5:23 am
1xbet g?ncel [url=www.1xbet-giris-6.com]1xbet g?ncel[/url] .
1xbet giris_gbsl
23 Oct 25 at 5:23 am
вопросы юридического перевода [url=teletype.in/@alexd78/HN462R01hzy]teletype.in/@alexd78/HN462R01hzy[/url] .
Vidi perevodov v buro Perevod i Pravo_tast
23 Oct 25 at 5:24 am
1xbet turkiye [url=1xbet-giris-1.com]1xbet-giris-1.com[/url] .
1xbet giris_yqkt
23 Oct 25 at 5:24 am
Detox Yoga
PHP hook, building hooks in your application – Sjoerd Maessen blog at Sjoerd Maessen blog
Detox Yoga
23 Oct 25 at 5:24 am
Этот информационный материал собраны данные, которые помогут лучше понять текущие тенденции и процессы в различных сферах жизни. Мы предоставляем четкий анализ, графики и примеры, чтобы информация была не только понятной, но и практичной для принятия решений.
Откройте для себя больше – https://www.ophthalmetryoptical.com/blog/tonometer-for-home-use
MiguelEdumn
23 Oct 25 at 5:28 am
топ агентств seo продвижения [url=http://reiting-seo-kompaniy.ru]http://reiting-seo-kompaniy.ru[/url] .
reiting seo kompanii_ndon
23 Oct 25 at 5:29 am
В данной обзорной статье представлены интригующие факты, которые не оставят вас равнодушными. Мы критикуем и анализируем события, которые изменили наше восприятие мира. Узнайте, что стоит за новыми открытиями и как они могут изменить ваше восприятие реальности.
Только факты! – https://catsanz.com/about-the-last-8-months
Frankcox
23 Oct 25 at 5:32 am
Выведение из запоя в стационаре Воронежа — помощь при острых состояниях и хронической зависимости. Наши опытные наркологи используют современные методы лечения для быстрого и безопасного вывода из запоя.
Детальнее – [url=https://vyvod-iz-zapoya-v-stacionare-voronezh24.ru/]вывод из запоя в стационаре в воронеже[/url]
Gregorykip
23 Oct 25 at 5:33 am
Стационар «Частного Медика 24» в Воронеже — место, где пациент, страдающий от длительного запоя, получает не просто деньги-стоимость услуги, а полноценную помощь: диагностику, детоксикацию, медикаментозную поддержку и психологическую помощь с уважением к личному пространству и анонимности.
Изучить вопрос глубже – http://vyvod-iz-zapoya-v-stacionare-voronezh22.ru
Craigret
23 Oct 25 at 5:33 am
Если вы ищете надежную клинику для вывода из запоя, обратитесь в «Детокс» в Краснодаре. Услуга вызова нарколога на дом доступна круглосуточно. Врачи приедут к вам в течение 1–2 часов и окажут необходимую помощь.
Подробнее тут – [url=https://narkolog-na-dom-krasnodar26.ru/]нарколог на дом вывод в краснодаре[/url]
Victorplaus
23 Oct 25 at 5:34 am
да мэн правильно говоришь KEY фраернулся
Приобрести онлайн кокаин, мефедрон, гашиш, бошки
Как привило мелкие селлеры о конфиденциальности не думают, а потом с ними метоморфозы и происходят..
Thomasneump
23 Oct 25 at 5:34 am
hardman4schools – I like how transparent and sincere the campaign presentation feels.
Maynard Nees
23 Oct 25 at 5:40 am
1xbet mobil giri? [url=http://www.1xbet-giris-3.com]http://www.1xbet-giris-3.com[/url] .
1xbet giris_ifMi
23 Oct 25 at 5:42 am
inspiredgrowthteam – I appreciate how they tailor strategies to each team’s unique needs.
Victor Arwood
23 Oct 25 at 5:43 am
Как купить Экстази в Серове?Обнаружил на https://2Axe.ru
– адекватные отзывы и цены. Есть курьерская доставка. Кто-нибудь заказывал их услугами? Насколько качественный товар?
Stevenref
23 Oct 25 at 5:43 am
When someone writes an piece of writing he/she maintains the image of a user in his/her mind that how a user can know it.
So that’s why this paragraph is amazing. Thanks!
https://akniga.org/profile/1259889-fun88play/
23 Oct 25 at 5:45 am
birxbet giri? [url=https://www.1xbet-giris-5.com]https://www.1xbet-giris-5.com[/url] .
1xbet giris_tfSa
23 Oct 25 at 5:47 am
nextgeninnovation – Excellent presentation, very professional, I’ll be returning regularly for updates.
Rigoberto Freed
23 Oct 25 at 5:47 am
Выезд нарколога на дом в Нижнем Новгороде — капельница от запоя с выездом на дом. Мы обеспечиваем быстрое и качественное лечение без необходимости посещения клиники.
Исследовать вопрос подробнее – [url=https://vyvod-iz-zapoya-nizhnij-novgorod12.ru/]вывод из запоя нижний новгород[/url]
CharlesDof
23 Oct 25 at 5:48 am
seo agencies list [url=www.reiting-seo-kompaniy.ru/]www.reiting-seo-kompaniy.ru/[/url] .
reiting seo kompanii_gaon
23 Oct 25 at 5:48 am
urbanwearzone – Prices are reasonable and products look exactly like pictures.
Giuseppe Pidcock
23 Oct 25 at 5:52 am
globalideasnetwork – Love exploring ideas here, everything is presented very clearly.
Moses Aumend
23 Oct 25 at 5:55 am
купить диплом в каменске-шахтинском [url=http://www.rudik-diplom5.ru]http://www.rudik-diplom5.ru[/url] .
Diplomi_nbma
23 Oct 25 at 5:56 am
learnshareconnect – Saved a few articles for future reference; this site is becoming a favourite.
Lizzie Morant
23 Oct 25 at 5:58 am
Hi every one, here every one is sharing these
experience, thus it’s good to read this webpage, and I used to pay a quick visit this weblog daily.
Erfolgsimmo Erfahrungen
23 Oct 25 at 5:58 am
1xbwt giri? [url=https://1xbet-giris-6.com/]1xbet-giris-6.com[/url] .
1xbet giris_kxsl
23 Oct 25 at 6:03 am
bahis sitesi 1xbet [url=https://1xbet-giris-2.com]https://1xbet-giris-2.com[/url] .
1xbet giris_wiPt
23 Oct 25 at 6:03 am
Вызов нарколога на дом в Краснодаре — услуга клиники «Детокс». Специалисты оказывают квалифицированную помощь прямо у вас дома.
Разобраться лучше – [url=https://narkolog-na-dom-krasnodar26.ru/]вызвать врача нарколога на дом[/url]
Victorplaus
23 Oct 25 at 6:04 am
Где купить A-PVP в Внуковое?Друзья, расскажите – есть сайт https://glosslife.ru
. Цены нормальные, доставляют. Кто-то пробовал с ними? Как у них с товаром?
Stevenref
23 Oct 25 at 6:08 am
discovernewideas – A go-to place for innovative ideas and fresh perspectives.
Blair Groff
23 Oct 25 at 6:09 am
агентство seo [url=https://reiting-seo-kompaniy.ru/]агентство seo[/url] .
reiting seo kompanii_qson
23 Oct 25 at 6:10 am
I do not know if it’s just me or if perhaps everybody else encountering problems with
your site. It seems like some of the written text
on your content are running off the screen. Can somebody else please provide feedback and let me know if this is
happening to them as well? This might be a issue with
my internet browser because I’ve had this happen previously.
Kudos
that it quite clearly
23 Oct 25 at 6:11 am
This piece of writing is actually a fastidious one it helps new internet visitors, who are wishing for blogging.
blue salt trick for men
23 Oct 25 at 6:11 am
https://factava.com.ua/virshi/virshi-pro-zymu-dlia-ditey-5-6-rokiv-naykrashchi-virshi-ta-rozvahy-dlia-malenkykh-doslidnykiv-zymy/
JessieVinge
23 Oct 25 at 6:18 am
рейтинг сео агентств [url=https://reiting-seo-kompaniy.ru/]рейтинг сео агентств[/url] .
reiting seo kompanii_hjon
23 Oct 25 at 6:18 am
Не менее опасны и психоэмоциональные нарушения, связанные с абстинентным синдромом: тревога, чувство паники, галлюцинации, нарушения координации. В тяжёлых случаях может развиться алкогольный делирий (белая горячка) со спутанностью сознания, бредовыми идеями и приступами агрессии. Самостоятельный резкий отказ от спиртного в этом состоянии чреват непредсказуемыми осложнениями вплоть до судорог и комы.
Выяснить больше – http://narko-reabcentr.ru/
JamesSworp
23 Oct 25 at 6:19 am
Предлагаем вашему вниманию интересную справочную статью, в которой собраны ключевые моменты и нюансы по актуальным вопросам. Эта информация будет полезна как для профессионалов, так и для тех, кто только начинает изучать тему. Узнайте ответы на важные вопросы и расширьте свои знания!
Обратиться к источнику – https://tradingtree.com.au/product/shiraz-semi-cured-gel-nail-stickers
Edwardken
23 Oct 25 at 6:21 am
I always used to read post in news papers but now as
I am a user of net so from now I am using net for content, thanks to web.
강남룸싸롱
23 Oct 25 at 6:21 am
купить диплом в великом новгороде [url=http://rudik-diplom13.ru]купить диплом в великом новгороде[/url] .
Diplomi_rion
23 Oct 25 at 6:22 am
bahis siteler 1xbet [url=https://www.1xbet-giris-3.com]https://www.1xbet-giris-3.com[/url] .
1xbet giris_llMi
23 Oct 25 at 6:22 am
В этом информативном тексте представлены захватывающие события и факты, которые заставят вас задуматься. Мы обращаем внимание на важные моменты, которые часто остаются незамеченными, и предлагаем новые перспективы на привычные вещи. Подготовьтесь к тому, чтобы быть поглощенным увлекательными рассказами!
Смотрите также… – https://okusurijoho.com/2013/12/30/just-a-cool-blog-post-with-images
SamuelBrita
23 Oct 25 at 6:23 am
We’re a group of volunteers and opening a new scheme in our community.
Your website offered us with valuable information to work on. You’ve done an impressive job and our entire community will be thankful to
you.
Magnus AI Opiniones
23 Oct 25 at 6:27 am
где купить диплом техникума в ижевске [url=www.frei-diplom7.ru/]где купить диплом техникума в ижевске[/url] .
Diplomi_eiei
23 Oct 25 at 6:28 am
This design is incredible! You certainly know how to keep a reader entertained.
Between your wit and your videos, I was almost moved to start my own blog (well,
almost…HaHa!) Excellent job. I really loved what you had to say, and more than that, how you presented it.
Too cool!
phising
23 Oct 25 at 6:28 am
Как купить Шишки в Ессентукие?Обратите внимание – сайт https://kernatoms.ru
. Цены нормальные, доставка заявлена. Может, кто-то тестил у них? Как у них с надежностью?
Stevenref
23 Oct 25 at 6:29 am
https://factava.com.ua/znachennya-imen/roman-znachennia-imeni-yak-vybir-imeni-vplyvaie-na-doliu-liudyny/
JessieVinge
23 Oct 25 at 6:32 am
Viagra generic price comparison: how generic Viagra works in the body – discreet shipping for ED medication
AnthonySep
23 Oct 25 at 6:34 am
Incredible points. Solid arguments. Keep up the amazing spirit.
paito hongkong
23 Oct 25 at 6:36 am