[RFC|Merged] General Hook Architecture of phpBB3.1

These requests for comments/change have lead to an implemented feature that has been successfully merged into the 3.1/Ascraeus branch. Everything listed in this forum will be available in phpBB 3.1.
Post Reply
User avatar
MichaelC
Development Team
Development Team
Posts: 889
Joined: Thu Jan 28, 2010 6:29 pm

Re: [RFC|Accepted] General Hook Architecture of phpBB3.1

Post by MichaelC » Sat Mar 17, 2012 1:56 am

Formerly known as Unknown Bliss
psoTFX wrote: I went with Olympus because as I said to the teams ... "It's been one hell of a hill to climb"
No unsolicited PMs please except for quotes.

Oleg
Posts: 1150
Joined: Tue Feb 23, 2010 2:38 am
Contact:

Re: [RFC|Accepted] General Hook Architecture of phpBB3.1

Post by Oleg » Sun Mar 18, 2012 7:23 am

I redid template events over the new dispatcher pr.

Currently https://github.com/p/phpbb3-ext-php-hoo ... 452d14fb00 is required for listeners to work.

I am interested in ideas for how to restore our previous API for the listeners.

(03:11:49) rxu: nn- : we could use class_alias() probably to keep names in phpBB namespace
(03:12:13) nn-: it's not just class name though, there is also the function name that must match symfony's
(03:12:36) nn-: good point on class_alias still
(03:12:41) nn-: haven't thought of that
(03:16:03) rxu: for aliasing function we'd need to create a simple wrapper, I'm not sure that's viable thing though
(03:16:20) rxu: ok, that's useless
(03:16:28) nn-: why not? is it going to work?
(03:17:00) rxu: getSubscribedEvents() has to be implemented in child class I guess
(03:17:07) rxu: with exact name
(03:18:02) rxu: so we'd need to implement getSubscribedEvents() and wrapper at the same time
(03:18:08) rxu: that would work
(03:19:13) nn-: so an abstract class then?
(03:19:24) nn-: which extensions would extend instead of implementing symfony's interface?
(03:24:18) rxu: probably yes, to operate with phpBB namespace instaed of Symphony's one
(03:26:39) rxu: and if it won't make the code senselessly overcomplicated

Oleg
Posts: 1150
Joined: Tue Feb 23, 2010 2:38 am
Contact:

Re: [RFC|Accepted] General Hook Architecture of phpBB3.1

Post by Oleg » Sun Mar 18, 2012 9:39 pm

My todo list here:

1. Rename RUNHOOKS to EVENT
2. Rename everything else from hooks/ledges to listeners/events
3. Add an acp template event
4. Investigate reinstating our underscored api on top of camelcased event dispatcher
5. Investigate renaming of event/*_subscriber to listener/*_subscriber or something along those lines.

Oleg
Posts: 1150
Joined: Tue Feb 23, 2010 2:38 am
Contact:

Re: [RFC|Accepted] General Hook Architecture of phpBB3.1

Post by Oleg » Mon Mar 19, 2012 2:04 pm

Deciding on a new and improved api for events:

$vars = array('page_title');
$event = 'core.index';
extract($phpbb_dispatcher->dispatch($event, compact($vars), $vars));

User avatar
igorw
Registered User
Posts: 500
Joined: Thu Jan 04, 2007 11:47 pm

Re: [RFC|Accepted] General Hook Architecture of phpBB3.1

Post by igorw » Mon Mar 19, 2012 2:34 pm

What I don't like about this is that it is no longer using the standard EventDispatcher API provided by Symfony.

User avatar
rxu
Registered User
Posts: 126
Joined: Tue Apr 04, 2006 4:28 pm
Contact:

Re: [RFC|Accepted] General Hook Architecture of phpBB3.1

Post by rxu » Mon Mar 19, 2012 2:39 pm

Just for the record, a common idea for extracting previously compacted variables into globals: https://gist.github.com/2113808
Image

User avatar
naderman
Consultant
Posts: 1727
Joined: Sun Jan 11, 2004 2:11 am
Location: Karlsruhe, Germany
Contact:

Re: [RFC|Accepted] General Hook Architecture of phpBB3.1

Post by naderman » Mon Mar 19, 2012 3:05 pm

igorw wrote:What I don't like about this is that it is no longer using the standard EventDispatcher API provided by Symfony.
Not sure what the problem with that is? Nothing wrong with wrapping the dispatcher or creating a specialisation (kind of what inheritance is for :)) for phpBB? If we're going to put these all over the place, it would certainly be nice if it was concise.

User avatar
naderman
Consultant
Posts: 1727
Joined: Sun Jan 11, 2004 2:11 am
Location: Karlsruhe, Germany
Contact:

Re: [RFC|Accepted] General Hook Architecture of phpBB3.1

Post by naderman » Mon Mar 19, 2012 3:06 pm

rxu wrote:Just for the record, a common idea for extracting previously compacted variables into globals: https://gist.github.com/2113808
We do not want to extract them into globals. We want to extract them into local variables in the scope of the function which triggers the event.

User avatar
rxu
Registered User
Posts: 126
Joined: Tue Apr 04, 2006 4:28 pm
Contact:

Re: [RFC|Accepted] General Hook Architecture of phpBB3.1

Post by rxu » Mon Mar 19, 2012 3:13 pm

Well, the function should do exactly this thing.
Image

User avatar
naderman
Consultant
Posts: 1727
Joined: Sun Jan 11, 2004 2:11 am
Location: Karlsruhe, Germany
Contact:

Re: [RFC|Accepted] General Hook Architecture of phpBB3.1

Post by naderman » Mon Mar 19, 2012 3:17 pm

Oleg wrote:Deciding on a new and improved api for events:

$vars = array('page_title');
$event = 'core.index';
extract($phpbb_dispatcher->dispatch($event, compact($vars), $vars));
Is the reason 'core.index' is stored in a variable, solely so the word event is mentioned? My proposal:

Code: Select all

$vars = array('page_title');
extract($phpbb_dispatcher->trigger_event('core.index', compact($vars), $vars));
This also keeps "dispatch" working the same as in Symfony, but we use trigger_event in phpBB which has the phpBB event semantics?

Post Reply