makary/phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-28 06:08:52 +00:00
Code Issues Projects Releases Packages Wiki Activity

[ticket/12060] Further clarifying new event docblocks as much as possible

Browse source 
PHPBB3-12060
This commit is contained in:
Matt Friedman 2013-12-16 23:54:55 -08:00
parent 01c4235f00
commit 4665e3df21
3 changed files with 17 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
phpBB/docs/events.md
View file

@ -14,7 +14,7 @@ acp_bbcodes_edit_fieldsets_after
===
* Location: adm/style/acp_bbcodes.html
* Since: 3.1.0-a3
* Purpose: Add settings to edit BBCodes form
* Purpose: Add settings to BBCode add/edit form
acp_forums_normal_settings_append
===

16
phpBB/includes/acp/acp_bbcodes.php
View file

@ -111,12 +111,13 @@ class acp_bbcodes
$bbcode_tokens = array('TEXT', 'SIMPLETEXT', 'INTTEXT', 'IDENTIFIER', 'NUMBER', 'EMAIL', 'URL', 'LOCAL_URL', 'RELATIVE_URL', 'COLOR');
/**
* Event to modify custom bbcode template before displaying the add/edit form
* Modify custom bbcode template data before we display the add/edit form
*
* @event core.acp_bbcodes_edit_add
* @var string action Type of the action: add|edit
* @var array tpl_ary Array with bbcodes add/edit data
* @var int bbcode_id The id of the bbcode (being edited)
* @var array tpl_ary Array with custom bbcode add/edit data
* @var int bbcode_id When editing: the bbcode id,
* when creating: 0
* @var array bbcode_tokens Array of bbcode tokens
* @since 3.1.0-a3
*/
@ -143,12 +144,13 @@ class acp_bbcodes
$sql_ary = $hidden_fields = array();
/**
* Event to modify custom bbcode data before modify/create
* Modify custom bbcode data before the modify/create action
*
* @event core.acp_bbcodes_modify_create
* @var string action Type of the action: modify|create
* @var array sql_ary Array with new bbcode data
* @var int bbcode_id The id of the bbcode (being modified)
* @var int bbcode_id When editing: the bbcode id,
* when creating: 0
* @var bool display_on_posting Display bbcode on posting form
* @var string bbcode_match The bbcode usage string to match
* @var string bbcode_tpl The bbcode HTML replacement string
@ -349,7 +351,7 @@ class acp_bbcodes
);
/**
* Event to modify custom bbcode template data before displaying the form
* Modify custom bbcode template data before we display the form
*
* @event core.acp_bbcodes_display_form
* @var string action Type of the action: modify|create
@ -374,7 +376,7 @@ class acp_bbcodes
);
/**
* Event to modify display of custom bbcodes in the form
* Modify display of custom bbcodes in the form
*
* @event core.acp_bbcodes_display_bbcodes
* @var array row Array with current bbcode data

13
phpBB/includes/message_parser.php
View file

@ -1252,12 +1252,13 @@ class parse_message extends bbcode_firstpass
* Use this event to modify the text after it is parsed
*
* @event core.modify_format_display_text_after
* @var string text The text to parse
* @var string uid The BBCode UID
* @var bool allow_bbcode Allow BBCodes switch
* @var bool allow_magic_url Allow magic urls switch
* @var bool allow_smilies Allow smilies switch
* @var bool update_this_message Update message switch
* @var string text The message text to parse
* @var string uid The bbcode uid
* @var bool allow_bbcode Do we allow bbcodes
* @var bool allow_magic_url Do we allow magic urls
* @var bool allow_smilies Do we allow smilies
* @var bool update_this_message Do we update the internal message
* with the parsed result
* @since 3.1.0-a3
*/
$vars = array('text', 'uid', 'allow_bbcode', 'allow_magic_url', 'allow_smilies', 'update_this_message');