makary/phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-07-25 19:38:53 +00:00
Code Issues Projects Releases Packages Wiki Activity

[ticket/13429] Replace @change with @changed

Browse source 
PHPBB3-13429
This commit is contained in:
Jakub Senko 2016-12-04 17:30:42 +01:00
parent 2f1d2e847e
commit 779758f219
No known key found for this signature in database
GPG key ID: 6A7C328CD66EC21E
21 changed files with 60 additions and 60 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
phpBB/download/file.php
View file

@ -262,7 +262,7 @@ else
* @var string mode Download mode
* @var bool thumbnail Flag indicating if the file is a thumbnail
* @since 3.1.6-RC1
* @change 3.1.7-RC1 Fixing wrong name of a variable (replacing "extension" by "extensions")
* @changed 3.1.7-RC1 Fixing wrong name of a variable (replacing "extension" by "extensions")
*/
$vars = array(
'attach_id',

6
phpBB/includes/functions.php
View file

@ -2636,7 +2636,7 @@ function add_form_key($form_name, $template_variable_suffix = '')
* @var string template_variable_suffix The string that is appended to template variable name
*
* @since 3.1.0-RC3
* @change 3.1.11-RC1 Added template_variable_suffix
* @changed 3.1.11-RC1 Added template_variable_suffix
*/
$vars = array(
'form_name',
@ -2928,7 +2928,7 @@ function login_box($redirect = '', $l_explain = '', $l_success = '', $admin = fa
* @var string redirect Redirect string
* @var bool admin Is admin?
* @since 3.1.0-RC5
* @change 3.1.9-RC1 Removed undefined return variable
* @changed 3.1.9-RC1 Removed undefined return variable
*/
$vars = array('redirect', 'admin');
extract($phpbb_dispatcher->trigger_event('core.login_box_redirect', compact($vars)));
@ -4310,7 +4310,7 @@ function obtain_users_online_string($online_users, $item_id = 0, $item = 'forum'
* session_forum_id
* @var array sql_ary SQL query array to obtain users online data
* @since 3.1.4-RC1
* @change 3.1.7-RC1 Change sql query into array and adjust var accordingly. Allows extension authors the ability to adjust the sql_ary.
* @changed 3.1.7-RC1 Change sql query into array and adjust var accordingly. Allows extension authors the ability to adjust the sql_ary.
*/
$vars = array('online_users', 'item_id', 'item', 'sql_ary');
extract($phpbb_dispatcher->trigger_event('core.obtain_users_online_string_sql', compact($vars)));

2
phpBB/includes/functions_admin.php
View file

@ -2611,7 +2611,7 @@ function prune($forum_id, $prune_mode, $prune_date, $prune_flags = 0, $auto_sync
* @var string sql_and SQL text appended to where clause
* @var int prune_limit The prune limit
* @since 3.1.3-RC1
* @change 3.1.10-RC1 Added prune_limit
* @changed 3.1.10-RC1 Added prune_limit
*/
$vars = array(
'forum_id',

2
phpBB/includes/functions_display.php
View file

@ -646,7 +646,7 @@ function display_forums($root_data = '', $display_moderators = true, $return_mod
* @var array row The data of the forum
* @var array subforums_row Template data of subforums
* @since 3.1.0-a1
* @change 3.1.0-b5 Added var subforums_row
* @changed 3.1.0-b5 Added var subforums_row
*/
$vars = array('forum_row', 'row', 'subforums_row');
extract($phpbb_dispatcher->trigger_event('core.display_forums_modify_template_vars', compact($vars)));

2
phpBB/includes/functions_posting.php
View file

@ -2514,7 +2514,7 @@ function submit_post($mode, $subject, $username, $topic_type, &$poll, &$data, $u
* @var string url The "Return to topic" URL
*
* @since 3.1.0-a3
* @change 3.1.0-RC3 Added vars mode, subject, username, topic_type,
* @changed 3.1.0-RC3 Added vars mode, subject, username, topic_type,
* poll, update_message, update_search_index
*/
$vars = array(

2
phpBB/includes/functions_user.php
View file

@ -276,7 +276,7 @@ function user_add($user_row, $cp_data = false, $notifications_data = null)
* @var array cp_data Array of Custom profile fields submited to user_add
* @var array sql_ary Array of data to be inserted when a user is added
* @since 3.1.0-a1
* @change 3.1.0-b5 Added user_row and cp_data
* @changed 3.1.0-b5 Added user_row and cp_data
*/
$vars = array('user_row', 'cp_data', 'sql_ary');
extract($phpbb_dispatcher->trigger_event('core.user_add_modify_data', compact($vars)));

2
phpBB/includes/mcp/mcp_main.php
View file

@ -164,7 +164,7 @@ class mcp_main
* @var string action Topic quick moderation action name
* @var bool quickmod Flag indicating whether MCP is in quick moderation mode
* @since 3.1.0-a4
* @change 3.1.0-RC4 Added variables: action, quickmod
* @changed 3.1.0-RC4 Added variables: action, quickmod
*/
$vars = array('action', 'quickmod');
extract($phpbb_dispatcher->trigger_event('core.modify_quickmod_actions', compact($vars)));

2
phpBB/includes/mcp/mcp_post.php
View file

@ -556,7 +556,7 @@ function change_poster(&$post_info, $userdata)
* @var array userdata Information on a post's new poster
* @var array post_info Information on the affected post
* @since 3.1.6-RC1
* @change 3.1.7-RC1 Change location to prevent post_info from being set to the new post information
* @changed 3.1.7-RC1 Change location to prevent post_info from being set to the new post information
*/
$vars = array('userdata', 'post_info');
extract($phpbb_dispatcher->trigger_event('core.mcp_change_poster_after', compact($vars)));

2
phpBB/includes/message_parser.php
View file

@ -1171,7 +1171,7 @@ class parse_message extends bbcode_firstpass
* @var bool return Do we return after the event is triggered if $warn_msg is not empty
* @var array warn_msg Array of the warning messages
* @since 3.1.2-RC1
* @change 3.1.3-RC1 Added vars $bbcode_bitfield and $bbcode_uid
* @changed 3.1.3-RC1 Added vars $bbcode_bitfield and $bbcode_uid
*/
$message = $this->message;
$warn_msg = $this->warn_msg;

2
phpBB/includes/ucp/ucp_pm_viewmessage.php
View file

@ -267,7 +267,7 @@ function view_message($id, $mode, $folder_id, $msg_id, $folder, $message_row)
* @var array msg_data Template array with message data
* @var array user_info User data of the sender
* @since 3.1.0-a1
* @change 3.1.6-RC1 Added user_info into event
* @changed 3.1.6-RC1 Added user_info into event
*/
$vars = array(
'id',

2
phpBB/includes/ucp/ucp_prefs.php
View file

@ -69,7 +69,7 @@ class ucp_prefs
* @var array data Array with current ucp options data
* @var array error Array with list of errors
* @since 3.1.0-a1
* @change 3.1.4-RC1 Added error variable to the event
* @changed 3.1.4-RC1 Added error variable to the event
*/
$vars = array('submit', 'data', 'error');
extract($phpbb_dispatcher->trigger_event('core.ucp_prefs_personal_data', compact($vars)));

4
phpBB/memberlist.php
View file

@ -665,8 +665,8 @@ switch ($mode)
* @var bool foe Is the user foe?
* @var array profile_fields Array with user's profile field data
* @since 3.1.0-a1
* @change 3.1.0-b2 Added friend and foe status
* @change 3.1.0-b3 Added profile fields data
* @changed 3.1.0-b2 Added friend and foe status
* @changed 3.1.0-b3 Added profile fields data
*/
$vars = array(
'member',

2
phpBB/phpbb/avatar/driver/upload.php
View file

@ -186,7 +186,7 @@ class upload extends \phpbb\avatar\driver\driver
* @var array row Array with avatar row data
* @var array error Array of errors, if filled in by this event file will not be moved
* @since 3.1.6-RC1
* @change 3.1.9-RC1 Added filedata
* @changed 3.1.9-RC1 Added filedata
*/
$vars = array(
'filedata',

8
phpBB/phpbb/event/php_exporter.php
View file

@ -508,7 +508,7 @@ class php_exporter
}
/**
* Find the "@change" Information lines
* Find the "@changed" Information lines
*
* @param string $tag_name Should be 'change', not 'changed'
* @return array Absolute line numbers
@ -648,7 +648,7 @@ class php_exporter
}
/**
* Validate "@change" Information
* Validate "@changed" Information
*
* @param string $line
* @return string
@ -658,10 +658,10 @@ class php_exporter
{
$match = array();
$line = str_replace("\t", ' ', ltrim($line, "\t "));
preg_match('#^\* @change (\d+\.\d+\.\d+(?:-(?:a|b|RC|pl)\d+)?)( (?:.*))?$#', $line, $match);
preg_match('#^\* @changed (\d+\.\d+\.\d+(?:-(?:a|b|RC|pl)\d+)?)( (?:.*))?$#', $line, $match);
if (!isset($match[2]))
{
throw new \LogicException("Invalid '@change' information for event "
throw new \LogicException("Invalid '@changed' information for event "
. "'{$this->current_event}' in file '{$this->current_file}:{$this->current_event_line}'");
}

18
phpBB/posting.php
View file

@ -84,7 +84,7 @@ $current_time = time();
* NOTE: Should be actual language strings, NOT
* language keys.
* @since 3.1.0-a1
* @change 3.1.2-RC1 Removed 'delete' var as it does not exist
* @changed 3.1.2-RC1 Removed 'delete' var as it does not exist
*/
$vars = array(
'post_id',
@ -373,7 +373,7 @@ switch ($mode)
* @var bool is_authed Does the user have the required permissions?
* @var array post_data All post data from database
* @since 3.1.3-RC1
* @change 3.1.10-RC1 Added post_data
* @changed 3.1.10-RC1 Added post_data
*/
$vars = array(
'post_id',
@ -1261,7 +1261,7 @@ if ($submit || $preview || $refresh)
* @var array error Any error strings; a non-empty array aborts form submission.
* NOTE: Should be actual language strings, NOT language keys.
* @since 3.1.0-RC5
* @change 3.1.5-RC1 Added poll array to the event
* @changed 3.1.5-RC1 Added poll array to the event
*/
$vars = array(
'post_data',
@ -1385,7 +1385,7 @@ if ($submit || $preview || $refresh)
* @var bool update_subject Boolean if the post subject was changed
* NOTE: Should be actual language strings, NOT language keys.
* @since 3.1.0-RC5
* @change 3.1.6-RC1 remove submit and error from event Submit and Error are checked previously prior to running event
* @changed 3.1.6-RC1 remove submit and error from event Submit and Error are checked previously prior to running event
*/
$vars = array(
'post_data',
@ -1424,7 +1424,7 @@ if ($submit || $preview || $refresh)
* @var string redirect_url URL the user is going to be redirected to
* NOTE: Should be actual language strings, NOT language keys.
* @since 3.1.0-RC5
* @change 3.1.6-RC1 remove submit and error from event Submit and Error are checked previously prior to running event
* @changed 3.1.6-RC1 remove submit and error from event Submit and Error are checked previously prior to running event
*/
$vars = array(
'post_data',
@ -1869,13 +1869,13 @@ if (($mode == 'post' || ($mode == 'edit' && $post_id == $post_data['topic_first_
* posting page via $template->assign_vars()
* @var object message_parser The message parser object
* @since 3.1.0-a1
* @change 3.1.0-b3 Added vars post_data, moderators, mode, page_title,
* @changed 3.1.0-b3 Added vars post_data, moderators, mode, page_title,
* s_topic_icons, form_enctype, s_action, s_hidden_fields,
* post_id, topic_id, forum_id, submit, preview, save, load,
* delete, cancel, refresh, error, page_data, message_parser
* @change 3.1.2-RC1 Removed 'delete' var as it does not exist
* @change 3.1.5-RC1 Added poll variables to the page_data array
* @change 3.1.6-RC1 Added 'draft_id' var
* @changed 3.1.2-RC1 Removed 'delete' var as it does not exist
* @changed 3.1.5-RC1 Added poll variables to the page_data array
* @changed 3.1.6-RC1 Added 'draft_id' var
*/
$vars = array(
'post_data',

16
phpBB/search.php
View file

@ -343,7 +343,7 @@ if ($keywords || $author || $author_id || $search_id || $submit)
* @var array id_ary Array of post or topic ids for search result
* @var string show_results 'posts' or 'topics' type of ids
* @since 3.1.3-RC1
* @change 3.1.10-RC1 Added id_ary, show_results
* @changed 3.1.10-RC1 Added id_ary, show_results
*/
$vars = array(
'keywords',
@ -692,8 +692,8 @@ if ($keywords || $author || $author_id || $search_id || $submit)
* @var int total_match_count The total number of search matches
* @var array ex_fid_ary Array of excluded forum ids
* @since 3.1.7-RC1
* @change 3.1.10-RC1 Added show_results, sql_where, total_match_count
* @change 3.1.11-RC1 Added ex_fid_ary
* @changed 3.1.10-RC1 Added show_results, sql_where, total_match_count
* @changed 3.1.11-RC1 Added ex_fid_ary
*/
$vars = array(
'u_search',
@ -830,8 +830,8 @@ if ($keywords || $author || $author_id || $search_id || $submit)
* @var string sort_key The sorting key
* @var string sql_order_by The SQL ORDER BY string used by search to get topic data
* @since 3.1.0-a1
* @change 3.1.0-RC5 Added total_match_count
* @change 3.1.7-RC1 Added sort_by_sql, sort_dir, sort_key, sql_order_by
* @changed 3.1.0-RC5 Added total_match_count
* @changed 3.1.7-RC1 Added sort_by_sql, sort_dir, sort_key, sql_order_by
*/
$vars = array(
'sql_select',
@ -1021,7 +1021,7 @@ if ($keywords || $author || $author_id || $search_id || $submit)
* @var string view Search results view mode
* @var array zebra Array with zebra data for the current user
* @since 3.1.0-b4
* @change 3.1.0-b5 Added var show_results
* @changed 3.1.0-b5 Added var show_results
*/
$vars = array(
'attachments',
@ -1198,7 +1198,7 @@ if ($keywords || $author || $author_id || $search_id || $submit)
* @var array zebra The zebra data of the current user
* @var array attachments All the attachments of the search results
* @since 3.1.0-a1
* @change 3.1.0-b3 Added vars show_results, topic_title, replies,
* @changed 3.1.0-b3 Added vars show_results, topic_title, replies,
* view_topic_url, folder_img, folder_alt, topic_type, unread_topic,
* topic_unapproved, posts_unapproved, topic_deleted, u_mcp_queue,
* zebra, attachments
@ -1302,7 +1302,7 @@ if ($keywords || $author || $author_id || $search_id || $submit)
* @var int total_match_count The count of search results
* @var string keywords The search keywords
* @since 3.1.0-RC4
* @change 3.1.6-RC1 Added total_match_count and keywords
* @changed 3.1.6-RC1 Added total_match_count and keywords
*/
$vars = array(
'author_id',

10
phpBB/viewforum.php
View file

@ -431,9 +431,9 @@ $sql_array = array(
* Author, Post time, Replies, Subject, Views
* @var string sort_dir Either "a" for ascending or "d" for descending
* @since 3.1.0-a1
* @change 3.1.0-RC4 Added forum_data var
* @change 3.1.4-RC1 Added forum_id, topics_count, sort_days, sort_key and sort_dir vars
* @change 3.1.9-RC1 Fix types of properties
* @changed 3.1.0-RC4 Added forum_data var
* @changed 3.1.4-RC1 Added forum_id, topics_count, sort_days, sort_key and sort_dir vars
* @changed 3.1.9-RC1 Fix types of properties
*/
$vars = array(
'forum_data',
@ -631,7 +631,7 @@ $sql_ary = array(
*
* @since 3.1.0-RC4
*
* @change 3.1.3 Added forum_data
* @changed 3.1.3 Added forum_data
*/
$vars = array(
'forum_data',
@ -945,7 +945,7 @@ if (sizeof($topic_list))
* @var bool s_type_switch_test Flag indicating if the test topic type is [global] announcement
* @since 3.1.0-a1
*
* @change 3.1.10-RC1 Added s_type_switch, s_type_switch_test
* @changed 3.1.10-RC1 Added s_type_switch, s_type_switch_test
*/
$vars = array('row', 'topic_row', 's_type_switch', 's_type_switch_test');
extract($phpbb_dispatcher->trigger_event('core.viewforum_modify_topicrow', compact($vars)));

4
phpBB/viewonline.php
View file

@ -168,7 +168,7 @@ $sql_ary = array(
* @var int guest_counter Number of guests displayed
* @var array forum_data Array with forum data
* @since 3.1.0-a1
* @change 3.1.0-a2 Added vars guest_counter and forum_data
* @changed 3.1.0-a2 Added vars guest_counter and forum_data
*/
$vars = array('sql_ary', 'show_guests', 'guest_counter', 'forum_data');
extract($phpbb_dispatcher->trigger_event('core.viewonline_modify_sql', compact($vars)));
@ -385,7 +385,7 @@ while ($row = $db->sql_fetchrow($result))
* @var string location_url Page url to displayed in the list
* @var array forum_data Array with forum data
* @since 3.1.0-a1
* @change 3.1.0-a2 Added var forum_data
* @changed 3.1.0-a2 Added var forum_data
*/
$vars = array('on_page', 'row', 'location', 'location_url', 'forum_data');
extract($phpbb_dispatcher->trigger_event('core.viewonline_overwrite_location', compact($vars)));

14
phpBB/viewtopic.php
View file

@ -678,7 +678,7 @@ $base_url = append_sid("{$phpbb_root_path}viewtopic.$phpEx", "f=$forum_id&t=
* @var int total_posts Topic total posts count
* @var string viewtopic_url URL to the topic page
* @since 3.1.0-RC4
* @change 3.1.2-RC1 Added viewtopic_url
* @changed 3.1.2-RC1 Added viewtopic_url
*/
$vars = array(
'base_url',
@ -1178,7 +1178,7 @@ $sql_ary = array(
* @var int start Pagination information
* @var array sql_ary The SQL array to get the data of posts and posters
* @since 3.1.0-a1
* @change 3.1.0-a2 Added vars forum_id, topic_id, topic_data, post_list, sort_days, sort_key, sort_dir, start
* @changed 3.1.0-a2 Added vars forum_id, topic_id, topic_data, post_list, sort_days, sort_key, sort_dir, start
*/
$vars = array(
'forum_id',
@ -1986,9 +1986,9 @@ for ($i = 0, $end = sizeof($post_list); $i < $end; ++$i)
* @var array post_row Template block array of the post
* @var array topic_data Array with topic data
* @since 3.1.0-a1
* @change 3.1.0-a3 Added vars start, current_row_number, end, attachments
* @change 3.1.0-b3 Added topic_data array, total_posts
* @change 3.1.0-RC3 Added poster_id
* @changed 3.1.0-a3 Added vars start, current_row_number, end, attachments
* @changed 3.1.0-b3 Added topic_data array, total_posts
* @changed 3.1.0-RC3 Added poster_id
*/
$vars = array(
'start',
@ -2086,7 +2086,7 @@ for ($i = 0, $end = sizeof($post_list); $i < $end; ++$i)
* @var array post_row Template block array of the post
* @var array topic_data Array with topic data
* @since 3.1.0-a3
* @change 3.1.0-b3 Added topic_data array, total_posts
* @changed 3.1.0-b3 Added topic_data array, total_posts
*/
$vars = array(
'start',
@ -2249,7 +2249,7 @@ $page_title = $topic_data['topic_title'] . ($start ? ' - ' . sprintf($user->lang
* @var int start Start offset used to calculate the page
* @var array post_list Array with post_ids we are going to display
* @since 3.1.0-a1
* @change 3.1.0-RC4 Added post_list var
* @changed 3.1.0-RC4 Added post_list var
*/
$vars = array('page_title', 'topic_data', 'forum_id', 'start', 'post_list');
extract($phpbb_dispatcher->trigger_event('core.viewtopic_modify_page_title', compact($vars)));

2
tests/event/fixtures/trigger_many_vars.test
View file

@ -34,7 +34,7 @@
* posting page via $template->assign_vars()
* @var object message_parser The message parser object
* @since 3.1.0-a1
* @change 3.1.0-b3 Added vars post_data, moderators, mode, page_title,
* @changed 3.1.0-b3 Added vars post_data, moderators, mode, page_title,
* s_topic_icons, form_enctype, s_action, s_hidden_fields,
* post_id, topic_id, forum_id, submit, preview, save, load,
* delete, cancel, refresh, error, page_data, message_parser

16
tests/event/php_exporter_test.php
View file

@ -552,7 +552,7 @@ class phpbb_event_php_exporter_test extends phpbb_test_case
'* @since 3.1.0-a1',
'/**',
'* @since 3.1.0-a1',
'* @change 3.1.0-a2',
'* @changed 3.1.0-a2',
'*/',
'$phpbb_dispatcher->dispatch(\'test\');',
),
@ -590,9 +590,9 @@ class phpbb_event_php_exporter_test extends phpbb_test_case
array(
array(
'/**',
'* @change 3.1.0-a1',
'* @change 3.1.0-a2',
'* @change 3.1.0-a3',
'* @changed 3.1.0-a1',
'* @changed 3.1.0-a2',
'* @changed 3.1.0-a3',
'*/',
'$phpbb_dispatcher->dispatch(\'test\');',
),
@ -657,7 +657,7 @@ class phpbb_event_php_exporter_test extends phpbb_test_case
' * Hello Bertie!',
' *',
' * @since 3.1.0-a1',
' * @change 3.1.0-a2',
' * @changed 3.1.0-a2',
' */',
' $phpbb_dispatcher->dispatch(\'test\');',
),
@ -691,9 +691,9 @@ class phpbb_event_php_exporter_test extends phpbb_test_case
array(
array(
'/**',
'* @change 3.1.0-a1',
'* @change 3.1.0-a2',
'* @change 3.1.0-a3',
'* @changed 3.1.0-a1',
'* @changed 3.1.0-a2',
'* @changed 3.1.0-a3',
'*/',
'$phpbb_dispatcher->dispatch(\'test\');',
),