{L_TITLE_EXPLAIN}
{ERROR_MSG}
{L_FORUM_ADMIN_EXPLAIN}
{L_PROGRESS_EXPLAIN}
{L_FORUM_RESYNCED}
{NAVIGATION} [{L_EDIT} | {L_DELETE} | {L_RESYNC}]
{L_INACTIVE_USERS_EXPLAIN}
{L_MARK_ALL} • {L_UNMARK_ALL}
{L_ADMIN_INTRO}
{L_DEBUG_EXTRA_WARNING}
{L_REMOVE_INSTALL}
{L_PERMISSIONS_TRANSFERED_EXPLAIN}
{L_ADMIN_LOG_INDEX_EXPLAIN}
{L_INACTIVE_USERS_EXPLAIN_INDEX}
{L_USERNAMES_EXPLAIN}
{L_CUSTOM_FIELDS_NOT_TRANSLATED}
{S_AVAILABLE_TITLES}
{L_IS_TRANSLATED}{L_IS_NOT_TRANSLATED}
{L_IS_TRANSLATED_EXPLAIN}{L_IS_NOT_TRANSLATED_EXPLAIN}
{L_ACP_SEARCH_INDEX_EXPLAIN}
{L_CONTINUE_EXPLAIN}
{L_VERSION_CHECK_EXPLAIN}
{L_VERSION_UP_TO_DATE_ACP}
{L_VERSION_NOT_UP_TO_DATE_ACP}
{BODY}
{L_UPDATE_INSTALLATION_EXPLAIN}
{L_UPDATE_SUCCESS_EXPLAIN}
{L_VERSION_UP_TO_DATE}
{L_VERSION_NOT_UP_TO_DATE}
{L_CHECK_FILES_EXPLAIN}
{L_CHECK_FILES_UP_TO_DATE}
{L_COLLECTED_INFORMATIONS_EXPLAIN}
{L_NO_UPDATE_FILES_EXPLAIN}
{files.EXPLAIN}
{L_NO_DATABASE_UPDATE_NEEDED}
{L_ALL_FILES_UP_TO_DATE}
{L_UPDATE_METHOD_EXPLAIN}
{L_DOWNLOAD_UPDATE_METHOD_EXPLAIN}
{L_MAPPING_FILE_STRUCTURE}
{L_CONNECTION_SUCCESS}
{L_CONNECTION_FAILED}{ERROR_MSG}
+ {L_PERFORM_DATABASE_UPDATE_EXPLAIN} + + » {L_RUN_DATABASE_SCRIPT} « +
{MESSAGE_TEXT}
- [{L_ALL_YES}] - [{L_ALL_NEVER}] - [{L_ALL_NO}] + [{L_ALL_YES}] + [{L_ALL_NEVER}] + [{L_ALL_NO}]
These are the phpBB Coding Guidelines for Olympus, all attempts should be made to follow it as closely as possible. This document is (c) 2006 phpBB Group, copying or redistribution is not allowed without permission.
These are the phpBB Coding Guidelines for Olympus, all attempts should be made to follow it as closely as possible.This document is (c) 2006 phpBB Group, copying or redistribution is not allowed without permission.
In order to make this as simple as possible, we will be using tabs, not spaces. Feel free to set how many spaces your editor uses when it displays tabs, but 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.
Additionally please check your editor for the indent size. If tabs are set to 4 spaces for example, the indent size needs to be 4 too:
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.
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:
-$mode{TAB}{TAB}= request_var('mode', ''); -$search_id{TAB}= request_var('search_id', ''); +{TAB}$mode{TAB}{TAB}= request_var('mode', ''); +{TAB}$search_id{TAB}= request_var('search_id', '');
If entered with tabs (replace the {TAB}) both equal signs need to be on the same column.
/** -* * {HEADER} -* */ /** @@ -304,31 +305,26 @@ class ... - 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. + 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. 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: phpBB3Core files and all files not assigned to a seperate package - acm/includes/acmCache System, seperated because of equal class names - - acm_main/includes/acm/acm_main.phpBase caching class. All functions obtaining cached data should be placed into this file - acm_db/includes/acm/acm_db.phpDatabase based caching - acm_file/includes/acm/acm_file.phpFile based caching - - + acm/includes/acm, /includes/cache.phpCache System acp/adm, /includes/acp, /includes/functions_admin.phpAdministration Control Panel dbal/includes/dbDatabase Abstraction Layer.Base class is dbal - dbal_firebird/includes/db/firebird.phpFirebird/Interbase Database Abstraction LayerMinimum Requirement is Firebird 1.5+/Interbase 7.1+ - dbal_mssql/includes/db/msssql.phpMSSQL Database Abstraction LayerMinimum Requirement is MSSQL 2000+ - dbal_mssql_odbc/includes/db/mssql_odbc.phpMSSQL ODBC Database Abstraction Layer for MSSQLMinimum Requirement is Version 2000+ - dbal_mysql/includes/db/mysql.phpMySQL Database Abstraction LayerMinimum Requirement is 3.23+/4.0+/4.1+ - dbal_mysql4/includes/db/mysql4.phpMySQL4 Database Abstraction LayerMinimum Requirement is 4.0+/4.1+/5.0+ - dbal_mysqli/includes/db/mysqli.phpMySQLi Database Abstraction LayerMinimum Requirement is MySQLi extension with MySQL 4.1+/5.0+ - dbal_oracle/includes/db/oracle.phpOracle Database Abstraction Layer - dbal_postgres/includes/db/postgres.phpPostgreSQL Database Abstraction LayerMinimum Requirement is Version 7.3+ - dbal_sqlite/includes/db/sqlite.phpSqlite Database Abstraction Layer + /includes/db/dbal.phpBase DBAL class, defining the overall framework as well as common detominators + /includes/db/firebird.phpFirebird/Interbase Database Abstraction Layer + /includes/db/msssql.phpMSSQL Database Abstraction Layer + /includes/db/mssql_odbc.phpMSSQL ODBC Database Abstraction Layer for MSSQL + /includes/db/mysql.phpMySQL Database Abstraction Layer for MySQL 3.x/4.0.x + /includes/db/mysql4.phpMySQL4 Database Abstraction Layer for MySQL 4.1.x/5.x + /includes/db/mysqli.phpMySQLi Database Abstraction Layer + /includes/db/oracle.phpOracle Database Abstraction Layer + /includes/db/postgres.phpPostgreSQL Database Abstraction Layer + /includes/db/sqlite.phpSqlite Database Abstraction Layer docs/docsphpBB Documentation @@ -336,6 +332,7 @@ class ... install/installInstallation System language/languageAll language files login/includes/authLogin Authentication Plugins + VC/includes/captchaCAPTCHA mcpmcp.php, /includes/mcp, report.phpModerator Control Panel ucpucp.php, /includes/ucpUser Control Panel search/includes/search, search.phpSearch System @@ -350,7 +347,7 @@ class ... 2. Code Layout/Guidelines - Please note that these Guidelines also applies to javascript code. + Please note that these Guidelines applies to all php, html, javascript and css files. 2.i. Variable/Function Naming @@ -369,6 +366,7 @@ class ... Loop Indices: 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: + for ($i = 0; $i < $outer_size; $i++) { @@ -404,6 +402,7 @@ for ($i = 0; $i < $outer_size; $i++) 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: // These are all wrong. + if (condition) do_stuff(); @@ -471,6 +470,7 @@ function do_stuff() 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: // Each pair shows the wrong way followed by the right way. + $i=0; $i = 0; @@ -481,8 +481,8 @@ if ($i < 7) ... if ( ($i < 7)&&($j > 8) ) ... if ($i < 7 && $j > 8) ... -do_stuff( $i, "foo", $b ); -do_stuff($i, "foo", $b); +do_stuff( $i, 'foo', $b ); +do_stuff($i, 'foo', $b); for($i=0; $i<$size; $i++) ... for ($i = 0; $i < $size; $i++) ... @@ -552,8 +552,18 @@ $foo = $assoc_array[blah]; $foo = $assoc_array['blah']; + // wrong + +$foo = $assoc_array["$var"]; + + + // right + +$foo = $assoc_array[$var]; + + Comments: - 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.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. + 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. Magic numbers: 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). @@ -590,7 +600,7 @@ $min = ($i < $j) ? $i : $j; Don't use uninitialized variables. - 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, examples: + 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: // Wrong @@ -607,6 +617,8 @@ if (isset($forum)) ... if (isset($forum) && $forum == 5) + 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). + Switch statements: 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: @@ -704,7 +716,7 @@ switch ($mode) Common SQL Guidelines: - 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, otherwise DB2)). + 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)). All SQL commands should utilise the DataBase Abstraction Layer (DBAL) SQL code layout: @@ -731,7 +743,7 @@ $sql = 'SELECT * SQL Quotes: - Double quotes where applicable ... examples: + Double quotes where applicable (The variables in these examples are typecasted to integers before) ... examples: // These are wrong. @@ -752,6 +764,8 @@ $sql = 'SELECT * Common DBAL methods: + sql_escape(): + Always use $db->sql_escape() if you need to check for a string within an SQL statement (even if you are sure the variable can not contain single quotes - never trust your input), for example: @@ -760,7 +774,9 @@ $sql = 'SELECT * WHERE username = '" . $db->sql_escape($username) . "'"; - If you need to UPDATE or INSERT data, make use of the $db->sql_build_array() function. This function already escapes strings and checkes 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 one or two variables needs to be inserted/updated. An example of an insert statement would be: + sql_build_array(): + + 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 one or two variables needs to be inserted/updated. An example of an insert statement would be: $sql_ary = array( @@ -782,13 +798,127 @@ $sql_ary = array( ); $sql = 'UPDATE ' . SOME_TABLE . ' - SET ' . $db->sql_build_array('UPDATE', $sql_ary) . " - WHERE user_id = $user_id"; + SET ' . $db->sql_build_array('UPDATE', $sql_ary) . ' + WHERE user_id = ' . (int) $user_id; $db->sql_query($sql); 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), MULTI_INSERT (for returning extended inserts), UPDATE (example above) and SELECT (for building WHERE statement [AND logic]). + sql_in_set(): + + 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: + + +$sql = 'SELECT * + FROM ' . FORUMS_TABLE . ' + WHERE ' . $db->sql_in_set('forum_id', $forum_ids); +$db->sql_query($sql); + + + Based on the number of values in $forum_ids, the query can look differently. + + // SQL Statement if $forum_ids = array(1, 2, 3); + + +SELECT FROM phpbb_forums WHERE forum_id IN (1, 2, 3) + + + // SQL Statement if $forum_ids = array(1) or $forum_ids = 1 + + +SELECT FROM phpbb_forums WHERE forum_id = 1 + + + Of course the same is possible for doing a negative match against a number of values: + + +$sql = 'SELECT * + FROM ' . FORUMS_TABLE . ' + WHERE ' . $db->sql_in_set('forum_id', $forum_ids, true); +$db->sql_query($sql); + + + Based on the number of values in $forum_ids, the query can look differently here too. + + // SQL Statement if $forum_ids = array(1, 2, 3); + + +SELECT FROM phpbb_forums WHERE forum_id NOT IN (1, 2, 3) + + + // SQL Statement if $forum_ids = array(1) or $forum_ids = 1 + + +SELECT FROM phpbb_forums WHERE forum_id <> 1 + + + If the given array is empty, an error will be produced. + + sql_build_query(): + 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: + + +$sql_array = array( + 'SELECT' => 'f.*, ft.mark_time', + + 'FROM' => array( + FORUMS_WATCH_TABLE => 'fw', + FORUMS_TABLE => 'f' + ), + + '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' + ) + ); + + 'WHERE' => 'fw.user_id = ' . $user->data['user_id'] . ' + AND f.forum_id = fw.forum_id', + + 'ORDER_BY' => 'left_id' +); + +$sql = $db->sql_build_query('SELECT', $sql_array); + + + 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: + + +$sql_array = array( + 'SELECT' => 'f.*', + + 'FROM' => array( + FORUMS_WATCH_TABLE => 'fw', + FORUMS_TABLE => 'f' + ), + + 'WHERE' => 'fw.user_id = ' . $user->data['user_id'] . ' + AND f.forum_id = fw.forum_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' + ) + ); + + $sql_array['SELECT'] .= ', ft.mark_time '; +} +else +{ + // Here we read the cookie data +} + +$sql = $db->sql_build_query('SELECT', $sql_array); + + Top @@ -818,7 +948,7 @@ for ($i = 0, $size = sizeof($post_data); $i < $size; $i++) Use of in_array(): - 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. + 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. Top @@ -830,9 +960,11 @@ for ($i = 0, $size = sizeof($post_data); $i < $size; $i++) General things: - Never trust user input. - The auth class should be used for all authorisation checking - 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) + Never trust user input (this also applies to server variables as well as cookies). + Try to sanitize values returned from a function. + Try to sanitize given function variables within your function. + The auth class should be used for all authorisation checking. + 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). Variables: Make use of the request_var() function for anything except for submit or single checking params. @@ -868,7 +1000,7 @@ $action_ary = request_var('action', array('' => 0)); Login checks/redirection: To show a forum login box use login_forum_box($forum_data), else use the login_box() function. - The login_box() function could 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). + 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). Sensitive Operations: For sensitive operations always let the user confirm the action. For the confirmation screens, make use of the confirm_box() function. @@ -882,22 +1014,36 @@ $auth->acl($user->data); $user->setup(); - The $user->setup() call can be used to pass on additional language definitions and a custom style (used in viewforum). + The $user->setup() call can be used to pass on additional language definition and a custom style (used in viewforum). Errors and messages: - All messages/errors should be output by calling trigger_error() using the appropriate message type and language string. Example: + All messages/errors should be outputed by calling trigger_error() using the appropriate message type and language string. Example: trigger_error('NO_FORUM'); + +trigger_error($user->lang['NO_FORUM']); + + + +trigger_error('NO_APPROPIATE_MODE', E_USER_ERROR); + + Url formatting - 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. - + 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). + + 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: + + +append_sid("{$phpbb_root_path}memberlist.$phpEx", 'mode=group&g=' . $row['group_id']) + + General function usage: - Some of these functions are only chosen over others because of a personal preference and are having no other benefit than to be consistant over the code. + 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. @@ -909,6 +1055,12 @@ trigger_error('NO_FORUM'); Use else if instead of elseif + + Use false (lowercase) instead of FALSE + + + Use true (lowercase) instead of TRUE + @@ -921,7 +1073,7 @@ trigger_error('NO_FORUM'); General things -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). +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. The outer table class forumline has gone and is replaced with tablebg. 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. @@ -945,33 +1097,33 @@ trigger_error('NO_FORUM'); 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. -Use div container for styling and table for data representation +Use div container/css for styling and table for data representation. The seperate catXXXX and thXXX classes are gone. When defining a header cell just use <th> rather than <th class="thHead"> etc. Similarly for cat, don't use <td class="catLeft"> use <td class="cat"> etc. -Try to retain consistency of basic layout and class useage, i.e. _EXPLAIN text should generally be placed below the title it explains, e.g. {L_POST_USERNAME}<br /><span class="gensmall">{L_POST_USERNAME_EXPLAIN}</span> is the typical way of handling this ... there may be exceptions and this isn't a hard and fast rule +Try to retain consistency of basic layout and class useage, i.e. _EXPLAIN text should generally be placed below the title it explains, e.g. {L_POST_USERNAME}<br /><span class="gensmall">{L_POST_USERNAME_EXPLAIN}</span> is the typical way of handling this ... there may be exceptions and this isn't a hard and fast rule. Try to keep template conditional and other statements tabbed in line with the block to which they refer. -this is incorrect +this is correct -<!-- BEGIN test --> +<!-- BEGIN test --> <tr> <td>{test.TEXT}</td> </tr> -<!-- END test --> +<!-- END test --> -this is correct: +this is also correct: -<!-- BEGIN test --> +<!-- BEGIN test --> <tr> <td>{test.TEXT}</td> </tr> -<!-- END test --> +<!-- END test --> -it gives immediate feedback on exactly what is looping. +it gives immediate feedback on exactly what is looping - decide which way to use based on the readability. Top @@ -986,50 +1138,26 @@ trigger_error('NO_FORUM'); Firstly templates now take the suffix ".html" rather than ".tpl". This was done simply to make the lifes of some people easier wrt syntax highlighting, etc. Variables -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_, all other variables should be presented 'as is'. +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'. -Note that unlike 2.0.x most language strings are not assigned from the source. When a language variable is found {L_YYYYYY} phpBB first looks if an assigned variable exists with that name. If it does, it uses that. If not it looks if an exsting string defined in the language file exists. This should reduce the need to assign loads of new lang vars in Mods. +L_* template variables are automatically tried to be mapped to the corresponding language entry if the code does not set (and therefore overwrite) this variable specifically. For example {L_USERNAME} maps to $user->lang['USERNAME']. The LA_* template variables are handled within the same way, but properly escaped to be put in javascript code. This should reduce the need to assign loads of new lang vars in Mods. + -Blocks +Blocks/Loops The basic block level loop remains and takes the form: -<!-- BEGIN loopname --> -markup, {loopname.X_YYYYY}, etc. -<!-- END loopname --> +<!-- BEGIN loopname --> + markup, {loopname.X_YYYYY}, etc. +<!-- END loopname --> -However this has now been extended with the following additions. Firstly you can set the start and end points of the loop. For example: - - -<!-- BEGIN loopname(2) --> -markup -<!-- END loopname --> - - -Will start the loop on the third entry (note that indexes start at zero). Extensions of this are: - -loopname(2,4): Starts loop on third values, ends on fourth -loopname(-4): Starts loop fourth from last value -loopname(2, -4): Starts loop on third value, ends four from end -Note that the indexing method may change since it's not really consistent at this time :) - -A further extension to begin is BEGINELSE: - - -<!-- BEGIN loop --> -markup -<!-- BEGINELSE --> -markup -<!-- END loop --> - - -This will cause the markup between BEGINELSE and END to be output if the loop contains no values. This is useful for forums with no topics (for example) ... in some ways it replaces "bits of" the existing "switch_" type control (the rest being replaced by conditionals, see below). +A bit later loops will be explained further. To not irretate you we will explain conditionals as well as other statements first. Including files Something that existed in 2.0.x which no longer exists in 3.0.x is the ability to assign a template to a variable. This was used (for example) to output the jumpbox. Instead (perhaps better, perhaps not but certainly more flexible) we now have INCLUDE. This takes the simple form: -<!-- INCLUDE filename --> +<!-- INCLUDE filename --> You will note in the 3.0 templates the major sources start with <!-- INCLUDE overall_header.html --> or <!-- INCLUDE simple_header.html -->, etc. In 2.0.x control of "which" header to use was defined entirely within the code. In 3.0.x the template designer can output what they like. Note that you can introduce new templates (i.e. other than those in the default set) using this system and include them as you wish ... perhaps useful for a common "menu" bar or some such. No need to modify loads of files as with 2.0.x. @@ -1038,15 +1166,15 @@ markup A contentious decision has seen the ability to include PHP within the template introduced. This is achieved by enclosing the PHP within relevant tags: -<!-- PHP --> -echo "hello!"; -<!-- ENDPHP --> +<!-- PHP --> + echo "hello!"; +<!-- ENDPHP --> You may also include PHP from an external file using: -<!-- INCLUDEPHP somefile.php --> +<!-- INCLUDEPHP somefile.php --> it will be included and executed inline.A note, it is very much encouraged that template designers do not include PHP. The ability to include raw PHP was introduced primarily to allow end users to include banner code, etc. without modifying multiple files (as with 2.0.x). It was not intended for general use ... hence www.phpbb.com will not make available template sets which include PHP. And by default templates will have PHP disabled (the admin will need to specifically activate PHP for a template). @@ -1055,18 +1183,20 @@ echo "hello!"; The most significant addition to 3.0.x are conditions or control structures, "if something then do this else do that". The system deployed is very similar to Smarty. This may confuse some people at first but it offers great potential and great flexibility with a little imagination. In their most simple form these constructs take the form: -<!-- IF expr -->markup<!-- ENDIF --> +<!-- IF expr --> + markup +<!-- ENDIF --> expr can take many forms, for example: -<!-- IF loop.S_ROW_COUNT is even --> -markup -<!-- ENDIF --> +<!-- IF loop.S_ROW_COUNT is even --> + markup +<!-- ENDIF --> -This will output the markup if the S_ROW_COUNT variable in the current iteration of loop is an even value (i.e. the expr is TRUE). You can use various comparison methods (standard as well as equivalent textual versions noted in square brackets) including: +This will output the markup if the S_ROW_COUNT variable in the current iteration of loop is an even value (i.e. the expr is TRUE). You can use various comparison methods (standard as well as equivalent textual versions noted in square brackets) including (not, or, and, eq, neq, is should be used if possible for better readability): == [eq] @@ -1086,6 +1216,7 @@ markup - * / +, << (bitwise shift left) >> (bitwise shift right) | (bitwise or) @@ -1106,29 +1237,29 @@ div Beyond the simple use of IF you can also do a sequence of comparisons using the following: -<!-- IF expr1 --> -markup -<!-- ELSEIF expr2 --> -markup -. -. -. -<!-- ELSEIF exprN --> -markup -<!-- ELSE --> -markup -<!-- ENDIF --> +<!-- IF expr1 --> + markup +<!-- ELSEIF expr2 --> + markup + . + . + . +<!-- ELSEIF exprN --> + markup +<!-- ELSE --> + markup +<!-- ENDIF --> Each statement will be tested in turn and the relevant output generated when a match (if a match) is found. It is not necessary to always use ELSEIF, ELSE can be used alone to match "everything else".So what can you do with all this? Well take for example the colouration of rows in viewforum. In 2.0.x row colours were predefined within the source as either row color1, row color2 or row class1, row class2. In 3.0.x this is moved to the template, it may look a little daunting at first but remember control flows from top to bottom and it's not too difficult: <table> - <!-- IF loop.S_ROW_COUNT is even --> - <tr class="row1"> - <!-- ELSE --> - <tr class="row2"> - <!-- ENDIF --> + <!-- IF loop.S_ROW_COUNT is even --> + <tr class="row1"> + <!-- ELSE --> + <tr class="row2"> + <!-- ENDIF --> <td>HELLO!</td> </tr> </table> @@ -1138,15 +1269,15 @@ markup <table> - <!-- IF loop.S_ROW_COUNT > 10 --> - <tr bgcolor="#FF0000"> - <!-- ELSEIF loop.S_ROW_COUNT > 5 --> - <tr bgcolor="#00FF00"> - <!-- ELSEIF loop.S_ROW_COUNT > 2 --> - <tr bgcolor="#0000FF"> - <!-- ELSE --> - <tr bgcolor="#FF00FF"> - <!-- ENDIF --> + <!-- IF loop.S_ROW_COUNT > 10 --> + <tr bgcolor="#FF0000"> + <!-- ELSEIF loop.S_ROW_COUNT > 5 --> + <tr bgcolor="#00FF00"> + <!-- ELSEIF loop.S_ROW_COUNT > 2 --> + <tr bgcolor="#0000FF"> + <!-- ELSE --> + <tr bgcolor="#FF00FF"> + <!-- ENDIF --> <td>hello!</td> </tr> </table> @@ -1155,13 +1286,229 @@ markup This will output the row cell in purple for the first two rows, blue for rows 2 to 5, green for rows 5 to 10 and red for remainder. So, you could produce a "nice" gradient effect, for example.What else can you do? Well, you could use IF to do common checks on for example the login state of a user: -<!-- IF S_USER_LOGGED_IN --> -markup -<!-- ENDIF --> +<!-- IF S_USER_LOGGED_IN --> + markup +<!-- ENDIF --> This replaces the existing (fudged) method in 2.0.x using a zero length array and BEGIN/END. +Extended syntax for Blocks/Loops + +Back to our loops - they had been extended with the following additions. Firstly you can set the start and end points of the loop. For example: + + +<!-- BEGIN loopname(2) --> + markup +<!-- END loopname --> + + +Will start the loop on the third entry (note that indexes start at zero). Extensions of this are: + +loopname(2): Will start the loop on the 3rd entry +loopname(-2): Will start the loop two entries from the end +loopname(3,4): Will start the loop on the fourth entry and end it on the fifth +loopname(3,-4): Will start the loop on the fourth entry and end it four from last + + +A further extension to begin is BEGINELSE: + + +<!-- BEGIN loop --> + markup +<!-- BEGINELSE --> + markup +<!-- END loop --> + + +This will cause the markup between BEGINELSE and END to be output if the loop contains no values. This is useful for forums with no topics (for example) ... in some ways it replaces "bits of" the existing "switch_" type control (the rest being replaced by conditionals). + +Another way of checking if a loop contains values is by prefixing the loops name with a dot: + + +<!-- IF .loop --> + <!-- BEGIN loop --> + markup + <!-- END loop --> +<!-- ELSE --> + markup +<!-- ENDIF --> + + +You are even able to check the number of items within a loop by comparing it with values within the IF condition: + + +<!-- IF .loop > 2 --> + <!-- BEGIN loop --> + markup + <!-- END loop --> +<!-- ELSE --> + markup +<!-- ENDIF --> + + +Nesting loops cause the conditionals needing prefixed with all loops from the outer one to the inner most. An illustration of this: + + +<!-- BEGIN firstloop --> + {firstloop.MY_VARIABLE_FROM_FIRSTLOOP} + + <!-- BEGIN secondloop --> + {firstloop.secondloop.MY_VARIABLE_FROM_SECONDLOOP} + <!-- END secondloop --> +<!-- END firstloop --> + + +Sometimes it is necessary to break out of nested loops to be able to call another loop within the current iteration. This sounds a little bit confusing and it is not used very often. The following (rather complex) example shows this quite good - it also shows how you test for the first and last row in a loop (i will explain the example in detail further down): + + +<!-- BEGIN l_block1 --> + <!-- IF l_block1.S_SELECTED --> + <strong>{l_block1.L_TITLE}</strong> + <!-- IF S_PRIVMSGS --> + + <!-- the ! at the beginning of the loop name forces the loop to be not a nested one of l_block1 --> + <!-- BEGIN !folder --> + <!-- IF folder.S_FIRST_ROW --> + <ul class="nav"> + <!-- ENDIF --> + + <li><a href="{folder.U_FOLDER}">{folder.FOLDER_NAME}</a></li> + + <!-- IF folder.S_LAST_ROW --> + </ul> + <!-- ENDIF --> + <!-- END !folder --> + + <!-- ENDIF --> + + <ul class="nav"> + <!-- BEGIN l_block2 --> + <li> + <!-- IF l_block1.l_block2.S_SELECTED --> + <strong>{l_block1.l_block2.L_TITLE}</strong> + <!-- ELSE --> + <a href="{l_block1.l_block2.U_TITLE}">{l_block1.l_block2.L_TITLE}</a> + <!-- ENDIF --> + </li> + <!-- END l_block2 --> + </ul> + <!-- ELSE --> + <a class="nav" href="{l_block1.U_TITLE}">{l_block1.L_TITLE}</a> + <!-- ENDIF --> +<!-- END l_block1 --> + + +Let us first concentrate on this part of the example: + + +<!-- BEGIN l_block1 --> + <!-- IF l_block1.S_SELECTED --> + markup + <!-- ELSE --> + <a class="nav" href="{l_block1.U_TITLE}">{l_block1.L_TITLE}</a> + <!-- ENDIF --> +<!-- END l_block1 --> + + +Here we open the loop l_block1 and doing some things if the value S_SELECTED within the current loop iteration is true, else we write the blocks link and title. Here, you see {l_block1.L_TITLE} referenced - you remember that L_* variables get automatically assigned the corresponding language entry? This is true, but not within loops. The L_TITLE variable within the loop l_block1 is assigned within the code itself. + +Let's have a closer look to the markup: + + +<!-- BEGIN l_block1 --> +. +. + <!-- IF S_PRIVMSGS --> + + <!-- BEGIN !folder --> + <!-- IF folder.S_FIRST_ROW --> + <ul class="nav"> + <!-- ENDIF --> + + <li><a href="{folder.U_FOLDER}">{folder.FOLDER_NAME}</a></li> + + <!-- IF folder.S_LAST_ROW --> + </ul> + <!-- ENDIF --> + <!-- END !folder --> + + <!-- ENDIF --> +. +. +<!-- END l_block1 --> + + +The <!-- IF S_PRIVMSGS --> statement clearly checks a global variable and not one within the loop, since the loop is not given here. So, if S_PRIVMSGS is true we execute the shown markup. Now, you see the <!-- BEGIN !folder --> statement. The exclamation mark is responsible for instructing the template engine to iterate through the main loop folder. So, we are now within the loop folder - with <!-- BEGIN folder --> we would have been within the loop l_block1.folder automatically as is the case with l_block2: + + +<!-- BEGIN l_block1 --> +. +. + <ul class="nav"> + <!-- BEGIN l_block2 --> + <li> + <!-- IF l_block1.l_block2.S_SELECTED --> + <strong>{l_block1.l_block2.L_TITLE}</strong> + <!-- ELSE --> + <a href="{l_block1.l_block2.U_TITLE}">{l_block1.l_block2.L_TITLE}</a> + <!-- ENDIF --> + </li> + <!-- END l_block2 --> + </ul> +. +. +<!-- END l_block1 --> + + +You see the difference? The loop l_block2 is a member of the loop l_block1 but the loop folder is a main loop. + +Now back to our folder loop: + + +<!-- IF folder.S_FIRST_ROW --> + <ul class="nav"> +<!-- ENDIF --> + +<li><a href="{folder.U_FOLDER}">{folder.FOLDER_NAME}</a></li> + +<!-- IF folder.S_LAST_ROW --> + </ul> +<!-- ENDIF --> + + +You may have wondered what the comparison to S_FIRST_ROW and S_LAST_ROW is about. If you haven't guessed already - it is checking for the first iteration of the loop with S_FIRST_ROW and the last iteration with S_LAST_ROW. This can come in handy quite often if you want to open or close design elements, like the above list. Let us imagine a folder loop build with three iterations, it would go this way: + + +<ul class="nav"> <!-- written on first iteration --> + <li>first element</li> <!-- written on first iteration --> + <li>second element</li> <!-- written on second iteration --> + <li>third element</li> <!-- written on third iteration --> +</ul> <!-- written on third iteration --> + + +As you can see, all three elements are written down as well as the markup for the first iteration and the last one. Sometimes you want to omit writing the general markup - for example: + + +<!-- IF folder.S_FIRST_ROW --> + <ul class="nav"> +<!-- ELSEIF folder.S_LAST_ROW --> + </ul> +<!-- ELSE --> + <li><a href="{folder.U_FOLDER}">{folder.FOLDER_NAME}</a></li> +<!-- ENDIF --> + + +would result in the following markup: + + +<ul class="nav"> <!-- written on first iteration --> + <li>second element</li> <!-- written on second iteration --> +</ul> <!-- written on third iteration --> + + +Just always remember that processing is taking place from up to down. +
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.
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.
/includes
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:
/includes/acm
/includes/acm/acm_main.php
/includes/acm/acm_db.php
/includes/acm/acm_file.php
/includes/cache.php
/adm
/includes/acp
/includes/functions_admin.php
/includes/db
dbal
/includes/db/firebird.php
/includes/db/msssql.php
/includes/db/mssql_odbc.php
/includes/db/mysql.php
/includes/db/mysql4.php
/includes/db/mysqli.php
/includes/db/oracle.php
/includes/db/postgres.php
/includes/db/sqlite.php
/includes/db/dbal.php
/docs
/install
/language
/includes/auth
/includes/captcha
mcp.php
/includes/mcp
report.php
ucp.php
/includes/ucp
/includes/search
search.php
Please note that these Guidelines also applies to javascript code.
Please note that these Guidelines applies to all php, html, javascript and css files.
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:
for ($i = 0; $i < $outer_size; $i++) { @@ -404,6 +402,7 @@ for ($i = 0; $i < $outer_size; $i++) 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: // These are all wrong. + if (condition) do_stuff(); @@ -471,6 +470,7 @@ function do_stuff() 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: // Each pair shows the wrong way followed by the right way. + $i=0; $i = 0; @@ -481,8 +481,8 @@ if ($i < 7) ... if ( ($i < 7)&&($j > 8) ) ... if ($i < 7 && $j > 8) ... -do_stuff( $i, "foo", $b ); -do_stuff($i, "foo", $b); +do_stuff( $i, 'foo', $b ); +do_stuff($i, 'foo', $b); for($i=0; $i<$size; $i++) ... for ($i = 0; $i < $size; $i++) ... @@ -552,8 +552,18 @@ $foo = $assoc_array[blah]; $foo = $assoc_array['blah']; + // wrong + +$foo = $assoc_array["$var"]; + + + // right + +$foo = $assoc_array[$var]; + + Comments: - 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.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. + 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. Magic numbers: 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). @@ -590,7 +600,7 @@ $min = ($i < $j) ? $i : $j; Don't use uninitialized variables. - 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, examples: + 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: // Wrong @@ -607,6 +617,8 @@ if (isset($forum)) ... if (isset($forum) && $forum == 5) + 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). + Switch statements: 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: @@ -704,7 +716,7 @@ switch ($mode) Common SQL Guidelines: - 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, otherwise DB2)). + 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)). All SQL commands should utilise the DataBase Abstraction Layer (DBAL) SQL code layout: @@ -731,7 +743,7 @@ $sql = 'SELECT * SQL Quotes: - Double quotes where applicable ... examples: + Double quotes where applicable (The variables in these examples are typecasted to integers before) ... examples: // These are wrong. @@ -752,6 +764,8 @@ $sql = 'SELECT * Common DBAL methods: + sql_escape(): + Always use $db->sql_escape() if you need to check for a string within an SQL statement (even if you are sure the variable can not contain single quotes - never trust your input), for example: @@ -760,7 +774,9 @@ $sql = 'SELECT * WHERE username = '" . $db->sql_escape($username) . "'"; - If you need to UPDATE or INSERT data, make use of the $db->sql_build_array() function. This function already escapes strings and checkes 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 one or two variables needs to be inserted/updated. An example of an insert statement would be: + sql_build_array(): + + 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 one or two variables needs to be inserted/updated. An example of an insert statement would be: $sql_ary = array( @@ -782,13 +798,127 @@ $sql_ary = array( ); $sql = 'UPDATE ' . SOME_TABLE . ' - SET ' . $db->sql_build_array('UPDATE', $sql_ary) . " - WHERE user_id = $user_id"; + SET ' . $db->sql_build_array('UPDATE', $sql_ary) . ' + WHERE user_id = ' . (int) $user_id; $db->sql_query($sql); 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), MULTI_INSERT (for returning extended inserts), UPDATE (example above) and SELECT (for building WHERE statement [AND logic]). + sql_in_set(): + + 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: + + +$sql = 'SELECT * + FROM ' . FORUMS_TABLE . ' + WHERE ' . $db->sql_in_set('forum_id', $forum_ids); +$db->sql_query($sql); + + + Based on the number of values in $forum_ids, the query can look differently. + + // SQL Statement if $forum_ids = array(1, 2, 3); + + +SELECT FROM phpbb_forums WHERE forum_id IN (1, 2, 3) + + + // SQL Statement if $forum_ids = array(1) or $forum_ids = 1 + + +SELECT FROM phpbb_forums WHERE forum_id = 1 + + + Of course the same is possible for doing a negative match against a number of values: + + +$sql = 'SELECT * + FROM ' . FORUMS_TABLE . ' + WHERE ' . $db->sql_in_set('forum_id', $forum_ids, true); +$db->sql_query($sql); + + + Based on the number of values in $forum_ids, the query can look differently here too. + + // SQL Statement if $forum_ids = array(1, 2, 3); + + +SELECT FROM phpbb_forums WHERE forum_id NOT IN (1, 2, 3) + + + // SQL Statement if $forum_ids = array(1) or $forum_ids = 1 + + +SELECT FROM phpbb_forums WHERE forum_id <> 1 + + + If the given array is empty, an error will be produced. + + sql_build_query(): + 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: + + +$sql_array = array( + 'SELECT' => 'f.*, ft.mark_time', + + 'FROM' => array( + FORUMS_WATCH_TABLE => 'fw', + FORUMS_TABLE => 'f' + ), + + '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' + ) + ); + + 'WHERE' => 'fw.user_id = ' . $user->data['user_id'] . ' + AND f.forum_id = fw.forum_id', + + 'ORDER_BY' => 'left_id' +); + +$sql = $db->sql_build_query('SELECT', $sql_array); + + + 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: + + +$sql_array = array( + 'SELECT' => 'f.*', + + 'FROM' => array( + FORUMS_WATCH_TABLE => 'fw', + FORUMS_TABLE => 'f' + ), + + 'WHERE' => 'fw.user_id = ' . $user->data['user_id'] . ' + AND f.forum_id = fw.forum_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' + ) + ); + + $sql_array['SELECT'] .= ', ft.mark_time '; +} +else +{ + // Here we read the cookie data +} + +$sql = $db->sql_build_query('SELECT', $sql_array); + + Top @@ -818,7 +948,7 @@ for ($i = 0, $size = sizeof($post_data); $i < $size; $i++)
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:
// These are all wrong.
if (condition) do_stuff(); @@ -471,6 +470,7 @@ function do_stuff() 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: // Each pair shows the wrong way followed by the right way. + $i=0; $i = 0; @@ -481,8 +481,8 @@ if ($i < 7) ... if ( ($i < 7)&&($j > 8) ) ... if ($i < 7 && $j > 8) ... -do_stuff( $i, "foo", $b ); -do_stuff($i, "foo", $b); +do_stuff( $i, 'foo', $b ); +do_stuff($i, 'foo', $b); for($i=0; $i<$size; $i++) ... for ($i = 0; $i < $size; $i++) ... @@ -552,8 +552,18 @@ $foo = $assoc_array[blah]; $foo = $assoc_array['blah']; + // wrong + +$foo = $assoc_array["$var"]; + + + // right + +$foo = $assoc_array[$var]; + + Comments: - 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.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. + 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. Magic numbers: 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). @@ -590,7 +600,7 @@ $min = ($i < $j) ? $i : $j;
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:
// Each pair shows the wrong way followed by the right way.
$i=0; $i = 0; @@ -481,8 +481,8 @@ if ($i < 7) ... if ( ($i < 7)&&($j > 8) ) ... if ($i < 7 && $j > 8) ... -do_stuff( $i, "foo", $b ); -do_stuff($i, "foo", $b); +do_stuff( $i, 'foo', $b ); +do_stuff($i, 'foo', $b); for($i=0; $i<$size; $i++) ... for ($i = 0; $i < $size; $i++) ... @@ -552,8 +552,18 @@ $foo = $assoc_array[blah]; $foo = $assoc_array['blah'];
// wrong
+$foo = $assoc_array["$var"]; +
// right
+$foo = $assoc_array[$var]; +
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.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.
/* */
//
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.
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).
true
false
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, examples:
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:
// Wrong
@@ -607,6 +617,8 @@ if (isset($forum)) ... if (isset($forum) && $forum == 5)
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).
empty()
isset($array) && sizeof($array) > 0
!empty($array)
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:
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, otherwise DB2)).
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)).
All SQL commands should utilise the DataBase Abstraction Layer (DBAL)
Double quotes where applicable ... examples:
Double quotes where applicable (The variables in these examples are typecasted to integers before) ... examples:
// These are wrong.
@@ -752,6 +764,8 @@ $sql = 'SELECT * Common DBAL methods: + sql_escape(): + Always use $db->sql_escape() if you need to check for a string within an SQL statement (even if you are sure the variable can not contain single quotes - never trust your input), for example: @@ -760,7 +774,9 @@ $sql = 'SELECT * WHERE username = '" . $db->sql_escape($username) . "'"; - If you need to UPDATE or INSERT data, make use of the $db->sql_build_array() function. This function already escapes strings and checkes 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 one or two variables needs to be inserted/updated. An example of an insert statement would be: + sql_build_array(): + + 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 one or two variables needs to be inserted/updated. An example of an insert statement would be: $sql_ary = array( @@ -782,13 +798,127 @@ $sql_ary = array( ); $sql = 'UPDATE ' . SOME_TABLE . ' - SET ' . $db->sql_build_array('UPDATE', $sql_ary) . " - WHERE user_id = $user_id"; + SET ' . $db->sql_build_array('UPDATE', $sql_ary) . ' + WHERE user_id = ' . (int) $user_id; $db->sql_query($sql); 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), MULTI_INSERT (for returning extended inserts), UPDATE (example above) and SELECT (for building WHERE statement [AND logic]). + sql_in_set(): + + 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: + + +$sql = 'SELECT * + FROM ' . FORUMS_TABLE . ' + WHERE ' . $db->sql_in_set('forum_id', $forum_ids); +$db->sql_query($sql); + + + Based on the number of values in $forum_ids, the query can look differently. + + // SQL Statement if $forum_ids = array(1, 2, 3); + + +SELECT FROM phpbb_forums WHERE forum_id IN (1, 2, 3) + + + // SQL Statement if $forum_ids = array(1) or $forum_ids = 1 + + +SELECT FROM phpbb_forums WHERE forum_id = 1 + + + Of course the same is possible for doing a negative match against a number of values: + + +$sql = 'SELECT * + FROM ' . FORUMS_TABLE . ' + WHERE ' . $db->sql_in_set('forum_id', $forum_ids, true); +$db->sql_query($sql); + + + Based on the number of values in $forum_ids, the query can look differently here too. + + // SQL Statement if $forum_ids = array(1, 2, 3); + + +SELECT FROM phpbb_forums WHERE forum_id NOT IN (1, 2, 3) + + + // SQL Statement if $forum_ids = array(1) or $forum_ids = 1 + + +SELECT FROM phpbb_forums WHERE forum_id <> 1 + + + If the given array is empty, an error will be produced. + + sql_build_query(): + 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: + + +$sql_array = array( + 'SELECT' => 'f.*, ft.mark_time', + + 'FROM' => array( + FORUMS_WATCH_TABLE => 'fw', + FORUMS_TABLE => 'f' + ), + + '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' + ) + ); + + 'WHERE' => 'fw.user_id = ' . $user->data['user_id'] . ' + AND f.forum_id = fw.forum_id', + + 'ORDER_BY' => 'left_id' +); + +$sql = $db->sql_build_query('SELECT', $sql_array); + + + 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: + + +$sql_array = array( + 'SELECT' => 'f.*', + + 'FROM' => array( + FORUMS_WATCH_TABLE => 'fw', + FORUMS_TABLE => 'f' + ), + + 'WHERE' => 'fw.user_id = ' . $user->data['user_id'] . ' + AND f.forum_id = fw.forum_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' + ) + ); + + $sql_array['SELECT'] .= ', ft.mark_time '; +} +else +{ + // Here we read the cookie data +} + +$sql = $db->sql_build_query('SELECT', $sql_array); + +
Always use $db->sql_escape() if you need to check for a string within an SQL statement (even if you are sure the variable can not contain single quotes - never trust your input), for example:
$db->sql_escape()
@@ -760,7 +774,9 @@ $sql = 'SELECT * WHERE username = '" . $db->sql_escape($username) . "'";
If you need to UPDATE or INSERT data, make use of the $db->sql_build_array() function. This function already escapes strings and checkes 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 one or two variables needs to be inserted/updated. An example of an insert statement would be:
$db->sql_build_array()
$sql_ary
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 one or two variables needs to be inserted/updated. An example of an insert statement would be:
$sql_ary = array( @@ -782,13 +798,127 @@ $sql_ary = array( ); $sql = 'UPDATE ' . SOME_TABLE . ' - SET ' . $db->sql_build_array('UPDATE', $sql_ary) . " - WHERE user_id = $user_id"; + SET ' . $db->sql_build_array('UPDATE', $sql_ary) . ' + WHERE user_id = ' . (int) $user_id; $db->sql_query($sql);
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), MULTI_INSERT (for returning extended inserts), UPDATE (example above) and SELECT (for building WHERE statement [AND logic]).
INSERT
INSERT_SELECT
INSERT INTO table (...) SELECT value, column ...
MULTI_INSERT
UPDATE
SELECT
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:
$db->sql_in_set()
IN ()
NOT IN ()
=
<>
+$sql = 'SELECT * + FROM ' . FORUMS_TABLE . ' + WHERE ' . $db->sql_in_set('forum_id', $forum_ids); +$db->sql_query($sql); +
Based on the number of values in $forum_ids, the query can look differently.
// SQL Statement if $forum_ids = array(1, 2, 3);
+SELECT FROM phpbb_forums WHERE forum_id IN (1, 2, 3) +
// SQL Statement if $forum_ids = array(1) or $forum_ids = 1
+SELECT FROM phpbb_forums WHERE forum_id = 1 +
Of course the same is possible for doing a negative match against a number of values:
+$sql = 'SELECT * + FROM ' . FORUMS_TABLE . ' + WHERE ' . $db->sql_in_set('forum_id', $forum_ids, true); +$db->sql_query($sql); +
Based on the number of values in $forum_ids, the query can look differently here too.
+SELECT FROM phpbb_forums WHERE forum_id NOT IN (1, 2, 3) +
+SELECT FROM phpbb_forums WHERE forum_id <> 1 +
If the given array is empty, an error will be produced.
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:
$db->sql_build_query()
+$sql_array = array( + 'SELECT' => 'f.*, ft.mark_time', + + 'FROM' => array( + FORUMS_WATCH_TABLE => 'fw', + FORUMS_TABLE => 'f' + ), + + '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' + ) + ); + + 'WHERE' => 'fw.user_id = ' . $user->data['user_id'] . ' + AND f.forum_id = fw.forum_id', + + 'ORDER_BY' => 'left_id' +); + +$sql = $db->sql_build_query('SELECT', $sql_array); +
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:
+$sql_array = array( + 'SELECT' => 'f.*', + + 'FROM' => array( + FORUMS_WATCH_TABLE => 'fw', + FORUMS_TABLE => 'f' + ), + + 'WHERE' => 'fw.user_id = ' . $user->data['user_id'] . ' + AND f.forum_id = fw.forum_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' + ) + ); + + $sql_array['SELECT'] .= ', ft.mark_time '; +} +else +{ + // Here we read the cookie data +} + +$sql = $db->sql_build_query('SELECT', $sql_array); +
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.
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.
isset($array[$var])
in_array($var, array_keys($array))
Never trust user input.
The auth class should be used for all authorisation checking
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)
Never trust user input (this also applies to server variables as well as cookies).
Try to sanitize values returned from a function.
Try to sanitize given function variables within your function.
The auth class should be used for all authorisation checking.
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).
Make use of the request_var() function for anything except for submit or single checking params.
request_var()
To show a forum login box use login_forum_box($forum_data), else use the login_box() function.
login_forum_box($forum_data)
login_box()
The login_box() function could 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).
$SID
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).
For sensitive operations always let the user confirm the action. For the confirmation screens, make use of the confirm_box() function.
confirm_box()
The $user->setup() call can be used to pass on additional language definitions and a custom style (used in viewforum).
$user->setup()
The $user->setup() call can be used to pass on additional language definition and a custom style (used in viewforum).
All messages/errors should be output by calling trigger_error() using the appropriate message type and language string. Example:
trigger_error()
All messages/errors should be outputed by calling trigger_error() using the appropriate message type and language string. Example:
trigger_error('NO_FORUM');
+trigger_error($user->lang['NO_FORUM']); +
+trigger_error('NO_APPROPIATE_MODE', E_USER_ERROR); +
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.
$phpbb_root_path
$phpbb_admin_path
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).
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:
append_sid()
+append_sid("{$phpbb_root_path}memberlist.$phpEx", 'mode=group&g=' . $row['group_id']) +
Some of these functions are only chosen over others because of a personal preference and are having no other benefit than to be consistant over the code.
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.
Use else if instead of elseif
else if
elseif
Use false (lowercase) instead of FALSE
FALSE
Use true (lowercase) instead of TRUE
TRUE
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).
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.
The outer table class forumline has gone and is replaced with tablebg.
forumline
tablebg
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.
<table>
<table class="" cellspacing="" cellpadding="" border="" align="">
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.
Use div container for styling and table for data representation
Use div container/css for styling and table for data representation.
The seperate catXXXX and thXXX classes are gone. When defining a header cell just use <th> rather than <th class="thHead"> etc. Similarly for cat, don't use <td class="catLeft"> use <td class="cat"> etc.
<th>
<th class="thHead">
<td class="catLeft">
<td class="cat">
Try to retain consistency of basic layout and class useage, i.e. _EXPLAIN text should generally be placed below the title it explains, e.g. {L_POST_USERNAME}<br /><span class="gensmall">{L_POST_USERNAME_EXPLAIN}</span> is the typical way of handling this ... there may be exceptions and this isn't a hard and fast rule
{L_POST_USERNAME}<br /><span class="gensmall">{L_POST_USERNAME_EXPLAIN}</span>
Try to retain consistency of basic layout and class useage, i.e. _EXPLAIN text should generally be placed below the title it explains, e.g. {L_POST_USERNAME}<br /><span class="gensmall">{L_POST_USERNAME_EXPLAIN}</span> is the typical way of handling this ... there may be exceptions and this isn't a hard and fast rule.
Try to keep template conditional and other statements tabbed in line with the block to which they refer.
this is incorrect
this is correct
-<!-- BEGIN test --> +<!-- BEGIN test --> <tr> <td>{test.TEXT}</td> </tr> -<!-- END test --> +<!-- END test -->
this is correct:
this is also correct:
it gives immediate feedback on exactly what is looping.
it gives immediate feedback on exactly what is looping - decide which way to use based on the readability.
Firstly templates now take the suffix ".html" rather than ".tpl". This was done simply to make the lifes of some people easier wrt syntax highlighting, etc.
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_, all other variables should be presented 'as is'.
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'.
Note that unlike 2.0.x most language strings are not assigned from the source. When a language variable is found {L_YYYYYY} phpBB first looks if an assigned variable exists with that name. If it does, it uses that. If not it looks if an exsting string defined in the language file exists. This should reduce the need to assign loads of new lang vars in Mods.
L_* template variables are automatically tried to be mapped to the corresponding language entry if the code does not set (and therefore overwrite) this variable specifically. For example {L_USERNAME} maps to $user->lang['USERNAME']. The LA_* template variables are handled within the same way, but properly escaped to be put in javascript code. This should reduce the need to assign loads of new lang vars in Mods. +
{L_USERNAME}
$user->lang['USERNAME']
The basic block level loop remains and takes the form:
-<!-- BEGIN loopname --> -markup, {loopname.X_YYYYY}, etc. -<!-- END loopname --> +<!-- BEGIN loopname --> + markup, {loopname.X_YYYYY}, etc. +<!-- END loopname -->
However this has now been extended with the following additions. Firstly you can set the start and end points of the loop. For example:
-<!-- BEGIN loopname(2) --> -markup -<!-- END loopname --> -
Will start the loop on the third entry (note that indexes start at zero). Extensions of this are: - -loopname(2,4): Starts loop on third values, ends on fourth -loopname(-4): Starts loop fourth from last value -loopname(2, -4): Starts loop on third value, ends four from end -Note that the indexing method may change since it's not really consistent at this time :)
loopname(2,4)
loopname(-4)
loopname(2, -4)
A further extension to begin is BEGINELSE:
-<!-- BEGIN loop --> -markup -<!-- BEGINELSE --> -markup -<!-- END loop --> -
This will cause the markup between BEGINELSE and END to be output if the loop contains no values. This is useful for forums with no topics (for example) ... in some ways it replaces "bits of" the existing "switch_" type control (the rest being replaced by conditionals, see below).
BEGINELSE
END
A bit later loops will be explained further. To not irretate you we will explain conditionals as well as other statements first.
Something that existed in 2.0.x which no longer exists in 3.0.x is the ability to assign a template to a variable. This was used (for example) to output the jumpbox. Instead (perhaps better, perhaps not but certainly more flexible) we now have INCLUDE. This takes the simple form:
-<!-- INCLUDE filename --> +<!-- INCLUDE filename -->
You will note in the 3.0 templates the major sources start with <!-- INCLUDE overall_header.html --> or <!-- INCLUDE simple_header.html -->, etc. In 2.0.x control of "which" header to use was defined entirely within the code. In 3.0.x the template designer can output what they like. Note that you can introduce new templates (i.e. other than those in the default set) using this system and include them as you wish ... perhaps useful for a common "menu" bar or some such. No need to modify loads of files as with 2.0.x.
<!-- INCLUDE overall_header.html -->
<!-- INCLUDE simple_header.html -->
A contentious decision has seen the ability to include PHP within the template introduced. This is achieved by enclosing the PHP within relevant tags:
-<!-- PHP --> -echo "hello!"; -<!-- ENDPHP --> +<!-- PHP --> + echo "hello!"; +<!-- ENDPHP -->
You may also include PHP from an external file using:
-<!-- INCLUDEPHP somefile.php --> +<!-- INCLUDEPHP somefile.php -->
it will be included and executed inline.A note, it is very much encouraged that template designers do not include PHP. The ability to include raw PHP was introduced primarily to allow end users to include banner code, etc. without modifying multiple files (as with 2.0.x). It was not intended for general use ... hence www.phpbb.com will not make available template sets which include PHP. And by default templates will have PHP disabled (the admin will need to specifically activate PHP for a template).
The most significant addition to 3.0.x are conditions or control structures, "if something then do this else do that". The system deployed is very similar to Smarty. This may confuse some people at first but it offers great potential and great flexibility with a little imagination. In their most simple form these constructs take the form:
-<!-- IF expr -->markup<!-- ENDIF --> +<!-- IF expr --> + markup +<!-- ENDIF -->
expr can take many forms, for example:
-<!-- IF loop.S_ROW_COUNT is even --> -markup -<!-- ENDIF --> +<!-- IF loop.S_ROW_COUNT is even --> + markup +<!-- ENDIF -->
This will output the markup if the S_ROW_COUNT variable in the current iteration of loop is an even value (i.e. the expr is TRUE). You can use various comparison methods (standard as well as equivalent textual versions noted in square brackets) including:
This will output the markup if the S_ROW_COUNT variable in the current iteration of loop is an even value (i.e. the expr is TRUE). You can use various comparison methods (standard as well as equivalent textual versions noted in square brackets) including (not, or, and, eq, neq, is should be used if possible for better readability):
not, or, and, eq, neq, is
== [eq] @@ -1086,6 +1216,7 @@ markup - * / +, << (bitwise shift left) >> (bitwise shift right) | (bitwise or) @@ -1106,29 +1237,29 @@ div Beyond the simple use of IF you can also do a sequence of comparisons using the following: -<!-- IF expr1 --> -markup -<!-- ELSEIF expr2 --> -markup -. -. -. -<!-- ELSEIF exprN --> -markup -<!-- ELSE --> -markup -<!-- ENDIF --> +<!-- IF expr1 --> + markup +<!-- ELSEIF expr2 --> + markup + . + . + . +<!-- ELSEIF exprN --> + markup +<!-- ELSE --> + markup +<!-- ENDIF --> Each statement will be tested in turn and the relevant output generated when a match (if a match) is found. It is not necessary to always use ELSEIF, ELSE can be used alone to match "everything else".So what can you do with all this? Well take for example the colouration of rows in viewforum. In 2.0.x row colours were predefined within the source as either row color1, row color2 or row class1, row class2. In 3.0.x this is moved to the template, it may look a little daunting at first but remember control flows from top to bottom and it's not too difficult: <table> - <!-- IF loop.S_ROW_COUNT is even --> - <tr class="row1"> - <!-- ELSE --> - <tr class="row2"> - <!-- ENDIF --> + <!-- IF loop.S_ROW_COUNT is even --> + <tr class="row1"> + <!-- ELSE --> + <tr class="row2"> + <!-- ENDIF --> <td>HELLO!</td> </tr> </table> @@ -1138,15 +1269,15 @@ markup <table> - <!-- IF loop.S_ROW_COUNT > 10 --> - <tr bgcolor="#FF0000"> - <!-- ELSEIF loop.S_ROW_COUNT > 5 --> - <tr bgcolor="#00FF00"> - <!-- ELSEIF loop.S_ROW_COUNT > 2 --> - <tr bgcolor="#0000FF"> - <!-- ELSE --> - <tr bgcolor="#FF00FF"> - <!-- ENDIF --> + <!-- IF loop.S_ROW_COUNT > 10 --> + <tr bgcolor="#FF0000"> + <!-- ELSEIF loop.S_ROW_COUNT > 5 --> + <tr bgcolor="#00FF00"> + <!-- ELSEIF loop.S_ROW_COUNT > 2 --> + <tr bgcolor="#0000FF"> + <!-- ELSE --> + <tr bgcolor="#FF00FF"> + <!-- ENDIF --> <td>hello!</td> </tr> </table> @@ -1155,13 +1286,229 @@ markup This will output the row cell in purple for the first two rows, blue for rows 2 to 5, green for rows 5 to 10 and red for remainder. So, you could produce a "nice" gradient effect, for example.What else can you do? Well, you could use IF to do common checks on for example the login state of a user: -<!-- IF S_USER_LOGGED_IN --> -markup -<!-- ENDIF --> +<!-- IF S_USER_LOGGED_IN --> + markup +<!-- ENDIF --> This replaces the existing (fudged) method in 2.0.x using a zero length array and BEGIN/END. +Extended syntax for Blocks/Loops + +Back to our loops - they had been extended with the following additions. Firstly you can set the start and end points of the loop. For example: + + +<!-- BEGIN loopname(2) --> + markup +<!-- END loopname --> + + +Will start the loop on the third entry (note that indexes start at zero). Extensions of this are: + +loopname(2): Will start the loop on the 3rd entry +loopname(-2): Will start the loop two entries from the end +loopname(3,4): Will start the loop on the fourth entry and end it on the fifth +loopname(3,-4): Will start the loop on the fourth entry and end it four from last + + +A further extension to begin is BEGINELSE: + + +<!-- BEGIN loop --> + markup +<!-- BEGINELSE --> + markup +<!-- END loop --> + + +This will cause the markup between BEGINELSE and END to be output if the loop contains no values. This is useful for forums with no topics (for example) ... in some ways it replaces "bits of" the existing "switch_" type control (the rest being replaced by conditionals). + +Another way of checking if a loop contains values is by prefixing the loops name with a dot: + + +<!-- IF .loop --> + <!-- BEGIN loop --> + markup + <!-- END loop --> +<!-- ELSE --> + markup +<!-- ENDIF --> + + +You are even able to check the number of items within a loop by comparing it with values within the IF condition: + + +<!-- IF .loop > 2 --> + <!-- BEGIN loop --> + markup + <!-- END loop --> +<!-- ELSE --> + markup +<!-- ENDIF --> + + +Nesting loops cause the conditionals needing prefixed with all loops from the outer one to the inner most. An illustration of this: + + +<!-- BEGIN firstloop --> + {firstloop.MY_VARIABLE_FROM_FIRSTLOOP} + + <!-- BEGIN secondloop --> + {firstloop.secondloop.MY_VARIABLE_FROM_SECONDLOOP} + <!-- END secondloop --> +<!-- END firstloop --> + + +Sometimes it is necessary to break out of nested loops to be able to call another loop within the current iteration. This sounds a little bit confusing and it is not used very often. The following (rather complex) example shows this quite good - it also shows how you test for the first and last row in a loop (i will explain the example in detail further down): + + +<!-- BEGIN l_block1 --> + <!-- IF l_block1.S_SELECTED --> + <strong>{l_block1.L_TITLE}</strong> + <!-- IF S_PRIVMSGS --> + + <!-- the ! at the beginning of the loop name forces the loop to be not a nested one of l_block1 --> + <!-- BEGIN !folder --> + <!-- IF folder.S_FIRST_ROW --> + <ul class="nav"> + <!-- ENDIF --> + + <li><a href="{folder.U_FOLDER}">{folder.FOLDER_NAME}</a></li> + + <!-- IF folder.S_LAST_ROW --> + </ul> + <!-- ENDIF --> + <!-- END !folder --> + + <!-- ENDIF --> + + <ul class="nav"> + <!-- BEGIN l_block2 --> + <li> + <!-- IF l_block1.l_block2.S_SELECTED --> + <strong>{l_block1.l_block2.L_TITLE}</strong> + <!-- ELSE --> + <a href="{l_block1.l_block2.U_TITLE}">{l_block1.l_block2.L_TITLE}</a> + <!-- ENDIF --> + </li> + <!-- END l_block2 --> + </ul> + <!-- ELSE --> + <a class="nav" href="{l_block1.U_TITLE}">{l_block1.L_TITLE}</a> + <!-- ENDIF --> +<!-- END l_block1 --> + + +Let us first concentrate on this part of the example: + + +<!-- BEGIN l_block1 --> + <!-- IF l_block1.S_SELECTED --> + markup + <!-- ELSE --> + <a class="nav" href="{l_block1.U_TITLE}">{l_block1.L_TITLE}</a> + <!-- ENDIF --> +<!-- END l_block1 --> + + +Here we open the loop l_block1 and doing some things if the value S_SELECTED within the current loop iteration is true, else we write the blocks link and title. Here, you see {l_block1.L_TITLE} referenced - you remember that L_* variables get automatically assigned the corresponding language entry? This is true, but not within loops. The L_TITLE variable within the loop l_block1 is assigned within the code itself. + +Let's have a closer look to the markup: + + +<!-- BEGIN l_block1 --> +. +. + <!-- IF S_PRIVMSGS --> + + <!-- BEGIN !folder --> + <!-- IF folder.S_FIRST_ROW --> + <ul class="nav"> + <!-- ENDIF --> + + <li><a href="{folder.U_FOLDER}">{folder.FOLDER_NAME}</a></li> + + <!-- IF folder.S_LAST_ROW --> + </ul> + <!-- ENDIF --> + <!-- END !folder --> + + <!-- ENDIF --> +. +. +<!-- END l_block1 --> + + +The <!-- IF S_PRIVMSGS --> statement clearly checks a global variable and not one within the loop, since the loop is not given here. So, if S_PRIVMSGS is true we execute the shown markup. Now, you see the <!-- BEGIN !folder --> statement. The exclamation mark is responsible for instructing the template engine to iterate through the main loop folder. So, we are now within the loop folder - with <!-- BEGIN folder --> we would have been within the loop l_block1.folder automatically as is the case with l_block2: + + +<!-- BEGIN l_block1 --> +. +. + <ul class="nav"> + <!-- BEGIN l_block2 --> + <li> + <!-- IF l_block1.l_block2.S_SELECTED --> + <strong>{l_block1.l_block2.L_TITLE}</strong> + <!-- ELSE --> + <a href="{l_block1.l_block2.U_TITLE}">{l_block1.l_block2.L_TITLE}</a> + <!-- ENDIF --> + </li> + <!-- END l_block2 --> + </ul> +. +. +<!-- END l_block1 --> + + +You see the difference? The loop l_block2 is a member of the loop l_block1 but the loop folder is a main loop. + +Now back to our folder loop: + + +<!-- IF folder.S_FIRST_ROW --> + <ul class="nav"> +<!-- ENDIF --> + +<li><a href="{folder.U_FOLDER}">{folder.FOLDER_NAME}</a></li> + +<!-- IF folder.S_LAST_ROW --> + </ul> +<!-- ENDIF --> + + +You may have wondered what the comparison to S_FIRST_ROW and S_LAST_ROW is about. If you haven't guessed already - it is checking for the first iteration of the loop with S_FIRST_ROW and the last iteration with S_LAST_ROW. This can come in handy quite often if you want to open or close design elements, like the above list. Let us imagine a folder loop build with three iterations, it would go this way: + + +<ul class="nav"> <!-- written on first iteration --> + <li>first element</li> <!-- written on first iteration --> + <li>second element</li> <!-- written on second iteration --> + <li>third element</li> <!-- written on third iteration --> +</ul> <!-- written on third iteration --> + + +As you can see, all three elements are written down as well as the markup for the first iteration and the last one. Sometimes you want to omit writing the general markup - for example: + + +<!-- IF folder.S_FIRST_ROW --> + <ul class="nav"> +<!-- ELSEIF folder.S_LAST_ROW --> + </ul> +<!-- ELSE --> + <li><a href="{folder.U_FOLDER}">{folder.FOLDER_NAME}</a></li> +<!-- ENDIF --> + + +would result in the following markup: + + +<ul class="nav"> <!-- written on first iteration --> + <li>second element</li> <!-- written on second iteration --> +</ul> <!-- written on third iteration --> + + +Just always remember that processing is taking place from up to down. +
Beyond the simple use of IF you can also do a sequence of comparisons using the following:
-<!-- IF expr1 --> -markup -<!-- ELSEIF expr2 --> -markup -. -. -. -<!-- ELSEIF exprN --> -markup -<!-- ELSE --> -markup -<!-- ENDIF --> +<!-- IF expr1 --> + markup +<!-- ELSEIF expr2 --> + markup + . + . + . +<!-- ELSEIF exprN --> + markup +<!-- ELSE --> + markup +<!-- ENDIF -->
Each statement will be tested in turn and the relevant output generated when a match (if a match) is found. It is not necessary to always use ELSEIF, ELSE can be used alone to match "everything else".So what can you do with all this? Well take for example the colouration of rows in viewforum. In 2.0.x row colours were predefined within the source as either row color1, row color2 or row class1, row class2. In 3.0.x this is moved to the template, it may look a little daunting at first but remember control flows from top to bottom and it's not too difficult:
<table> - <!-- IF loop.S_ROW_COUNT is even --> - <tr class="row1"> - <!-- ELSE --> - <tr class="row2"> - <!-- ENDIF --> + <!-- IF loop.S_ROW_COUNT is even --> + <tr class="row1"> + <!-- ELSE --> + <tr class="row2"> + <!-- ENDIF --> <td>HELLO!</td> </tr> </table> @@ -1138,15 +1269,15 @@ markup <table> - <!-- IF loop.S_ROW_COUNT > 10 --> - <tr bgcolor="#FF0000"> - <!-- ELSEIF loop.S_ROW_COUNT > 5 --> - <tr bgcolor="#00FF00"> - <!-- ELSEIF loop.S_ROW_COUNT > 2 --> - <tr bgcolor="#0000FF"> - <!-- ELSE --> - <tr bgcolor="#FF00FF"> - <!-- ENDIF --> + <!-- IF loop.S_ROW_COUNT > 10 --> + <tr bgcolor="#FF0000"> + <!-- ELSEIF loop.S_ROW_COUNT > 5 --> + <tr bgcolor="#00FF00"> + <!-- ELSEIF loop.S_ROW_COUNT > 2 --> + <tr bgcolor="#0000FF"> + <!-- ELSE --> + <tr bgcolor="#FF00FF"> + <!-- ENDIF --> <td>hello!</td> </tr> </table> @@ -1155,13 +1286,229 @@ markup This will output the row cell in purple for the first two rows, blue for rows 2 to 5, green for rows 5 to 10 and red for remainder. So, you could produce a "nice" gradient effect, for example.What else can you do? Well, you could use IF to do common checks on for example the login state of a user: -<!-- IF S_USER_LOGGED_IN --> -markup -<!-- ENDIF --> +<!-- IF S_USER_LOGGED_IN --> + markup +<!-- ENDIF --> This replaces the existing (fudged) method in 2.0.x using a zero length array and BEGIN/END. +Extended syntax for Blocks/Loops + +Back to our loops - they had been extended with the following additions. Firstly you can set the start and end points of the loop. For example: + + +<!-- BEGIN loopname(2) --> + markup +<!-- END loopname --> + + +Will start the loop on the third entry (note that indexes start at zero). Extensions of this are: + +loopname(2): Will start the loop on the 3rd entry +loopname(-2): Will start the loop two entries from the end +loopname(3,4): Will start the loop on the fourth entry and end it on the fifth +loopname(3,-4): Will start the loop on the fourth entry and end it four from last + + +A further extension to begin is BEGINELSE: + + +<!-- BEGIN loop --> + markup +<!-- BEGINELSE --> + markup +<!-- END loop --> + + +This will cause the markup between BEGINELSE and END to be output if the loop contains no values. This is useful for forums with no topics (for example) ... in some ways it replaces "bits of" the existing "switch_" type control (the rest being replaced by conditionals). + +Another way of checking if a loop contains values is by prefixing the loops name with a dot: + + +<!-- IF .loop --> + <!-- BEGIN loop --> + markup + <!-- END loop --> +<!-- ELSE --> + markup +<!-- ENDIF --> + + +You are even able to check the number of items within a loop by comparing it with values within the IF condition: + + +<!-- IF .loop > 2 --> + <!-- BEGIN loop --> + markup + <!-- END loop --> +<!-- ELSE --> + markup +<!-- ENDIF --> + + +Nesting loops cause the conditionals needing prefixed with all loops from the outer one to the inner most. An illustration of this: + + +<!-- BEGIN firstloop --> + {firstloop.MY_VARIABLE_FROM_FIRSTLOOP} + + <!-- BEGIN secondloop --> + {firstloop.secondloop.MY_VARIABLE_FROM_SECONDLOOP} + <!-- END secondloop --> +<!-- END firstloop --> + + +Sometimes it is necessary to break out of nested loops to be able to call another loop within the current iteration. This sounds a little bit confusing and it is not used very often. The following (rather complex) example shows this quite good - it also shows how you test for the first and last row in a loop (i will explain the example in detail further down): + + +<!-- BEGIN l_block1 --> + <!-- IF l_block1.S_SELECTED --> + <strong>{l_block1.L_TITLE}</strong> + <!-- IF S_PRIVMSGS --> + + <!-- the ! at the beginning of the loop name forces the loop to be not a nested one of l_block1 --> + <!-- BEGIN !folder --> + <!-- IF folder.S_FIRST_ROW --> + <ul class="nav"> + <!-- ENDIF --> + + <li><a href="{folder.U_FOLDER}">{folder.FOLDER_NAME}</a></li> + + <!-- IF folder.S_LAST_ROW --> + </ul> + <!-- ENDIF --> + <!-- END !folder --> + + <!-- ENDIF --> + + <ul class="nav"> + <!-- BEGIN l_block2 --> + <li> + <!-- IF l_block1.l_block2.S_SELECTED --> + <strong>{l_block1.l_block2.L_TITLE}</strong> + <!-- ELSE --> + <a href="{l_block1.l_block2.U_TITLE}">{l_block1.l_block2.L_TITLE}</a> + <!-- ENDIF --> + </li> + <!-- END l_block2 --> + </ul> + <!-- ELSE --> + <a class="nav" href="{l_block1.U_TITLE}">{l_block1.L_TITLE}</a> + <!-- ENDIF --> +<!-- END l_block1 --> + + +Let us first concentrate on this part of the example: + + +<!-- BEGIN l_block1 --> + <!-- IF l_block1.S_SELECTED --> + markup + <!-- ELSE --> + <a class="nav" href="{l_block1.U_TITLE}">{l_block1.L_TITLE}</a> + <!-- ENDIF --> +<!-- END l_block1 --> + + +Here we open the loop l_block1 and doing some things if the value S_SELECTED within the current loop iteration is true, else we write the blocks link and title. Here, you see {l_block1.L_TITLE} referenced - you remember that L_* variables get automatically assigned the corresponding language entry? This is true, but not within loops. The L_TITLE variable within the loop l_block1 is assigned within the code itself. + +Let's have a closer look to the markup: + + +<!-- BEGIN l_block1 --> +. +. + <!-- IF S_PRIVMSGS --> + + <!-- BEGIN !folder --> + <!-- IF folder.S_FIRST_ROW --> + <ul class="nav"> + <!-- ENDIF --> + + <li><a href="{folder.U_FOLDER}">{folder.FOLDER_NAME}</a></li> + + <!-- IF folder.S_LAST_ROW --> + </ul> + <!-- ENDIF --> + <!-- END !folder --> + + <!-- ENDIF --> +. +. +<!-- END l_block1 --> + + +The <!-- IF S_PRIVMSGS --> statement clearly checks a global variable and not one within the loop, since the loop is not given here. So, if S_PRIVMSGS is true we execute the shown markup. Now, you see the <!-- BEGIN !folder --> statement. The exclamation mark is responsible for instructing the template engine to iterate through the main loop folder. So, we are now within the loop folder - with <!-- BEGIN folder --> we would have been within the loop l_block1.folder automatically as is the case with l_block2: + + +<!-- BEGIN l_block1 --> +. +. + <ul class="nav"> + <!-- BEGIN l_block2 --> + <li> + <!-- IF l_block1.l_block2.S_SELECTED --> + <strong>{l_block1.l_block2.L_TITLE}</strong> + <!-- ELSE --> + <a href="{l_block1.l_block2.U_TITLE}">{l_block1.l_block2.L_TITLE}</a> + <!-- ENDIF --> + </li> + <!-- END l_block2 --> + </ul> +. +. +<!-- END l_block1 --> + + +You see the difference? The loop l_block2 is a member of the loop l_block1 but the loop folder is a main loop. + +Now back to our folder loop: + + +<!-- IF folder.S_FIRST_ROW --> + <ul class="nav"> +<!-- ENDIF --> + +<li><a href="{folder.U_FOLDER}">{folder.FOLDER_NAME}</a></li> + +<!-- IF folder.S_LAST_ROW --> + </ul> +<!-- ENDIF --> + + +You may have wondered what the comparison to S_FIRST_ROW and S_LAST_ROW is about. If you haven't guessed already - it is checking for the first iteration of the loop with S_FIRST_ROW and the last iteration with S_LAST_ROW. This can come in handy quite often if you want to open or close design elements, like the above list. Let us imagine a folder loop build with three iterations, it would go this way: + + +<ul class="nav"> <!-- written on first iteration --> + <li>first element</li> <!-- written on first iteration --> + <li>second element</li> <!-- written on second iteration --> + <li>third element</li> <!-- written on third iteration --> +</ul> <!-- written on third iteration --> + + +As you can see, all three elements are written down as well as the markup for the first iteration and the last one. Sometimes you want to omit writing the general markup - for example: + + +<!-- IF folder.S_FIRST_ROW --> + <ul class="nav"> +<!-- ELSEIF folder.S_LAST_ROW --> + </ul> +<!-- ELSE --> + <li><a href="{folder.U_FOLDER}">{folder.FOLDER_NAME}</a></li> +<!-- ENDIF --> + + +would result in the following markup: + + +<ul class="nav"> <!-- written on first iteration --> + <li>second element</li> <!-- written on second iteration --> +</ul> <!-- written on third iteration --> + + +Just always remember that processing is taking place from up to down. +
<table> - <!-- IF loop.S_ROW_COUNT > 10 --> - <tr bgcolor="#FF0000"> - <!-- ELSEIF loop.S_ROW_COUNT > 5 --> - <tr bgcolor="#00FF00"> - <!-- ELSEIF loop.S_ROW_COUNT > 2 --> - <tr bgcolor="#0000FF"> - <!-- ELSE --> - <tr bgcolor="#FF00FF"> - <!-- ENDIF --> + <!-- IF loop.S_ROW_COUNT > 10 --> + <tr bgcolor="#FF0000"> + <!-- ELSEIF loop.S_ROW_COUNT > 5 --> + <tr bgcolor="#00FF00"> + <!-- ELSEIF loop.S_ROW_COUNT > 2 --> + <tr bgcolor="#0000FF"> + <!-- ELSE --> + <tr bgcolor="#FF00FF"> + <!-- ENDIF --> <td>hello!</td> </tr> </table> @@ -1155,13 +1286,229 @@ markup This will output the row cell in purple for the first two rows, blue for rows 2 to 5, green for rows 5 to 10 and red for remainder. So, you could produce a "nice" gradient effect, for example.What else can you do? Well, you could use IF to do common checks on for example the login state of a user: -<!-- IF S_USER_LOGGED_IN --> -markup -<!-- ENDIF --> +<!-- IF S_USER_LOGGED_IN --> + markup +<!-- ENDIF --> This replaces the existing (fudged) method in 2.0.x using a zero length array and BEGIN/END. +Extended syntax for Blocks/Loops + +Back to our loops - they had been extended with the following additions. Firstly you can set the start and end points of the loop. For example: + + +<!-- BEGIN loopname(2) --> + markup +<!-- END loopname --> + + +Will start the loop on the third entry (note that indexes start at zero). Extensions of this are: + +loopname(2): Will start the loop on the 3rd entry +loopname(-2): Will start the loop two entries from the end +loopname(3,4): Will start the loop on the fourth entry and end it on the fifth +loopname(3,-4): Will start the loop on the fourth entry and end it four from last + + +A further extension to begin is BEGINELSE: + + +<!-- BEGIN loop --> + markup +<!-- BEGINELSE --> + markup +<!-- END loop --> + + +This will cause the markup between BEGINELSE and END to be output if the loop contains no values. This is useful for forums with no topics (for example) ... in some ways it replaces "bits of" the existing "switch_" type control (the rest being replaced by conditionals). + +Another way of checking if a loop contains values is by prefixing the loops name with a dot: + + +<!-- IF .loop --> + <!-- BEGIN loop --> + markup + <!-- END loop --> +<!-- ELSE --> + markup +<!-- ENDIF --> + + +You are even able to check the number of items within a loop by comparing it with values within the IF condition: + + +<!-- IF .loop > 2 --> + <!-- BEGIN loop --> + markup + <!-- END loop --> +<!-- ELSE --> + markup +<!-- ENDIF --> + + +Nesting loops cause the conditionals needing prefixed with all loops from the outer one to the inner most. An illustration of this: + + +<!-- BEGIN firstloop --> + {firstloop.MY_VARIABLE_FROM_FIRSTLOOP} + + <!-- BEGIN secondloop --> + {firstloop.secondloop.MY_VARIABLE_FROM_SECONDLOOP} + <!-- END secondloop --> +<!-- END firstloop --> + + +Sometimes it is necessary to break out of nested loops to be able to call another loop within the current iteration. This sounds a little bit confusing and it is not used very often. The following (rather complex) example shows this quite good - it also shows how you test for the first and last row in a loop (i will explain the example in detail further down): + + +<!-- BEGIN l_block1 --> + <!-- IF l_block1.S_SELECTED --> + <strong>{l_block1.L_TITLE}</strong> + <!-- IF S_PRIVMSGS --> + + <!-- the ! at the beginning of the loop name forces the loop to be not a nested one of l_block1 --> + <!-- BEGIN !folder --> + <!-- IF folder.S_FIRST_ROW --> + <ul class="nav"> + <!-- ENDIF --> + + <li><a href="{folder.U_FOLDER}">{folder.FOLDER_NAME}</a></li> + + <!-- IF folder.S_LAST_ROW --> + </ul> + <!-- ENDIF --> + <!-- END !folder --> + + <!-- ENDIF --> + + <ul class="nav"> + <!-- BEGIN l_block2 --> + <li> + <!-- IF l_block1.l_block2.S_SELECTED --> + <strong>{l_block1.l_block2.L_TITLE}</strong> + <!-- ELSE --> + <a href="{l_block1.l_block2.U_TITLE}">{l_block1.l_block2.L_TITLE}</a> + <!-- ENDIF --> + </li> + <!-- END l_block2 --> + </ul> + <!-- ELSE --> + <a class="nav" href="{l_block1.U_TITLE}">{l_block1.L_TITLE}</a> + <!-- ENDIF --> +<!-- END l_block1 --> + + +Let us first concentrate on this part of the example: + + +<!-- BEGIN l_block1 --> + <!-- IF l_block1.S_SELECTED --> + markup + <!-- ELSE --> + <a class="nav" href="{l_block1.U_TITLE}">{l_block1.L_TITLE}</a> + <!-- ENDIF --> +<!-- END l_block1 --> + + +Here we open the loop l_block1 and doing some things if the value S_SELECTED within the current loop iteration is true, else we write the blocks link and title. Here, you see {l_block1.L_TITLE} referenced - you remember that L_* variables get automatically assigned the corresponding language entry? This is true, but not within loops. The L_TITLE variable within the loop l_block1 is assigned within the code itself. + +Let's have a closer look to the markup: + + +<!-- BEGIN l_block1 --> +. +. + <!-- IF S_PRIVMSGS --> + + <!-- BEGIN !folder --> + <!-- IF folder.S_FIRST_ROW --> + <ul class="nav"> + <!-- ENDIF --> + + <li><a href="{folder.U_FOLDER}">{folder.FOLDER_NAME}</a></li> + + <!-- IF folder.S_LAST_ROW --> + </ul> + <!-- ENDIF --> + <!-- END !folder --> + + <!-- ENDIF --> +. +. +<!-- END l_block1 --> + + +The <!-- IF S_PRIVMSGS --> statement clearly checks a global variable and not one within the loop, since the loop is not given here. So, if S_PRIVMSGS is true we execute the shown markup. Now, you see the <!-- BEGIN !folder --> statement. The exclamation mark is responsible for instructing the template engine to iterate through the main loop folder. So, we are now within the loop folder - with <!-- BEGIN folder --> we would have been within the loop l_block1.folder automatically as is the case with l_block2: + + +<!-- BEGIN l_block1 --> +. +. + <ul class="nav"> + <!-- BEGIN l_block2 --> + <li> + <!-- IF l_block1.l_block2.S_SELECTED --> + <strong>{l_block1.l_block2.L_TITLE}</strong> + <!-- ELSE --> + <a href="{l_block1.l_block2.U_TITLE}">{l_block1.l_block2.L_TITLE}</a> + <!-- ENDIF --> + </li> + <!-- END l_block2 --> + </ul> +. +. +<!-- END l_block1 --> + + +You see the difference? The loop l_block2 is a member of the loop l_block1 but the loop folder is a main loop. + +Now back to our folder loop: + + +<!-- IF folder.S_FIRST_ROW --> + <ul class="nav"> +<!-- ENDIF --> + +<li><a href="{folder.U_FOLDER}">{folder.FOLDER_NAME}</a></li> + +<!-- IF folder.S_LAST_ROW --> + </ul> +<!-- ENDIF --> + + +You may have wondered what the comparison to S_FIRST_ROW and S_LAST_ROW is about. If you haven't guessed already - it is checking for the first iteration of the loop with S_FIRST_ROW and the last iteration with S_LAST_ROW. This can come in handy quite often if you want to open or close design elements, like the above list. Let us imagine a folder loop build with three iterations, it would go this way: + + +<ul class="nav"> <!-- written on first iteration --> + <li>first element</li> <!-- written on first iteration --> + <li>second element</li> <!-- written on second iteration --> + <li>third element</li> <!-- written on third iteration --> +</ul> <!-- written on third iteration --> + + +As you can see, all three elements are written down as well as the markup for the first iteration and the last one. Sometimes you want to omit writing the general markup - for example: + + +<!-- IF folder.S_FIRST_ROW --> + <ul class="nav"> +<!-- ELSEIF folder.S_LAST_ROW --> + </ul> +<!-- ELSE --> + <li><a href="{folder.U_FOLDER}">{folder.FOLDER_NAME}</a></li> +<!-- ENDIF --> + + +would result in the following markup: + + +<ul class="nav"> <!-- written on first iteration --> + <li>second element</li> <!-- written on second iteration --> +</ul> <!-- written on third iteration --> + + +Just always remember that processing is taking place from up to down. +
This will output the row cell in purple for the first two rows, blue for rows 2 to 5, green for rows 5 to 10 and red for remainder. So, you could produce a "nice" gradient effect, for example.What else can you do? Well, you could use IF to do common checks on for example the login state of a user:
-<!-- IF S_USER_LOGGED_IN --> -markup -<!-- ENDIF --> +<!-- IF S_USER_LOGGED_IN --> + markup +<!-- ENDIF -->
This replaces the existing (fudged) method in 2.0.x using a zero length array and BEGIN/END.
Back to our loops - they had been extended with the following additions. Firstly you can set the start and end points of the loop. For example:
+<!-- BEGIN loopname(2) --> + markup +<!-- END loopname --> +
Will start the loop on the third entry (note that indexes start at zero). Extensions of this are: + +loopname(2): Will start the loop on the 3rd entry +loopname(-2): Will start the loop two entries from the end +loopname(3,4): Will start the loop on the fourth entry and end it on the fifth +loopname(3,-4): Will start the loop on the fourth entry and end it four from last +
loopname(2)
loopname(-2)
loopname(3,4)
loopname(3,-4)
+<!-- BEGIN loop --> + markup +<!-- BEGINELSE --> + markup +<!-- END loop --> +
This will cause the markup between BEGINELSE and END to be output if the loop contains no values. This is useful for forums with no topics (for example) ... in some ways it replaces "bits of" the existing "switch_" type control (the rest being replaced by conditionals).
Another way of checking if a loop contains values is by prefixing the loops name with a dot:
+<!-- IF .loop --> + <!-- BEGIN loop --> + markup + <!-- END loop --> +<!-- ELSE --> + markup +<!-- ENDIF --> +
You are even able to check the number of items within a loop by comparing it with values within the IF condition:
+<!-- IF .loop > 2 --> + <!-- BEGIN loop --> + markup + <!-- END loop --> +<!-- ELSE --> + markup +<!-- ENDIF --> +
Nesting loops cause the conditionals needing prefixed with all loops from the outer one to the inner most. An illustration of this:
+<!-- BEGIN firstloop --> + {firstloop.MY_VARIABLE_FROM_FIRSTLOOP} + + <!-- BEGIN secondloop --> + {firstloop.secondloop.MY_VARIABLE_FROM_SECONDLOOP} + <!-- END secondloop --> +<!-- END firstloop --> +
Sometimes it is necessary to break out of nested loops to be able to call another loop within the current iteration. This sounds a little bit confusing and it is not used very often. The following (rather complex) example shows this quite good - it also shows how you test for the first and last row in a loop (i will explain the example in detail further down):
+<!-- BEGIN l_block1 --> + <!-- IF l_block1.S_SELECTED --> + <strong>{l_block1.L_TITLE}</strong> + <!-- IF S_PRIVMSGS --> + + <!-- the ! at the beginning of the loop name forces the loop to be not a nested one of l_block1 --> + <!-- BEGIN !folder --> + <!-- IF folder.S_FIRST_ROW --> + <ul class="nav"> + <!-- ENDIF --> + + <li><a href="{folder.U_FOLDER}">{folder.FOLDER_NAME}</a></li> + + <!-- IF folder.S_LAST_ROW --> + </ul> + <!-- ENDIF --> + <!-- END !folder --> + + <!-- ENDIF --> + + <ul class="nav"> + <!-- BEGIN l_block2 --> + <li> + <!-- IF l_block1.l_block2.S_SELECTED --> + <strong>{l_block1.l_block2.L_TITLE}</strong> + <!-- ELSE --> + <a href="{l_block1.l_block2.U_TITLE}">{l_block1.l_block2.L_TITLE}</a> + <!-- ENDIF --> + </li> + <!-- END l_block2 --> + </ul> + <!-- ELSE --> + <a class="nav" href="{l_block1.U_TITLE}">{l_block1.L_TITLE}</a> + <!-- ENDIF --> +<!-- END l_block1 --> +
Let us first concentrate on this part of the example:
+<!-- BEGIN l_block1 --> + <!-- IF l_block1.S_SELECTED --> + markup + <!-- ELSE --> + <a class="nav" href="{l_block1.U_TITLE}">{l_block1.L_TITLE}</a> + <!-- ENDIF --> +<!-- END l_block1 --> +
Here we open the loop l_block1 and doing some things if the value S_SELECTED within the current loop iteration is true, else we write the blocks link and title. Here, you see {l_block1.L_TITLE} referenced - you remember that L_* variables get automatically assigned the corresponding language entry? This is true, but not within loops. The L_TITLE variable within the loop l_block1 is assigned within the code itself.
{l_block1.L_TITLE}
Let's have a closer look to the markup:
+<!-- BEGIN l_block1 --> +. +. + <!-- IF S_PRIVMSGS --> + + <!-- BEGIN !folder --> + <!-- IF folder.S_FIRST_ROW --> + <ul class="nav"> + <!-- ENDIF --> + + <li><a href="{folder.U_FOLDER}">{folder.FOLDER_NAME}</a></li> + + <!-- IF folder.S_LAST_ROW --> + </ul> + <!-- ENDIF --> + <!-- END !folder --> + + <!-- ENDIF --> +. +. +<!-- END l_block1 --> +
The <!-- IF S_PRIVMSGS --> statement clearly checks a global variable and not one within the loop, since the loop is not given here. So, if S_PRIVMSGS is true we execute the shown markup. Now, you see the <!-- BEGIN !folder --> statement. The exclamation mark is responsible for instructing the template engine to iterate through the main loop folder. So, we are now within the loop folder - with <!-- BEGIN folder --> we would have been within the loop l_block1.folder automatically as is the case with l_block2:
<!-- IF S_PRIVMSGS -->
<!-- BEGIN !folder -->
<!-- BEGIN folder -->
l_block1.folder
+<!-- BEGIN l_block1 --> +. +. + <ul class="nav"> + <!-- BEGIN l_block2 --> + <li> + <!-- IF l_block1.l_block2.S_SELECTED --> + <strong>{l_block1.l_block2.L_TITLE}</strong> + <!-- ELSE --> + <a href="{l_block1.l_block2.U_TITLE}">{l_block1.l_block2.L_TITLE}</a> + <!-- ENDIF --> + </li> + <!-- END l_block2 --> + </ul> +. +. +<!-- END l_block1 --> +
You see the difference? The loop l_block2 is a member of the loop l_block1 but the loop folder is a main loop.
Now back to our folder loop:
+<!-- IF folder.S_FIRST_ROW --> + <ul class="nav"> +<!-- ENDIF --> + +<li><a href="{folder.U_FOLDER}">{folder.FOLDER_NAME}</a></li> + +<!-- IF folder.S_LAST_ROW --> + </ul> +<!-- ENDIF --> +
You may have wondered what the comparison to S_FIRST_ROW and S_LAST_ROW is about. If you haven't guessed already - it is checking for the first iteration of the loop with S_FIRST_ROW and the last iteration with S_LAST_ROW. This can come in handy quite often if you want to open or close design elements, like the above list. Let us imagine a folder loop build with three iterations, it would go this way:
S_FIRST_ROW
S_LAST_ROW
+<ul class="nav"> <!-- written on first iteration --> + <li>first element</li> <!-- written on first iteration --> + <li>second element</li> <!-- written on second iteration --> + <li>third element</li> <!-- written on third iteration --> +</ul> <!-- written on third iteration --> +
As you can see, all three elements are written down as well as the markup for the first iteration and the last one. Sometimes you want to omit writing the general markup - for example:
+<!-- IF folder.S_FIRST_ROW --> + <ul class="nav"> +<!-- ELSEIF folder.S_LAST_ROW --> + </ul> +<!-- ELSE --> + <li><a href="{folder.U_FOLDER}">{folder.FOLDER_NAME}</a></li> +<!-- ENDIF --> +
would result in the following markup:
+<ul class="nav"> <!-- written on first iteration --> + <li>second element</li> <!-- written on second iteration --> +</ul> <!-- written on third iteration --> +
Just always remember that processing is taking place from up to down.
+ * if (strpos($upload_dir, '/') !== 0 && strpos($upload_dir, '../') === false) + * { + * header('X-Sendfile: ' . $filename); + * } + *
Page generated in ' . round($totaltime, 4) . " seconds with {$this->num_queries['normal']} queries" . (($this->num_queries['cached']) ? " + {$this->num_queries['cached']} " . (($this->num_queries['cached'] == 1) ? 'query' : 'queries') . ' returning data from cache' : '') . '
Time spent on ' . SQL_LAYER . ' queries: ' . round($this->sql_time, 5) . 's | Time spent on PHP: ' . round($totaltime - $this->sql_time, 5) . 's
Time spent on ' . $this->sql_layer . ' queries: ' . round($this->sql_time, 5) . 's | Time spent on PHP: ' . round($totaltime - $this->sql_time, 5) . 's
+ * $diff = &new diff($lines1, $lines2); + * $rev = $diff->reverse(); + *
' . htmlspecialchars($this->_lines($lines, ' ')) . '
' . htmlspecialchars($this->_lines($lines, '+')) . '
' . htmlspecialchars($this->_lines($lines, '-')) . '
' . nl2br($this->render($diff)) . '
' . ((strlen($line)) ? $line : ' ') . '
' . $left . '
' . $right . '
Please notify the board administrator or webmaster: ' . $config['board_contact'] . '
'; } - while (list($key, $val) = @each($array)) + foreach ($array as $key => $val) { if (is_array($val)) { @@ -1135,7 +1409,7 @@ class jabber } else { - echo '$' . $arr_name . '[' . $key . '] = "' . $val . "\"\n"; + $GLOBALS['traverse_array'][] = '$' . $arr_name . '[' . $key . '] = "' . $val . "\"\n"; } } @@ -1143,117 +1417,13 @@ class jabber { echo '
' . implode('', array_map('htmlspecialchars', $this->backtrace_log)) . '
:: sql_layer; ?> +sql_query($sql); +$row = $db->sql_fetchrow($result); +$db->sql_freeresult($result); + +echo $lang['PREVIOUS_VERSION'] . ' :: ' . $row['config_value'] . ''; +echo $lang['UPDATED_VERSION'] . ' :: ' . $updates_to_version . ''; + +$current_version = strtolower($row['config_value']); +$latest_version = strtolower($updates_to_version); + +// Schema updates +?> +
:: + + $schema_changes) +{ + if (version_compare($version, $current_version, '<')) + { + continue; + } + + if (!sizeof($schema_changes)) + { + continue; + } + + $no_updates = false; + + // Change columns? + if (!empty($schema_changes['change_columns'])) + { + foreach ($schema_changes['change_columns'] as $table => $columns) + { + foreach ($columns as $column_name => $column_data) + { + sql_column_change($map_dbms, $table, $column_name, $column_data); + } + } + } + + // Add columns? + if (!empty($schema_changes['add_columns'])) + { + foreach ($schema_changes['add_columns'] as $table => $columns) + { + foreach ($columns as $column_name => $column_data) + { + // Only add the column if it does not exist yet + if (!column_exists($map_dbms, $table, $column_name)) + { + sql_column_add($map_dbms, $table, $column_name, $column_data); + } + } + } + } +} + +_write_result($no_updates, $errored, $error_ary); + +// Data updates +$error_ary = array(); +$errored = $no_updates = false; + +?> + + + + + :: + + + + + + + :: + +sql_layer) +{ + case 'mysql': + case 'mysqli': + case 'mysql4': + $sql = 'OPTIMIZE TABLE ' . $table_prefix . 'auth_access, ' . $table_prefix . 'banlist, ' . $table_prefix . 'categories, ' . $table_prefix . 'config, ' . $table_prefix . 'disallow, ' . $table_prefix . 'forum_prune, ' . $table_prefix . 'forums, ' . $table_prefix . 'groups, ' . $table_prefix . 'posts, ' . $table_prefix . 'posts_text, ' . $table_prefix . 'privmsgs, ' . $table_prefix . 'privmsgs_text, ' . $table_prefix . 'ranks, ' . $table_prefix . 'search_results, ' . $table_prefix . 'search_wordlist, ' . $table_prefix . 'search_wordmatch, ' . $table_prefix . 'sessions_keys' . $table_prefix . 'smilies, ' . $table_prefix . 'themes, ' . $table_prefix . 'themes_name, ' . $table_prefix . 'topics, ' . $table_prefix . 'topics_watch, ' . $table_prefix . 'user_group, ' . $table_prefix . 'users, ' . $table_prefix . 'vote_desc, ' . $table_prefix . 'vote_results, ' . $table_prefix . 'vote_voters, ' . $table_prefix . 'words'; + _sql($sql, $errored, $error_ary); + break; + + case 'postgresql': + _sql("VACUUM ANALYZE", $errored, $error_ary); + break; +} +*/ + +_write_result($no_updates, $errored, $error_ary); + +?> + + + + + + + + + + +purge(); + +?> + +
:: + + + + + + + :: + +sql_layer) +{ + case 'mysql': + case 'mysqli': + case 'mysql4': + $sql = 'OPTIMIZE TABLE ' . $table_prefix . 'auth_access, ' . $table_prefix . 'banlist, ' . $table_prefix . 'categories, ' . $table_prefix . 'config, ' . $table_prefix . 'disallow, ' . $table_prefix . 'forum_prune, ' . $table_prefix . 'forums, ' . $table_prefix . 'groups, ' . $table_prefix . 'posts, ' . $table_prefix . 'posts_text, ' . $table_prefix . 'privmsgs, ' . $table_prefix . 'privmsgs_text, ' . $table_prefix . 'ranks, ' . $table_prefix . 'search_results, ' . $table_prefix . 'search_wordlist, ' . $table_prefix . 'search_wordmatch, ' . $table_prefix . 'sessions_keys' . $table_prefix . 'smilies, ' . $table_prefix . 'themes, ' . $table_prefix . 'themes_name, ' . $table_prefix . 'topics, ' . $table_prefix . 'topics_watch, ' . $table_prefix . 'user_group, ' . $table_prefix . 'users, ' . $table_prefix . 'vote_desc, ' . $table_prefix . 'vote_results, ' . $table_prefix . 'vote_voters, ' . $table_prefix . 'words'; + _sql($sql, $errored, $error_ary); + break; + + case 'postgresql': + _sql("VACUUM ANALYZE", $errored, $error_ary); + break; +} +*/ + +_write_result($no_updates, $errored, $error_ary); + +?> + + + + + + + + + + +purge(); + +?> + +
:: + +sql_layer) +{ + case 'mysql': + case 'mysqli': + case 'mysql4': + $sql = 'OPTIMIZE TABLE ' . $table_prefix . 'auth_access, ' . $table_prefix . 'banlist, ' . $table_prefix . 'categories, ' . $table_prefix . 'config, ' . $table_prefix . 'disallow, ' . $table_prefix . 'forum_prune, ' . $table_prefix . 'forums, ' . $table_prefix . 'groups, ' . $table_prefix . 'posts, ' . $table_prefix . 'posts_text, ' . $table_prefix . 'privmsgs, ' . $table_prefix . 'privmsgs_text, ' . $table_prefix . 'ranks, ' . $table_prefix . 'search_results, ' . $table_prefix . 'search_wordlist, ' . $table_prefix . 'search_wordmatch, ' . $table_prefix . 'sessions_keys' . $table_prefix . 'smilies, ' . $table_prefix . 'themes, ' . $table_prefix . 'themes_name, ' . $table_prefix . 'topics, ' . $table_prefix . 'topics_watch, ' . $table_prefix . 'user_group, ' . $table_prefix . 'users, ' . $table_prefix . 'vote_desc, ' . $table_prefix . 'vote_results, ' . $table_prefix . 'vote_voters, ' . $table_prefix . 'words'; + _sql($sql, $errored, $error_ary); + break; + + case 'postgresql': + _sql("VACUUM ANALYZE", $errored, $error_ary); + break; +} +*/ + +_write_result($no_updates, $errored, $error_ary); + +?> + + + + + + + + + + +purge(); + +?> + +
php
php3
php4
phtml
pl
cgi
py
rb
asp
aspx
date
[FLASH]
[IMG]
[URL]
PHP
INCLUDEPHP
+* +* if (empty($lang) || !is_array($lang)) +* { +* $lang = array(); +* } +* +* // Adding new category +* $lang['permission_cat']['bugs'] = 'Bugs'; +* +* // Adding new permission set +* $lang['permission_type']['bug_'] = 'Bug Permissions'; +* +* // Adding the permissions +* $lang = array_merge($lang, array( +* 'acl_bug_view' => array('lang' => 'Can view bug reports', 'cat' => 'bugs'), +* 'acl_bug_post' => array('lang' => 'Can post bugs', 'cat' => 'post'), // Using a phpBB category here +* )); +* +*
In order to proceed, you will need the following information to hand:
Some more introductory text can go here...', +
Some more introductory text can go here…', 'INSTALL_INTRO_NEXT' => 'To commence the installation, please press the button below.', 'INSTALL_LOGIN' => 'Login', 'INSTALL_NEXT' => 'Next stage', @@ -155,13 +157,17 @@ $lang = array_merge($lang, array( 'INST_ERR_DB_CONNECT' => 'Could not connect to the database, see error message below', 'INST_ERR_DB_FORUM_PATH' => 'The database file specified is within your forum directory tree. You should put this file in a non web-accessible location', 'INST_ERR_DB_NO_ERROR' => 'No error message given', - 'INST_ERR_DB_NO_MYSQL4' => 'The version of MySQL installed on this machine is incompatible with the "MySQL 4.x/5.x" option you have selected. Please try the "MySQL 3.23.x/4.x" option instead.', - 'INST_ERR_DB_NO_MYSQLI' => 'The version of MySQL installed on this machine is incompatible with the "MySQL 4.1.x/5.x with MySQLi Extension" option you have selected. Please try the "MySQL 4.x/5.x" or "MySQL 3.23.x/4.x" option instead.', + 'INST_ERR_DB_NO_MYSQL4' => 'The version of MySQL installed on this machine is incompatible with the “MySQL 4.x/5.x†option you have selected. Please try the “MySQL 3.23.x/4.x†option instead.', + 'INST_ERR_DB_NO_MYSQLI' => 'The version of MySQL installed on this machine is incompatible with the “MySQL 4.1.x/5.x with MySQLi Extension†option you have selected. Please try the “MySQL 3.23.x/4.x†option instead.', + 'INST_ERR_DB_NO_SQLITE' => 'The version of the SQLite extension you have installed is too old, it must be upgraded to at least 2.8.2.', + 'INST_ERR_DB_NO_ORACLE' => 'The version of Oracle installed on this machine requires you to set the NLS_CHARACTERSET parameter to UTF8. Either upgrade your installation to 9.2+ or change the parameter.', + 'INST_ERR_DB_NO_FIREBIRD' => 'The version of Firebird installed on this machine is older than 2.0, please upgrade to a newer version.', + 'INST_ERR_DB_NO_POSTGRES' => 'The database you have selected was not created in UNICODE or UTF8 encoding. Try installing with a database in UNICODE or UTF8 encoding', 'INST_ERR_DB_NO_NAME' => 'No database name specified', 'INST_ERR_EMAIL_INVALID' => 'The email address you entered is invalid', 'INST_ERR_EMAIL_MISMATCH' => 'The emails you entered did not match.', 'INST_ERR_FATAL' => 'Fatal installation error', - 'INST_ERR_FATAL_DB' => 'A fatal and unrecoverable database error has occured. This may be because the specified user does not have appropriate rights to CREATE TABLES or INSERT data, etc. Further information may be given below. Please contact your hosting provider in the first instance or the support forums of phpBB for further assistance.', + 'INST_ERR_FATAL_DB' => 'A fatal and unrecoverable database error has occured. This may be because the specified user does not have appropriate rights to CREATE TABLES or INSERT data, etc. Further information may be given below. Please contact your hosting provider in the first instance or the support forums of phpBB for further assistance.', 'INST_ERR_FTP_PATH' => 'Could not change to the given directory, please check the path.', 'INST_ERR_FTP_LOGIN' => 'Could not login to FTP server, check your username and password', 'INST_ERR_MISSING_DATA' => 'You must fill out all fields in this block', @@ -170,13 +176,14 @@ $lang = array_merge($lang, array( 'INST_ERR_PASSWORD_TOO_LONG' => 'The password you entered is too long. The maximum length is 30 characters.', 'INST_ERR_PASSWORD_TOO_SHORT' => 'The password you entered is too short. The minimum length is 6 characters.', 'INST_ERR_PREFIX' => 'Tables with the specified prefix already exist, please choose an alternative.', + 'INST_ERR_PREFIX_INVALID' => 'The table prefix you have specified is invalid for your database. Please try another, removing characters such as the hyphen', 'INST_ERR_PREFIX_TOO_LONG' => 'The table prefix you have specified is too long. The maximum length is %d characters.', 'INST_ERR_USER_TOO_LONG' => 'The username you entered is too long. The maximum length is 20 characters.', 'INST_ERR_USER_TOO_SHORT' => 'The username you entered is too short. The minimum length is 3 characters.', 'INVALID_PRIMARY_KEY' => 'Invalid primary key : %s', - 'MAKE_FOLDER_WRITABLE' => 'Please make sure that this folder exists and is writable by the webserver then try again:»%s', - 'MAKE_FOLDERS_WRITABLE' => 'Please make sure that these folders exist and are writable by the webserver then try again:»%s', + 'MAKE_FOLDER_WRITABLE' => 'Please make sure that this folder exists and is writable by the webserver then try again:»%s', + 'MAKE_FOLDERS_WRITABLE' => 'Please make sure that these folders exist and are writable by the webserver then try again:»%s', 'NAMING_CONFLICT' => 'Naming conflict: %s and %s are both aliases%s', 'NEXT_STEP' => 'Proceed to next step', @@ -192,11 +199,11 @@ $lang = array_merge($lang, array( 'PHP_OPTIONAL_MODULE_EXPLAIN' => 'Optional - These modules or applications are optional, you do not need these to use phpBB 3.0. However if you do have them they will will enable greater functionality.', 'PHP_SUPPORTED_DB' => 'Supported Databases', 'PHP_SUPPORTED_DB_EXPLAIN' => 'Required - You must have support for at least one compatible database within PHP. If no database modules are shown as available you should contact your hosting provider or review the relevant PHP installation documentation for advice.', - 'PHP_REGISTER_GLOBALS' => 'PHP setting "register_globals" is disabled', + 'PHP_REGISTER_GLOBALS' => 'PHP setting register_globals is disabled', 'PHP_REGISTER_GLOBALS_EXPLAIN' => 'phpBB will still run if this setting is enabled, but if possible, it is recommended that register_globals is disabled on your PHP install for security reasons.', 'PHP_SAFE_MODE' => 'Safe Mode', 'PHP_SETTINGS' => 'PHP Version and Settings', - 'PHP_SETTINGS_EXPLAIN' => 'Required - You must be running at least version 4.3.3 of PHP in order to install phpBB. If "safe mode" is displayed below your PHP installation is running in that mode. This will impose limitations on remote administration and similar features.', + 'PHP_SETTINGS_EXPLAIN' => 'Required - You must be running at least version 4.3.3 of PHP in order to install phpBB. If safe mode is displayed below your PHP installation is running in that mode. This will impose limitations on remote administration and similar features.', 'PHP_VERSION_REQD' => 'PHP version >= 4.3.3', 'PREFIX_FOUND' => 'A scan of your tables has shown a valid installation using %s as table prefix.', 'PREPROCESS_STEP' => 'Executing pre-processing functions/queries', @@ -228,23 +235,24 @@ $lang = array_merge($lang, array( 'STAGE_REQUIREMENTS' => 'Requirements', 'STAGE_SETTINGS' => 'Settings', 'STARTING_CONVERT' => 'Starting Conversion Process', - 'STEP_PERCENT_COMPLETED' => 'Step %d of %d: %d%% completed', + 'STEP_PERCENT_COMPLETED' => 'Step %d of %d: %d%% completed', 'SUB_INTRO' => 'Introduction', 'SUB_LICENSE' => 'License', 'SUB_SUPPORT' => 'Support', 'SUCCESSFUL_CONNECT' => 'Successful Connection', // TODO: Write some text on obtaining support - 'SUPPORT_BODY' => 'During the beta phase a minimal level of support will be given at the phpBB 3.0 Beta support forum. We will provide answers to general setup questions, configuration problems and support for determining common problems mostly related to bugs. We will not support modifications, custom code/style additions or any users using the beta packages within a live environment.
CREATE TABLES
For additional assistance, please refer to our Quick Start Guide.
To ensure you stay up to date with the latest news and releases, why not subscribe to our mailing list', + 'SUPPORT_BODY' => 'During the beta phase a minimal level of support will be given at the phpBB 3.0 Beta support forum. We will provide answers to general setup questions, configuration problems and support for determining common problems mostly related to bugs. We will not support modifications, custom code/style additions or any users using the beta packages within a live environment.
To ensure you stay up to date with the latest news and releases, why not subscribe to our mailing list', 'SYNC_FORUMS' => 'Starting to sync forums', 'SYNC_TOPICS' => 'Starting to sync topics', 'SYNC_TOPIC_ID' => 'Synchronising topics from topic_id $1%s to $2%s', - 'TABLES_MISSING' => 'Could not find these tables» %s.', + 'TABLES_MISSING' => 'Could not find these tables» %s.', 'TABLE_PREFIX' => 'Prefix for tables in database', - 'TABLE_PREFIX_SAME' => 'The table prefix needs to be the one used by the software you are converting from.» Specified table prefix was %s', + 'TABLE_PREFIX_SAME' => 'The table prefix needs to be the one used by the software you are converting from.» Specified table prefix was %s', 'TESTS_PASSED' => 'Tests passed', 'TESTS_FAILED' => 'Tests failed', + 'UNABLE_WRITE_LOCK' => 'Unable to write lock file', 'UNAVAILABLE' => 'Unavailable', 'UNWRITEABLE' => 'Unwriteable', @@ -254,4 +262,171 @@ $lang = array_merge($lang, array( 'WRITEABLE' => 'Writeable', )); +// Updater +$lang = array_merge($lang, array( + 'ALL_FILES_UP_TO_DATE' => 'All files are up to date with the latest phpBB version. You may want to run the database update tool now.', + 'ARCHIVE_FILE' => 'Source file within archive', + + 'BACK' => 'Back', + + 'CHECK_FILES' => 'Check files', + 'CHECK_FILES_AGAIN' => 'Check files again', + 'CHECK_FILES_EXPLAIN' => 'Within the next step all files will be checked against the update files - this can take a while if this is the first file check.', + 'CHECK_FILES_UP_TO_DATE' => 'According to your database your version is up to date. You may want to proceed with the file check to make sure all files are really up to date with the latest phpBB version.', + 'COLLECTED_INFORMATIONS' => 'Collected file informations', + 'COLLECTED_INFORMATIONS_EXPLAIN'=> 'The list below shows informations about the files needing an update. Please read the information in front of every status block to see what they mean and what you may need to do to perform a successful update.', + 'COMPLETE_LOGIN_TO_BOARD' => 'You should now login to your board and check if everything is working fine. Don’t forget to delete, rename or move your install directory!', + 'CURRENT_FILE' => 'Current original file', + 'CURRENT_VERSION' => 'Current version', + + 'DATABASE_TYPE' => 'Database type', + 'DATABASE_UPDATE_INFO_OLD' => 'The database update file within the install directory is outdated. Please make sure you uploaded the correct version of the file.', + 'DESTINATION' => 'Destination file', + 'DIFF_INLINE' => 'Inline', + 'DIFF_RAW' => 'Raw unified diff', + 'DIFF_SEP_EXPLAIN' => 'End of current file / Begin of new updated file', + 'DIFF_SIDE_BY_SIDE' => 'Side by Side', + 'DIFF_UNIFIED' => 'Unified diff', + 'DO_NOT_UPDATE' => 'Do not update this file', + 'DONE' => 'Done', + 'DOWNLOAD' => 'Download', + 'DOWNLOAD_AS' => 'Download as', + 'DOWNLOAD_UPDATE_METHOD' => 'Download modified files archive', + 'DOWNLOAD_UPDATE_METHOD_EXPLAIN' => 'Once downloaded you should unpack the archive. You will find the modified files you need to upload to your phpBB root directory within it. Please upload the files to their respective locations then. After you have uploaded all files, please check the files again with the other button below.', + + 'ERROR' => 'Error', + + 'FILE_ALREADY_UP_TO_DATE' => 'File is already up to date', + 'FILE_USED' => 'Informations used from', + 'FILES_CONFLICT' => 'Conflict files', + 'FILES_CONFLICT_EXPLAIN' => 'The following files are modified and do not represent the original files from the old version. phpBB determined that these files create conflicts if they are tried to be merged. Please investigate the conflicts and try to manually resolve them or continue the update choosing the preferred merging method. If you resolve the conflicts manually check the files again after you modified the them. You are also able to choose between the preferred merge method for every file. The first one will result in a file where the conflicting lines from your old file will be lost, the other one will result in loosing the changes from the newer file.', + 'FILES_MODIFIED' => 'Modified files', + 'FILES_MODIFIED_EXPLAIN' => 'The following files are modified and do not represent the original files from the old version. The updated file will be a merge between your modifications and the new file.', + 'FILES_NEW' => 'New files', + 'FILES_NEW_EXPLAIN' => 'The following files currently do not exist within your installation.', + 'FILES_NEW_CONFLICT' => 'New conflicting files', + 'FILES_NEW_CONFLICT_EXPLAIN' => 'The following files are new within the latest version but it has been determined that there is already a file with the same name within the same position. This file will be overwritten by the new file.', + 'FILES_NOT_MODIFIED' => 'Not modified files', + 'FILES_NOT_MODIFIED_EXPLAIN' => 'The following files were not modified and represent the original phpBB files from the version you want to update from.', + 'FILES_UP_TO_DATE' => 'Already updated files', + 'FILES_UP_TO_DATE_EXPLAIN' => 'The following files are already up to date and do not need to be updated.', + 'FTP_SETTINGS' => 'FTP Settings', + 'FTP_UPDATE_METHOD' => 'FTP Upload', + + 'INCOMPATIBLE_UPDATE_FILES' => 'The update files found are incompatible with your installed version. Your installed version is %1$s and the update file is for updating phpBB %2$s to %3$s.', + 'INCOMPLETE_UPDATE_FILES' => 'The update files are incomplete', + + 'LATEST_VERSION' => 'Latest version', + 'LINE' => 'Line', + 'LINE_ADDED' => 'Added', + 'LINE_MODIFIED' => 'Modified', + 'LINE_REMOVED' => 'Removed', + 'LINE_UNMODIFIED' => 'Unmodified', + 'LOGIN_UPDATE_EXPLAIN' => 'In order to update your installation you need to login first.', + + 'MAPPING_FILE_STRUCTURE' => 'To ease the upload here are the file locations which map your phpBB installation.', + 'MERGE_MOD_FILE_OPTION' => 'Use modified file code on final merge', + 'MERGE_NEW_FILE_OPTION' => 'Use new file code on final merge', + 'MERGE_SELECT_ERROR' => 'Conflicting file merge modes are not correctly selected.', + + 'NEW_FILE' => 'New updated file', + 'NO_AUTH_UPDATE' => 'Not authorized to update', + 'NO_DATABASE_UPDATE_NEEDED' => 'All of your files seem to be up to date. Since you are already running the latest version you do not need to update your database.', + 'NO_ERRORS' => 'No errors', + 'NO_UPDATE_FILES' => 'Not updating the following files', + 'NO_UPDATE_FILES_EXPLAIN' => 'The following files are new or modified but the directory they normally reside in could not be found on your installation. If this list contains files to other directories than language/ or styles/ than you may have modified your directory structure and the update may be incomplete.', + 'NO_UPDATE_FILES_OUTDATED' => 'No valid update directory was found, please make sure you uploaded the relevant files.Your installation does not seem to be up to date. Updates are available for your version of phpBB %1$s, please visit http://www.phpbb.com/downloads.php to obtain the correct package to update from Version %2$s to Version %3$s.', + 'NO_UPDATE_FILES_UP_TO_DATE' => 'Your version is up to date. There is no need to run the update tool. If you want to make an integrity check on your files make sure you uploaded the correct update files.', + 'NO_UPDATE_INFO' => 'Update file informations could not be found.', + 'NO_UPDATES_REQUIRED' => 'No updates required', + 'NO_VISIBLE_CHANGES' => 'No visible changes', + 'NOTICE' => 'Notice', + 'NUM_CONFLICTS' => 'Number of conflicts', + + 'OLD_UPDATE_FILES' => 'Update files are out of date. The update files found are for updating to phpBB %1$s to phpBB %2$s but the latest version of phpBB is %3$s.', + + 'PERFORM_DATABASE_UPDATE' => 'Perform database update', + 'PERFORM_DATABASE_UPDATE_EXPLAIN' => 'Below you will find a link to the database update script. This script needs to be run seperatly because updating the database might result in unexpected behaviour if you are logged in. The database update can take a while, so please do not stop the execution if it only seems to hang. After you clicked the link and the update finished you can close this window too.', + 'PREVIOUS_VERSION' => 'Previous version', + 'PROGRESS' => 'Progress', + + 'RESULT' => 'Result', + 'RUN_DATABASE_SCRIPT' => 'Update my database now', + + 'SELECT_DIFF_MODE' => 'Select diff mode', + 'SELECT_DOWNLOAD_FORMAT' => 'Select download archive format', + 'SELECT_FTP_SETTINGS' => 'Select FTP Settings', + 'SHOW_DIFF_CONFLICT' => 'Show differences/conflicts', + 'SHOW_DIFF_MODIFIED' => 'Show merged differences', + 'SHOW_DIFF_NEW' => 'Show file contents', + 'SHOW_DIFF_NEW_CONFLICT' => 'Show differences', + 'SHOW_DIFF_NOT_MODIFIED' => 'Show differences', + 'SOME_QUERIES_FAILED' => 'Some queries failed, the statements and errors are listing below', + 'SQL' => 'SQL', + 'SQL_FAILURE_EXPLAIN' => 'This is probably nothing to worry about, update will continue. Should this fail to complete you may need to seek help at our support forums. See README for details on how to obtain advice.', + 'STAGE_FILE_CHECK' => 'Check files', + 'STAGE_UPDATE_DB' => 'Update database', + 'STAGE_UPDATE_FILES' => 'Update files', + 'STAGE_VERSION_CHECK' => 'Version Check', + 'STATUS_CONFLICT' => 'Modified file producing conflicts', + 'STATUS_MODIFIED' => 'Modified file', + 'STATUS_NEW' => 'New file', + 'STATUS_NEW_CONFLICT' => 'Conflicting new file', + 'STATUS_NOT_MODIFIED' => 'Not modified file', + 'STATUS_UP_TO_DATE' => 'Already updated file', + + 'UPDATE_COMPLETED' => 'Update completed', + 'UPDATE_DATABASE' => 'Update database', + 'UPDATE_DATABASE_SCHEMA' => 'Updating database schema', + 'UPDATE_FILES' => 'Update files', + 'UPDATE_FILES_NOTICE' => 'Please make sure you have updated your board files too, this file is only updating your database.', + 'UPDATE_INSTALLATION' => 'Update phpBB Installation', + 'UPDATE_INSTALLATION_EXPLAIN' => 'With this option, it is possible to update your phpBB installation to the latest version.During the process all of your files will be checked for their integrity. You are able to review all differences and files before the update.The file update itself can be done in two different ways.
With this update you only download your personal set of changed files to make sure you do not loose your file modifications you may have done. After you downloaded this package you need to manually upload the files to their correct position under your phpBB root directory. Once done, you are able to do the file check stage again to see if you moved the files to their correct location. If everything is correctly updated you will be forwarded to the database updater.
This method is similar to the first one but without the need to download the changed files and uploading them on your own. This will be done for you. In order to use this method you need to know your FTP login details since you will be asked for them. Once finished you will be redirected to the file check again to make sure everything got updated correctly. If so, you will be forwarded to the database updater.', + 'UPDATE_INSTRUCTIONS' => ' + +
Please read the release announcement for the latest version before you continue your update process, it may contain useful information. It also contains full download links as well as the change log.
The recommended way of updating your installation only takes the following steps:
Once uploaded your board will be offline for normal users. + Now start the update process by pointing your browser to the install folder. + + You will then be guided through the update process. The update is complete after the database update script has been completed successfully - this is the last step within the udpate process. +
{L_INDEX} » {navlinks.FORUM_NAME}
{S_TIMEZONE}
{forumrow.FORUM_DESC}
{forumrow.L_SUBFORUM_STR} {forumrow.SUBFORUMS}
{forumrow.TOPICS}
{forumrow.POSTS}
{forumrow.LAST_POST_TIME}
- {forumrow.LAST_POSTER} + style="font-weight: bold; color: {forumrow.LAST_POSTER_COLOUR}">{forumrow.LAST_POSTER} {forumrow.LAST_POSTER} @@ -59,7 +67,9 @@
{L_NO_FORUMS}
{forumrow.L_MODERATOR_STR}: {forumrow.MODERATORS}
- - {forumrow.LAST_POSTER} - - {forumrow.LAST_POSTER} - - {LAST_POST_IMG} -
{L_NO_POSTS}
{L_INDEX}
{L_LOGIN_INFO}
{L_IN} {searchresults.FORUM_TITLE}
{searchresults.TOPIC_AUTHOR}
style="font-weight: bold; color: {searchresults.TOPIC_AUTHOR_COLOUR}">{searchresults.TOPIC_AUTHOR}{searchresults.TOPIC_AUTHOR}
{searchresults.TOPIC_REPLIES}
{searchresults.TOPIC_VIEWS}
{searchresults.LAST_POST_TIME}
{searchresults.LAST_POST_AUTHOR}{searchresults.LAST_POST_AUTHOR} +
style="font-weight: bold; color: {searchresults.LAST_POST_AUTHOR_COLOUR}">{searchresults.LAST_POST_AUTHOR}{searchresults.LAST_POST_AUTHOR} {searchresults.LAST_POST_IMG}
{L_FORUM}: {searchresults.FORUM_TITLE}{L_GLOBAL} {L_TOPIC}: {searchresults.TOPIC_TITLE}
{topicrow.LAST_POST_TIME}
{topicrow.LAST_POST_AUTHOR}{topicrow.LAST_POST_AUTHOR} +
style="font-weight: bold; color: {topicrow.LAST_POST_AUTHOR_COLOUR}">{topicrow.LAST_POST_AUTHOR}{topicrow.LAST_POST_AUTHOR} {topicrow.LAST_POST_IMG}
- {topicrow.LAST_POST_AUTHOR} + style="font-weight: bold; color: {topicrow.LAST_POST_AUTHOR_COLOUR}">{topicrow.LAST_POST_AUTHOR} {topicrow.LAST_POST_AUTHOR} diff --git a/phpBB/styles/subSilver/template/ucp_main_subscribed.html b/phpBB/styles/subSilver/template/ucp_main_subscribed.html index b0f3d455c0..9bcab695ed 100644 --- a/phpBB/styles/subSilver/template/ucp_main_subscribed.html +++ b/phpBB/styles/subSilver/template/ucp_main_subscribed.html @@ -16,7 +16,7 @@
{forumrow.FORUM_NAME}
{messagerow.RECIPIENTS}{messagerow.MESSAGE_AUTHOR}
![' . $user->lang['MOVE_UP'] . '](' . $phpbb_admin_path . 'images/icon_up.gif "' . $user->lang['MOVE_UP'] . '"){kind=icon}
',
- 'ICON_MOVE_DOWN' => '![' . $user->lang['MOVE_DOWN'] . '](' . $phpbb_admin_path . 'images/icon_down.gif "' . $user->lang['MOVE_DOWN'] . '"){kind=icon}
',
- 'ICON_EDIT' => '![' . $user->lang['EDIT'] . '](' . $phpbb_admin_path . 'images/icon_edit.gif "' . $user->lang['EDIT'] . '"){kind=icon}
',
- 'ICON_DELETE' => '![' . $user->lang['DELETE'] . '](' . $phpbb_admin_path . 'images/icon_delete.gif "' . $user->lang['DELETE'] . '"){kind=icon}
',
- 'ICON_SYNC' => '![' . $user->lang['RESYNC'] . '](' . $phpbb_admin_path . 'images/icon_sync.gif "' . $user->lang['RESYNC'] . '"){kind=icon}
',
+ 'ICON_MOVE_UP' => '![' . $user->lang['MOVE_UP'] . '](' . $phpbb_admin_path . 'images/icon_up_disabled.gif "' . $user->lang['MOVE_UP'] . '"){kind=icon}
',
+ 'ICON_MOVE_DOWN' => '![' . $user->lang['MOVE_DOWN'] . '](' . $phpbb_admin_path . 'images/icon_down_disabled.gif "' . $user->lang['MOVE_DOWN'] . '"){kind=icon}
',
+ 'ICON_EDIT' => '![' . $user->lang['EDIT'] . '](' . $phpbb_admin_path . 'images/icon_edit_disabled.gif "' . $user->lang['EDIT'] . '"){kind=icon}
',
+ 'ICON_DELETE' => '![' . $user->lang['DELETE'] . '](' . $phpbb_admin_path . 'images/icon_delete_disabled.gif "' . $user->lang['DELETE'] . '"){kind=icon}
',
+ 'ICON_SYNC' => '![' . $user->lang['RESYNC'] . '](' . $phpbb_admin_path . 'images/icon_sync_disabled.gif "' . $user->lang['RESYNC'] . '"){kind=icon}
',
+ 'S_USER_LANG' => $user->lang['USER_LANG'],
'S_CONTENT_DIRECTION' => $user->lang['DIRECTION'],
- 'S_CONTENT_ENCODING' => $user->lang['ENCODING'],
+ 'S_CONTENT_ENCODING' => 'UTF-8',
'S_CONTENT_DIR_LEFT' => $user->lang['LEFT'],
'S_CONTENT_DIR_RIGHT' => $user->lang['RIGHT'])
);
- if (!empty($config['send_encoding']))
+ if ($config['send_encoding'])
{
- header('Content-type: text/html; charset: ' . $user->lang['ENCODING']);
+ header('Content-type: text/html; charset=UTF-8');
}
header('Cache-Control: private, no-cache="set-cookie"');
header('Expires: 0');
@@ -371,4 +377,102 @@ function build_cfg_template($tpl_type, $key, &$new, $config_key, $vars)
return $tpl;
}
+/**
+* Going through a config array and validate values, writing errors to $error.
+*/
+function validate_config_vars($config_vars, &$cfg_array, &$error)
+{
+ global $phpbb_root_path, $user;
+
+ foreach ($config_vars as $config_name => $config_definition)
+ {
+ if (!isset($cfg_array[$config_name]) || strpos($config_name, 'legend') !== false)
+ {
+ continue;
+ }
+
+ if (!isset($config_definition['validate']))
+ {
+ continue;
+ }
+
+ // Validate a bit. ;) String is already checked through request_var(), therefore we do not check this again
+ switch ($config_definition['validate'])
+ {
+ case 'bool':
+ $cfg_array[$config_name] = ($cfg_array[$config_name]) ? 1 : 0;
+ break;
+
+ case 'int':
+ $cfg_array[$config_name] = (int) $cfg_array[$config_name];
+ break;
+
+ // Relative path (appended $phpbb_root_path)
+ case 'rpath':
+ case 'rwpath':
+ if (!$cfg_array[$config_name])
+ {
+ break;
+ }
+
+ $destination = $cfg_array[$config_name];
+
+ // Adjust destination path (no trailing slash)
+ if ($destination{(sizeof($destination)-1)} == '/' || $destination{(sizeof($destination)-1)} == '\\')
+ {
+ $destination = substr($destination, 0, sizeof($destination)-2);
+ }
+
+ $destination = str_replace(array('../', '..\\', './', '.\\'), '', $destination);
+ if ($destination && ($destination[0] == '/' || $destination[0] == "\\"))
+ {
+ $destination = '';
+ }
+
+ $cfg_array[$config_name] = trim($destination);
+
+ // Path being relative (still prefixed by phpbb_root_path), but with the ability to escape the root dir...
+ case 'path':
+ case 'wpath':
+
+ if (!$cfg_array[$config_name])
+ {
+ break;
+ }
+
+ $cfg_array[$config_name] = trim($cfg_array[$config_name]);
+
+ // Make sure no NUL byte is present...
+ if (strpos($cfg_array[$config_name], '\0') !== false || strpos($cfg_array[$config_name], '%00') !== false)
+ {
+ $cfg_array[$config_name] = '';
+ break;
+ }
+
+ if (!file_exists($phpbb_root_path . $cfg_array[$config_name]))
+ {
+ $error[] = sprintf($user->lang['DIRECTORY_DOES_NOT_EXIST'], $cfg_array[$config_name]);
+ }
+
+ if (file_exists($phpbb_root_path . $cfg_array[$config_name]) && !is_dir($phpbb_root_path . $cfg_array[$config_name]))
+ {
+ $error[] = sprintf($user->lang['DIRECTORY_NOT_DIR'], $cfg_array[$config_name]);
+ }
+
+ // Check if the path is writeable
+ if ($config_definition['validate'] == 'wpath' || $config_definition['validate'] == 'rwpath')
+ {
+ if (file_exists($phpbb_root_path . $cfg_array[$config_name]) && !is_writeable($phpbb_root_path . $cfg_array[$config_name]))
+ {
+ $error[] = sprintf($user->lang['DIRECTORY_NOT_WRITEABLE'], $cfg_array[$config_name]);
+ }
+ }
+
+ break;
+ }
+ }
+
+ return;
+}
+
?>
\ No newline at end of file
diff --git a/phpBB/adm/style/acp_attachments.html b/phpBB/adm/style/acp_attachments.html
index 964a07bf67..42de3e7060 100644
--- a/phpBB/adm/style/acp_attachments.html
+++ b/phpBB/adm/style/acp_attachments.html
@@ -295,10 +295,9 @@