mirror of
https://github.com/phpbb/phpbb.git
synced 2025-07-30 21:40:43 +02:00
[ticket/15424] Multiple typo fixes in docs & comments
Fixed typos in some docs, guidelines, some non-user-facing files. PHPBB3-15424
This commit is contained in:
luzpaz
Marc Alexander
@@ -64,7 +64,7 @@ class class_loader
|
||||
|
||||
/**
|
||||
* Provide the class loader with a cache to store paths. If set to null, the
|
||||
* the class loader will resolve paths by checking for the existance of every
|
||||
* the class loader will resolve paths by checking for the existence of every
|
||||
* directory in the class name every time.
|
||||
*
|
||||
* @param \phpbb\cache\driver\driver_interface $cache An implementation of the phpBB cache interface.
|
||||
|
||||
@@ -73,7 +73,7 @@ class run extends \phpbb\console\command\command
|
||||
* @param InputInterface $input The input stream used to get the argument and verboe option.
|
||||
* @param OutputInterface $output The output stream, used for printing verbose-mode and error information.
|
||||
*
|
||||
* @return int 0 if all is ok, 1 if a lock error occured and 2 if no task matching the argument was found.
|
||||
* @return int 0 if all is ok, 1 if a lock error occurred and 2 if no task matching the argument was found.
|
||||
*/
|
||||
protected function execute(InputInterface $input, OutputInterface $output)
|
||||
{
|
||||
|
||||
@@ -77,7 +77,7 @@ class check extends \phpbb\console\command\command
|
||||
*
|
||||
* @param InputInterface $input Input stream, used to get the options.
|
||||
* @param OutputInterface $output Output stream, used to print messages.
|
||||
* @return int 0 if the board is up to date, 1 if it is not and 2 if an error occured.
|
||||
* @return int 0 if the board is up to date, 1 if it is not and 2 if an error occurred.
|
||||
* @throws \RuntimeException
|
||||
*/
|
||||
protected function execute(InputInterface $input, OutputInterface $output)
|
||||
|
||||
@@ -684,7 +684,7 @@ class content_visibility
|
||||
* @param $time int Timestamp when the action is performed
|
||||
* @param $reason string Reason why the visibilty was changed.
|
||||
* @param $force_update_all bool Force to update all posts within the topic
|
||||
* @return array Changed topic data, empty array if an error occured.
|
||||
* @return array Changed topic data, empty array if an error occurred.
|
||||
*/
|
||||
public function set_topic_visibility($visibility, $topic_id, $forum_id, $user_id, $time, $reason, $force_update_all = false)
|
||||
{
|
||||
|
||||
@@ -390,7 +390,7 @@ class mysql extends \phpbb\db\driver\mysql_base
|
||||
{
|
||||
static $test_prof;
|
||||
|
||||
// current detection method, might just switch to see the existance of INFORMATION_SCHEMA.PROFILING
|
||||
// current detection method, might just switch to see the existence of INFORMATION_SCHEMA.PROFILING
|
||||
if ($test_prof === null)
|
||||
{
|
||||
$test_prof = false;
|
||||
|
||||
@@ -373,7 +373,7 @@ class mysqli extends \phpbb\db\driver\mysql_base
|
||||
{
|
||||
static $test_prof;
|
||||
|
||||
// current detection method, might just switch to see the existance of INFORMATION_SCHEMA.PROFILING
|
||||
// current detection method, might just switch to see the existence of INFORMATION_SCHEMA.PROFILING
|
||||
if ($test_prof === null)
|
||||
{
|
||||
$test_prof = false;
|
||||
|
||||
@@ -300,7 +300,7 @@ class mysql_extractor extends base_extractor
|
||||
}
|
||||
|
||||
/**
|
||||
* Extracts database table structure (for MySQL verisons older than 3.23.20)
|
||||
* Extracts database table structure (for MySQL versions older than 3.23.20)
|
||||
*
|
||||
* @param string $table_name name of the database table
|
||||
* @return null
|
||||
|
||||
@@ -117,7 +117,7 @@ class release_3_0_4_rc1 extends \phpbb\db\migration\migration
|
||||
}
|
||||
else
|
||||
{
|
||||
// equivelant to "none", which is the "Display in user control panel" option
|
||||
// equivalent to "none", which is the "Display in user control panel" option
|
||||
$sql_ary['field_show_profile'] = 1;
|
||||
}
|
||||
|
||||
|
||||
@@ -132,7 +132,7 @@ class softdelete_p1 extends \phpbb\db\migration\migration
|
||||
/*
|
||||
* Using sql_case here to avoid "BIGINT UNSIGNED value is out of range" errors.
|
||||
* As we update all topics in 2 queries, one broken topic would stop the conversion
|
||||
* for all topics and the surpressed error will cause the admin to not even notice it.
|
||||
* for all topics and the suppressed error will cause the admin to not even notice it.
|
||||
*/
|
||||
$sql = 'UPDATE ' . $this->table_prefix . 'topics
|
||||
SET topic_posts_approved = topic_replies + 1,
|
||||
|
||||
@@ -509,7 +509,7 @@ class module implements \phpbb\db\migration\tool\tool_interface
|
||||
* Get parent module id
|
||||
*
|
||||
* @param string|int $parent_id The parent module_id|module_langname
|
||||
* @param int|string|array $data The module_id, module_langname for existance checking or module data array for adding
|
||||
* @param int|string|array $data The module_id, module_langname for existence checking or module data array for adding
|
||||
* @param bool $throw_exception The flag indicating if exception should be thrown on error
|
||||
* @return mixed The int parent module_id, an array of int parent module_id values or false
|
||||
* @throws \phpbb\db\migration\exception
|
||||
|
||||
@@ -194,7 +194,7 @@ class mssql extends tools
|
||||
$primary_key_gen = isset($prepared_column['primary_key_set']) && $prepared_column['primary_key_set'];
|
||||
}
|
||||
|
||||
// create sequence DDL based off of the existance of auto incrementing columns
|
||||
// create sequence DDL based off of the existence of auto incrementing columns
|
||||
if (!$create_sequence && isset($prepared_column['auto_increment']) && $prepared_column['auto_increment'])
|
||||
{
|
||||
$create_sequence = $column_name;
|
||||
|
||||
@@ -141,7 +141,7 @@ class postgres extends tools
|
||||
$primary_key_gen = isset($prepared_column['primary_key_set']) && $prepared_column['primary_key_set'];
|
||||
}
|
||||
|
||||
// create sequence DDL based off of the existance of auto incrementing columns
|
||||
// create sequence DDL based off of the existence of auto incrementing columns
|
||||
if (!$create_sequence && isset($prepared_column['auto_increment']) && $prepared_column['auto_increment'])
|
||||
{
|
||||
$create_sequence = $column_name;
|
||||
|
||||
@@ -335,7 +335,7 @@ class tools implements tools_interface
|
||||
$primary_key_gen = isset($prepared_column['primary_key_set']) && $prepared_column['primary_key_set'];
|
||||
}
|
||||
|
||||
// create sequence DDL based off of the existance of auto incrementing columns
|
||||
// create sequence DDL based off of the existence of auto incrementing columns
|
||||
if (!$create_sequence && isset($prepared_column['auto_increment']) && $prepared_column['auto_increment'])
|
||||
{
|
||||
$create_sequence = $column_name;
|
||||
|
||||
@@ -17,7 +17,7 @@ namespace phpbb\feed;
|
||||
* Active Topics feed
|
||||
*
|
||||
* This will give you the last {$this->num_items} topics
|
||||
* with replies made withing the last {$this->sort_days} days
|
||||
* with replies made within the last {$this->sort_days} days
|
||||
* including the last post.
|
||||
*/
|
||||
class topics_active extends topic_base
|
||||
|
||||
@@ -204,7 +204,7 @@ interface filesystem_interface
|
||||
* This function determines owner and group whom the file belongs to and user and group of PHP and then set safest possible file permissions.
|
||||
* The function determines owner and group from common.php file and sets the same to the provided file.
|
||||
* The function uses bit fields to build the permissions.
|
||||
* The function sets the appropiate execute bit on directories.
|
||||
* The function sets the appropriate execute bit on directories.
|
||||
*
|
||||
* Supported constants representing bit fields are:
|
||||
*
|
||||
|
||||
@@ -80,7 +80,7 @@ class finder
|
||||
/**
|
||||
* Set the array of extensions
|
||||
*
|
||||
* @param array $extensions A list of extensions that should be searched aswell
|
||||
* @param array $extensions A list of extensions that should be searched as well
|
||||
* @param bool $replace_list Should the list be emptied before adding the extensions
|
||||
* @return \phpbb\finder This object for chaining calls
|
||||
*/
|
||||
@@ -237,7 +237,7 @@ class finder
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes occurances of /./ and makes sure path ends without trailing slash
|
||||
* Removes occurrences of /./ and makes sure path ends without trailing slash
|
||||
*
|
||||
* @param string $directory A directory pattern
|
||||
* @return string A cleaned up directory pattern
|
||||
|
||||
@@ -181,7 +181,7 @@ class container_factory
|
||||
$this->request->disable_super_globals();
|
||||
}
|
||||
|
||||
// Get compatibilty globals and constants
|
||||
// Get compatibility globals and constants
|
||||
$this->update_helper->include_file('includes/compatibility_globals.' . $this->php_ext);
|
||||
|
||||
register_compatibility_globals();
|
||||
|
||||
@@ -31,7 +31,7 @@ interface iohandler_interface
|
||||
* @param string $name Name of the input variable to obtain
|
||||
* @param mixed $default A default value that is returned if the variable was not set.
|
||||
* This function will always return a value of the same type as the default.
|
||||
* @param bool $multibyte If $default is a string this paramater has to be true if the variable may contain any UTF-8 characters
|
||||
* @param bool $multibyte If $default is a string this parameter has to be true if the variable may contain any UTF-8 characters
|
||||
* Default is false, causing all bytes outside the ASCII range (0-127) to be replaced with question marks
|
||||
*
|
||||
* @return mixed Value of the input variable
|
||||
|
||||
@@ -76,7 +76,7 @@ class guesser
|
||||
* should be used first and vice versa. usort() orders the array values
|
||||
* from low to high depending on what the comparison function returns
|
||||
* to it. Return value should be smaller than 0 if value a is smaller
|
||||
* than value b. This has been reversed in the comparision function in
|
||||
* than value b. This has been reversed in the comparison function in
|
||||
* order to sort the guessers from high to low.
|
||||
* Method has been set to public in order to allow proper testing.
|
||||
*
|
||||
|
||||
@@ -94,7 +94,7 @@ class approve_post extends \phpbb\notification\type\post
|
||||
*
|
||||
* @param array $post Post data from submit_post
|
||||
* @param array $notify_users Notify users list
|
||||
* Formated from find_users_for_notification()
|
||||
* Formatted from find_users_for_notification()
|
||||
* @return array Whatever you want to send to create_insert_array().
|
||||
*/
|
||||
public function pre_create_insert_array($post, $notify_users)
|
||||
|
||||
@@ -94,7 +94,7 @@ class approve_topic extends \phpbb\notification\type\topic
|
||||
*
|
||||
* @param array $post Post data from submit_post
|
||||
* @param array $notify_users Notify users list
|
||||
* Formated from find_users_for_notification()
|
||||
* Formatted from find_users_for_notification()
|
||||
* @return array Whatever you want to send to create_insert_array().
|
||||
*/
|
||||
public function pre_create_insert_array($post, $notify_users)
|
||||
|
||||
@@ -336,7 +336,7 @@ abstract class base implements \phpbb\notification\type\type_interface
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the reference of the notifcation (fall back)
|
||||
* Get the reference of the notification (fall back)
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
@@ -356,7 +356,7 @@ abstract class base implements \phpbb\notification\type\type_interface
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the reason for the notifcation (fall back)
|
||||
* Get the reason for the notification (fall back)
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
|
||||
@@ -352,7 +352,7 @@ class post extends \phpbb\notification\type\base
|
||||
*
|
||||
* @param array $post Post data from submit_post
|
||||
* @param array $notify_users Notify users list
|
||||
* Formated from find_users_for_notification()
|
||||
* Formatted from find_users_for_notification()
|
||||
* @return array Whatever you want to send to create_insert_array().
|
||||
*/
|
||||
public function pre_create_insert_array($post, $notify_users)
|
||||
|
||||
@@ -256,7 +256,7 @@ class topic extends \phpbb\notification\type\base
|
||||
*
|
||||
* @param array $post Post data from submit_post
|
||||
* @param array $notify_users Notify users list
|
||||
* Formated from find_users_for_notification()
|
||||
* Formatted from find_users_for_notification()
|
||||
* @return array Whatever you want to send to create_insert_array().
|
||||
*/
|
||||
public function pre_create_insert_array($post, $notify_users)
|
||||
|
||||
@@ -170,7 +170,7 @@ interface type_interface
|
||||
*
|
||||
* @param array $type_data The type specific data
|
||||
* @param array $notify_users Notify users list
|
||||
* Formated from find_users_for_notification()
|
||||
* Formatted from find_users_for_notification()
|
||||
* @return array Whatever you want to send to create_insert_array().
|
||||
*/
|
||||
public function pre_create_insert_array($type_data, $notify_users);
|
||||
|
||||
@@ -250,7 +250,7 @@ class manager
|
||||
|
||||
/**
|
||||
* Check supplied password against hash and set convert_flag if password
|
||||
* needs to be converted to different format (preferrably newer one)
|
||||
* needs to be converted to different format (preferably newer one)
|
||||
*
|
||||
* @param string $password Password that should be checked
|
||||
* @param string $hash Stored hash
|
||||
|
||||
@@ -51,7 +51,7 @@ abstract class report_handler implements report_handler_interface
|
||||
protected $report_data;
|
||||
|
||||
/**
|
||||
* Construtor
|
||||
* Constructor
|
||||
*
|
||||
* @param \phpbb\db\driver\driver_interface $db
|
||||
* @param \phpbb\event\dispatcher_interface $dispatcher
|
||||
|
||||
@@ -179,7 +179,7 @@ class request implements \phpbb\request\request_interface
|
||||
* then specifying array("var", 1) as the name will return "a".
|
||||
* @param mixed $default A default value that is returned if the variable was not set.
|
||||
* This function will always return a value of the same type as the default.
|
||||
* @param bool $multibyte If $default is a string this paramater has to be true if the variable may contain any UTF-8 characters
|
||||
* @param bool $multibyte If $default is a string this parameter has to be true if the variable may contain any UTF-8 characters
|
||||
* Default is false, causing all bytes outside the ASCII range (0-127) to be replaced with question marks
|
||||
* @param \phpbb\request\request_interface::POST|GET|REQUEST|COOKIE $super_global
|
||||
* Specifies which super global should be used
|
||||
@@ -203,7 +203,7 @@ class request implements \phpbb\request\request_interface
|
||||
* then specifying array("var", 1) as the name will return "a".
|
||||
* @param mixed $default A default value that is returned if the variable was not set.
|
||||
* This function will always return a value of the same type as the default.
|
||||
* @param bool $multibyte If $default is a string this paramater has to be true if the variable may contain any UTF-8 characters
|
||||
* @param bool $multibyte If $default is a string this parameter has to be true if the variable may contain any UTF-8 characters
|
||||
* Default is false, causing all bytes outside the ASCII range (0-127) to be replaced with question marks
|
||||
* @param \phpbb\request\request_interface::POST|GET|REQUEST|COOKIE $super_global
|
||||
* Specifies which super global should be used
|
||||
@@ -395,7 +395,7 @@ class request implements \phpbb\request\request_interface
|
||||
* then specifying array("var", 1) as the name will return "a".
|
||||
* @param mixed $default A default value that is returned if the variable was not set.
|
||||
* This function will always return a value of the same type as the default.
|
||||
* @param bool $multibyte If $default is a string this paramater has to be true if the variable may contain any UTF-8 characters
|
||||
* @param bool $multibyte If $default is a string this parameter has to be true if the variable may contain any UTF-8 characters
|
||||
* Default is false, causing all bytes outside the ASCII range (0-127) to be replaced with question marks
|
||||
* @param \phpbb\request\request_interface::POST|GET|REQUEST|COOKIE $super_global
|
||||
* Specifies which super global should be used
|
||||
|
||||
@@ -54,7 +54,7 @@ interface request_interface
|
||||
* then specifying array("var", 1) as the name will return "a".
|
||||
* @param mixed $default A default value that is returned if the variable was not set.
|
||||
* This function will always return a value of the same type as the default.
|
||||
* @param bool $multibyte If $default is a string this paramater has to be true if the variable may contain any UTF-8 characters
|
||||
* @param bool $multibyte If $default is a string this parameter has to be true if the variable may contain any UTF-8 characters
|
||||
* Default is false, causing all bytes outside the ASCII range (0-127) to be replaced with question marks
|
||||
* @param \phpbb\request\request_interface::POST|GET|REQUEST|COOKIE $super_global
|
||||
* Specifies which super global should be used
|
||||
|
||||
@@ -150,7 +150,7 @@ class fulltext_mysql extends \phpbb\search\base
|
||||
/**
|
||||
* Checks for correct MySQL version and stores min/max word length in the config
|
||||
*
|
||||
* @return string|bool Language key of the error/incompatiblity occurred
|
||||
* @return string|bool Language key of the error/incompatibility occurred
|
||||
*/
|
||||
public function init()
|
||||
{
|
||||
|
||||
@@ -351,7 +351,7 @@ class fulltext_native extends \phpbb\search\base
|
||||
$this->db->sql_freeresult($result);
|
||||
}
|
||||
|
||||
// Handle +, - without preceeding whitespace character
|
||||
// Handle +, - without preceding whitespace character
|
||||
$match = array('#(\S)\+#', '#(\S)-#');
|
||||
$replace = array('$1 +', '$1 +');
|
||||
|
||||
|
||||
@@ -173,7 +173,7 @@ class fulltext_postgres extends \phpbb\search\base
|
||||
/**
|
||||
* Checks for correct PostgreSQL version and stores min/max word length in the config
|
||||
*
|
||||
* @return string|bool Language key of the error/incompatiblity occurred
|
||||
* @return string|bool Language key of the error/incompatibility occurred
|
||||
*/
|
||||
public function init()
|
||||
{
|
||||
|
||||
@@ -18,7 +18,7 @@ define('SPHINX_CONNECT_RETRIES', 3);
|
||||
define('SPHINX_CONNECT_WAIT_TIME', 300);
|
||||
|
||||
/**
|
||||
* Fulltext search based on the sphinx search deamon
|
||||
* Fulltext search based on the sphinx search daemon
|
||||
*/
|
||||
class fulltext_sphinx
|
||||
{
|
||||
@@ -210,7 +210,7 @@ class fulltext_sphinx
|
||||
/**
|
||||
* Checks permissions and paths, if everything is correct it generates the config file
|
||||
*
|
||||
* @return string|bool Language key of the error/incompatiblity encountered, or false if successful
|
||||
* @return string|bool Language key of the error/incompatibility encountered, or false if successful
|
||||
*/
|
||||
public function init()
|
||||
{
|
||||
|
||||
@@ -250,7 +250,7 @@ class session
|
||||
$ips = explode(' ', $this->forwarded_for);
|
||||
foreach ($ips as $ip)
|
||||
{
|
||||
// check IPv4 first, the IPv6 is hopefully only going to be used very seldomly
|
||||
// check IPv4 first, the IPv6 is hopefully only going to be used very seldom
|
||||
if (!empty($ip) && !preg_match(get_preg_expression('ipv4'), $ip) && !preg_match(get_preg_expression('ipv6'), $ip))
|
||||
{
|
||||
// contains invalid data, don't use the forwarded for header
|
||||
@@ -478,7 +478,7 @@ class session
|
||||
}
|
||||
else
|
||||
{
|
||||
// Added logging temporarly to help debug bugs...
|
||||
// Added logging temporarily to help debug bugs...
|
||||
if (defined('DEBUG') && $this->data['user_id'] != ANONYMOUS)
|
||||
{
|
||||
if ($referer_valid)
|
||||
@@ -1336,7 +1336,7 @@ class session
|
||||
* Only IPv4 (rbldns does not support AAAA records/IPv6 lookups)
|
||||
*
|
||||
* @author satmd (from the php manual)
|
||||
* @param string $mode register/post - spamcop for example is ommitted for posting
|
||||
* @param string $mode register/post - spamcop for example is omitted for posting
|
||||
* @param string|false $ip the IPv4 address to check
|
||||
*
|
||||
* @return false if ip is not blacklisted, else an array([checked server], [lookup])
|
||||
@@ -1395,7 +1395,7 @@ class session
|
||||
|
||||
/**
|
||||
* Check if URI is blacklisted
|
||||
* This should be called only where absolutly necessary, for example on the submitted website field
|
||||
* This should be called only where absolutely necessary, for example on the submitted website field
|
||||
* This function is not in use at the moment and is only included for testing purposes, it may not work at all!
|
||||
* This means it is untested at the moment and therefore commented out
|
||||
*
|
||||
|
||||
@@ -87,7 +87,7 @@ class context
|
||||
}
|
||||
|
||||
/**
|
||||
* Retreive a single scalar value from a single key.
|
||||
* Retrieve a single scalar value from a single key.
|
||||
*
|
||||
* @param string $varname Variable name
|
||||
* @return mixed Variable value, or null if not set
|
||||
@@ -149,7 +149,7 @@ class context
|
||||
{
|
||||
// If the key name is lowercase and the data is an array,
|
||||
// it could be a template loop. So we set the S_NUM_ROWS there
|
||||
// aswell.
|
||||
// as well.
|
||||
if ($sub_block_name === strtolower($sub_block_name) && is_array($sub_block))
|
||||
{
|
||||
$this->set_num_rows($sub_block);
|
||||
|
||||
@@ -136,7 +136,7 @@ interface template
|
||||
public function retrieve_vars(array $vararray);
|
||||
|
||||
/**
|
||||
* Retreive a single scalar value from a single key.
|
||||
* Retrieve a single scalar value from a single key.
|
||||
*
|
||||
* @param string $varname Variable name
|
||||
* @return mixed Variable value, or null if not set
|
||||
|
||||
@@ -327,7 +327,7 @@ class user extends \phpbb\session
|
||||
}
|
||||
|
||||
// Disable board if the install/ directory is still present
|
||||
// For the brave development army we do not care about this, else we need to comment out this everytime we develop locally
|
||||
// For the brave development army we do not care about this, else we need to comment out this every time we develop locally
|
||||
if (!defined('DEBUG') && !defined('ADMIN_START') && !defined('IN_INSTALL') && !defined('IN_LOGIN') && file_exists($phpbb_root_path . 'install') && !is_file($phpbb_root_path . 'install'))
|
||||
{
|
||||
// Adjust the message slightly according to the permissions
|
||||
@@ -752,7 +752,7 @@ class user extends \phpbb\session
|
||||
}
|
||||
|
||||
/**
|
||||
* Funtion to make the user leave the NEWLY_REGISTERED system group.
|
||||
* Function to make the user leave the NEWLY_REGISTERED system group.
|
||||
* @access public
|
||||
*/
|
||||
function leave_newly_registered()
|
||||
|
||||
@@ -123,7 +123,7 @@ class user_loader
|
||||
/**
|
||||
* Get a user row from our users cache
|
||||
*
|
||||
* @param int $user_id User ID of the user you want to retreive
|
||||
* @param int $user_id User ID of the user you want to retrieve
|
||||
* @param bool $query Should we query the database if this user has not yet been loaded?
|
||||
* Typically this should be left as false and you should make sure
|
||||
* you load users ahead of time with load_users()
|
||||
@@ -150,7 +150,7 @@ class user_loader
|
||||
/**
|
||||
* Get username
|
||||
*
|
||||
* @param int $user_id User ID of the user you want to retreive the username for
|
||||
* @param int $user_id User ID of the user you want to retrieve the username for
|
||||
* @param string $mode The mode to load (same as get_username_string). One of the following:
|
||||
* profile (for getting an url to the profile)
|
||||
* username (for obtaining the username)
|
||||
@@ -204,7 +204,7 @@ class user_loader
|
||||
/**
|
||||
* Get rank
|
||||
*
|
||||
* @param int $user_id User ID of the user you want to retreive the rank for
|
||||
* @param int $user_id User ID of the user you want to retrieve the rank for
|
||||
* @param bool $query Should we query the database if this user has not yet been loaded?
|
||||
* Typically this should be left as false and you should make sure
|
||||
* you load users ahead of time with load_users()
|
||||
|
||||
Reference in New Issue
Block a user