phpBB Lead Developer: naderman (Nils Adermann)

phpBB Developers: bantu (Andreas Fischer)

dhruv.goel92 (Dhruv Goel)

imkingdavid (David King)

nickvergessen (Joas Schilling)

Contributions by: leviatan21 (Gabriel Vazquez)

Raimon (Raimon Meuldijk)

<ol>

<li><a href="#changelog">Changelog</a>

<ol style="list-style-type: lower-roman;">

<li><a href="#v310a1">Changes since 3.1.0-a1</a></li>

<li><a href="#v30x">Changes since 3.0.x</a></li>

<li><a href="#v3011">Changes since 3.0.11</a></li>

<div class="content">

<h4>Bug</h4>

<ul>

<li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-11998">PHPBB3-11998</a>] - Add console / command line client environment </li>

</ul>

<h4>Bug</h4>

<ul>

<li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-11913">PHPBB3-11913</a>] - Apply reorganisation of download.phpbb.com to build_announcement.php</li>

</ul>

<h4>Bug</h4>

<ul>

<li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-11753">PHPBB3-11753</a>] - Upgrade mysql_upgrader.php schema data.</li>

</ul>

<h4>Bug</h4>

<ul>

<li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-10909">PHPBB3-10909</a>] - Update Travis Test Configuration: Travis no longer supports PHP 5.3.2</li>

</ul>

<h4>Bug</h4>

<ul>

<li>[<a href="http://tracker.phpbb.com/browse/PHPBB3-10480">PHPBB3-10480</a>] - Automate changelog building</li>

</ul>

<h4> Bug

</h4>

</ul>

<h4> Security

</h4>

<ul>

</ul>

<ul>

<li>[Sec] Do not expose forum content of forums with ACL entries but no actual permission in ATOM Feeds. (Bug #58595)</li>

</ul>

<ul>

<li>[Fix] Allow ban reason and length to be selected and copied in ACP and subsilver2 MCP. (Bug #51095)</li>

</ul>

<ul>

<li>[Fix] Allow whitespaces in avatar gallery names. (Bug #44955)</li>

<li>[Feature] Send anonymous statistical information to phpBB on installation and update (optional).</li>

</ul>

<ul>

<li>[Fix] Delete user entry from ban list table upon user deletion (Bug #40015 - Patch by TerraFrost)</li>

<li>[Sec] Only use forum id supplied for posting if global announcement detected. (Reported by nickvergessen)</li>

</ul>

<ul>

<li>[Fix] Allow mixed-case template directories to be inherited (Bug #36725)</li>

<li>[Sec] Ask for forum password if post within passworded forum quoted in private message. (Reported by nickvergessen)</li>

</ul>

<ul>

<li>[Fix] Correctly set topic starter if first post in topic removed (Bug #30575 - Patch by blueray2048)</li>

<li>[Sec Precaution] Stricter validation of the HTTP_HOST header (Thanks to Techie-Micheal et al for pointing out possible issues in derived code)</li>

</ul>

<ul>

<li>[Fix] Ability to set permissions on non-mysql dbms (Bug #24955)</li>

<li>[Sec] Only allow urls gone through redirect() being used within login_box(). (thanks nookieman)</li>

</ul>

<ul>

<li>[Change] Validate birthdays (Bug #15004)</li>

<li>[Fix] Find and display colliding usernames correctly when converting from one database to another (Bug #23925)</li>

</ul>

<ul>

<li>[Fix] Cleaned usernames contain only single spaces, so &quot;a_name&quot; and &quot;a__name&quot; are treated as the same name (Bug #15634)</li>

<li>[Fix] Call garbage_collection() within database updater to correctly close connections (affects Oracle for example)</li>

</ul>

<ul>

<li>[Fix] Fixed MSSQL related bug in the update system</li>

<li>[Fix] No duplication of active topics (Bug #15474)</li>

</ul>

<ul>

<li>[Fix] Submitting language changes using acp_language (Bug #14736)</li>

<li>[Fix] Able to request new password (Bug #14743)</li>

</ul>

<ul>

<li>[Feature] Removing constant PHPBB_EMBEDDED in favor of using an exit_handler(); the constant was meant to achive this more or less.</li>

<li>[Sec] New password hashing mechanism for storing passwords (#i42)</li>

</ul>

<ul>

<li>[Fix] MySQL, PostgreSQL and SQLite related database fixes (Bug #13862)</li>

<li>[Fix] odbc_autocommit causing existing result sets to be dropped (Bug #14182)</li>

</ul>

<ul>

<li>[Fix] Fixing some subsilver2 and prosilver style issues</li>

</ul>

<ul>

<li>[Fix] Re-allow searching within the memberlist</li>

</ul>

<ul>

<li>[Fix] (X)HTML issues within the templates (Bug #11255, #11255)</li>

<ol style="list-style-type: lower-roman;">

<li><a href="#standardisation">Standardisation</a></li>

<li><a href="#otherconsiderations">Other considerations</a></li>

<li><a href="#writingstyle">Writing Style</a></li>

</ol>

</li>

<p>Tabs in front of lines are no problem, but having them within the text can be a problem if you do not set it to the amount of spaces every one of us uses. Here is a short example of how it should look like:</p>

<div class="codebox"><pre>

</pre></div>

<p>If entered with tabs (replace the {TAB}) both equal signs need to be on the same column.</p>

<ul>

<li><strong>phpBB3</strong><br />Core files and all files not assigned to a separate package</li>

<li><strong>acp</strong><br /><code>/adm</code>, <code>/includes/acp</code>, <code>/includes/functions_admin.php</code><br />Administration Control Panel</li>

<ul>

</ul>

</li>

<li><strong>diff</strong><br /><code>/includes/diff</code><br />Diff Engine</li>

<li><strong>images</strong><br /><code>/images</code><br />All global images not connected to styles</li>

<li><strong>install</strong><br /><code>/install</code><br />Installation System</li>

<li><strong>language</strong><br /><code>/language</code><br />All language files</li>

<li><strong>VC</strong><br /><code>/includes/captcha</code><br />CAPTCHA</li>

<li><strong>mcp</strong><br /><code>mcp.php</code>, <code>/includes/mcp</code>, <code>report.php</code><br />Moderator Control Panel</li>

<li><strong>ucp</strong><br /><code>ucp.php</code>, <code>/includes/ucp</code><br />User Control Panel</li>

<li><strong>utf</strong><br /><code>/includes/utf</code><br />UTF8-related functions/classes</li>

</ul>

<a name="constants"></a><h3>1.iv. Special Constants</h3>

<p>If the <code>PHPBB_USE_BOARD_URL_PATH</code> constant is set to true, phpBB uses generate_board_url() (this will return the boards url with the script path included) on all instances where web-accessible images are loaded. The exact locations are:</p>

<ul>

<li>/includes/functions_content.php - smiley_text()</li>

</ul>

<li>{T_THEME_PATH} - styles/xxx/theme</li>

<li>{T_TEMPLATE_PATH} - styles/xxx/template</li>

<li>{T_SUPER_TEMPLATE_PATH} - styles/xxx/template</li>

<li>{T_IMAGES_PATH} - images/</li>

<li>{T_SMILIES_PATH} - $config['smilies_path']/</li>

<li>{T_AVATAR_PATH} - $config['avatar_path']/</li>

<li>{T_ICONS_PATH} - $config['icons_path']/</li>

<li>{T_RANKS_PATH} - $config['ranks_path']/</li>

<li>{T_UPLOAD_PATH} - $config['upload_path']/</li>

<li>New template variable {BOARD_URL} for the board url + script path.</li>

</ul>

</pre></div>

<h4>Function Names:</h4>

<h4>Function Arguments:</h4>

<p>Arguments are subject to the same guidelines as variable names. We don't want a bunch of functions like: <code>do_stuff($a, $b, $c)</code>. In most cases, we'd like to be able to tell how to use a function by just looking at its declaration. </p>

<p>Apart from following the rules for function names, all classes should meet the following conditions:</p>

<ul>

<li>Every class must be defined in a separate file.</li>

<li>Directories should typically be a singular noun (e.g. <code>dir</code> in the example below, not <code>dirs</code>.</li>

</ul>

<p>So given the following example directory structure you would result in the below listed lookups</p>

<div class="codebox"><pre>

class_name.php

dir/

class_name.php

subdir/

class_name.php

</pre></div>

<div class="codebox"><pre>

</pre></div>

<h4>Summary:</h4>

<h4>Special Namings: </h4>

<p>For all emoticons use the term <code>smiley</code> in singular and <code>smilies</code> in plural. For emails we use the term <code>email</code> (without dash between “e” and “m”).</p>

<p>No attempt should be made to remove any copyright information (either contained within the source or displayed interactively when the source is run/compiled), neither should the copyright information be altered in any way (it may be added to).</p>

<h4>Variables: </h4>

<p class="bad">// Old method, do not use it</p>

<div class="codebox"><pre>

<p class="good">// Use request var and define a default variable (use the correct type)</p>

<div class="codebox"><pre>

</pre></div>

<div class="codebox"><pre>

</pre></div>

<p class="good">// Getting an array, keys are integers, value defaults to 0</p>

<div class="codebox"><pre>

</pre></div>

<p class="good">// Getting an array, keys are strings, value defaults to 0</p>

<div class="codebox"><pre>

</pre></div>

<h4>Login checks/redirection: </h4>

<p>The <strong>e</strong> modifier in <strong>preg_replace</strong> can be replaced by <strong>preg_replace_callback</strong> and objects to encapsulate state that is needed in the callback code.</p>

</div>

<div class="back2top"><a href="#wrap" class="top">Back to Top</a></div>

<div class="codebox"><pre>

# General Information about this style

name = prosilver_duplicate

# Defining a different template bitfield

# template_bitfield = lNg=

<div class="codebox"><pre>

# General Information about this style

name = Custom Style

# Defining a different template bitfield

# template_bitfield = lNg=

<ul>

<li>An event name must be all lowercase, with each word separated by an underscore.</li>

<li>An event name must briefly describe the location and purpose of the event.</li>

</ul>

<h4>Template event documentation</h4>

* Location: styles/&lt;style_name&gt;/template/filename.html

* Purpose: A brief description of what this event should be used for.

This may span multiple lines.

</pre></div></li>

<li>An event found in multiple template files:

<div class="codebox"><pre>event_name

+ first/file/path.html

+ second/file/path.html

* Purpose: Same as above.

</pre></div>

<li>An event that is found multiple times in a file should have the number of instances in parenthesis next to the filename.

<div class="codebox"><pre>event_name

+ first/file/path.html (2)

+ second/file/path.html

* Purpose: Same as above.

</pre></div></li>

<li>An actual example event documentation:

<div class="codebox"><pre>forumlist_body_last_post_title_prepend

* Locations:

+ styles/prosilver/template/forumlist_body.html

+ styles/subsilver2/template/forumlist_body.html

</div>

<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>

<div class="codebox"><pre>

// an input string containing a multibyte character

$_REQUEST['multibyte_string'] = 'K&#228;se';

// print request variable as a UTF-8 string allowing multibyte characters

// print request variable as ASCII string

</pre></div>

<p>This code snippet will generate the following output:</p>

K??se

</pre></div>

<h4>Case Folding</h4>

<p>Case insensitive comparison of strings is no longer possible with <code>strtolower</code> or <code>strtoupper</code> as some characters have multiple lower case or multiple upper case forms depending on their position in a word. The <code>utf8_strtolower</code> and the <code>utf8_strtoupper</code> functions suffer from the same problem so they can only be used to display upper/lower case versions of a string but they cannot be used for case insensitive comparisons either. So instead you should use case folding which gives you a case insensitive version of the string which can be used for case insensitive comparisons. An NFC normalized string can be case folded using <code>utf8_case_fold_nfc()</code>.</p>

<p>Within some cases, there may be mixed scripts of a left-to-right and right-to-left direction, so using <code>LRE</code> &amp; <code>RLE</code> with <code>PDF</code> may be more appropriate. Lastly, in very rare instances where directionality must be forced, then use <code>LRO</code> &amp; <code>RLO</code> with <code>PDF</code>.</p>

<p>For further information on authoring techniques of bi-directional text, please see the W3C tutorial on <a href="http://www.w3.org/International/tutorials/bidi-xhtml/">authoring techniques for XHTML pages with bi-directional text</a>.</p>

<p>As phpBB is translated into languages with different ordering rules to that of English, it is possible to show specific values in any order deemed appropriate. Take for example the extremely simple &quot;Page <em>X</em> of <em>Y</em>&quot;, whilst in English this could just be coded as:</p>

...

</pre></div>

<h4>Miscellaneous tips &amp; hints:</h4>

* Since: 3.1.0-a1

* Purpose: Add content below the footer in the ACP

acp_overall_header_head_append

===

* Location: adm/style/overall_header.html

* Since: 3.1.0-a1

* Purpose: Add content below the simple footer in the ACP

acp_simple_header_head_append

===

* Since: 3.1.0-a1

* Purpose: Add assets within the `<head>` tags in the simple header of the ACP

acp_users_overview_options_append

===

* Since: 3.1.0-a1

* Purpose: Add options and settings on user overview page

acp_users_signature_editor_buttons_after

===

* Locations:

* Since: 3.1.0-a3

* Purpose: Add content before BBCode posting buttons in the ACP user signature

forumlist_body_last_post_title_prepend

* Locations:

+ styles/prosilver/template/forumlist_body.html

+ styles/subsilver2/template/forumlist_body.html

* Since: 3.1.0-a1

* Purpose: Add content before the post title of the latest post in a forum on the forum list.

index_body_linklist_after

===

* Locations:

* Since: 3.1.0-a3

* Purpose: Add content before the linklist above the forum list on Board index

index_body_stat_blocks_before

===

* Locations:

* Purpose: Add information before every username in the memberlist. Works in

all display modes (leader, group and normal memberlist).

memberlist_view_user_statistics_after

===

* Locations:

overall_footer_breadcrumb_append

===

* Locations:

* Since: 3.1.0-a1

* Purpose: Add links to the list of breadcrumbs in the footer

* Since: 3.1.0-a1

* Purpose: Add content before the copyright line

===

* Locations:

+ styles/prosilver/template/overall_header.html

+ styles/subsilver2/template/breadcrumbs.html

* Since: 3.1.0-a1

* Purpose: Add links to the list of breadcrumbs in the header

overall_header_navigation_append

===

* Locations:

* Since: 3.1.0-a1

* Purpose: Add links after the navigation links in the header

overall_header_navigation_prepend

===

* Locations:

* Since: 3.1.0-a1

* Purpose: Add links before the navigation links in the header

posting_editor_buttons_after

===

* Locations:

* Since: 3.1.0-a2

* Purpose: Add field (e.g. textbox) to the posting screen before the subject

simple_footer_after

===

* Locations:

+ styles/prosilver/template/simple_footer.html

* Since: 3.1.0-a1

* Purpose: Add content directly prior to the `</body>` tag of the simple footer

topiclist_row_prepend

===

* Locations:

* Since: 3.1.0-a1

* Purpose: Add content into topic rows (inside the elements containing topic titles)

ucp_pm_viewmessage_custom_fields_after

===

* Locations:

===

* Locations:

+ styles/prosilver/template/ucp_pm_viewmessage_print.html

* Since: 3.1.0-a1

* Purpose: Add asset calls directly before the `</head>` tag of the Print PM screen

* Purpose: Add options to the bottom of the drop-down lists block of the Edit

Display Options screen

viewtopic_print_head_append

===

* Locations:

+ styles/prosilver/template/viewtopic_print.html

* Since: 3.1.0-a1

* Purpose: Add asset calls directly before the `</head>` tag of the Print Topic screen

* Purpose: Add data before the custom fields on the user profile when viewing

a post

viewtopic_topic_title_prepend

===

* Locations:

sql_attr_bool = deleted

sql_attr_timestamp = post_time

sql_attr_timestamp = topic_last_post_time

}

source source_phpbb_{SPHINX_ID}_delta : source_phpbb_{SPHINX_ID}_main

{