* GNU General Public License for more details.

*

* You should have received a copy of the GNU General Public License

*

*/

<ol>

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

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

<li><a href="#v308">Changes since 3.0.8</a></li>

<li><a href="#v307-PL1">Changes since 3.0.7-PL1</a></li>

<li><a href="#v307">Changes since 3.0.7</a></li>

<div class="content">

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

<div class="content">

</div>

<div class="content">

<p>If you have a problem with a given board please take it up with them, not us. We are not and cannot be held legally responsible for any third party use of this software (much like Microsoft et al cannot be held responsible for the use of Windows in illegal activities, etc.). Additionally we do <strong>not</strong> track the use of phpBB software in any way. So please do not ask us for details on a &quot;given&quot; board we will not be able to help you. If any law firms or lawyers out there send us writs, cease and desist orders, etc. for third party website use of this software we reserve the right to charge for time wasted dealing with such issues...</p>

<div class="content">

</div>

<li><a href="#webserver_configuration">Webserver configuration</a></li>

</ol>

</li>

</ol>

</div>

<p>This package is meant for those wanting to only replace changed files from a previous version to the latest version. This package normally contains the changed files from up to five previous versions.</p>

<p>The directory structure has been preserved enabling you (if you wish) to simply upload the contents of the archive to the appropriate location on your server, i.e. simply overwrite the existing files with the new versions. Do not forget that if you have installed any MODs these files will overwrite the originals possibly destroying them in the process. You will need to re-add MODs to any affected file before uploading.</p>

<p>The patch file is one solution for those with many Modifications (MODs) or other changes who do not want to re-add them back to all the changed files if they use the method explained above. To use this you will need command line access to a standard UNIX type <strong>patch</strong> application. If you do not have access to such an application but still want to use this update approach, we strongly recommend the <a href="#update_auto">Automatic update package</a> explained below. It is also the recommended update method.</p>

<p>If you do get failures you should look at using the <a href="#update_files">Changed files only</a> package to replace the files which failed to patch, please note that you will need to manually re-add any Modifications (MODs) to these particular files. Alternatively if you know how you can examine the .rej files to determine what failed where and make manual adjustments to the relevant source.</p>

<div class="content">

</div>

<p>The relevant database type/version is listed within the administration control panel</p>

<p>Once a bug has been submitted you will be emailed any follow up comments added to it. <strong>Please</strong> if you are requested to supply additional information, do so! It is frustrating for us to receive bug reports, ask for additional information but get nothing. In these cases we have a policy of closing the bug, which may leave a very real problem in place. Obviously we would rather not have this situation arise.</p>

<div class="content">

</div>

<div class="content">

</div>

<head>

<meta charset="utf-8">

<meta name="keywords" content="" />

<title>phpBB3 &bull; Coding Guidelines</title>

<link href="stylesheet.css" rel="stylesheet" type="text/css" media="screen, projection" />

<div id="doc-description">

<a href="../index.php" id="logo"><img src="site_logo.gif" alt="" /></a>

<h1>Coding Guidelines</h1>

<p style="display: none;"><a href="#start_here">Skip</a></p>

</div>

<!-- BEGIN DOCUMENT -->

<h1>Coding Guidelines</h1>

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

</ol>

</li>

<li><a href="#disclaimer">Copyright and disclaimer</a></li>

</ol>

/**

*

* @package {PACKAGENAME}

* @copyright (c) 2007 phpBB Group

*

*/

</pre></div>

$post_url = $phpbb_root_path . 'posting.' . $phpEx . '?mode=' . $mode . '&amp;amp;start=' . $start;

</pre></div>

<div class="codebox"><pre>

$post_url = "{$phpbb_root_path}posting.$phpEx?mode=$mode&amp;amp;start=$start";

</pre></div>

<h4>Commas after every array element:</h4>

<p>If an array is defined with each element on its own line, you still have to modify the previous line to add a comma when appending a new element. PHP allows for trailing (useless) commas in array definitions. These should always be used so each element including the comma can be appended with a single line</p>

<p>Each complex function should be preceded by a comment that tells a programmer everything they need to know to use that function. The meaning of every parameter, the expected input, and the output are required as a minimal comment. The function's behaviour in error conditions (and what those error conditions are) should also be present - but mostly included within the comment about the output.<br /><br />Especially important to document are any assumptions the code makes, or preconditions for its proper operation. Any one of the developers should be able to look at any part of the application and figure out what's going on in a reasonable amount of time.<br /><br />Avoid using <code>/* */</code> comment blocks for one-line comments, <code>//</code> should be used for one/two-liners.</p>

<h4>Magic numbers:</h4>

<h4>Shortcut operators:</h4>

<p>The only shortcut operators that cause readability problems are the shortcut increment <code>$i++</code> and decrement <code>$j--</code> operators. These operators should not be used as part of an expression. They can, however, be used on their own line. Using them in expressions is just not worth the headaches when debugging, examples:</p>

</pre></div>

<h4>SQL Quotes: </h4>

<p class="bad">// These are wrong.</p>

<div class="codebox"><pre>

<h4>sql_build_query():</h4>

<div class="codebox"><pre>

$sql_array = array(

</pre></div>

<h4>Use of in_array(): </h4>

<a name="general"></a><h3>2.v. General Guidelines</h3>

<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>The request_var function determines the type to set from the second parameter (which determines the default value too). If you need to get a scalar variable type, you need to tell this the request_var function explicitly. Examples:</p>

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

<p>The <code>$user-&gt;setup()</code> call can be used to pass on additional language definition and a custom style (used in viewforum).</p>

<h4>Errors and messages: </h4>

<div class="codebox"><pre>

trigger_error('NO_FORUM');

<p>All urls pointing to internal files need to be prepended by the <code>$phpbb_root_path</code> variable. Within the administration control panel all urls pointing to internal files need to be prepended by the <code>$phpbb_admin_path</code> variable. This makes sure the path is always correct and users being able to just rename the admin folder and the acp still working as intended (though some links will fail and the code need to be slightly adjusted).</p>

<div class="codebox"><pre>

append_sid(&quot;{$phpbb_root_path}memberlist.$phpEx&quot;, 'mode=group&amp;amp;g=' . $row['group_id'])

<h4>General function usage: </h4>

<ul>

<li>

required_imageset = prosilver

</pre></div>

<a name="genstyling"></a><h3>3.2. General Styling Rules</h3>

<p>The outer table class <code>forumline</code> has gone and is replaced with <code>tablebg</code>.</p>

<p>When writing <code>&lt;table&gt;</code> the order <code>&lt;table class="" cellspacing="" cellpadding="" border="" align=""&gt;</code> creates consistency and allows everyone to easily see which table produces which "look". The same applies to most other tags for which additional parameters can be set, consistency is the major aim here.</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>

<p>Use a standard cellpadding of 2 and cellspacing of 0 on outer tables. Inner tables can vary from 0 to 3 or even 4 depending on the need.</p>

<a name="templates"></a><h3>4.i. General Templating</h3>

<h4>File naming</h4>

<h4>Variables</h4>

<p>All template variables should be named appropriately (using underscores for spaces), language entries should be prefixed with L_, system data with S_, urls with U_, javascript urls with UA_, language to be put in javascript statements with LA_, all other variables should be presented 'as is'.</p>

</p>

<h4>Blocks/Loops</h4>

<span class="comment">&lt;!-- END l_block1 --&gt;</span>

</pre></div>

<div class="codebox"><pre>

<span class="comment">&lt;!-- BEGIN l_block1 --&gt;</span>

&lt;/ul&gt; <span class="comment">&lt;!-- written on third iteration --&gt;</span>

</pre></div>

<h4>Forms</h4>

<p>If a form is used for a non-trivial operation (i.e. more than a jumpbox), then it should include the <code>{S_FORM_TOKEN}</code> template variable.</p>

</pre></div><br />

<a name="inheritance"></a><h3>4.ii. Template Inheritance</h3>

<p>We strongly encourage the use of inheritance for styles based on the bundled styles, as it will ease the update procedure.</p>

<h4>Encoding:</h4>

<p>The impact is that the language files for phpBB must now also be encoded as UTF-8, with a caveat that the files must <strong>not contain</strong> a <abbr title="Byte-Order-Mark">BOM</abbr> for compatibility reasons with non-Unicode aware versions of PHP. For those with forums using the Latin character set (ie: most European languages), this change is transparent since UTF-8 is superset to US-ASCII and ISO-8859-1.</p>

<hr />

<div class="paragraph">

<div class="inner"><span class="corners-top"><span></span></span>

<div class="content">

</div>

<div class="content">

</div>