Ledges Forum

Discuss general development subjects that are not specific to a particular version like the versioning control system we use or other infrastructure.
User avatar
MichaelC
Development Team
Development Team
Posts: 889
Joined: Thu Jan 28, 2010 6:29 pm

Ledges Forum

Post by MichaelC »

Would it be possible to archive the current hooks locations forum and make a new ledges request forum?

I would suggest this because of the rename
The way hooks are set up is different from way when those hook location requests were made
Topic Prefixes of [CORE] or [TEMPLATE] for all ledge requests.

Suggested template:

Code: Select all

Ledge Name:
Ledge Location (include file and rough line location):
Ledge Arguments:
Reason:
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.

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

Re: Ledges Forum

Post by igorw »

If we really want to call them ledges, please just rename the forum.

User avatar
MichaelC
Development Team
Development Team
Posts: 889
Joined: Thu Jan 28, 2010 6:29 pm

[Info] How to request an event

Post by MichaelC »

Events are hook locations/ledges. For more information about them and how to add them please take a look at the wiki events and listeners category.

Please note all explanations in this post should include:
  • At least 1 use-case
  • Preferably an extension/MOD that exists that might make use of it (optional)
  • What it could be used for
  • Why should it have those parameters and that location
How to request a template event:
Post a topic with the title [Template] Identifier

Then it should include the following information:

Code: Select all

Identifier:
Prosilver Location (if applicable):
Subsilver Location (if applicable):
Explanation:
The identifier should be formatted as prosilver location file followed by a descriptor. For e.g.
overall_footer_copyright
If it is only in subsilver then the subsilver location should be used (as hooks don't have to be in both styles)

How to request an acp template event:
Post a topic with the title [ACP Template] Identifier

Then it should include the following information:

Code: Select all

Identifier:
Location:
Explanation:
How to request a core event:
Post a topic with the title [Core] Identifier

Then it should include the following information:

Code: Select all

Identifer:
Location:
Parameters:
Explanation:
The identifier should be formatted as a general descriptor. All core events are prefixed by core. For e.g.
core.viewtopic_postrow for postrow in viewtopic.php

Review Process:
After being posted it will be reviewed to check it would work ok and then someone will either implement it for you or you can submit a patch for it.

The patch will then be reviewed by somone who cannot be the original suggester or implementer. It will then be merged by a developer.

Adding events:
For now if you choose to add any events yourself then you must base it on https://github.com/p/phpbb3/tree/feature/ledges-2
Then send a PR to oleg (p) and it will be reviewed by myself or nickvergessen and then it will be merged.

If not then the ledge will be added by myself or nickvergessen at some point.

After it has been merged to the core then this post will be updated.
Thats the new information topic.

Once thats posted up all current ledge requests need to be checked to see if they are useless or not.
Last edited by MichaelC on Sun Mar 18, 2012 12:25 am, edited 5 times in total.
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.

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

Re: Ledges Forum

Post by naderman »

igorw wrote:If we really want to call them ledges, please just rename the forum.
Well I still haven't seen any reasonable alternative that doesn't mix up terminology of source and destination of events/hooks so I'll just rename it for now.

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

Re: Ledges Forum

Post by igorw »

IMO events/listeners still makes most sense, but I rest my case.

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

Re: Ledges Forum

Post by naderman »

I think we had concerns about that terminology previously because we always meant to implement some event system that users can set up events with in the ACP. But seeing how that certainly hasn't happened yet, I'm fine with using event/listener. It's the common terminology in other software, so probably preferable. What does everyone else think?

User avatar
MichaelC
Development Team
Development Team
Posts: 889
Joined: Thu Jan 28, 2010 6:29 pm

Re: Ledges Forum

Post by MichaelC »

I personally prefer ledge and I don't see any substantial reason to change all the terminology again?
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.

User avatar
brunoais
Registered User
Posts: 964
Joined: Fri Dec 18, 2009 3:55 pm

Re: Ledges Forum

Post by brunoais »

I still prefer the event/listener like it is called in javascript

User avatar
callumacrae
Former Team Member
Posts: 1046
Joined: Tue Apr 27, 2010 9:37 am
Location: England
Contact:

Re: Ledges Forum

Post by callumacrae »

brunoais wrote:I still prefer the event/listener like it is called in javascript
+1
Made by developers, for developers!
My blog

User avatar
nickvergessen
Former Team Member
Posts: 733
Joined: Sun Oct 07, 2007 11:54 am
Location: Stuttgart, Germany
Contact:

Re: Ledges Forum

Post by nickvergessen »

Listener seems okay to me, but event is very misleading when you deal with "not-programmer"-guys.
Member of the Development-TeamNo Support via PM

Post Reply