</li>

<li><a href="#code">Code Layout/Guidelines</a>

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

<li><a href="#codelayout">Code Layout</a></li>

<li><a href="#sql">SQL/SQL Layout</a></li>

<li><a href="#optimizing">Optimizations</a></li>

<li><a href="#general">General Guidelines</a></li>

</ol>

</li>

<li><a href="#styling">Styling</a>

<li><a href="#vcs">VCS Guidelines</a>

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

<li><a href="#repostruct">Repository structure</a></li>

</ol>

</li>

<li><a href="#changes">Guidelines Changelog</a></li>

<h3>Linefeeds:</h3>

<p>Ensure that your editor is saving files in the UNIX (LF) line ending format. This means that lines are terminated with a newline, not with Windows Line endings (CR/LF combo) as they are on Win32 or Classic Mac (CR) Line endings. Any decent editor should be able to do this, but it might not always be the default setting. Know your editor. If you want advice for an editor for your Operating System, just ask one of the developers. Some of them do their editing on Win32.</p>

<h4>Standard header for new files:</h4>

<p>This template of the header must be included at the start of all phpBB files: </p>

<p>Please see the <a href="#locations">File Locations section</a> for the correct package name.</p>

<h4>Files containing inline code:</h4>

<p>For those files you have to put an empty comment directly after the header to prevent the documentor assigning the header to the first code element found.</p>

<p>Please note that these guidelines apply to all php, html, javascript and css files.</p>

<p>We will not be using any form of hungarian notation in our naming conventions. Many of us believe that hungarian naming is one of the primary code obfuscation techniques currently in use.</p>

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

<h4>Summary:</h4>

<p>The basic philosophy here is to not hurt code clarity for the sake of laziness. This has to be balanced by a little bit of common sense, though; <code>print_login_status_for_a_given_user()</code> goes too far, for example -- that function would be better named <code>print_user_login_status()</code>, or just <code>print_login_status()</code>.</p>

<p>In SQL Statements mixing single and double quotes is partly allowed (following the guidelines listed here about SQL Formatting), else it should be tryed to only use one method - mostly single quotes.</p>

<h4>Associative array keys:</h4>

<p>In PHP, it's legal to use a literal string as a key to an associative array without quoting that string. We don't want to do this -- the string should always be quoted to avoid confusion. Note that this is only when we're using a literal, not when we're using a variable, examples:</p>

}

</pre></div>

<a name="sql"></a><h3>2.iii. SQL/SQL Layout</h3>

<h4>Common SQL Guidelines: </h4>

<p>Your page should either call <code>page_footer()</code> in the end to trigger output through the template engine and terminate the script, or alternatively at least call the <code>exit_handler()</code>. That call is necessary because it provides a method for external applications embedding phpBB to be called at the end of the script.</p>

</div>

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

<div class="content">

<a name="repostruct"></a><h3>7.i. Repository Structure</h3>

<ul>

<ul>

</ul>

</li>

<ul>

</ul>

</li>

</ul>

</div>