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=http://frei-diplom3.ru]купить диплом об образовании с занесением в реестр[/url] .
Diplomi_ecKt
5 Oct 25 at 3:59 am
купить диплом в волгограде [url=https://www.rudik-diplom5.ru]купить диплом в волгограде[/url] .
Diplomi_xhma
5 Oct 25 at 4:00 am
ラブドール 女性 用and then calmlyasked,how he proposed to maintain himself and spouse? He replied,
ラブドール
5 Oct 25 at 4:00 am
Hi, this weekend is fastidious designed for me, as this time i am reading this impressive educational post here at my home.
Criminal Defense Lawyer
5 Oct 25 at 4:02 am
купить диплом воспитателя [url=http://www.rudik-diplom3.ru]купить диплом воспитателя[/url] .
Diplomi_asei
5 Oct 25 at 4:02 am
купить диплом в рыбинске [url=https://rudik-diplom4.ru/]https://rudik-diplom4.ru/[/url] .
Diplomi_ygOr
5 Oct 25 at 4:03 am
купить диплом в озёрске [url=http://www.rudik-diplom7.ru]http://www.rudik-diplom7.ru[/url] .
Diplomi_xaPl
5 Oct 25 at 4:04 am
高級 ラブドールs wne.Nghts wthther fre of star Cold,
ラブドール
5 Oct 25 at 4:04 am
Складчик — это настоящая находка для всех, кто любит учиться. Совместная покупка курсов экономит огромные деньги. Сайт удобный, доступ открывается моментально. Я всем доволен, https://v27.skladchik.org/
BryanTop
5 Oct 25 at 4:04 am
Заказывали пластиковые окна для всей квартиры в компании Окна в СПб. Работу сделали качественно, монтаж прошёл в срок. Окна выглядят современно и удобны в использовании. Теперь в доме комфортно и тепло: https://okna-v-spb.ru/
RobertPhece
5 Oct 25 at 4:05 am
Недавно попробовал Складчик впервые и был приятно удивлён. Купил складчину на курс по дизайну. Материалы пришли быстро, доступ открыли сразу. Всё полное и качественное. Цена минимальная, экономия впечатляющая. Удобство сайта отличное. Теперь буду пользоваться регулярно – https://v27.skladchik.org/
BryanTop
5 Oct 25 at 4:06 am
купить диплом в миассе [url=http://rudik-diplom5.ru/]купить диплом в миассе[/url] .
Diplomi_npma
5 Oct 25 at 4:06 am
buy amoxicillin [url=https://amoxdirectusa.com/#]Buy Amoxicillin for tooth infection[/url] Amoxicillin 500mg buy online
Davidbax
5 Oct 25 at 4:07 am
диплом медсестры с занесением в реестр купить [url=http://www.frei-diplom1.ru]диплом медсестры с занесением в реестр купить[/url] .
Diplomi_cxOi
5 Oct 25 at 4:08 am
fixing on the truth.フィギュア オナホ“Why? ?“I should have though Fisher leaning on “youcould have seen that it is my room.
ラブドール
5 Oct 25 at 4:09 am
I just like the helpful info you provide on your articles.
I will bookmark your blog and check once more
here regularly. I am moderately sure I’ll be told many new stuff proper right here!
Best of luck for the following!
Sheffield Escorts Agency
5 Oct 25 at 4:09 am
Does your site have a contact page? I’m having problems locating it but, I’d like to send you an email.
I’ve got some recommendations for your blog you might
be interested in hearing. Either way, great blog and I look forward to
seeing it grow over time.
bingostar.games
5 Oct 25 at 4:09 am
apart from her need of help,anupsetting kind of character.ダッチワイフ エロ
ラブドール
5 Oct 25 at 4:11 am
купить диплом с занесением в реестр новокузнецке [url=http://www.frei-diplom3.ru]купить диплом с занесением в реестр новокузнецке[/url] .
Diplomi_jwKt
5 Oct 25 at 4:13 am
купить диплом с занесением в реестр в москве [url=http://frei-diplom5.ru/]купить диплом с занесением в реестр в москве[/url] .
Diplomi_rjPa
5 Oct 25 at 4:13 am
купить диплом бакалавра [url=http://rudik-diplom8.ru]купить диплом бакалавра[/url] .
Diplomi_uxMt
5 Oct 25 at 4:13 am
купить диплом техникума недорого [url=https://educ-ua7.ru]https://educ-ua7.ru[/url] .
Diplomi_ecea
5 Oct 25 at 4:13 am
купить диплом с реестром отзывы [url=http://frei-diplom4.ru/]купить диплом с реестром отзывы[/url] .
Diplomi_psOl
5 Oct 25 at 4:14 am
купить диплом в туапсе [url=http://www.rudik-diplom2.ru]купить диплом в туапсе[/url] .
Diplomi_chpi
5 Oct 25 at 4:15 am
AmoxDirect USA: Buy Amoxicillin for tooth infection – Amoxicillin 500mg buy online
Glennchilt
5 Oct 25 at 4:16 am
купить медицинский диплом медсестры [url=www.frei-diplom14.ru/]купить медицинский диплом медсестры[/url] .
Diplomi_tboi
5 Oct 25 at 4:18 am
Fruityliner X играть в леонбетс
TommyCap
5 Oct 25 at 4:20 am
Требуются деньги в ближайшие минуты? Забудьте про банки — оформить займ можно онлайн. На https://mikro-zaim-online.ru/ подобраны десятки официальных МФО, где одобряют в 97 % случаев. Подборка составлена по реальным отзывам пользователей и скорости перевода средств: от 2 до 15 минут — и вы получаете перевод.
Минимум формальностей, всё просто и удобно: только паспорт, интернет и пару кликов. Здесь вы сможете получить первый займ без переплат, подать заявку через Госуслуги или оформить займ даже ночью. Всё честно, быстро и без общения с менеджерами — просто находите подходящее МФО и получайте деньги на карту.
Mirkolahon
5 Oct 25 at 4:20 am
Дизайн обложки Анимация обложки – это современный тренд в музыкальной индустрии, который позволяет оживить статичное изображение и сделать его более привлекательным и запоминающимся. Анимированная обложка может быть короткой петлей видео, интерактивным элементом или просто динамичным эффектом. Анимация привлекает внимание пользователя в ленте новостей и увеличивает шансы на прослушивание трека. Однако, важно помнить, что анимация должна быть качественной и соответствовать стилю музыки. Плохая анимация может произвести обратный эффект и отпугнуть потенциальных слушателей. Используйте простую, но эффектную анимацию, которая подчеркнет настроение и атмосферу вашей музыки. Экспериментируйте с разными стилями и эффектами, чтобы найти идеальное решение для своего трека. Анимация обложки – это отличный способ выделиться из толпы и привлечь внимание к своему музыкальному проекту.
HarryWaf
5 Oct 25 at 4:20 am
Hello, I check your blogs like every week. Your story-telling style is awesome, keep up the good
work!
http://bohhchaos.listbb.ru/viewtopic.php?f=9&t=11098
5 Oct 25 at 4:20 am
купить диплом техникума с занесением в реестр [url=https://www.frei-diplom1.ru]купить диплом техникума с занесением в реестр[/url] .
Diplomi_slOi
5 Oct 25 at 4:20 am
диплом с проведением купить [url=http://www.frei-diplom4.ru]диплом с проведением купить[/url] .
Diplomi_fpOl
5 Oct 25 at 4:21 am
Купить диплом техникума в Запорожье [url=http://educ-ua7.ru/]http://educ-ua7.ru/[/url] .
Diplomi_klea
5 Oct 25 at 4:21 am
купить диплом в новомосковске [url=http://rudik-diplom8.ru/]купить диплом в новомосковске[/url] .
Diplomi_fuMt
5 Oct 25 at 4:21 am
Формат
Получить дополнительную информацию – https://narkologicheskaya-klinika-lyubercy0.ru/chastnaya-narkologicheskaya-klinika-v-lyubercah/
Jorgesmusy
5 Oct 25 at 4:21 am
купить диплом в саратове [url=www.rudik-diplom4.ru/]купить диплом в саратове[/url] .
Diplomi_qmOr
5 Oct 25 at 4:21 am
Закладки тут – купить гашиш, мефедрон, альфа-РїРІРї
RodneyDof
5 Oct 25 at 4:22 am
https://zithromedsonline.shop/# zithromax z- pak buy online
DavidThink
5 Oct 25 at 4:22 am
Usted ha presentado el asunto de manera impecable.|
En serio, una gran cantidad de contenidos de apuestas!|
Valioso análisis. Mil gracias.|
Esto está muy bien presentado!|
Valioso recurso, Gracias!|
Saludos. Valoré este review|Interesante análisis de casino.|
Saludos! Amplia colección de tips sobre bonos aquí.
https://enplan.page.place/bbs/board.php?bo_table=free&wr_id=965022
5 Oct 25 at 4:23 am
купить диплом повара-кондитера [url=www.rudik-diplom2.ru/]купить диплом повара-кондитера[/url] .
Diplomi_typi
5 Oct 25 at 4:24 am
купить диплом о высшем образовании с занесением в реестр в москве [url=http://www.frei-diplom6.ru]купить диплом о высшем образовании с занесением в реестр в москве[/url] .
Diplomi_otOl
5 Oct 25 at 4:26 am
купить диплом о высшем образовании с занесением в реестр в ижевске [url=frei-diplom5.ru]купить диплом о высшем образовании с занесением в реестр в ижевске[/url] .
Diplomi_ocPa
5 Oct 25 at 4:26 am
Uncover curated events аt Kaizenaire.com, covering
Singapore’ѕ promotions landscape.
Singapore aѕ a deal ρlace mesmerizes Singaporeans that love evｅry promotion.
Going to real-tіme performances ɑt the Esplanade keepѕ songs
fans in Singapore captivated, and bear in mind to stay updated on Singapore’s moѕt current promotions and
shopping deals.
DBS, ɑ leading banking institution in Singapore, ɡives ɑ variety of monetary solutions from electronic financial tο wealth
management, ԝhich Singaporeans adore f᧐r theіr seamless combination гight intо daily life.
Charles & Keith оffers fashionable shoes аnd bags leh, beloved by style-savvy Singaporeans fⲟr thеir fashionable designs аnd cost one.
Gardenia giveѕ soft, fresh bread loaves daily, treasured ƅy households
for trustworthy sandwiches ɑnd salutes that feel ⅼike home.
Ɗо not slouch mah, mɑke Kaizenaire.ϲom your routine for promotions lah.
Take a lοoҝ at my site :: singapore promo
singapore promo
5 Oct 25 at 4:26 am
купить диплом в королёве [url=http://rudik-diplom5.ru/]купить диплом в королёве[/url] .
Diplomi_gtma
5 Oct 25 at 4:26 am
What’s Going down i’m new to this, I stumbled upon this I’ve
discovered It absolutely useful and it has helped me out loads.
I am hoping to contribute & help other users like its aided me.
Great job.
luxury hotel Staffordshire
5 Oct 25 at 4:27 am
купить диплом в великом новгороде [url=http://rudik-diplom8.ru/]купить диплом в великом новгороде[/url] .
Diplomi_ooMt
5 Oct 25 at 4:28 am
техникум это какое образование украина [url=http://educ-ua7.ru/]http://educ-ua7.ru/[/url] .
Diplomi_itea
5 Oct 25 at 4:28 am
купить дипломы о высшем образовании цена [url=www.rudik-diplom4.ru/]купить дипломы о высшем образовании цена[/url] .
Diplomi_giOr
5 Oct 25 at 4:29 am
купить диплом слесаря [url=https://rudik-diplom2.ru]купить диплом слесаря[/url] .
Diplomi_uypi
5 Oct 25 at 4:31 am
I blog quite often and I truly appreciate your information. This article has truly peaked my interest.
I will take a note of your website and keep checking for new details about once a week.
I subscribed to your Feed as well.
Meteor Profit Review
5 Oct 25 at 4:33 am