|
 |
d6e8d8 |
|
|
|
d6e8d8 |
<html xmlns="http://www.w3.org/1999/xhtml" dir="ltr" lang="en" xml:lang="en">
|
|
|
d6e8d8 |
<head>
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
|
|
d6e8d8 |
<meta http-equiv="content-style-type" content="text/css" />
|
|
|
d6e8d8 |
<meta http-equiv="content-language" content="en" />
|
|
|
d6e8d8 |
<meta http-equiv="imagetoolbar" content="no" />
|
|
|
d6e8d8 |
<meta name="resource-type" content="document" />
|
|
|
d6e8d8 |
<meta name="distribution" content="global" />
|
|
|
d6e8d8 |
<meta name="copyright" content="2007 phpBB Group" />
|
|
|
d6e8d8 |
<meta name="keywords" content="" />
|
|
|
d6e8d8 |
<meta name="description" content="Olympus coding guidelines document" />
|
|
|
d6e8d8 |
<title>phpBB3 • Coding Guidelines</title>
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
<link href="stylesheet.css" rel="stylesheet" type="text/css" media="screen, projection" />
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
</head>
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
<body id="phpbb" class="section-docs">
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Coding Guidelines
|
|
|
d6e8d8 |
Olympus coding guidelines document
|
|
|
d6e8d8 |
Skip
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
These are the phpBB Coding Guidelines for Olympus, all attempts should be made to follow them as closely as possible.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Coding Guidelines
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Defaults
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Editor Settings
|
|
|
d6e8d8 |
File Header
|
|
|
d6e8d8 |
File Locations
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Code Layout/Guidelines
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Variable/Function Naming
|
|
|
d6e8d8 |
Code Layout
|
|
|
d6e8d8 |
SQL/SQL Layout
|
|
|
d6e8d8 |
Optimizations
|
|
|
d6e8d8 |
General Guidelines
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Styling
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Style Config Files
|
|
|
d6e8d8 |
General Styling Rules
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Templating
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
General Templating
|
|
|
d6e8d8 |
Template Inheritance
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Character Sets and Encodings
|
|
|
d6e8d8 |
Translation (i18n/L10n) Guidelines
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Standardisation
|
|
|
d6e8d8 |
Other considerations
|
|
|
d6e8d8 |
Writing Style
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Guidelines Changelog
|
|
|
d6e8d8 |
Copyright and disclaimer
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
1. Defaults
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
1.i. Editor Settings
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Tabs vs Spaces:
|
|
|
d6e8d8 |
In order to make this as simple as possible, we will be using tabs, not spaces. We enforce 4 (four) spaces for one tab - therefore you need to set your tab width within your editor to 4 spaces. Make sure that when you save the file, it's saving tabs and not spaces. This way, we can each have the code be displayed the way we like it, without breaking the layout of the actual files.
|
|
|
d6e8d8 |
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:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
{TAB}$mode{TAB}{TAB}= request_var('mode', '');
|
|
|
d6e8d8 |
{TAB}$search_id{TAB}= request_var('search_id', '');
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
If entered with tabs (replace the {TAB}) both equal signs need to be on the same column.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Linefeeds:
|
|
|
d6e8d8 |
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.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
1.ii. File Header
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Standard header for new files:
|
|
|
d6e8d8 |
This template of the header must be included at the start of all phpBB files:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
/**
|
|
|
d6e8d8 |
*
|
|
|
d6e8d8 |
* @package {PACKAGENAME}
|
|
|
d6e8d8 |
* @version $Id: $
|
|
|
d6e8d8 |
* @copyright (c) 2007 phpBB Group
|
|
|
d6e8d8 |
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
|
|
|
d6e8d8 |
*
|
|
|
d6e8d8 |
*/
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Please see the File Locations section for the correct package name.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Files containing inline code:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
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.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
/**
|
|
|
d6e8d8 |
* {HEADER}
|
|
|
d6e8d8 |
*/
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
/**
|
|
|
d6e8d8 |
*/
|
|
|
d6e8d8 |
{CODE}
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Files containing only functions:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Do not forget to comment the functions (especially the first function following the header). Each function should have at least a comment of what this function does. For more complex functions it is recommended to document the parameters too.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Files containing only classes:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Do not forget to comment the class. Classes need a separate @package definition, it is the same as the header package name. Apart from this special case the above statement for files containing only functions needs to be applied to classes and it's methods too.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Code following the header but only functions/classes file:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
If this case is true, the best method to avoid documentation confusions is adding an ignore command, for example:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
/**
|
|
|
d6e8d8 |
* {HEADER}
|
|
|
d6e8d8 |
*/
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
/**
|
|
|
d6e8d8 |
* @ignore
|
|
|
d6e8d8 |
*/
|
|
|
d6e8d8 |
Small code snipped, mostly one or two defines or an if statement
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
/**
|
|
|
d6e8d8 |
* {DOCUMENTATION}
|
|
|
d6e8d8 |
*/
|
|
|
d6e8d8 |
class ...
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
1.iii. File Locations
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Functions used by more than one page should be placed in functions.php, functions specific to one page should be placed on that page (at the bottom) or within the relevant sections functions file. Some files in /includes are holding functions responsible for special sections, for example uploading files, displaying "things", user related functions and so forth.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
The following packages are defined, and related new features/functions should be placed within the mentioned files/locations, as well as specifying the correct package name. The package names are bold within this list:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
phpBB3
Core files and all files not assigned to a separate package
|
|
|
d6e8d8 |
acm
/includes/acm, /includes/cache.php
Cache System
|
|
|
d6e8d8 |
acp
/adm, /includes/acp, /includes/functions_admin.php
Administration Control Panel
|
|
|
d6e8d8 |
dbal
/includes/db
Database Abstraction Layer.
Base class is dbal
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
/includes/db/dbal.php
Base DBAL class, defining the overall framework
|
|
|
d6e8d8 |
/includes/db/firebird.php
Firebird/Interbase Database Abstraction Layer
|
|
|
d6e8d8 |
/includes/db/msssql.php
MSSQL Database Abstraction Layer
|
|
|
d6e8d8 |
/includes/db/mssql_odbc.php
MSSQL ODBC Database Abstraction Layer for MSSQL
|
|
|
d6e8d8 |
/includes/db/mysql.php
MySQL Database Abstraction Layer for MySQL 3.x/4.0.x/4.1.x/5.x
|
|
|
d6e8d8 |
/includes/db/mysqli.php
MySQLi Database Abstraction Layer
|
|
|
d6e8d8 |
/includes/db/oracle.php
Oracle Database Abstraction Layer
|
|
|
d6e8d8 |
/includes/db/postgres.php
PostgreSQL Database Abstraction Layer
|
|
|
d6e8d8 |
/includes/db/sqlite.php
Sqlite Database Abstraction Layer
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
diff
/includes/diff
Diff Engine
|
|
|
d6e8d8 |
docs
/docs
phpBB Documentation
|
|
|
d6e8d8 |
images
/images
All global images not connected to styles
|
|
|
d6e8d8 |
install
/install
Installation System
|
|
|
d6e8d8 |
language
/language
All language files
|
|
|
d6e8d8 |
login
/includes/auth
Login Authentication Plugins
|
|
|
d6e8d8 |
VC
/includes/captcha
CAPTCHA
|
|
|
d6e8d8 |
mcp
mcp.php, /includes/mcp, report.php
Moderator Control Panel
|
|
|
d6e8d8 |
ucp
ucp.php, /includes/ucp
User Control Panel
|
|
|
d6e8d8 |
utf
/includes/utf
UTF8-related functions/classes
|
|
|
d6e8d8 |
search
/includes/search, search.php
Search System
|
|
|
d6e8d8 |
styles
/styles, style.php
phpBB Styles/Templates/Themes/Imagesets
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
2. Code Layout/Guidelines
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Please note that these Guidelines applies to all php, html, javascript and css files.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
2.i. Variable/Function Naming
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
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.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Variable Names:
|
|
|
d6e8d8 |
Variable names should be in all lowercase, with words separated by an underscore, example:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$current_user is right, but $currentuser and $currentUser are not.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Names should be descriptive, but concise. We don't want huge sentences as our variable names, but typing an extra couple of characters is always better than wondering what exactly a certain variable is for.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Loop Indices:
|
|
|
d6e8d8 |
The only situation where a one-character variable name is allowed is when it's the index for some looping construct. In this case, the index of the outer loop should always be $i. If there's a loop inside that loop, its index should be $j, followed by $k, and so on. If the loop is being indexed by some already-existing variable with a meaningful name, this guideline does not apply, example:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
for ($i = 0; $i < $outer_size; $i++)
|
|
|
d6e8d8 |
{
|
|
|
d6e8d8 |
for ($j = 0; $j < $inner_size; $j++)
|
|
|
d6e8d8 |
{
|
|
|
d6e8d8 |
foo($i, $j);
|
|
|
d6e8d8 |
}
|
|
|
d6e8d8 |
}
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Function Names:
|
|
|
d6e8d8 |
Functions should also be named descriptively. We're not programming in C here, we don't want to write functions called things like "stristr()". Again, all lower-case names with words separated by a single underscore character. Function names should preferably have a verb in them somewhere. Good function names are print_login_status(), get_user_data(), etc.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Function Arguments:
|
|
|
d6e8d8 |
Arguments are subject to the same guidelines as variable names. We don't want a bunch of functions like: do_stuff($a, $b, $c). In most cases, we'd like to be able to tell how to use a function by just looking at its declaration.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Summary:
|
|
|
d6e8d8 |
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; print_login_status_for_a_given_user() goes too far, for example -- that function would be better named print_user_login_status(), or just print_login_status().
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Special Namings:
|
|
|
d6e8d8 |
For all emoticons use the term smiley in singular and smilies in plural.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
2.ii. Code Layout
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Always include the braces:
|
|
|
d6e8d8 |
This is another case of being too lazy to type 2 extra characters causing problems with code clarity. Even if the body of some construct is only one line long, do not drop the braces. Just don't, examples:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// These are all wrong.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
if (condition) do_stuff();
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
if (condition)
|
|
|
d6e8d8 |
do_stuff();
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
while (condition)
|
|
|
d6e8d8 |
do_stuff();
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
for ($i = 0; $i < size; $i++)
|
|
|
d6e8d8 |
do_stuff($i);
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// These are all right.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
if (condition)
|
|
|
d6e8d8 |
{
|
|
|
d6e8d8 |
do_stuff();
|
|
|
d6e8d8 |
}
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
while (condition)
|
|
|
d6e8d8 |
{
|
|
|
d6e8d8 |
do_stuff();
|
|
|
d6e8d8 |
}
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
for ($i = 0; $i < size; $i++)
|
|
|
d6e8d8 |
{
|
|
|
d6e8d8 |
do_stuff();
|
|
|
d6e8d8 |
}
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Where to put the braces:
|
|
|
d6e8d8 |
This one is a bit of a holy war, but we're going to use a style that can be summed up in one sentence: Braces always go on their own line. The closing brace should also always be at the same column as the corresponding opening brace, examples:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
if (condition)
|
|
|
d6e8d8 |
{
|
|
|
d6e8d8 |
while (condition2)
|
|
|
d6e8d8 |
{
|
|
|
d6e8d8 |
...
|
|
|
d6e8d8 |
}
|
|
|
d6e8d8 |
}
|
|
|
d6e8d8 |
else
|
|
|
d6e8d8 |
{
|
|
|
d6e8d8 |
...
|
|
|
d6e8d8 |
}
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
for ($i = 0; $i < $size; $i++)
|
|
|
d6e8d8 |
{
|
|
|
d6e8d8 |
...
|
|
|
d6e8d8 |
}
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
while (condition)
|
|
|
d6e8d8 |
{
|
|
|
d6e8d8 |
...
|
|
|
d6e8d8 |
}
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
function do_stuff()
|
|
|
d6e8d8 |
{
|
|
|
d6e8d8 |
...
|
|
|
d6e8d8 |
}
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Use spaces between tokens:
|
|
|
d6e8d8 |
This is another simple, easy step that helps keep code readable without much effort. Whenever you write an assignment, expression, etc.. Always leave one space between the tokens. Basically, write code as if it was English. Put spaces between variable names and operators. Don't put spaces just after an opening bracket or before a closing bracket. Don't put spaces just before a comma or a semicolon. This is best shown with a few examples, examples:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// Each pair shows the wrong way followed by the right way.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$i=0;
|
|
|
d6e8d8 |
$i = 0;
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
if($i<7) ...
|
|
|
d6e8d8 |
if ($i < 7) ...
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
if ( ($i < 7)&&($j > 8) ) ...
|
|
|
d6e8d8 |
if ($i < 7 && $j > 8) ...
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
do_stuff( $i, 'foo', $b );
|
|
|
d6e8d8 |
do_stuff($i, 'foo', $b);
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
for($i=0; $i<$size; $i++) ...
|
|
|
d6e8d8 |
for ($i = 0; $i < $size; $i++) ...
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$i=($j < $size)?0:1;
|
|
|
d6e8d8 |
$i = ($j < $size) ? 0 : 1;
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Operator precedence:
|
|
|
d6e8d8 |
Do you know the exact precedence of all the operators in PHP? Neither do I. Don't guess. Always make it obvious by using brackets to force the precedence of an equation so you know what it does. Remember to not over-use this, as it may harden the readability. Basically, do not enclose single expressions. Examples:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// what's the result? who knows.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$bool = ($i < 7 && $j > 8 || $k == 4);
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// now you can be certain what I'm doing here.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$bool = (($i < 7) && (($j < 8) || ($k == 4)));
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// But this one is even better, because it is easier on the eye but the intention is preserved
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$bool = ($i < 7 && ($j < 8 || $k == 4));
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Quoting strings:
|
|
|
d6e8d8 |
There are two different ways to quote strings in PHP - either with single quotes or with double quotes. The main difference is that the parser does variable interpolation in double-quoted strings, but not in single quoted strings. Because of this, you should always use single quotes unless you specifically need variable interpolation to be done on that string. This way, we can save the parser the trouble of parsing a bunch of strings where no interpolation needs to be done.
|
|
|
d6e8d8 |
Also, if you are using a string variable as part of a function call, you do not need to enclose that variable in quotes. Again, this will just make unnecessary work for the parser. Note, however, that nearly all of the escape sequences that exist for double-quoted strings will not work with single-quoted strings. Be careful, and feel free to break this guideline if it's making your code easier to read, examples:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// wrong
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$str = "This is a really long string with no variables for the parser to find.";
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
do_stuff("$str");
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// right
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$str = 'This is a really long string with no variables for the parser to find.';
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
do_stuff($str);
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// Sometimes single quotes are just not right
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$post_url = $phpbb_root_path . 'posting.' . $phpEx . '?mode=' . $mode . '&start=' . $start;
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// Double quotes are sometimes needed to not overcroud the line with concentinations
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$post_url = "{$phpbb_root_path}posting.$phpEx?mode=$mode&start=$start";
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
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.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Associative array keys:
|
|
|
d6e8d8 |
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:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// wrong
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$foo = $assoc_array[blah];
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// right
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$foo = $assoc_array['blah'];
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// wrong
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$foo = $assoc_array["$var"];
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// right
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$foo = $assoc_array[$var];
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Comments:
|
|
|
d6e8d8 |
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.
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.
Avoid using /* */ comment blocks for one-line comments, // should be used for one/two-liners.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Magic numbers:
|
|
|
d6e8d8 |
Don't use them. Use named constants for any literal value other than obvious special cases. Basically, it's ok to check if an array has 0 elements by using the literal 0. It's not ok to assign some special meaning to a number and then use it everywhere as a literal. This hurts readability AND maintainability. The constants true and false should be used in place of the literals 1 and 0 -- even though they have the same values (but not type!), it's more obvious what the actual logic is when you use the named constants. Typecast variables where it is needed, do not rely on the correct variable type (PHP is currently very loose on typecasting which can lead to security problems if a developer does not have a very close eye to it).
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Shortcut operators:
|
|
|
d6e8d8 |
The only shortcut operators that cause readability problems are the shortcut increment $i++ and decrement $j-- 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:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// wrong
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$array[++$i] = $j;
|
|
|
d6e8d8 |
$array[$i++] = $k;
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// right
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$i++;
|
|
|
d6e8d8 |
$array[$i] = $j;
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$array[$i] = $k;
|
|
|
d6e8d8 |
$i++;
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Inline conditionals:
|
|
|
d6e8d8 |
Inline conditionals should only be used to do very simple things. Preferably, they will only be used to do assignments, and not for function calls or anything complex at all. They can be harmful to readability if used incorrectly, so don't fall in love with saving typing by using them, examples:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// Bad place to use them
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
($i < $size && $j > $size) ? do_stuff($foo) : do_stuff($bar);
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// OK place to use them
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$min = ($i < $j) ? $i : $j;
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Don't use uninitialized variables.
|
|
|
d6e8d8 |
For phpBB3, we intend to use a higher level of run-time error reporting. This will mean that the use of an uninitialized variable will be reported as a warning. These warnings can be avoided by using the built-in isset() function to check whether a variable has been set - but preferably the variable is always existing. For checking if an array has a key set this can come in handy though, examples:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// Wrong
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
if ($forum) ...
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// Right
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
if (isset($forum)) ...
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// Also possible
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
if (isset($forum) && $forum == 5)
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
The empty() function is useful if you want to check if a variable is not set or being empty (an empty string, 0 as an integer or string, NULL, false, an empty array or a variable declared, but without a value in a class). Therefore empty should be used in favor of isset($array) && sizeof($array) > 0 - this can be written in a shorter way as !empty($array).
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Switch statements:
|
|
|
d6e8d8 |
Switch/case code blocks can get a bit long sometimes. To have some level of notice and being in-line with the opening/closing brace requirement (where they are on the same line for better readability), this also applies to switch/case code blocks and the breaks. An example:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// Wrong
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
switch ($mode)
|
|
|
d6e8d8 |
{
|
|
|
d6e8d8 |
case 'mode1':
|
|
|
d6e8d8 |
// I am doing something here
|
|
|
d6e8d8 |
break;
|
|
|
d6e8d8 |
case 'mode2':
|
|
|
d6e8d8 |
// I am doing something completely different here
|
|
|
d6e8d8 |
break;
|
|
|
d6e8d8 |
}
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// Good
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
switch ($mode)
|
|
|
d6e8d8 |
{
|
|
|
d6e8d8 |
case 'mode1':
|
|
|
d6e8d8 |
// I am doing something here
|
|
|
d6e8d8 |
break;
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
case 'mode2':
|
|
|
d6e8d8 |
// I am doing something completely different here
|
|
|
d6e8d8 |
break;
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
default:
|
|
|
d6e8d8 |
// Always assume that a case was not caught
|
|
|
d6e8d8 |
break;
|
|
|
d6e8d8 |
}
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// Also good, if you have more code between the case and the break
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
switch ($mode)
|
|
|
d6e8d8 |
{
|
|
|
d6e8d8 |
case 'mode1':
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// I am doing something here
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
break;
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
case 'mode2':
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// I am doing something completely different here
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
break;
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
default:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// Always assume that a case was not caught
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
break;
|
|
|
d6e8d8 |
}
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Even if the break for the default case is not needed, it is sometimes better to include it just for readability and completeness.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
If no break is intended, please add a comment instead. An example:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// Example with no break
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
switch ($mode)
|
|
|
d6e8d8 |
{
|
|
|
d6e8d8 |
case 'mode1':
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// I am doing something here
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// no break here
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
case 'mode2':
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// I am doing something completely different here
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
break;
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
default:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// Always assume that a case was not caught
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
break;
|
|
|
d6e8d8 |
}
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
2.iii. SQL/SQL Layout
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Common SQL Guidelines:
|
|
|
d6e8d8 |
All SQL should be cross-DB compatible, if DB specific SQL is used alternatives must be provided which work on all supported DB's (MySQL3/4/5, MSSQL (7.0 and 2000), PostgreSQL (7.0+), Firebird, SQLite, Oracle8, ODBC (generalised if possible)).
|
|
|
d6e8d8 |
All SQL commands should utilise the DataBase Abstraction Layer (DBAL)
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
SQL code layout:
|
|
|
d6e8d8 |
SQL Statements are often unreadable without some formatting, since they tend to be big at times. Though the formatting of sql statements adds a lot to the readability of code. SQL statements should be formatted in the following way, basically writing keywords:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$sql = 'SELECT *
|
|
|
d6e8d8 |
<-one tab->FROM ' . SOME_TABLE . '
|
|
|
d6e8d8 |
<-one tab->WHERE a = 1
|
|
|
d6e8d8 |
<-two tabs->AND (b = 2
|
|
|
d6e8d8 |
<-three tabs->OR b = 3)
|
|
|
d6e8d8 |
<-one tab->ORDER BY b';
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Here the example with the tabs applied:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$sql = 'SELECT *
|
|
|
d6e8d8 |
FROM ' . SOME_TABLE . '
|
|
|
d6e8d8 |
WHERE a = 1
|
|
|
d6e8d8 |
AND (b = 2
|
|
|
d6e8d8 |
OR b = 3)
|
|
|
d6e8d8 |
ORDER BY b';
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
SQL Quotes:
|
|
|
d6e8d8 |
Double quotes where applicable (The variables in these examples are typecasted to integers before) ... examples:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// These are wrong.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
"UPDATE " . SOME_TABLE . " SET something = something_else WHERE a = $b";
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
'UPDATE ' . SOME_TABLE . ' SET something = ' . $user_id . ' WHERE a = ' . $something;
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// These are right.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
'UPDATE ' . SOME_TABLE . " SET something = something_else WHERE a = $b";
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
'UPDATE ' . SOME_TABLE . " SET something = $user_id WHERE a = $something";
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
In other words use single quotes where no variable substitution is required or where the variable involved shouldn't appear within double quotes. Otherwise use double quotes.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Avoid DB specific SQL:
|
|
|
d6e8d8 |
The "not equals operator", as defined by the SQL:2003 standard, is "<>"
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// This is wrong.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$sql = 'SELECT *
|
|
|
d6e8d8 |
FROM ' . SOME_TABLE . '
|
|
|
d6e8d8 |
WHERE a != 2';
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// This is right.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$sql = 'SELECT *
|
|
|
d6e8d8 |
FROM ' . SOME_TABLE . '
|
|
|
d6e8d8 |
WHERE a <> 2';
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Common DBAL methods:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
sql_escape():
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Always use $db->sql_escape() if you need to check for a string within an SQL statement (even if you are sure the variable cannot contain single quotes - never trust your input), for example:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$sql = 'SELECT *
|
|
|
d6e8d8 |
FROM ' . SOME_TABLE . "
|
|
|
d6e8d8 |
WHERE username = '" . $db->sql_escape($username) . "'";
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
sql_query_limit():
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
We do not add limit statements to the sql query, but instead use $db->sql_query_limit(). You basically pass the query, the total number of lines to retrieve and the offset.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Note: Since Oracle handles limits differently and because of how we implemented this handling you need to take special care if you use sql_query_limit with an sql query retrieving data from more than one table.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Make sure when using something like "SELECT x.*, y.jars" that there is not a column named jars in x; make sure that there is no overlap between an implicit column and the explicit columns.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
sql_build_array():
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
If you need to UPDATE or INSERT data, make use of the $db->sql_build_array() function. This function already escapes strings and checks other types, so there is no need to do this here. The data to be inserted should go into an array - $sql_ary - or directly within the statement if one or two variables needs to be inserted/updated. An example of an insert statement would be:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$sql_ary = array(
|
|
|
d6e8d8 |
'somedata' => $my_string,
|
|
|
d6e8d8 |
'otherdata' => $an_int,
|
|
|
d6e8d8 |
'moredata' => $another_int
|
|
|
d6e8d8 |
);
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$db->sql_query('INSERT INTO ' . SOME_TABLE . ' ' . $db->sql_build_array('INSERT', $sql_ary));
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
To complete the example, this is how an update statement would look like:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$sql_ary = array(
|
|
|
d6e8d8 |
'somedata' => $my_string,
|
|
|
d6e8d8 |
'otherdata' => $an_int,
|
|
|
d6e8d8 |
'moredata' => $another_int
|
|
|
d6e8d8 |
);
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$sql = 'UPDATE ' . SOME_TABLE . '
|
|
|
d6e8d8 |
SET ' . $db->sql_build_array('UPDATE', $sql_ary) . '
|
|
|
d6e8d8 |
WHERE user_id = ' . (int) $user_id;
|
|
|
d6e8d8 |
$db->sql_query($sql);
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
The $db->sql_build_array() function supports the following modes: INSERT (example above), INSERT_SELECT (building query for INSERT INTO table (...) SELECT value, column ... statements), UPDATE (example above) and SELECT (for building WHERE statement [AND logic]).
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
sql_multi_insert():
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
If you want to insert multiple statements at once, please use the separate sql_multi_insert() method. An example:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$sql_ary = array();
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$sql_ary[] = array(
|
|
|
d6e8d8 |
'somedata' => $my_string_1,
|
|
|
d6e8d8 |
'otherdata' => $an_int_1,
|
|
|
d6e8d8 |
'moredata' => $another_int_1,
|
|
|
d6e8d8 |
);
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$sql_ary[] = array(
|
|
|
d6e8d8 |
'somedata' => $my_string_2,
|
|
|
d6e8d8 |
'otherdata' => $an_int_2,
|
|
|
d6e8d8 |
'moredata' => $another_int_2,
|
|
|
d6e8d8 |
);
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$db->sql_multi_insert(SOME_TABLE, $sql_ary);
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
sql_in_set():
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
The $db->sql_in_set() function should be used for building IN () and NOT IN () constructs. Since (specifically) MySQL tend to be faster if for one value to be compared the = and <> operator is used, we let the DBAL decide what to do. A typical example of doing a positive match against a number of values would be:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$sql = 'SELECT *
|
|
|
d6e8d8 |
FROM ' . FORUMS_TABLE . '
|
|
|
d6e8d8 |
WHERE ' . $db->sql_in_set('forum_id', $forum_ids);
|
|
|
d6e8d8 |
$db->sql_query($sql);
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Based on the number of values in $forum_ids, the query can look differently.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// SQL Statement if $forum_ids = array(1, 2, 3);
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
SELECT FROM phpbb_forums WHERE forum_id IN (1, 2, 3)
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// SQL Statement if $forum_ids = array(1) or $forum_ids = 1
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
SELECT FROM phpbb_forums WHERE forum_id = 1
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Of course the same is possible for doing a negative match against a number of values:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$sql = 'SELECT *
|
|
|
d6e8d8 |
FROM ' . FORUMS_TABLE . '
|
|
|
d6e8d8 |
WHERE ' . $db->sql_in_set('forum_id', $forum_ids, true);
|
|
|
d6e8d8 |
$db->sql_query($sql);
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Based on the number of values in $forum_ids, the query can look differently here too.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// SQL Statement if $forum_ids = array(1, 2, 3);
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
SELECT FROM phpbb_forums WHERE forum_id NOT IN (1, 2, 3)
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// SQL Statement if $forum_ids = array(1) or $forum_ids = 1
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
SELECT FROM phpbb_forums WHERE forum_id <> 1
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
If the given array is empty, an error will be produced.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
sql_build_query():
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
The $db->sql_build_query() function is responsible for building sql statements for select and select distinct queries if you need to JOIN on more than one table or retrieving data from more than one table while doing a JOIN. This needs to be used to make sure the resulting statement is working on all supported db's. Instead of explaining every possible combination, i will give a short example:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$sql_array = array(
|
|
|
d6e8d8 |
'SELECT' => 'f.*, ft.mark_time',
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
'FROM' => array(
|
|
|
d6e8d8 |
FORUMS_WATCH_TABLE => 'fw',
|
|
|
d6e8d8 |
FORUMS_TABLE => 'f'
|
|
|
d6e8d8 |
),
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
'LEFT_JOIN' => array(
|
|
|
d6e8d8 |
array(
|
|
|
d6e8d8 |
'FROM' => array(FORUMS_TRACK_TABLE => 'ft'),
|
|
|
d6e8d8 |
'ON' => 'ft.user_id = ' . $user->data['user_id'] . ' AND ft.forum_id = f.forum_id'
|
|
|
d6e8d8 |
)
|
|
|
d6e8d8 |
),
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
'WHERE' => 'fw.user_id = ' . $user->data['user_id'] . '
|
|
|
d6e8d8 |
AND f.forum_id = fw.forum_id',
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
'ORDER_BY' => 'left_id'
|
|
|
d6e8d8 |
);
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$sql = $db->sql_build_query('SELECT', $sql_array);
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
The possible first parameter for sql_build_query() is SELECT or SELECT_DISTINCT. As you can see, the logic is pretty self-explaining. For the LEFT_JOIN key, just add another array if you want to join on to tables for example. The added benefit of using this construct is that you are able to easily build the query statement based on conditions - for example the above LEFT_JOIN is only necessary if server side topic tracking is enabled; a slight adjustement would be:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$sql_array = array(
|
|
|
d6e8d8 |
'SELECT' => 'f.*',
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
'FROM' => array(
|
|
|
d6e8d8 |
FORUMS_WATCH_TABLE => 'fw',
|
|
|
d6e8d8 |
FORUMS_TABLE => 'f'
|
|
|
d6e8d8 |
),
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
'WHERE' => 'fw.user_id = ' . $user->data['user_id'] . '
|
|
|
d6e8d8 |
AND f.forum_id = fw.forum_id',
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
'ORDER_BY' => 'left_id'
|
|
|
d6e8d8 |
);
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
if ($config['load_db_lastread'])
|
|
|
d6e8d8 |
{
|
|
|
d6e8d8 |
$sql_array['LEFT_JOIN'] = array(
|
|
|
d6e8d8 |
array(
|
|
|
d6e8d8 |
'FROM' => array(FORUMS_TRACK_TABLE => 'ft'),
|
|
|
d6e8d8 |
'ON' => 'ft.user_id = ' . $user->data['user_id'] . ' AND ft.forum_id = f.forum_id'
|
|
|
d6e8d8 |
)
|
|
|
d6e8d8 |
);
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$sql_array['SELECT'] .= ', ft.mark_time ';
|
|
|
d6e8d8 |
}
|
|
|
d6e8d8 |
else
|
|
|
d6e8d8 |
{
|
|
|
d6e8d8 |
// Here we read the cookie data
|
|
|
d6e8d8 |
}
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$sql = $db->sql_build_query('SELECT', $sql_array);
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
2.iv. Optimizations
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Operations in loop definition:
|
|
|
d6e8d8 |
Always try to optimize your loops if operations are going on at the comparing part, since this part is executed every time the loop is parsed through. For assignments a descriptive name should be chosen. Example:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// On every iteration the sizeof function is called
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
for ($i = 0; $i < sizeof($post_data); $i++)
|
|
|
d6e8d8 |
{
|
|
|
d6e8d8 |
do_something();
|
|
|
d6e8d8 |
}
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// You are able to assign the (not changing) result within the loop itself
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
for ($i = 0, $size = sizeof($post_data); $i < $size; $i++)
|
|
|
d6e8d8 |
{
|
|
|
d6e8d8 |
do_something();
|
|
|
d6e8d8 |
}
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Use of in_array():
|
|
|
d6e8d8 |
Try to avoid using in_array() on huge arrays, and try to not place them into loops if the array to check consist of more than 20 entries. in_array() can be very time consuming and uses a lot of cpu processing time. For little checks it is not noticable, but if checked against a huge array within a loop those checks alone can be a bunch of seconds. If you need this functionality, try using isset() on the arrays keys instead, actually shifting the values into keys and vice versa. A call to isset($array[$var]) is a lot faster than in_array($var, array_keys($array)) for example.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
2.v. General Guidelines
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
General things:
|
|
|
d6e8d8 |
Never trust user input (this also applies to server variables as well as cookies).
|
|
|
d6e8d8 |
Try to sanitize values returned from a function.
|
|
|
d6e8d8 |
Try to sanitize given function variables within your function.
|
|
|
d6e8d8 |
The auth class should be used for all authorisation checking.
|
|
|
d6e8d8 |
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).
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Variables:
|
|
|
d6e8d8 |
Make use of the request_var() function for anything except for submit or single checking params.
|
|
|
d6e8d8 |
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:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// Old method, do not use it
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$start = (isset($HTTP_GET_VARS['start'])) ? intval($HTTP_GET_VARS['start']) : intval($HTTP_POST_VARS['start']);
|
|
|
d6e8d8 |
$submit = (isset($HTTP_POST_VARS['submit'])) ? true : false;
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// Use request var and define a default variable (use the correct type)
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$start = request_var('start', 0);
|
|
|
d6e8d8 |
$submit = (isset($_POST['submit'])) ? true : false;
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// $start is an int, the following use of request_var therefore is not allowed
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$start = request_var('start', '0');
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// Getting an array, keys are integers, value defaults to 0
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$mark_array = request_var('mark', array(0));
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
// Getting an array, keys are strings, value defaults to 0
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$action_ary = request_var('action', array('' => 0));
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Login checks/redirection:
|
|
|
d6e8d8 |
To show a forum login box use login_forum_box($forum_data), else use the login_box() function.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
The login_box() function can have a redirect as the first parameter. As a thumb of rule, specify an empty string if you want to redirect to the users current location, else do not add the $SID to the redirect string (for example within the ucp/login we redirect to the board index because else the user would be redirected to the login screen).
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Sensitive Operations:
|
|
|
d6e8d8 |
For sensitive operations always let the user confirm the action. For the confirmation screens, make use of the confirm_box() function.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Altering Operations:
|
|
|
d6e8d8 |
For operations altering the state of the database, for instance posting, always verify the form token, unless you are already using confirm_box(). To do so, make use of the add_form_key() and check_form_key() functions.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
add_form_key('my_form');
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
if ($submit)
|
|
|
d6e8d8 |
{
|
|
|
d6e8d8 |
if (!check_form_key('my_form'))
|
|
|
d6e8d8 |
{
|
|
|
d6e8d8 |
trigger_error('FORM_INVALID');
|
|
|
d6e8d8 |
}
|
|
|
d6e8d8 |
}
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
The string passed to add_form_key() needs to match the string passed to check_form_key(). Another requirement for this to work correctly is that all forms include the {S_FORM_TOKEN} template variable.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Sessions:
|
|
|
d6e8d8 |
Sessions should be initiated on each page, as near the top as possible using the following code:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
$user->session_begin();
|
|
|
d6e8d8 |
$auth->acl($user->data);
|
|
|
d6e8d8 |
$user->setup();
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
The $user->setup() call can be used to pass on additional language definition and a custom style (used in viewforum).
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Errors and messages:
|
|
|
d6e8d8 |
All messages/errors should be outputed by calling trigger_error() using the appropriate message type and language string. Example:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
trigger_error('NO_FORUM');
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
trigger_error($user->lang['NO_FORUM']);
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
trigger_error('NO_MODE', E_USER_ERROR);
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Url formatting
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
All urls pointing to internal files need to be prepended by the $phpbb_root_path variable. Within the administration control panel all urls pointing to internal files need to be prepended by the $phpbb_admin_path 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).
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
The append_sid() function from 2.0.x is available too, though does not handle url alterations automatically. Please have a look at the code documentation if you want to get more details on how to use append_sid(). A sample call to append_sid() can look like this:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
append_sid("{$phpbb_root_path}memberlist.$phpEx", 'mode=group&g=' . $row['group_id'])
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
General function usage:
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Some of these functions are only chosen over others because of personal preference and having no other benefit than to be consistant over the code.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Use sizeof instead of count
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Use strpos instead of strstr
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Use else if instead of elseif
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Use false (lowercase) instead of FALSE
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Use true (lowercase) instead of TRUE
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Exiting
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
Your page should either call page_footer() in the end to trigger output through the template engine and terminate the script, or alternatively at least call the exit_handler(). That call is necessary because it provides a method for external applications embedding phpBB to be called at the end of the script.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
3. Styling
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
3.i. Style Config Files
|
|
|
d6e8d8 |
Style cfg files are simple name-value lists with the information necessary for installing a style. Similar cfg files exist for templates, themes and imagesets. These follow the same principle and will not be introduced individually. Styles can use installed components by using the required_theme/required_template/required_imageset entries. The important part of the style configuration file is assigning an unique name.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
# General Information about this style
|
|
|
d6e8d8 |
name = prosilver_duplicate
|
|
|
d6e8d8 |
copyright = © phpBB Group, 2007
|
|
|
d6e8d8 |
version = 3.0.3
|
|
|
d6e8d8 |
required_template = prosilver
|
|
|
d6e8d8 |
required_theme = prosilver
|
|
|
d6e8d8 |
required_imageset = prosilver
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
3.2. General Styling Rules
|
|
|
d6e8d8 |
Templates should be produced in a consistent manner. Where appropriate they should be based off an existing copy, e.g. index, viewforum or viewtopic (the combination of which implement a range of conditional and variable forms). Please also note that the intendation and coding guidelines also apply to templates where possible.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
The outer table class forumline has gone and is replaced with tablebg.
|
|
|
d6e8d8 |
When writing <table> the order <table class="" cellspacing="" cellpadding="" border="" align=""> 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.
|
|
|
d6e8d8 |
Each block level element should be indented by one tab, same for tabular elements, e.g. <tr> <td> etc., whereby the intendiation of <table> and the following/ending <tr> should be on the same line. This applies not to div elements of course.
|
|
|
d6e8d8 |
Don't use <span> more than is essential ... the CSS is such that text sizes are dependent on the parent class. So writing <span class="gensmall"><span class="gensmall">TEST</span></span> will result in very very small text. Similarly don't use span at all if another element can contain the class definition, e.g.
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
|
|
|
d6e8d8 |
<td><span class="gensmall">TEST</span></td>
|