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!
Профессиональная дезинфекция офисов обязательна.
уничтожение блох
KennethceM
2 Nov 25 at 9:43 pm
я звонил седня.сказали либо номер не правлеьный..либо не отправили еще https://aquauslugi.ru/serpuhov.html действительно принимают?
WayneLar
2 Nov 25 at 9:45 pm
1xbet giri? 2025 [url=1xbet-giris-5.com]1xbet giri? 2025[/url] .
1xbet giris_mrSa
2 Nov 25 at 9:48 pm
Hello there, I do think your web site could be having web browser compatibility issues.
Whenever I take a look at your web site in Safari, it looks fine but when opening in I.E., it’s got some overlapping
issues. I just wanted to give you a quick heads up!
Other than that, fantastic site!
Cerita-Cerita Dewasa
2 Nov 25 at 9:49 pm
บทความนี้เกี่ยวกับการจัดดอกไม้งานศพ
มีสาระมาก
โดยส่วนตัวเพิ่งจัดงานศพให้ผู้ใหญ่ในบ้าน การเลือกดอกไม้งานศพเลยเป็นเรื่องที่ต้องใส่ใจ
ใครที่กำลังเตรียมตัวจัดงานศพให้คนสำคัญควรอ่านจริงๆ
Also visit my blog post – ดอกไม้งานขาวดำ
ดอกไม้งานขาวดำ
2 Nov 25 at 9:50 pm
купить диплом в златоусте [url=https://www.rudik-diplom13.ru]купить диплом в златоусте[/url] .
Diplomi_ppon
2 Nov 25 at 9:51 pm
1xbet yeni giri? [url=http://www.1xbet-giris-2.com]http://www.1xbet-giris-2.com[/url] .
1xbet giris_jbPt
2 Nov 25 at 9:51 pm
купить диплом о высшем образовании проведенный [url=http://www.frei-diplom3.ru]купить диплом о высшем образовании проведенный[/url] .
Diplomi_ygKt
2 Nov 25 at 9:54 pm
Курсы гитары с индивидуальным подходом — каждый урок подстроен под ваш темп и стиль. https://shkola-vocala.ru/shkola-igry-na-gitare.php
https://shkola-vocala.ru/shkola-igry-na-gitare.php
2 Nov 25 at 9:54 pm
Parents, kiasu mode on lah, robust primaryy maths гesults t᧐
ƅetter STEM grasp аs weⅼl as construction goals.
Wow, math іs tһe foundation pillar of primary learning, aiding kids
for dimensional thinking for building paths.
Catholic Junior College supplies а values-centered education rooted іn empathy and fɑct, developing a welcoming community ԝhere students
thrive academicallly ɑnd spiritually. Ꮤith a focus оn holistic growth, thе college offers
robust programs in liberal arts ɑnd sciences, directed Ьy caring mentors whⲟ motivate ⅼong-lasting knowing.
Іts vibrant co-curricular scene, including sports аnd arts,
promotes teamwork ɑnd self-discovery іn a supportive atmosphere.
Opportunities fоr neighborhood service and worldwide exchanges build empathy ɑnd worldwide
perspectives ɑmongst students. Alumni typically ƅecome understanding
leaders, equipped tо mаke meaningful contributions tο society.
Anglo-Chinese School (Independent) Junior College delivers
аn enhancing education deeply rooted in faith, ԝhere intellectual expedition іs harmoniously balanced
ԝith core ethical concepts, guiding students tоward еnding
up being compassionate ɑnd гesponsible international
people equipped t᧐ deal witһ intricate societal obstacles.
The school’s prestigious International Baccalaureate
Diploma Programme promotes innovative vital thinking, ｒesearch skills, аnd interdisciplinary learning,
strengthened Ƅy exceptional resources like devoted
development hubs аnd expert professors who coach students iin attaining
scholastic difference. Α broad spectrum ߋf co-curricular offerings, fｒom innovative robotics ϲlubs that motivate technological imagination tօ symphony orchestras that hone musical talents, ɑllows trainees tⲟ find and fine-tune thеir special capabilities іn a
encouraging аnd revitalizing environment.
Βy integrating service learning initiatives, suⅽh ɑs community outreach jobs аnd volunteer
programs ƅoth іn your arｅa and globally, tһe college cultivates a strong
sense of social obligation, compassion, аnd active citizenship ɑmongst itѕ student body.
Graduates ߋf Anglo-Chinese School (Independent) Junior College ɑre incredibly
wｅll-prepared fօr entry into elite universities аrοund
thе world, carrying with them a recognized legacy of academic excellence, individual
stability, ɑnd a commitment to lߋng-lasting knowing
and contribution.
Wow, mathematics iss tһe groundwork block οf primary education, helping
children іn geometric reasoning for design paths.
Mums ɑnd Dads, competitive style оn lah,solid primary math guides fⲟr superior scientific grasp and
engineering dreams.
Oh dear, mіnus solid mathematics ɗuring Junior College, no matter leading
school kids ｃould stumble ᴡith high school equations,
theгefore develop it immedіately leh.
Strong A-level Math scores impress ⅾuring NS interviews toⲟ.
Parents, fear the difference hor, math base proves essential ԁuring
Junior College tto comprehending figures, vital fοr modern online market.
Goodness, no matter іf establishment rｅmains atas, math іs
the make-or-break discipline tⲟ developing poise in figures.
Ⅿy blog post … sec school singapore
sec school singapore
2 Nov 25 at 9:55 pm
купить диплом в анжеро-судженске [url=rudik-diplom1.ru]rudik-diplom1.ru[/url] .
Diplomi_sier
2 Nov 25 at 9:56 pm
1xbet lite [url=www.1xbet-giris-2.com]www.1xbet-giris-2.com[/url] .
1xbet giris_dtPt
2 Nov 25 at 9:57 pm
рейтинг компаний по продвижению сайтов [url=www.luchshie-digital-agencstva.ru]рейтинг компаний по продвижению сайтов[/url] .
lychshie digital agentstva_qjoi
2 Nov 25 at 9:59 pm
купить диплом колледжа с занесением в реестр [url=www.frei-diplom3.ru/]купить диплом колледжа с занесением в реестр[/url] .
Diplomi_lwKt
2 Nov 25 at 10:00 pm
1x bet giri? [url=www.1xbet-giris-5.com]www.1xbet-giris-5.com[/url] .
1xbet giris_guSa
2 Nov 25 at 10:00 pm
маз стоимость Полуприцеп МАЗ: Универсальность в транспортировке грузов. Эффективное решение для вашего бизнеса, сочетающее в себе надежность и экономичность. Различные конфигурации, адаптированные под ваши потребности.
Richardaquat
2 Nov 25 at 10:02 pm
купить государственный диплом с занесением в реестр [url=www.frei-diplom3.ru]купить государственный диплом с занесением в реестр[/url] .
Diplomi_xvKt
2 Nov 25 at 10:04 pm
legitimate pharmacy sites UK: cheap medicines online UK – affordable medications UK
HaroldSHems
2 Nov 25 at 10:07 pm
купить диплом в самаре [url=https://rudik-diplom1.ru/]купить диплом в самаре[/url] .
Diplomi_pyer
2 Nov 25 at 10:08 pm
1xbet ?yelik [url=http://1xbet-giris-4.com/]http://1xbet-giris-4.com/[/url] .
1xbet giris_utSa
2 Nov 25 at 10:11 pm
1xbet yeni giri? [url=www.1xbet-giris-2.com/]www.1xbet-giris-2.com/[/url] .
1xbet giris_ecPt
2 Nov 25 at 10:11 pm
Наши преподаватели помогут освоить гитару в любом возрасте — главное, ваше желание играть! https://shkola-vocala.ru/shkola-igry-na-gitare.php
https://shkola-vocala.ru/shkola-igry-na-gitare.php
2 Nov 25 at 10:12 pm
1 x bet [url=https://1xbet-giris-4.com/]https://1xbet-giris-4.com/[/url] .
1xbet giris_vsSa
2 Nov 25 at 10:15 pm
code promo 1xbet burundi
AbrahamERAME
2 Nov 25 at 10:15 pm
1xbet turkiye [url=1xbet-giris-2.com]1xbet-giris-2.com[/url] .
1xbet giris_cvPt
2 Nov 25 at 10:17 pm
как купить диплом проведенный [url=http://frei-diplom3.ru]как купить диплом проведенный[/url] .
Diplomi_ueKt
2 Nov 25 at 10:18 pm
https://t.me/s/uD_KomEtA
AlbertTeery
2 Nov 25 at 10:22 pm
Отзывы о санэпидемстанция круглосуточно реальные? Делитесь.
уничтожение клопов в мебели
KennethceM
2 Nov 25 at 10:25 pm
купить диплом электромонтера [url=https://www.rudik-diplom1.ru]купить диплом электромонтера[/url] .
Diplomi_uzer
2 Nov 25 at 10:25 pm
xbet [url=http://1xbet-giris-4.com]xbet[/url] .
1xbet giris_lgSa
2 Nov 25 at 10:27 pm
Irish online pharmacy reviews
Edmundexpon
2 Nov 25 at 10:29 pm
https://www.cverla.ru/
Gregorykex
2 Nov 25 at 10:29 pm
Increíble artículo sobre los juegos más populares
de Pin-Up Casino en México. Increíble ver cómo Pragmatic Play y Play’n GO siguen liderando con sus slots más
reconocidas. Me gustó mucho cómo detallaron las mecánicas de
cada juego y sus bonificaciones.
Si te interesan los juegos de casino online o
las tragamonedas en México, definitivamente deberías leer este artículo completo.
La inclusión de juegos clásicos y modernos muestra la variedad del catálogo de Pin-Up Casino.
Puedes leer el artículo completo aquí y descubrir todos los
detalles sobre los juegos más jugados en Pin Up México.
press release
2 Nov 25 at 10:29 pm
РедМетСплав предлагает внушительный каталог высококачественных изделий из нестандартных материалов. Не важно, какие объемы вам необходимы – от мелких партий до крупных поставок, мы обеспечиваем оперативное исполнение вашего заказа.
Каждая единица изделия подтверждена соответствующими документами, подтверждающими их соответствие стандартам. Опытная поддержка – наша визитная карточка – мы на связи, чтобы ответить на ваши вопросы по мере того как предоставлять решения под специфику вашего бизнеса.
Доверьте потребности вашего бизнеса специалистам РедМетСплав и убедитесь в гибкости нашего предложения
Наша продукция:
Изделия из магния G-Z5Zr Поковка магниевая G-Z5Zr представляет собой современное решение для легких и прочных конструкций. Она идеально подходит для авиационной и автомобильной промышленности благодаря своим превосходным механическим свойствам и низкому весу. Магний в составе обеспечивает отличную коррозионную стойкость, а добавление циркония усиливает прочность. Чтобы улучшить производительность и долговечность своих изделий, купите Поковка магниевая G-Z5Zr. Этот материал оптимален для тех, кто ценит качество и надежность. Доступна в различных размерах для удовлетворения индивидуальных потребностей.
SheilaAlemn
2 Nov 25 at 10:31 pm
диплом высшего образования проведенный купить [url=https://frei-diplom3.ru/]диплом высшего образования проведенный купить[/url] .
Diplomi_gwKt
2 Nov 25 at 10:32 pm
https://t.me/s/ud_MRbIt
AlbertTeery
2 Nov 25 at 10:33 pm
купить диплом лаборанта [url=https://rudik-diplom1.ru/]купить диплом лаборанта[/url] .
Diplomi_fmer
2 Nov 25 at 10:33 pm
affordable medications UK [url=http://ukmedsguide.com/#]non-prescription medicines UK[/url] Uk Meds Guide
Hermanengam
2 Nov 25 at 10:35 pm
Покупка и продажа автомобиля – это всегда важный и ответственный шаг. Для многих это крупная финансовая операция, которая требует тщательного подхода и внимания к деталям. Подскажите где можно [url=https://империявыкупа.рф]где продать автомобиль[/url]
WayneGed
2 Nov 25 at 10:35 pm
1xbet guncel [url=https://1xbet-giris-4.com/]https://1xbet-giris-4.com/[/url] .
1xbet giris_deSa
2 Nov 25 at 10:35 pm
рейтинг агентств москвы [url=http://luchshie-digital-agencstva.ru]http://luchshie-digital-agencstva.ru[/url] .
lychshie digital agentstva_sdoi
2 Nov 25 at 10:35 pm
1 xbet giri? [url=https://1xbet-giris-2.com/]https://1xbet-giris-2.com/[/url] .
1xbet giris_csPt
2 Nov 25 at 10:35 pm
1xbet ?yelik [url=https://1xbet-giris-6.com/]https://1xbet-giris-6.com/[/url] .
1xbet giris_ahsl
2 Nov 25 at 10:35 pm
1xbet g?ncel adres [url=http://www.1xbet-giris-5.com]1xbet g?ncel adres[/url] .
1xbet giris_tgSa
2 Nov 25 at 10:36 pm
irishpharmafinder
Edmundexpon
2 Nov 25 at 10:36 pm
Visual һelp in OMT’s curriculum mаke abstract concepts concrete, fostering а deep gratitude
fօr math and motivation tօ overcome exams.
Enroll tοday in OMT’s standalone e-learning programs ɑnd vview yоur grades soar thгough unrestricted access tо top quality, syllabus-aligned material.
Ӏn Singapore’s rigorous education ѕystem, whеrе mathematics іs obligatory
and takeѕ in aгound 1600 hoսrs of curriculum timｅ іn primary annd secondary schools, math tuition bеｃomes neϲessary tⲟ assist trainees construct а strong structure fⲟr ⅼong-lasting success.
Enrolling іn primary school school math tuition еarly fosters sｅlf-confidence, lowering anxiety fօr PSLE takers
ᴡho deal ԝith hiցh-stakes questions on speed, range, and time.
Alternative development tһrough math tuition not only enhances О Level scores һowever аlso ɡrows ѕensible reasoning abilities valuable fоr lifelong understanding.
Ꮃith A Levels affеcting career paths in STEM fields, math tuition enhances foundational abilities
fօr future university гesearch studies.
Ꮤhɑt collections OMT ɑpɑrt іs its custom-madе curriculum that lines up wіth MOE wһile providing versatile pacing,
permitting advanced trainees t᧐ accelerate thеіr
knowing.
OMT’ѕ ѕystem tracks үour improvement with time ѕia, encouraging yοu to intend ցreater іn mathematics grades.
Individualized math tuition addresses specific weaknesses, transforming average performers іnto examination mattress toppers in Singapore’ѕ merit-based system.
mу webpage … math tuition primary school
math tuition primary school
2 Nov 25 at 10:37 pm
полуприцеп Полуприцеп: Разнообразие типов и объемов для любых грузов. Эффективное использование грузового пространства. Ваш выбор для оптимизации перевозок.
Richardaquat
2 Nov 25 at 10:37 pm
как легально купить диплом о [url=http://www.frei-diplom3.ru]как легально купить диплом о[/url] .
Diplomi_gvKt
2 Nov 25 at 10:38 pm
1xbet giri? adresi [url=https://1xbet-giris-5.com/]1xbet giri? adresi[/url] .
1xbet giris_qbSa
2 Nov 25 at 10:39 pm
one x bet [url=https://1xbet-giris-5.com/]1xbet-giris-5.com[/url] .
1xbet giris_wtSa
2 Nov 25 at 10:50 pm