aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJakub Senko <jakubsenko@gmail.com>2016-11-20 17:58:59 +0100
committerJakub Senko <jakubsenko@gmail.com>2016-11-20 17:58:59 +0100
commitc2836725f9692e907d77edce7c609142661af6c1 (patch)
tree1a1c9d9c41b2771b61a6df9d8c381e1648aca1ec
parentdbd9c1f242ae7c7660feddf2677d41aa82bd21b4 (diff)
downloadforums-c2836725f9692e907d77edce7c609142661af6c1.tar
forums-c2836725f9692e907d77edce7c609142661af6c1.tar.gz
forums-c2836725f9692e907d77edce7c609142661af6c1.tar.bz2
forums-c2836725f9692e907d77edce7c609142661af6c1.tar.xz
forums-c2836725f9692e907d77edce7c609142661af6c1.zip
[ticket/13429] Replace @changed with @change in event docblocks
PHPBB3-13429
Diffstat
-rw-r--r--phpBB/includes/functions.php6
-rw-r--r--phpBB/includes/functions_admin.php2
-rw-r--r--phpBB/includes/mcp/mcp_post.php2
-rw-r--r--phpBB/includes/ucp/ucp_pm_viewmessage.php2
-rw-r--r--phpBB/includes/ucp/ucp_prefs.php2
-rw-r--r--phpBB/memberlist.php4
-rw-r--r--phpBB/phpbb/avatar/driver/upload.php2
-rw-r--r--phpBB/phpbb/event/php_exporter.php10
-rw-r--r--phpBB/posting.php6
-rw-r--r--phpBB/search.php16
-rw-r--r--phpBB/viewforum.php4
-rw-r--r--tests/event/php_exporter_test.php16
12 files changed, 36 insertions, 36 deletions
diff --git a/phpBB/includes/functions.php b/phpBB/includes/functions.php
index a152d9b620..e5e54e28d7 100644
--- a/phpBB/includes/functions.php
+++ b/phpBB/includes/functions.php
@@ -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
- * @changed 3.1.11-RC1 Added template_variable_suffix
+ * @change 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
- * @changed 3.1.9-RC1 Removed undefined return variable
+ * @change 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
- * @changed 3.1.7-RC1 Change sql query into array and adjust var accordingly. Allows extension authors the ability to adjust the sql_ary.
+ * @change 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)));
diff --git a/phpBB/includes/functions_admin.php b/phpBB/includes/functions_admin.php
index 1dc246ec33..dabdd80bc6 100644
--- a/phpBB/includes/functions_admin.php
+++ b/phpBB/includes/functions_admin.php
@@ -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
- * @changed 3.1.10-RC1 Added prune_limit
+ * @change 3.1.10-RC1 Added prune_limit
*/
$vars = array(
'forum_id',
diff --git a/phpBB/includes/mcp/mcp_post.php b/phpBB/includes/mcp/mcp_post.php
index 2dcfcd608b..45f48419a0 100644
--- a/phpBB/includes/mcp/mcp_post.php
+++ b/phpBB/includes/mcp/mcp_post.php
@@ -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
- * @changed 3.1.7-RC1 Change location to prevent post_info from being set to the new post information
+ * @change 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)));
diff --git a/phpBB/includes/ucp/ucp_pm_viewmessage.php b/phpBB/includes/ucp/ucp_pm_viewmessage.php
index d7b9b32dbf..09e793d965 100644
--- a/phpBB/includes/ucp/ucp_pm_viewmessage.php
+++ b/phpBB/includes/ucp/ucp_pm_viewmessage.php
@@ -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
- * @changed 3.1.6-RC1 Added user_info into event
+ * @change 3.1.6-RC1 Added user_info into event
*/
$vars = array(
'id',
diff --git a/phpBB/includes/ucp/ucp_prefs.php b/phpBB/includes/ucp/ucp_prefs.php
index e63e9b4c08..6eed423363 100644
--- a/phpBB/includes/ucp/ucp_prefs.php
+++ b/phpBB/includes/ucp/ucp_prefs.php
@@ -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
- * @changed 3.1.4-RC1 Added error variable to the event
+ * @change 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)));
diff --git a/phpBB/memberlist.php b/phpBB/memberlist.php
index b93476b3bb..1f8dfc14c3 100644
--- a/phpBB/memberlist.php
+++ b/phpBB/memberlist.php
@@ -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
- * @changed 3.1.0-b2 Added friend and foe status
- * @changed 3.1.0-b3 Added profile fields data
+ * @change 3.1.0-b2 Added friend and foe status
+ * @change 3.1.0-b3 Added profile fields data
*/
$vars = array(
'member',
diff --git a/phpBB/phpbb/avatar/driver/upload.php b/phpBB/phpbb/avatar/driver/upload.php
index cb8dfcad4f..9e3f208210 100644
--- a/phpBB/phpbb/avatar/driver/upload.php
+++ b/phpBB/phpbb/avatar/driver/upload.php
@@ -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
- * @changed 3.1.9-RC1 Added filedata
+ * @change 3.1.9-RC1 Added filedata
*/
$vars = array(
'filedata',
diff --git a/phpBB/phpbb/event/php_exporter.php b/phpBB/phpbb/event/php_exporter.php
index d2ab0595c0..8923d35f6d 100644
--- a/phpBB/phpbb/event/php_exporter.php
+++ b/phpBB/phpbb/event/php_exporter.php
@@ -508,9 +508,9 @@ class php_exporter
}
/**
- * Find the "@changed" Information lines
+ * Find the "@change" Information lines
*
- * @param string $tag_name Should be 'changed' or 'change'
+ * @param string $tag_name Should be 'change', not 'changed'
* @return array Absolute line numbers
* @throws \LogicException
*/
@@ -648,7 +648,7 @@ class php_exporter
}
/**
- * Validate "@changed" Information
+ * Validate "@change" 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+\.\d+(?:-(?:a|b|RC|pl)\d+)?)( (?:.*))?$#', $line, $match);
+ preg_match('#^\* @change (\d+\.\d+\.\d+(?:-(?:a|b|RC|pl)\d+)?)( (?:.*))?$#', $line, $match);
if (!isset($match[2]))
{
- throw new \LogicException("Invalid '@changed' information for event "
+ throw new \LogicException("Invalid '@change' information for event "
. "'{$this->current_event}' in file '{$this->current_file}:{$this->current_event_line}'");
}
diff --git a/phpBB/posting.php b/phpBB/posting.php
index db580d926b..6f8225c198 100644
--- a/phpBB/posting.php
+++ b/phpBB/posting.php
@@ -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
-* @changed 3.1.10-RC1 Added post_data
+* @change 3.1.10-RC1 Added post_data
*/
$vars = array(
'post_id',
@@ -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
- * @changed 3.1.6-RC1 remove submit and error from event Submit and Error are checked previously prior to running event
+ * @change 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
- * @changed 3.1.6-RC1 remove submit and error from event Submit and Error are checked previously prior to running event
+ * @change 3.1.6-RC1 remove submit and error from event Submit and Error are checked previously prior to running event
*/
$vars = array(
'post_data',
diff --git a/phpBB/search.php b/phpBB/search.php
index 27ec8e4dab..cbc6b0f55a 100644
--- a/phpBB/search.php
+++ b/phpBB/search.php
@@ -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
- * @changed 3.1.10-RC1 Added id_ary, show_results
+ * @change 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
- * @changed 3.1.10-RC1 Added show_results, sql_where, total_match_count
- * @changed 3.1.11-RC1 Added ex_fid_ary
+ * @change 3.1.10-RC1 Added show_results, sql_where, total_match_count
+ * @change 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
- * @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
+ * @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
*/
$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
- * @changed 3.1.0-b5 Added var show_results
+ * @change 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
- * @changed 3.1.0-b3 Added vars show_results, topic_title, replies,
+ * @change 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
- * @changed 3.1.6-RC1 Added total_match_count and keywords
+ * @change 3.1.6-RC1 Added total_match_count and keywords
*/
$vars = array(
'author_id',
diff --git a/phpBB/viewforum.php b/phpBB/viewforum.php
index e0cc9ba512..d93afc7bb7 100644
--- a/phpBB/viewforum.php
+++ b/phpBB/viewforum.php
@@ -631,7 +631,7 @@ $sql_ary = array(
*
* @since 3.1.0-RC4
*
-* @changed 3.1.3 Added forum_data
+* @change 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
*
- * @changed 3.1.10-RC1 Added s_type_switch, s_type_switch_test
+ * @change 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)));
diff --git a/tests/event/php_exporter_test.php b/tests/event/php_exporter_test.php
index 692a57f93c..a3d7f27ced 100644
--- a/tests/event/php_exporter_test.php
+++ b/tests/event/php_exporter_test.php
@@ -552,7 +552,7 @@ class phpbb_event_php_exporter_test extends phpbb_test_case
'* @since 3.1.0-a1',
'/**',
'* @since 3.1.0-a1',
- '* @changed 3.1.0-a2',
+ '* @change 3.1.0-a2',
'*/',
'$phpbb_dispatcher->dispatch(\'test\');',
),
@@ -590,9 +590,9 @@ class phpbb_event_php_exporter_test extends phpbb_test_case
array(
array(
'/**',
- '* @changed 3.1.0-a1',
- '* @changed 3.1.0-a2',
- '* @changed 3.1.0-a3',
+ '* @change 3.1.0-a1',
+ '* @change 3.1.0-a2',
+ '* @change 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',
- ' * @changed 3.1.0-a2',
+ ' * @change 3.1.0-a2',
' */',
' $phpbb_dispatcher->dispatch(\'test\');',
),
@@ -691,9 +691,9 @@ class phpbb_event_php_exporter_test extends phpbb_test_case
array(
array(
'/**',
- '* @changed 3.1.0-a1',
- '* @changed 3.1.0-a2',
- '* @changed 3.1.0-a3',
+ '* @change 3.1.0-a1',
+ '* @change 3.1.0-a2',
+ '* @change 3.1.0-a3',
'*/',
'$phpbb_dispatcher->dispatch(\'test\');',
),
generated by cgit v1.2.1 (git 2.21.0) at 2024-09-25 16:48:04 +0000