diff options
| author | David M <davidmj@users.sourceforge.net> | 2007-02-20 04:46:07 +0000 |
|---|---|---|
| committer | David M <davidmj@users.sourceforge.net> | 2007-02-20 04:46:07 +0000 |
| commit | 66b18be324deca4d392ee51f8b73a6d65b75eacc (patch) | |
| tree | bc2a5913ee29ebc38ca7f85725d69efb29b748ce /phpBB/docs/coding-guidelines.html | |
| parent | e8e47bac0c6cb775b12a6393631f38b9e5962b1d (diff) | |
| download | forums-66b18be324deca4d392ee51f8b73a6d65b75eacc.tar forums-66b18be324deca4d392ee51f8b73a6d65b75eacc.tar.gz forums-66b18be324deca4d392ee51f8b73a6d65b75eacc.tar.bz2 forums-66b18be324deca4d392ee51f8b73a6d65b75eacc.tar.xz forums-66b18be324deca4d392ee51f8b73a6d65b75eacc.zip | |
#8148
git-svn-id: file:///svn/phpbb/trunk@7020 89ea8834-ac86-4346-8a33-228a782c2dd0
Diffstat (limited to 'phpBB/docs/coding-guidelines.html')
| -rw-r--r-- | phpBB/docs/coding-guidelines.html | 60 |
1 files changed, 30 insertions, 30 deletions
diff --git a/phpBB/docs/coding-guidelines.html b/phpBB/docs/coding-guidelines.html index 63d83a7c20..7e949d2d90 100644 --- a/phpBB/docs/coding-guidelines.html +++ b/phpBB/docs/coding-guidelines.html @@ -598,7 +598,7 @@ if (isset($forum)) ... if (isset($forum) && $forum == 5) </pre></blockquote> - <p>The <code>empty()</code> 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 <code>isset($array) && sizeof($array) > 0</code> - this can be written in a shorter way as <code>!empty($array)</code>.</p> + <p>The <code>empty()</code> 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 <code>isset($array) && sizeof($array) > 0</code> - this can be written in a shorter way as <code>!empty($array)</code>.</p> <h3>Switch statements:</h3> <p>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:</p> @@ -769,9 +769,9 @@ $sql = 'SELECT * <blockquote><pre> $sql_ary = array( - 'somedata' => $my_string, - 'otherdata' => $an_int, - 'moredata' => $another_int + 'somedata' => $my_string, + 'otherdata' => $an_int, + 'moredata' => $another_int ); $db->sql_query('INSERT INTO ' . SOME_TABLE . ' ' . $db->sql_build_array('INSERT', $sql_ary)); @@ -781,9 +781,9 @@ $db->sql_query('INSERT INTO ' . SOME_TABLE . ' ' . $db->sql_build_array('I <blockquote><pre> $sql_ary = array( - 'somedata' => $my_string, - 'otherdata' => $an_int, - 'moredata' => $another_int + 'somedata' => $my_string, + 'otherdata' => $an_int, + 'moredata' => $another_int ); $sql = 'UPDATE ' . SOME_TABLE . ' @@ -850,24 +850,24 @@ SELECT FROM phpbb_forums WHERE forum_id <strong><></strong> 1 <blockquote><pre> $sql_array = array( - 'SELECT' => 'f.*, ft.mark_time', + 'SELECT' => 'f.*, ft.mark_time', - 'FROM' => array( - FORUMS_WATCH_TABLE => 'fw', - FORUMS_TABLE => 'f' + 'FROM' => array( + FORUMS_WATCH_TABLE => 'fw', + FORUMS_TABLE => 'f' ), - 'LEFT_JOIN' => array( + 'LEFT_JOIN' => array( array( - 'FROM' => array(FORUMS_TRACK_TABLE => 'ft'), - 'ON' => 'ft.user_id = ' . $user->data['user_id'] . ' AND ft.forum_id = f.forum_id' + 'FROM' => array(FORUMS_TRACK_TABLE => 'ft'), + 'ON' => 'ft.user_id = ' . $user->data['user_id'] . ' AND ft.forum_id = f.forum_id' ) ), - 'WHERE' => 'fw.user_id = ' . $user->data['user_id'] . ' + 'WHERE' => 'fw.user_id = ' . $user->data['user_id'] . ' AND f.forum_id = fw.forum_id', - 'ORDER_BY' => 'left_id' + 'ORDER_BY' => 'left_id' ); $sql = $db->sql_build_query('SELECT', $sql_array); @@ -877,25 +877,25 @@ $sql = $db->sql_build_query('SELECT', $sql_array); <blockquote><pre> $sql_array = array( - 'SELECT' => 'f.*', + 'SELECT' => 'f.*', - 'FROM' => array( - FORUMS_WATCH_TABLE => 'fw', - FORUMS_TABLE => 'f' + 'FROM' => array( + FORUMS_WATCH_TABLE => 'fw', + FORUMS_TABLE => 'f' ), - 'WHERE' => 'fw.user_id = ' . $user->data['user_id'] . ' + 'WHERE' => 'fw.user_id = ' . $user->data['user_id'] . ' AND f.forum_id = fw.forum_id', - 'ORDER_BY' => 'left_id' + 'ORDER_BY' => 'left_id' ); if ($config['load_db_lastread']) { $sql_array['LEFT_JOIN'] = array( array( - 'FROM' => array(FORUMS_TRACK_TABLE => 'ft'), - 'ON' => 'ft.user_id = ' . $user->data['user_id'] . ' AND ft.forum_id = f.forum_id' + 'FROM' => array(FORUMS_TRACK_TABLE => 'ft'), + 'ON' => 'ft.user_id = ' . $user->data['user_id'] . ' AND ft.forum_id = f.forum_id' ) ); @@ -984,7 +984,7 @@ $mark_array = request_var('mark', array(0)); <p class="good">// Getting an array, keys are strings, value defaults to 0</p> <blockquote><pre> -$action_ary = request_var('action', array('' => 0)); +$action_ary = request_var('action', array('' => 0)); </pre></blockquote> <h3>Login checks/redirection: </h3> @@ -999,12 +999,12 @@ $action_ary = request_var('action', array('' => 0)); <p>Sessions should be initiated on each page, as near the top as possible using the following code:</p> <blockquote><pre> -$user->session_begin(); -$auth->acl($user->data); -$user->setup(); +$user->session_begin(); +$auth->acl($user->data); +$user->setup(); </pre></blockquote> - <p>The <code>$user->setup()</code> call can be used to pass on additional language definition and a custom style (used in viewforum).</p> + <p>The <code>$user->setup()</code> call can be used to pass on additional language definition and a custom style (used in viewforum).</p> <h3>Errors and messages: </h3> <p>All messages/errors should be outputed by calling <code>trigger_error()</code> using the appropriate message type and language string. Example:</p> @@ -1328,7 +1328,7 @@ div <p>You are even able to check the number of items within a loop by comparing it with values within the IF condition:</p> <blockquote><pre> -<span class="comment"><!-- IF .loop > 2 --></span> +<span class="comment"><!-- IF .loop > 2 --></span> <span class="comment"><!-- BEGIN loop --></span> markup <span class="comment"><!-- END loop --></span> |