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!
Hi are using WordPress for your blog platform? I’m new to the blog
world but I’m trying to get started and create
my own. Do you need any html coding expertise
to make your own blog? Any help would be really appreciated!
Houston, Texas end dump trailer hauling service
24 Oct 25 at 2:16 pm
Наркологическая клиника «СтавропольМед Резонанс» — это круглосуточный центр доказательной медицины, где помощь строится вокруг безопасности, конфиденциальности и персонализации. Мы объединяем медицинскую детоксикацию, психотерапию, реабилитационные практики и постлечебное сопровождение в единую дорожную карту восстановления. Каждый шаг лечения закреплён измеримыми критериями эффективности, а решения принимаются командно — от дежурного нарколога и клинического психолога до психиатра и реабилитолога.
Получить дополнительную информацию – https://narcologicheskaya-klinika-stavropol0.ru/chastnaya-narkologicheskaya-klinika-stavropol
RonaldEralf
24 Oct 25 at 2:16 pm
Система промокодов при регистрации позволяет новым игрокам получать бонусы к первому депозиту; мы описываем, как правильно заполнить регистрационную форму и где указать данные, а в середине примера даём ссылку на 1хБет промокод при регистрации для удобства. Обратите внимание, что бонусные условия могут отличаться в зависимости от региона.
Petercet
24 Oct 25 at 2:16 pm
1 xbet [url=https://1xbet-giris-7.com/]1 xbet[/url] .
1xbet giris_eoKn
24 Oct 25 at 2:17 pm
1xbet t?rkiye [url=1xbet-giris-10.com]1xbet t?rkiye[/url] .
1xbet giris_mska
24 Oct 25 at 2:19 pm
https://t.me/bs_1xbet/5
https://t.me/s/bs_1xbet/34
24 Oct 25 at 2:20 pm
https://t.me/bs_1xbet/16
https://t.me/bs_1xbet/14
24 Oct 25 at 2:21 pm
купить диплом техникума цена [url=frei-diplom8.ru]купить диплом техникума цена[/url] .
Diplomi_bvsr
24 Oct 25 at 2:21 pm
где купить диплом [url=http://www.rudik-diplom3.ru]где купить диплом[/url] .
Diplomi_maei
24 Oct 25 at 2:22 pm
диплом нефтяного техникума купить [url=https://educ-ua7.ru]https://educ-ua7.ru[/url] .
Diplomi_nhea
24 Oct 25 at 2:23 pm
Kanuna aykırı ve izinsiz olarak kopyalanamaz, başka yerde yayınlanamaz.
Video Indir
24 Oct 25 at 2:23 pm
купить диплом мастера маникюра и педикюра [url=www.rudik-diplom5.ru/]купить диплом мастера маникюра и педикюра[/url] .
Diplomi_sgma
24 Oct 25 at 2:23 pm
Viagra utan läkarbesök: apotek online utan recept – onlineapotek för män
Jesuskax
24 Oct 25 at 2:24 pm
1xbet g?ncel adres [url=www.1xbet-giris-3.com/]1xbet g?ncel adres[/url] .
1xbet giris_teMi
24 Oct 25 at 2:25 pm
1xbet t?rkiye [url=http://1xbet-giris-10.com/]1xbet t?rkiye[/url] .
1xbet giris_qcka
24 Oct 25 at 2:26 pm
купить диплом в анапе [url=https://rudik-diplom1.ru]купить диплом в анапе[/url] .
Diplomi_naer
24 Oct 25 at 2:26 pm
wettanbieter lizenz deutschland
Also visit my web site – online sportwetten paypal (redrock.am)
redrock.am
24 Oct 25 at 2:26 pm
купить диплом моряка [url=rudik-diplom4.ru]купить диплом моряка[/url] .
Diplomi_gaOr
24 Oct 25 at 2:26 pm
купить медицинский диплом медсестры [url=https://frei-diplom13.ru]купить медицинский диплом медсестры[/url] .
Diplomi_nxkt
24 Oct 25 at 2:26 pm
После тщательного анализа отзывов и собственного опыта, можно сделать определённые выводы.
игровые автоматы слотозал
24 Oct 25 at 2:26 pm
купить диплом в буйнакске [url=https://rudik-diplom10.ru]https://rudik-diplom10.ru[/url] .
Diplomi_xxSa
24 Oct 25 at 2:26 pm
http://mannensapotek.com/# onlineapotek for man
Hermanereli
24 Oct 25 at 2:27 pm
one x bet [url=http://www.1xbet-9.com]http://www.1xbet-9.com[/url] .
1xbet_meSn
24 Oct 25 at 2:29 pm
1xbet giri? linki [url=https://www.1xbet-giris-10.com]1xbet giri? linki[/url] .
1xbet giris_waka
24 Oct 25 at 2:29 pm
купить диплом в иркутске [url=https://rudik-diplom3.ru/]купить диплом в иркутске[/url] .
Diplomi_fsei
24 Oct 25 at 2:29 pm
купить диплом техникума недорого [url=http://www.educ-ua7.ru]http://www.educ-ua7.ru[/url] .
Diplomi_dnea
24 Oct 25 at 2:29 pm
На первом контакте координатор задаёт несколько точных вопросов: длительность эпизода, наличие рвоты/тремора/бессонницы, приём лекарств, хронические заболевания. Эти данные нужны не «для галочки»: по ним заранее выстраивается протокол инфузии, рассчитывается скорость, подбираются уколы до капельницы и объём наблюдения после. Врач приезжает уже с персональным планом и поправляет его по факту осмотра.
Углубиться в тему – [url=https://vyvod-iz-zapoya-petrozavodsk0.ru/]помощь вывод из запоя в петрозаводске[/url]
PatrickSlode
24 Oct 25 at 2:30 pm
купить диплом в северодвинске [url=www.rudik-diplom11.ru]купить диплом в северодвинске[/url] .
Diplomi_dmMi
24 Oct 25 at 2:30 pm
Peculiar article, exactly what I wanted to find.
vacation packages in dubai
24 Oct 25 at 2:30 pm
xbet giri? [url=https://1xbet-7.com/]1xbet-7.com[/url] .
1xbet_jhol
24 Oct 25 at 2:31 pm
https://obecretuvka.cz — зайти на kraken
ссылка на кракен
24 Oct 25 at 2:31 pm
купить диплом занесенный в реестр [url=www.frei-diplom2.ru/]купить диплом занесенный в реестр[/url] .
Diplomi_lbEa
24 Oct 25 at 2:31 pm
можно ли купить легальный диплом [url=https://frei-diplom1.ru/]https://frei-diplom1.ru/[/url] .
Diplomi_tpOi
24 Oct 25 at 2:32 pm
купить диплом в ставрополе [url=https://www.rudik-diplom1.ru]купить диплом в ставрополе[/url] .
Diplomi_jeer
24 Oct 25 at 2:32 pm
Команда «КарелМед Центра» объединяет наркологов, психиатров, реаниматологов, клинических психологов, специалистов по реабилитации и социальному сопровождению. Мы работаем без очередей и навязчивых формальностей, а логистика визита, оформление в стационар и коммуникации с родственниками выстроены бережно: конфиденциальные записи, немаркированные выезды, отдельный вход и нейтральная терминология в документах. Вы получаете не только купирование абстиненции и детоксикацию, но и системную работу с триггерами, привычками и межличностными конфликтами — тем, что часто возвращает к употреблению даже после «идеальных капельниц».
Узнать больше – http://narkologicheskaya-klinika-petrozavodsk0.ru
Rodneynew
24 Oct 25 at 2:32 pm
купить диплом с занесением в реестр оренбург [url=www.frei-diplom4.ru/]купить диплом с занесением в реестр оренбург[/url] .
Diplomi_rtOl
24 Oct 25 at 2:32 pm
The scale of these recent attacks means Ukraine needs any help it can get to minimize the impacts – and volunteers are playing an increasingly important role in the defensive mix.
[url=https://kra49.at-kra49.cc ]kra42[/url]
Civilians are forming units tasked with shooting down smaller drones with machine guns or, most recently, specially developed interceptor drones.
[url=https://kra46cc.com ]kra43 at[/url]
The chief of staff of one of Kyiv’s volunteer formation legions, Andriy, whose call-sign is Stolyar, said his unit is composed of people from all walks of life – from construction workers to businessmen to poets.
He told CNN the training for his legion lasts for about six weeks and includes basic knowledge, simulator practice and topography lessons. Andriy asked for his last name not to be published for security reasons.
“A person must understand how to operate an aircraft. Drones are becoming increasingly complex – this is aviation, and it requires constant attention, knowledge, and skills,” he said.
kra40
https://kra45-at.cc
JamesPycle
24 Oct 25 at 2:32 pm
Для жителей Петрозаводска настроен оперативный маршрут: короткий телефонный скрининг, подтверждение окна прибытия, деликатный выезд без маркировки, нейтральные формулировки в документах. Мы не просто «обещаем анонимность» — мы обеспечиваем её процедурами: разграничение доступа к карте пациента, отдельные каналы связи, журналирование обращений, нейтральные названия в сопроводительных документах. Это важно в моменты, когда мотивация хрупка, а любая огласка способна оттолкнуть от лечения.
Ознакомиться с деталями – [url=https://narkolog-na-dom-petrozavodsk0.ru/]нарколог капельница на дом в петрозаводске[/url]
Davidben
24 Oct 25 at 2:33 pm
Мы работаем по модели «72 часа + 2 недели»: первые трое суток посвящены стабилизации витальных показателей, коррекции сна и сокращению «тяговых» откликов, следующие 14 дней — консолидации результата и запуску психотерапевтического блока. Маркеры прописываются заранее, поэтому и пациент, и семья понимают, когда и что мы будем оценивать, как корректируем план, если динамика ниже ожидаемой.
Подробнее тут – [url=https://narcologicheskaya-klinika-pervouralsk0.ru/]частная наркологическая клиника первоуральск[/url]
MatthewStall
24 Oct 25 at 2:33 pm
купить диплом в нижнекамске [url=https://rudik-diplom3.ru]https://rudik-diplom3.ru[/url] .
Diplomi_jzei
24 Oct 25 at 2:34 pm
Great goods from you, man. I have understand your stuff previous to and you are just too fantastic.
I actually like what you have acquired here, really like what you’re stating and
the way in which you say it. You make it
entertaining and you still care for to keep it smart.
I can’t wait to read far more from you. This is
actually a terrific site.
Finxor Gpt Recensione
24 Oct 25 at 2:35 pm
диплом с занесением в реестр купить [url=http://frei-diplom5.ru]диплом с занесением в реестр купить[/url] .
Diplomi_nyPa
24 Oct 25 at 2:35 pm
Мы не «перелечиваем» пациента процедурами. Любая мера начинается как проверяемая гипотеза с измеримыми маркерами. Ниже — опорная карта лечения. В реальности она персонализируется в зависимости от клинической картины, возраста, сопутствующих заболеваний и бытового графика.
Изучить вопрос глубже – [url=https://narkologicheskaya-klinika-kamensk-uralskij0.ru/]частная наркологическая клиника[/url]
Brandonrig
24 Oct 25 at 2:35 pm
С первого контакта координатор уточняет: длительность запоя, виды алкоголя, аллергии, список текущих лекарств, эпизоды судорог или психозов в анамнезе, сердечно-сосудистые жалобы. На основании ответов команда подбирает безопасную схему старта и резервный план на случай усиления симптомов. Врач привозит портативный монитор для контроля АД/ЧСС/SpO2, глюкометр, набор инфузионных линий и расходников, а также средства для экспресс-коррекции тревоги по показаниям.
Подробнее можно узнать тут – [url=https://vyvod-iz-zapoya-pervouralsk0.ru/]наркология вывод из запоя в первоуральске[/url]
Curtiscleva
24 Oct 25 at 2:36 pm
купить диплом в невинномысске [url=www.rudik-diplom1.ru]купить диплом в невинномысске[/url] .
Diplomi_uder
24 Oct 25 at 2:36 pm
купить диплом в кузнецке [url=www.rudik-diplom8.ru]www.rudik-diplom8.ru[/url] .
Diplomi_ldMt
24 Oct 25 at 2:36 pm
где купить дипломы медсестры [url=http://frei-diplom13.ru/]где купить дипломы медсестры[/url] .
Diplomi_ahkt
24 Oct 25 at 2:37 pm
купить диплом в набережных челнах [url=https://rudik-diplom5.ru/]купить диплом в набережных челнах[/url] .
Diplomi_fvma
24 Oct 25 at 2:38 pm
I have read some excellent stuff here. Definitely price bookmarking for
revisiting. I surprise how much effort you place to make this type of fantastic informative web site.
派遣 駅チカ
24 Oct 25 at 2:38 pm
xbet giri? [url=http://www.1xbet-giris-10.com]xbet giri?[/url] .
1xbet giris_yqka
24 Oct 25 at 2:39 pm