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-diplom4.ru]купить проведенный диплом провести[/url] .
Diplomi_njOl
7 Oct 25 at 3:33 am
купить диплом косметолога [url=http://rudik-diplom5.ru]купить диплом косметолога[/url] .
Diplomi_fyma
7 Oct 25 at 3:35 am
купить диплом о высшем образовании с занесением в реестр в ижевске [url=https://frei-diplom2.ru/]купить диплом о высшем образовании с занесением в реестр в ижевске[/url] .
Diplomi_dkEa
7 Oct 25 at 3:37 am
купить диплом [url=http://rudik-diplom2.ru/]купить диплом[/url] .
Diplomi_fwpi
7 Oct 25 at 3:38 am
где заказать кухню в спб [url=www.kuhni-spb-4.ru/]где заказать кухню в спб[/url] .
kyhni spb_mzer
7 Oct 25 at 3:39 am
https://t.me/s/minotaurus_official Presale Attracts Interest from Institutional Investors
Exploring the Appeal of Minotaurus Presale Among Institutional Investors
For stakeholders keen on diversifying portfolios, this remarkable fundraising initiative represents a strategic option. With projections estimating participation from key financial entities, the potential for significant capital influx is evident. Analysts forecast a surge in demand, driven by both innovative offerings and a solid foundational support within the project.
The campaign’s unique structure appears to resonate well within institutional circles, aligning with diverse investment strategies. Current market analyses indicate strong backing from seasoned market players, eager to capitalize on the technological advancements embedded within this initiative. Participants can anticipate robust returns, underscoring the attractiveness of this opportunity.
Additionally, enhanced visibility through targeted communications has positioned this fundraising effort as a focal point for those with substantial assets. The strategy aims to create synergies that bolster investor confidence while generating substantial liquidity. As the fundraising phase progresses, maintaining a close watch on emerging trends will be key for potential participants seeking to leverage these dynamics effectively.
minotaurus ico
7 Oct 25 at 3:39 am
диплом техникума купить [url=https://www.educ-ua7.ru]https://www.educ-ua7.ru[/url] .
Diplomi_bkea
7 Oct 25 at 3:40 am
купить сертификат специалиста [url=https://rudik-diplom4.ru/]купить сертификат специалиста[/url] .
Diplomi_ojOr
7 Oct 25 at 3:41 am
купить диплом тренера [url=https://www.rudik-diplom14.ru]купить диплом тренера[/url] .
Diplomi_ubea
7 Oct 25 at 3:41 am
как купить диплом техникума с занесением в реестр цена в [url=www.frei-diplom5.ru]как купить диплом техникума с занесением в реестр цена в[/url] .
Diplomi_grPa
7 Oct 25 at 3:41 am
купить диплом без реестра [url=https://www.frei-diplom4.ru]купить диплом без реестра[/url] .
Diplomi_dvOl
7 Oct 25 at 3:42 am
https://maminboss.ru
HowardGoony
7 Oct 25 at 3:43 am
реабилитационный центр наркологический [url=http://narkologicheskaya-klinika-20.ru/]http://narkologicheskaya-klinika-20.ru/[/url] .
narkologicheskaya klinika _ytPr
7 Oct 25 at 3:43 am
диплом о высшем образовании с проводкой купить [url=www.frei-diplom1.ru/]диплом о высшем образовании с проводкой купить[/url] .
Diplomi_ujOi
7 Oct 25 at 3:43 am
купить диплом в пскове [url=www.rudik-diplom6.ru/]купить диплом в пскове[/url] .
Diplomi_cxKr
7 Oct 25 at 3:44 am
купить диплом в минусинске [url=http://rudik-diplom5.ru]купить диплом в минусинске[/url] .
Diplomi_nyma
7 Oct 25 at 3:44 am
купить диплом в донском [url=https://www.rudik-diplom3.ru]https://www.rudik-diplom3.ru[/url] .
Diplomi_knei
7 Oct 25 at 3:45 am
купить кухню на заказ спб [url=kuhni-spb-4.ru]kuhni-spb-4.ru[/url] .
kyhni spb_dfer
7 Oct 25 at 3:47 am
купить диплом в ухте [url=http://www.rudik-diplom4.ru]купить диплом в ухте[/url] .
Diplomi_ljOr
7 Oct 25 at 3:47 am
как купить диплом техникума цена [url=www.educ-ua7.ru]www.educ-ua7.ru[/url] .
Diplomi_dxea
7 Oct 25 at 3:48 am
купить диплом проведенный [url=www.frei-diplom6.ru/]купить диплом проведенный[/url] .
Diplomi_ylOl
7 Oct 25 at 3:49 am
Коллекционная сантехника Villeroy & Boch — это грамотная инвестиция в комфорт и долговечность. В официальном интернет-магазине найдете квариловые ванны Oberon и Subway 3.0, раковины Antao и Loop & Friends, умные решения SMARTFLOW, сертифицированные аксессуары и инсталляции TECE. Доставка по России, помощь в подборе, актуальный блог и сервисные консультации. Откройте витрину бренда на https://villeroy-boch-pro.ru — там стиль и инженерия соединяются в идеальный интерьер.
nubapGog
7 Oct 25 at 3:49 am
купить диплом реестр [url=www.frei-diplom1.ru/]купить диплом реестр[/url] .
Diplomi_lxOi
7 Oct 25 at 3:50 am
В Нижнем Новгороде стационар «Частного Медика 24» стал надежным местом для лечения запоя.
Детальнее – [url=https://vyvod-iz-zapoya-v-stacionare22.ru/]вывод из запоя в стационаре клиника нижний новгород[/url]
Nathangeash
7 Oct 25 at 3:51 am
Снятие интоксикации, восстановление организма и наблюдение — так проходит вывод из запоя в стационаре «Частный Медик 24».
Получить дополнительную информацию – [url=https://vyvod-iz-zapoya-v-stacionare22.ru/]быстрый вывод из запоя в стационаре[/url]
Nathangeash
7 Oct 25 at 3:51 am
купить диплом в ялте [url=https://www.rudik-diplom11.ru]купить диплом в ялте[/url] .
Diplomi_efMi
7 Oct 25 at 3:52 am
Пациентам в Самаре предлагается анонимное лечение в стационаре с круглосуточным уходом и безопасными условиями.
Получить дополнительные сведения – [url=https://vyvod-iz-zapoya-v-stacionare-samara25.ru/]вывод из запоя в стационаре клиника самара[/url]
Hectorpam
7 Oct 25 at 3:52 am
купить диплом в крыму [url=https://www.rudik-diplom14.ru]купить диплом в крыму[/url] .
Diplomi_xtea
7 Oct 25 at 3:53 am
купить диплом вуза [url=https://www.rudik-diplom3.ru]купить диплом вуза[/url] .
Diplomi_mgei
7 Oct 25 at 3:54 am
купить диплом об образовании с занесением в реестр [url=https://frei-diplom6.ru]купить диплом об образовании с занесением в реестр[/url] .
Diplomi_wsOl
7 Oct 25 at 3:54 am
как купить диплом о высшем образовании с занесением в реестр отзывы [url=http://www.frei-diplom1.ru]как купить диплом о высшем образовании с занесением в реестр отзывы[/url] .
Diplomi_muOi
7 Oct 25 at 3:55 am
Стационар «Частного Медика 24» в Воронеже — место, где пациент, страдающий от длительного запоя, получает не просто деньги-стоимость услуги, а полноценную помощь: диагностику, детоксикацию, медикаментозную поддержку и психологическую помощь с уважением к личному пространству и анонимности.
Изучить вопрос глубже – [url=https://vyvod-iz-zapoya-v-stacionare-voronezh24.ru/]вывод из запоя в стационаре клиника в воронеже[/url]
Ronaldsteaf
7 Oct 25 at 3:55 am
リアル えろbut then she usually liked everybody mostwhen they weren,t there.
ラブドール
7 Oct 25 at 3:55 am
купить диплом в димитровграде [url=https://rudik-diplom8.ru/]купить диплом в димитровграде[/url] .
Diplomi_qnMt
7 Oct 25 at 3:55 am
кухни на заказ в спб недорого [url=https://kuhni-spb-4.ru/]кухни на заказ в спб недорого[/url] .
kyhni spb_zker
7 Oct 25 at 3:56 am
купить диплом в пензе [url=https://rudik-diplom13.ru]https://rudik-diplom13.ru[/url] .
Diplomi_ukon
7 Oct 25 at 3:56 am
можно ли в техникуме купить диплом [url=https://frei-diplom9.ru]можно ли в техникуме купить диплом[/url] .
Diplomi_zvea
7 Oct 25 at 3:56 am
купить диплом в пскове [url=https://www.rudik-diplom7.ru]купить диплом в пскове[/url] .
Diplomi_pbPl
7 Oct 25 at 3:56 am
Типография «AVPrintPak» превращает упаковку в сильный элемент бренда: проектирует и изготавливает коробки любой сложности — от хром-эрзаца и микрогофрокартона до тубусов и круглых коробок для цветов и тортов. Для премиальных задач доступны тиснение, выборочный лак, конгрев и высокоточные ложементы. Офсетный и цифровой парк дает стабильное качество и быстрые тиражи, а конструкторский отдел изготавливает тестовые образцы под конкретный продукт. Ищете подарочная коробка на заказ? Подробности и портфолио — на сайте avprintpak.ru
emazaChomy
7 Oct 25 at 3:57 am
купить диплом фельдшера [url=rudik-diplom6.ru]купить диплом фельдшера[/url] .
Diplomi_nkKr
7 Oct 25 at 3:58 am
купить диплом техникума в рязани [url=frei-diplom10.ru]купить диплом техникума в рязани[/url] .
Diplomi_wlEa
7 Oct 25 at 3:59 am
ラブドール リアルabsolute fairness.Did you ever.
ラブドール
7 Oct 25 at 4:01 am
купить аттестат [url=https://www.rudik-diplom2.ru]купить аттестат[/url] .
Diplomi_jrpi
7 Oct 25 at 4:02 am
エロ 人形from abroad,letters to different correspondents,
ラブドール
7 Oct 25 at 4:02 am
I just like the helpful information you supply in your articles.
I will bookmark your blog and check again here regularly.
I’m relatively sure I’ll be told many new stuff right here!
Good luck for the following!
Mega Casino
7 Oct 25 at 4:02 am
купить свидетельство о браке [url=http://rudik-diplom5.ru/]купить свидетельство о браке[/url] .
Diplomi_wxma
7 Oct 25 at 4:03 am
купить диплом педагога [url=http://www.rudik-diplom8.ru]купить диплом педагога[/url] .
Diplomi_jtMt
7 Oct 25 at 4:04 am
ラブドール リアルKate had a flat face.That nowannoying as she wa loose-tongued as she waimpertinen objectionable,
ラブドール
7 Oct 25 at 4:05 am
купить диплом в старом осколе [url=www.rudik-diplom11.ru/]купить диплом в старом осколе[/url] .
Diplomi_bpMi
7 Oct 25 at 4:07 am
Hello I am so excited I found your website, I really found you by mistake, while
I was browsing on Aol for something else, Anyways I am here now and would
just like to say cheers for a remarkable post and a all round enjoyable blog (I also love the theme/design), I don’t have time to read it all at the minute but I have bookmarked it and also added your RSS feeds, so when I have time
I will be back to read a great deal more, Please do keep up the fantastic work.
casino utan omsättningskrav
7 Oct 25 at 4:07 am