mirror of
https://github.com/phpbb/phpbb.git
synced 2025-03-24 01:20:40 +01:00
Merge pull request #5020 from marc1706/ticket/15424
[ticket/15424] Multiple typo fixes in docs & comments
This commit is contained in:
Marc Alexander
commit
e157d8890b
@ -79,10 +79,10 @@ prosilver by subBlue Design, Tom Beddard, (c) 2004 phpBB Limited
|
||||
|
||||
phpBB contains code from the following applications:
|
||||
|
||||
LGPL licenced:
|
||||
LGPL licensed:
|
||||
Smarty (c) 2001, 2002 by ispi of Lincoln, Inc, http://smarty.php.net/
|
||||
|
||||
GPL licenced:
|
||||
GPL licensed:
|
||||
phpMyAdmin (c) 2001, 2003 phpMyAdmin Devel team, http://www.phpmyadmin.net/
|
||||
Jabber Class (c) 2006 Flyspray.org, http://www.flyspray.org/
|
||||
Chora (c) 2000-2006, The Horde Project. http://horde.org/chora/
|
||||
@ -96,6 +96,6 @@ Pear (c) 2001-2004 PHP Group, http://pear.php.net
|
||||
|
||||
Text_Diff-0.2.1 http://pear.php.net/package/Text_Diff
|
||||
|
||||
MIT licenced:
|
||||
MIT licensed:
|
||||
Symfony2 (c) 2004-2011 Fabien Potencier, https://symfony.com/
|
||||
Cookie Consent (c) 2015 Silktide Ltd, https://cookieconsent.insites.com
|
||||
|
||||
@ -1210,7 +1210,7 @@ parent = prosilver</pre>
|
||||
<td class="gensmall">TEST</td>
|
||||
</pre></div>
|
||||
|
||||
<p>Try to match text class types with existing useage, e.g. don't use the nav class where viewtopic uses gensmall for example.</p>
|
||||
<p>Try to match text class types with existing usage, e.g. don't use the nav class where viewtopic uses gensmall for example.</p>
|
||||
|
||||
<p>Row colours/classes are now defined by the template, use an <code>IF S_ROW_COUNT</code> switch, see viewtopic or viewforum for an example.</p>
|
||||
|
||||
@ -1222,7 +1222,7 @@ parent = prosilver</pre>
|
||||
|
||||
<p>The separate catXXXX and thXXX classes are gone. When defining a header cell just use <code><th></code> rather than <code><th class="thHead"></code> etc. Similarly for cat, don't use <code><td class="catLeft"></code> use <code><td class="cat"></code> etc.</p>
|
||||
|
||||
<p>Try to retain consistency of basic layout and class useage, i.e. _EXPLAIN text should generally be placed below the title it explains, e.g. <code>{L_POST_USERNAME}<br /><span class="gensmall">{L_POST_USERNAME_EXPLAIN}</span></code> is the typical way of handling this ... there may be exceptions and this isn't a hard and fast rule.</p>
|
||||
<p>Try to retain consistency of basic layout and class usage, i.e. _EXPLAIN text should generally be placed below the title it explains, e.g. <code>{L_POST_USERNAME}<br /><span class="gensmall">{L_POST_USERNAME_EXPLAIN}</span></code> is the typical way of handling this ... there may be exceptions and this isn't a hard and fast rule.</p>
|
||||
|
||||
<p>Try to keep template conditional and other statements tabbed in line with the block to which they refer.</p>
|
||||
|
||||
@ -1766,7 +1766,7 @@ This may span multiple lines.
|
||||
<p>The <a href="http://en.wikipedia.org/wiki/Universal_Character_Set">Universal Character Set (UCS)</a> described in ISO/IEC 10646 consists of a large amount of characters. Each of them has a unique name and a code point which is an integer number. <a href="http://en.wikipedia.org/wiki/Unicode">Unicode</a> - which is an industry standard - complements the Universal Character Set with further information about the characters' properties and alternative character encodings. More information on Unicode can be found on the <a href="http://www.unicode.org/">Unicode Consortium's website</a>. One of the Unicode encodings is the <a href="http://en.wikipedia.org/wiki/UTF-8">8-bit Unicode Transformation Format (UTF-8)</a>. It encodes characters with up to four bytes aiming for maximum compatibility with the <a href="http://en.wikipedia.org/wiki/ASCII">American Standard Code for Information Interchange</a> which is a 7-bit encoding of a relatively small subset of the UCS.</p>
|
||||
|
||||
<h4>phpBB's use of Unicode</h4>
|
||||
<p>Unfortunately PHP does not faciliate the use of Unicode prior to version 6. Most functions simply treat strings as sequences of bytes assuming that each character takes up exactly one byte. This behaviour still allows for storing UTF-8 encoded text in PHP strings but many operations on strings have unexpected results. To circumvent this problem we have created some alternative functions to PHP's native string operations which use code points instead of bytes. These functions can be found in <code>/includes/utf/utf_tools.php</code>. They are also covered in the <a href="http://area51.phpbb.com/docs/code/">phpBB3 Sourcecode Documentation</a>. A lot of native PHP functions still work with UTF-8 as long as you stick to certain restrictions. For example <code>explode</code> still works as long as the first and the last character of the delimiter string are ASCII characters.</p>
|
||||
<p>Unfortunately PHP does not facilitate the use of Unicode prior to version 6. Most functions simply treat strings as sequences of bytes assuming that each character takes up exactly one byte. This behaviour still allows for storing UTF-8 encoded text in PHP strings but many operations on strings have unexpected results. To circumvent this problem we have created some alternative functions to PHP's native string operations which use code points instead of bytes. These functions can be found in <code>/includes/utf/utf_tools.php</code>. They are also covered in the <a href="http://area51.phpbb.com/docs/code/">phpBB3 Sourcecode Documentation</a>. A lot of native PHP functions still work with UTF-8 as long as you stick to certain restrictions. For example <code>explode</code> still works as long as the first and the last character of the delimiter string are ASCII characters.</p>
|
||||
|
||||
<p>phpBB only uses the ASCII and the UTF-8 character encodings. Still all Strings are UTF-8 encoded because ASCII is a subset of UTF-8. The only exceptions to this rule are code sections which deal with external systems which use other encodings and character sets. Such external data should be converted to UTF-8 using the <code>utf8_recode()</code> function supplied with phpBB. It supports a variety of other character sets and encodings, a full list can be found below.</p>
|
||||
|
||||
@ -1847,7 +1847,7 @@ if (utf8_case_fold_nfc($string1) == utf8_case_fold_nfc($string2))
|
||||
|
||||
<p>The <abbr title="Internet Engineering Task Force">IETF</abbr> recently published <a href="http://tools.ietf.org/html/rfc4646">RFC 4646</a> for tags used to identify languages, which in combination with <a href="http://tools.ietf.org/html/rfc4647">RFC 4647</a> obseletes the older <a href="http://tools.ietf.org/html/rfc3066">RFC 3006</a> and older-still <a href="http://tools.ietf.org/html/rfc1766">RFC 1766</a>. <a href="http://tools.ietf.org/html/rfc4646">RFC 4646</a> uses <a href="http://www.loc.gov/standards/iso639-2/php/English_list.php">ISO 639-1/ISO 639-2</a>, <a href="http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html">ISO 3166-1 alpha-2</a>, <a href="http://www.unicode.org/iso15924/iso15924-codes.html">ISO 15924</a> and <a href="http://unstats.un.org/unsd/methods/m49/m49.htm">UN M.49</a> to define a language tag. Each complete tag is composed of subtags which are not case sensitive and can also be empty.</p>
|
||||
|
||||
<p>Ordering of the subtags in the case that they are all non-empty is: <code>language</code>-<code>script</code>-<code>region</code>-<code>variant</code>-<code>extension</code>-<code>privateuse</code>. Should any subtag be empty, its corresponding hyphen would also be ommited. Thus, the language tag for English will be <code>en</code> <strong>and not</strong> <code>en-----</code>.</p>
|
||||
<p>Ordering of the subtags in the case that they are all non-empty is: <code>language</code>-<code>script</code>-<code>region</code>-<code>variant</code>-<code>extension</code>-<code>privateuse</code>. Should any subtag be empty, its corresponding hyphen would also be omitted. Thus, the language tag for English will be <code>en</code> <strong>and not</strong> <code>en-----</code>.</p>
|
||||
|
||||
<p>Most language tags consist of a two- or three-letter language subtag (from <a href="http://www.loc.gov/standards/iso639-2/php/English_list.php">ISO 639-1/ISO 639-2</a>). Sometimes, this is followed by a two-letter or three-digit region subtag (from <a href="http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html">ISO 3166-1 alpha-2</a> or <a href="http://unstats.un.org/unsd/methods/m49/m49.htm">UN M.49</a>). Some examples are:</p>
|
||||
|
||||
@ -1901,7 +1901,7 @@ if (utf8_case_fold_nfc($string1) == utf8_case_fold_nfc($string2))
|
||||
|
||||
<p>The ultimate aim of a language tag is to convey the needed <strong>useful distingushing information</strong>, whilst keeping it as <strong>short as possible</strong>. So for example, use <code>en</code>, <code>fr</code> and <code>ja</code> as opposed to <code>en-GB</code>, <code>fr-FR</code> and <code>ja-JP</code>, since we know English, French and Japanese are the native language of Great Britain, France and Japan respectively.</p>
|
||||
|
||||
<p>Next is the <a href="http://www.unicode.org/iso15924/iso15924-codes.html">ISO 15924</a> language script code and when one should or shouldn't use it. For example, whilst <code>en-Latn</code> is syntaxically correct for describing English written with Latin script, real world English writing is <strong>more-or-less exclusively in the Latin script</strong>. For such languages like English that are written in a single script, the <a href="http://www.iana.org/assignments/language-subtag-registry"><abbr title="Internet Assigned Numbers Authority">IANA</abbr> Language Subtag Registry</a> has a "Suppress-Script" field meaning the script code <strong>should be ommitted</strong> unless a specific language tag requires a specific script code. Some languages are <strong>written in more than one script</strong> and in such cases, the script code <strong>is encouraged</strong> since an end-user may be able to read their language in one script, but not the other. Some examples are:</p>
|
||||
<p>Next is the <a href="http://www.unicode.org/iso15924/iso15924-codes.html">ISO 15924</a> language script code and when one should or shouldn't use it. For example, whilst <code>en-Latn</code> is syntaxically correct for describing English written with Latin script, real world English writing is <strong>more-or-less exclusively in the Latin script</strong>. For such languages like English that are written in a single script, the <a href="http://www.iana.org/assignments/language-subtag-registry"><abbr title="Internet Assigned Numbers Authority">IANA</abbr> Language Subtag Registry</a> has a "Suppress-Script" field meaning the script code <strong>should be omitted</strong> unless a specific language tag requires a specific script code. Some languages are <strong>written in more than one script</strong> and in such cases, the script code <strong>is encouraged</strong> since an end-user may be able to read their language in one script, but not the other. Some examples are:</p>
|
||||
|
||||
<table>
|
||||
<caption>Examples of using a language subtag in combination with a script subtag</caption>
|
||||
@ -1966,7 +1966,7 @@ if (utf8_case_fold_nfc($string1) == utf8_case_fold_nfc($string2))
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<p>Usage of the three-digit <a href="http://unstats.un.org/unsd/methods/m49/m49.htm">UN M.49</a> code over the two-letter <a href="http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html">ISO 3166-1 alpha-2</a> code should hapen if a macro-geographical entity is required and/or the <a href="http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html">ISO 3166-1 alpha-2</a> is ambiguous.</p>
|
||||
<p>Usage of the three-digit <a href="http://unstats.un.org/unsd/methods/m49/m49.htm">UN M.49</a> code over the two-letter <a href="http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html">ISO 3166-1 alpha-2</a> code should happen if a macro-geographical entity is required and/or the <a href="http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html">ISO 3166-1 alpha-2</a> is ambiguous.</p>
|
||||
|
||||
<p>Examples of English using marco-geographical regions:</p>
|
||||
|
||||
|
||||
@ -164,13 +164,13 @@ acp_group_options_before
|
||||
===
|
||||
* Location: adm/style/acp_groups.html
|
||||
* Since: 3.1.0-b4
|
||||
* Purpose: Add addtional options to group settings (before GROUP_FOUNDER_MANAGE)
|
||||
* Purpose: Add additional options to group settings (before GROUP_FOUNDER_MANAGE)
|
||||
|
||||
acp_group_options_after
|
||||
===
|
||||
* Location: adm/style/acp_groups.html
|
||||
* Since: 3.1.0-b4
|
||||
* Purpose: Add addtional options to group settings (after GROUP_RECEIVE_PM)
|
||||
* Purpose: Add additional options to group settings (after GROUP_RECEIVE_PM)
|
||||
|
||||
acp_groups_find_username_append
|
||||
===
|
||||
|
||||
@ -391,7 +391,7 @@ $lang = array_merge($lang, array(
|
||||
'DATABASE_SERVER_INFO' => 'Database server',
|
||||
'DATABASE_SIZE' => 'Database size',
|
||||
|
||||
// Enviroment configuration checks, mbstring related
|
||||
// Environment configuration checks, mbstring related
|
||||
'ERROR_MBSTRING_FUNC_OVERLOAD' => 'Function overloading is improperly configured',
|
||||
'ERROR_MBSTRING_FUNC_OVERLOAD_EXPLAIN' => '<var>mbstring.func_overload</var> must be set to either 0 or 4. You can check the current value on the <samp>PHP information</samp> page.',
|
||||
'ERROR_MBSTRING_ENCODING_TRANSLATION' => 'Transparent character encoding is improperly configured',
|
||||
|
||||
@ -481,7 +481,7 @@ $lang = array_merge($lang, array(
|
||||
'NOTIFICATION_TOPIC_IN_QUEUE' => '<strong>Topic approval</strong> request by %1$s:',
|
||||
'NOTIFICATION_TYPE_NOT_EXIST' => 'The notification type "%s" is missing from the file system.',
|
||||
'NOTIFICATION_ADMIN_ACTIVATE_USER' => '<strong>Activation required</strong> for deactivated or newly registered user: “%1$s”',
|
||||
// Used in conjuction with NOTIFICATION_BOOKMARK and NOTIFICATION_POST.
|
||||
// Used in conjunction with NOTIFICATION_BOOKMARK and NOTIFICATION_POST.
|
||||
'NOTIFICATION_MANY_OTHERS' => 'others',
|
||||
'NOTIFICATION_X_OTHERS' => array(
|
||||
2 => '%d others',
|
||||
|
||||
@ -219,7 +219,7 @@ $lang = array_merge($lang, array(
|
||||
'UPDATE_INCOMPLETE_MORE' => 'Please read the information below in order to fix this error.',
|
||||
'UPDATE_INCOMPLETE_EXPLAIN' => '<h1>Incomplete update</h1>
|
||||
|
||||
<p>We noticed that the last update of your phpBB installation hasn’t been completed. Visit the <a href="%1$s" title="%1$s">database updater</a>, ensure <em>Update database only</em> is selected and click on <strong>Submit</strong>. Don\'t forget to delete the "install"-directory after you have updated the database sucessfully.</p>',
|
||||
<p>We noticed that the last update of your phpBB installation hasn’t been completed. Visit the <a href="%1$s" title="%1$s">database updater</a>, ensure <em>Update database only</em> is selected and click on <strong>Submit</strong>. Don\'t forget to delete the "install"-directory after you have updated the database successfully.</p>',
|
||||
|
||||
//
|
||||
// Server data
|
||||
|
||||
@ -258,7 +258,7 @@ class oauth extends \phpbb\auth\provider\base
|
||||
$storage->set_user_id($row['user_id']);
|
||||
|
||||
/**
|
||||
* Event is triggered after user is successfuly logged in via OAuth.
|
||||
* Event is triggered after user is successfully logged in via OAuth.
|
||||
*
|
||||
* @event core.auth_oauth_login_after
|
||||
* @var array row User row
|
||||
|
||||
@ -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)
|
||||
|
||||
@ -664,7 +664,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,
|
||||
|
||||
@ -455,7 +455,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 or false
|
||||
* @throws \phpbb\db\migration\exception
|
||||
@ -513,7 +513,7 @@ class module implements \phpbb\db\migration\tool\tool_interface
|
||||
}
|
||||
else if (!empty($data) && !is_array($data))
|
||||
{
|
||||
// The module_langname is set, checking for the module existance
|
||||
// The module_langname is set, checking for the module existence
|
||||
// As more than 1 parents were found already, there's no way for null parent_id here
|
||||
$sql = 'SELECT m2.module_id as module_parent_id
|
||||
FROM ' . $this->modules_table . ' m1, ' . $this->modules_table . " m2
|
||||
|
||||
@ -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
|
||||
|
||||
@ -210,7 +210,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:
|
||||
*
|
||||
|
||||
@ -79,7 +79,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
|
||||
*/
|
||||
@ -236,7 +236,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
|
||||
|
||||
@ -181,7 +181,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
|
||||
@ -205,7 +205,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
|
||||
@ -397,7 +397,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()
|
||||
{
|
||||
|
||||
@ -339,7 +339,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()
|
||||
{
|
||||
|
||||
@ -252,7 +252,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
|
||||
@ -480,7 +480,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)
|
||||
@ -1333,7 +1333,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])
|
||||
@ -1392,7 +1392,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
|
||||
*
|
||||
|
||||
@ -38,7 +38,7 @@ interface adapter_interface
|
||||
*
|
||||
* @param string $path The file to read
|
||||
*
|
||||
* @throws \phpbb\storage\exception\exception When the file dont exists
|
||||
* @throws \phpbb\storage\exception\exception When the file doesn't exist
|
||||
* When cannot read file contents
|
||||
*
|
||||
* @return string Returns file contents
|
||||
|
||||
@ -89,7 +89,7 @@ class storage
|
||||
*
|
||||
* @param string $path The file to read
|
||||
*
|
||||
* @throws \phpbb\storage\exception\exception When the file dont exists
|
||||
* @throws \phpbb\storage\exception\exception When the file doesn't exist
|
||||
* When cannot read file contents
|
||||
*
|
||||
* @return string Returns file contents
|
||||
|
||||
@ -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
|
||||
|
||||
@ -324,7 +324,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
|
||||
@ -749,7 +749,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()
|
||||
|
||||
@ -121,7 +121,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()
|
||||
@ -148,7 +148,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)
|
||||
@ -202,7 +202,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()
|
||||
|
||||
@ -462,7 +462,7 @@ function parseDocument($container) {
|
||||
$linksLast = $linksNotSkip.filter(filterLast), // The items that will be hidden last
|
||||
persistent = $this.attr('id') === 'nav-main', // Does this list already have a menu (such as quick-links)?
|
||||
html = '<li class="responsive-menu hidden"><a href="javascript:void(0);" class="js-responsive-menu-link responsive-menu-link"><i class="icon fa-bars fa-fw" aria-hidden="true"></i></a><div class="dropdown"><div class="pointer"><div class="pointer-inner" /></div><ul class="dropdown-contents" /></div></li>',
|
||||
slack = 3; // Vertical slack space (in pixels). Determines how sensitive the script is in determining whether a line-break has occured.
|
||||
slack = 3; // Vertical slack space (in pixels). Determines how sensitive the script is in determining whether a line-break has occurred.
|
||||
|
||||
// Add a hidden drop-down menu to each links list (except those that already have one)
|
||||
if (!persistent) {
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
/* Global module setup
|
||||
---------------------------------------- */
|
||||
|
||||
/* Renamed version of .fa class for agnostic useage of icon fonts.
|
||||
/* Renamed version of .fa class for agnostic usage of icon fonts.
|
||||
* Just change the name of the font after the 14/1 to the name of
|
||||
* the font you wish to use.
|
||||
*/
|
||||
|
||||
@ -143,7 +143,7 @@ hr {
|
||||
float: right;
|
||||
}
|
||||
|
||||
/* Dont want to print url for names or titles in content area */
|
||||
/* Don't want to print url for names or titles in content area */
|
||||
.postbody .author a:link,
|
||||
.postbody .author a:visited,
|
||||
html > body .postbody .author a:link:after,
|
||||
|
||||
@ -52,7 +52,7 @@ By default all tests requiring a database connection will use sqlite. If you
|
||||
do not have sqlite installed the tests will be skipped. If you wish to run the
|
||||
tests on a different database you have to create a test_config.php file within
|
||||
your tests directory following the same format as phpBB's config.php. Testing
|
||||
makes use of a seperate database defined in this config file and before running
|
||||
makes use of a separate database defined in this config file and before running
|
||||
the tests each time this database is deleted. An example for mysqli can be
|
||||
found below. More information on configuration options can be found on the
|
||||
wiki (see below).
|
||||
|
||||
@ -239,7 +239,7 @@ class phpbb_extension_finder_test extends phpbb_test_case
|
||||
|
||||
/**
|
||||
* These do not work because of changes with PHPBB3-11386
|
||||
* They do not seem neccessary to me, so I am commenting them out for now
|
||||
* They do not seem necessary to me, so I am commenting them out for now
|
||||
public function test_get_classes_create_cache()
|
||||
{
|
||||
$cache = new phpbb_mock_cache;
|
||||
|
||||
@ -274,7 +274,7 @@ class phpbb_log_function_view_log_test extends phpbb_database_test_case
|
||||
// Offset that will be returned from the function
|
||||
'expected_returned' => 0,
|
||||
// view_log parameters (see includes/functions_admin.php for docblock)
|
||||
// $log is ommited!
|
||||
// $log is omitted!
|
||||
'mod', 5, 0, 12, 45,
|
||||
),
|
||||
*/
|
||||
|
||||
@ -33,7 +33,7 @@ class phpbb_mock_session_testable extends \phpbb\session
|
||||
* @param PHPUnit_Framework_Assert test The test from which this is called
|
||||
* @param array(string => mixed) cookies The cookie data to check against.
|
||||
* The keys are cookie names, the values can either be null to
|
||||
* check only the existance of the cookie, or an array(d, t),
|
||||
* check only the existence of the cookie, or an array(d, t),
|
||||
* where d is the cookie data to check, or null to skip the
|
||||
* check and t is the cookie time to check, or null to skip.
|
||||
*/
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user