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=https://mostbet12033.ru/]https://mostbet12033.ru/[/url]
mostbet_kg_dwpa
1 Nov 25 at 3:18 pm
Eski ama asla eskimeyen 90’lar modas?n?n guzellik s?rlar?yla dolu bu yaz?da bulusal?m.
Кстати, если вас интересует Evinizde Estetik ve Fonksiyonu Birlestirin: Ipuclar? ve Trendler, посмотрите сюда.
Смотрите сами:
[url=https://anadolustil.com]https://anadolustil.com[/url]
Guzellik, gecmisle gunumuz aras?nda bir kopru kurmakt?r. 90’lar?n moda s?rlar?, bu koprunun onemli parcalar?ndan.
Josephassof
1 Nov 25 at 3:18 pm
купить диплом в гатчине [url=https://rudik-diplom13.ru/]https://rudik-diplom13.ru/[/url] .
Diplomi_gion
1 Nov 25 at 3:19 pm
Zivoederevo.ru — краснодарская компания, строящая дома и бани из бруса и бревна «под ключ» с гарантией и по СНиП. Прямая закупка материалов, поэтапная оплата, фиксированная цена в договоре и опыт бригад более 10 лет — это прозрачность и результат в срок. На сайте — проекты, ответы на частые вопросы и фото реализованных объектов. Выберите материал и планировку на https://zivoederevo.ru/ — получите расчет, консультацию и проект в подарок при заказе; строят круглый год по всему Краснодарскому краю.
xezojasusark
1 Nov 25 at 3:20 pm
купить диплом техникума многих [url=frei-diplom12.ru]купить диплом техникума многих[/url] .
Diplomi_xxPt
1 Nov 25 at 3:21 pm
купить диплом в северске [url=https://rudik-diplom12.ru/]https://rudik-diplom12.ru/[/url] .
Diplomi_slPi
1 Nov 25 at 3:21 pm
This paragraph will assist the internet users for creating new webpage or even a weblog from start to end.
bk8
1 Nov 25 at 3:22 pm
Hey! This is kind of off topic but I need some advice from
an established blog. Is it very hard to set up your own blog?
I’m not very techincal but I can figure things out pretty fast.
I’m thinking about creating my own but I’m not sure where to start.
Do you have any tips or suggestions? Cheers
Finxor GPT Review
1 Nov 25 at 3:23 pm
This website was… how do you say it? Relevant!!
Finally I have found something which helped me. Thanks a lot!
buôn bán nội tạng
1 Nov 25 at 3:24 pm
Get daily crypto updates, BTC and ETH forecasts, altcoin trends, and memecoin buzz.
Clear analysis, price signals, and the latest news — all in one
place.
Cryptona.co
1 Nov 25 at 3:24 pm
купить диплом с реестром в москве [url=https://frei-diplom3.ru/]купить диплом с реестром в москве[/url] .
Diplomi_taKt
1 Nov 25 at 3:25 pm
купить диплом техникума казахстана [url=www.frei-diplom12.ru]купить диплом техникума казахстана[/url] .
Diplomi_efPt
1 Nov 25 at 3:26 pm
Safe Meds Guide: SafeMedsGuide – top rated online pharmacies
HaroldSHems
1 Nov 25 at 3:27 pm
compare online pharmacy prices: Safe Meds Guide – Safe Meds Guide
Johnnyfuede
1 Nov 25 at 3:28 pm
TG @‌LINKS_DEALER | EFFECTIVE SEO LINKS FOR SPINBETTER.LINK
Williamturdy
1 Nov 25 at 3:28 pm
discount pharmacies in Ireland [url=https://irishpharmafinder.com/#]online pharmacy ireland[/url] buy medicine online legally Ireland
Hermanengam
1 Nov 25 at 3:28 pm
Клиника «ЧСП№1» в Ростове-на-Дону предлагает услуги по выводу из запоя. Вы можете выбрать удобный для вас вариант: выезд нарколога на дом или лечение в стационаре. Все процедуры проводятся анонимно и с соблюдением конфиденциальности.
Выяснить больше – [url=https://vyvod-iz-zapoya-rostov11.ru/]вывод из запоя на дому цена[/url]
RobertTut
1 Nov 25 at 3:29 pm
В Ростове-на-Дону мы используем только сертифицированные препараты и современные методики, что обеспечивает высокую эффективность лечения.
Получить больше информации – [url=https://vyvod-iz-zapoya-rostov111.ru/]вывод из запоя вызов в ростове-на-дону[/url]
AltonPoula
1 Nov 25 at 3:31 pm
купить диплом техникума с реестром [url=https://www.frei-diplom3.ru]купить диплом техникума с реестром[/url] .
Diplomi_pvKt
1 Nov 25 at 3:31 pm
https://aussiemedshubau.com/# pharmacy discount codes AU
Haroldovaph
1 Nov 25 at 3:32 pm
online pharmacy
Edmundexpon
1 Nov 25 at 3:32 pm
learnsomethingeveryday – The posts are concise yet meaningful—very good for a quick knowledge boost.
Romeo Narkier
1 Nov 25 at 3:32 pm
Наши услуги в Ростове-на-Дону включают не только физическую детоксикацию, но и психологическую поддержку для более эффективного восстановления.
Ознакомиться с деталями – [url=https://vyvod-iz-zapoya-rostov236.ru/]вывод из запоя на дому недорого в ростове-на-дону[/url]
Ricardoben
1 Nov 25 at 3:33 pm
Touche. Great arguments. Keep up the great spirit.
چگونه فالور و فالوینگ را مخفی کنیم در اینستا
1 Nov 25 at 3:33 pm
Hi, everything is going nicely here and ofcourse every one
is sharing data, that’s actually fine, keep up writing.
omgprice4 cc
1 Nov 25 at 3:33 pm
What we’re covering
• Zelensky in Washington: European leaders will join Ukrainian President Volodymyr Zelensky at the White House, as he meets with US President Donald Trump this afternoon. Trump said Zelensky must agree to some of Russia’s conditions — including that Ukraine cede Crimea and agree never to join NATO — for the war to end.
[url=https://kra39at.com]kra36 СЃСЃ[/url]
• Potential security guarantees: At last week’s summit with Trump, Russian President Vladimir Putin agreed to allow security guarantees for Ukraine and made concessions on “land swaps” as part of a potential peace deal, US envoy Steve Witkoff told CNN. Zelensky suggested that such guarantees would need to be stronger than those that “didn’t work” in the past. Russia has yet to mention such agreements.
[url=https://kra-33cc.com]kra37 cc[/url]
• On the ground: Zelensky condemned Russia’s latest strikes across Ukraine, which killed at least 10 people, saying the Kremlin intends to “humiliate diplomatic efforts” and underscores “why reliable security guarantees are required.”
kra38 cc
https://kpa35.cc
JorgeKesia
1 Nov 25 at 3:34 pm
online pharmacy reviews and ratings: SafeMedsGuide – trusted online pharmacy USA
HaroldSHems
1 Nov 25 at 3:36 pm
lozol
prednisone
1 Nov 25 at 3:36 pm
It’s actually a nice and useful piece of information. I’m happy
that you shared this useful information with us. Please keep us informed like this.
Thank you for sharing.
homepage
1 Nov 25 at 3:38 pm
Wonderful post however , I was wanting to know
if you could write a litte more on this topic? I’d be very grateful if
you could elaborate a little bit further. Bless you!
My homepage: zinnat02
zinnat02
1 Nov 25 at 3:39 pm
купить диплом без внесения в реестр [url=https://frei-diplom3.ru]купить диплом без внесения в реестр[/url] .
Diplomi_adKt
1 Nov 25 at 3:39 pm
купить диплом колледжа пермь [url=https://www.frei-diplom10.ru]https://www.frei-diplom10.ru[/url] .
Diplomi_psEa
1 Nov 25 at 3:41 pm
Hello, i think that i saw you visited my blog thus i came to
“return the favor”.I am trying to find things to enhance my website!I
suppose its ok to use a few of your ideas!!
Panduan White SEO
1 Nov 25 at 3:42 pm
регистрация на мостбет [url=http://mostbet12034.ru/]http://mostbet12034.ru/[/url]
mostbet_kg_fqPr
1 Nov 25 at 3:44 pm
I do not even know how I finished up right here, however I believed this submit was
great. I do not recognise who you might be however definitely you’re going to a well-known blogger if you aren’t already.
Cheers!
it
1 Nov 25 at 3:44 pm
В Ростове-на-Дону клиника «Частный Медик 24» предлагает профессиональный вывод из запоя с современными методами детоксикации и инфузионной терапии.
Узнать больше – [url=https://vyvod-iz-zapoya-rostov112.ru/]срочный вывод из запоя в ростове-на-дону[/url]
Jamesver
1 Nov 25 at 3:46 pm
Nice post. I was checking continuously this blog and I’m impressed!
Extremely helpful info specially the last part 🙂 I care for such information much.
I was looking for this particular information for a long time.
Thank you and best of luck.
Live draw sdy lotto
1 Nov 25 at 3:46 pm
купить диплом медсестры [url=https://frei-diplom14.ru/]купить диплом медсестры[/url] .
Diplomi_uioi
1 Nov 25 at 3:46 pm
Scientists discovered something alarming seeping out from beneath the ocean around Antarctica
[url=https://otzyvov.net/otzyv-company/7684-zhk-bestwaycoop.html]смотреть порно жесток[/url]
Planet-heating methane is escaping from cracks in the Antarctic seabed as the region warms, with new seeps being discovered at an “astonishing rate,” scientists have found, raising fears that future global warming predictions may have been underestimated.
Huge amounts of methane lie in reservoirs that have formed over millennia beneath the seafloor around the world. This invisible, climate-polluting gas can escape into the water through fissures in the sea floor, often revealing itself with a stream of bubbles weaving their way up to the ocean surface.
https://neolurk.org/wiki/%D0%A0%D0%BE%D0%BC%D0%B0%D0%BD_%D0%92%D0%B0%D1%81%D0%B8%D0%BB%D0%B5%D0%BD%D0%BA%D0%BE
первый анальный секс
Relatively little is known about these underwater seeps, how they work, how many there are, and how much methane reaches the atmosphere versus how much is eaten by methane-munching microbes living beneath the ocean.
But scientists are keen to better understand them, as this super-polluting gas traps around 80 times more heat than carbon dioxide in its first 20 years in the atmosphere.
Methane seeps in Antarctica are among the least understood on the planet, so a team of international scientists set out to find them. They used a combination of ship-based acoustic surveys, remotely operated vehicles and divers to sample a range of sites in the Ross Sea, a bay in Antarctica’s Southern Ocean, at depths between 16 and 790 feet.
What they found surprised them. They identified more than 40 methane seeps in the shallow water of the Ross Sea, according to the study published this month in Nature Communications.
Bubbles rising from a methane seep at Cape Evans, Antarctica. Leigh Tate, Earth Sciences New Zealand
Many of the seeps were found at sites that had been repeatedly studied before, suggesting they were new. This may indicate a “fundamental shift” in the methane released in the region, according to the report.
Methane seeps are relatively common globally, but previously there was only one confirmed active seep in the Antarctic, said Sarah Seabrook, a report author and a marine scientist at Earth Sciences New Zealand, a research organization. “Something that was thought to be rare is now seemingly becoming widespread,” she told CNN.
Every seep they discovered was accompanied by an “immediate excitement” that was “quickly replaced with anxiety and concern,” Seabrook said.
The fear is these seeps could rapidly transfer methane into the atmosphere, making them a source of planet-heating pollution that is not currently factored into future climate change predictions.
The scientists are also concerned the methane could have cascading impacts on marine life.
DonaldCix
1 Nov 25 at 3:47 pm
купить свидетельство о разводе [url=http://rudik-diplom12.ru]купить свидетельство о разводе[/url] .
Diplomi_jdPi
1 Nov 25 at 3:48 pm
My spouse and I absolutely love your blog and find a lot
of your post’s to be exactly I’m looking for. can you offer guest writers to
write content to suit your needs? I wouldn’t mind writing a post or elaborating on a number of the subjects you
write about here. Again, awesome blog!
crypto
1 Nov 25 at 3:48 pm
Thanks for the good writeup. It if truth be told
was a enjoyment account it. Look complex to more added
agreeable from you! By the way, how can we keep up a correspondence?
kra44 сс
1 Nov 25 at 3:51 pm
скачать mostbet [url=https://mostbet12033.ru/]скачать mostbet[/url]
mostbet_kg_afpa
1 Nov 25 at 3:52 pm
What we’re covering
• Zelensky in Washington: European leaders will join Ukrainian President Volodymyr Zelensky at the White House, as he meets with US President Donald Trump this afternoon. Trump said Zelensky must agree to some of Russia’s conditions — including that Ukraine cede Crimea and agree never to join NATO — for the war to end.
[url=https://kra-34-at.com]kra35 СЃСЃ[/url]
• Potential security guarantees: At last week’s summit with Trump, Russian President Vladimir Putin agreed to allow security guarantees for Ukraine and made concessions on “land swaps” as part of a potential peace deal, US envoy Steve Witkoff told CNN. Zelensky suggested that such guarantees would need to be stronger than those that “didn’t work” in the past. Russia has yet to mention such agreements.
[url=https://kra31cc.cc]kra39 СЃСЃ[/url]
• On the ground: Zelensky condemned Russia’s latest strikes across Ukraine, which killed at least 10 people, saying the Kremlin intends to “humiliate diplomatic efforts” and underscores “why reliable security guarantees are required.”
kra36 at
https://kra37.net
Jasonsodia
1 Nov 25 at 3:52 pm
Logging into Pin Up Casino is just the first step to the adventure https://mbou40.ru
Robinkanty
1 Nov 25 at 3:52 pm
What we’re covering
• Zelensky in Washington: European leaders will join Ukrainian President Volodymyr Zelensky at the White House, as he meets with US President Donald Trump this afternoon. Trump said Zelensky must agree to some of Russia’s conditions — including that Ukraine cede Crimea and agree never to join NATO — for the war to end.
[url=https://kra-38-at.cc]kra40 at[/url]
• Potential security guarantees: At last week’s summit with Trump, Russian President Vladimir Putin agreed to allow security guarantees for Ukraine and made concessions on “land swaps” as part of a potential peace deal, US envoy Steve Witkoff told CNN. Zelensky suggested that such guarantees would need to be stronger than those that “didn’t work” in the past. Russia has yet to mention such agreements.
[url=https://kra35-at.cc]kra38[/url]
• On the ground: Zelensky condemned Russia’s latest strikes across Ukraine, which killed at least 10 people, saying the Kremlin intends to “humiliate diplomatic efforts” and underscores “why reliable security guarantees are required.”
kra34 at
https://kra31cc.cc
RichardJek
1 Nov 25 at 3:55 pm
What we’re covering
• Zelensky in Washington: European leaders will join Ukrainian President Volodymyr Zelensky at the White House, as he meets with US President Donald Trump this afternoon. Trump said Zelensky must agree to some of Russia’s conditions — including that Ukraine cede Crimea and agree never to join NATO — for the war to end.
[url=https://at-kra35.cc]kra36 СЃСЃ[/url]
• Potential security guarantees: At last week’s summit with Trump, Russian President Vladimir Putin agreed to allow security guarantees for Ukraine and made concessions on “land swaps” as part of a potential peace deal, US envoy Steve Witkoff told CNN. Zelensky suggested that such guarantees would need to be stronger than those that “didn’t work” in the past. Russia has yet to mention such agreements.
[url=https://kra33-at.cc]kra39 cc[/url]
• On the ground: Zelensky condemned Russia’s latest strikes across Ukraine, which killed at least 10 people, saying the Kremlin intends to “humiliate diplomatic efforts” and underscores “why reliable security guarantees are required.”
kra31 СЃСЃ
https://kraken33-at.com
Stephengoots
1 Nov 25 at 3:55 pm
sjqyhl.com – Color palette felt calming, nothing distracting, just focused, thoughtful design.
Ellan Detter
1 Nov 25 at 3:56 pm
Hmm it seems like your blog ate my first comment (it
was super long) so I guess I’ll just sum it up what I submitted and say, I’m thoroughly enjoying your blog.
I as well am an aspiring blog blogger but I’m
still new to everything. Do you have any recommendations for
inexperienced blog writers? I’d genuinely appreciate it.
surfing lessons with English-speaking instructors Bali
1 Nov 25 at 3:56 pm
http://bbs.abcdv.net/home.php?mod=space&uid=824706
JeremyRot
1 Nov 25 at 3:56 pm