From e9e7aeb7563642b0692051b7ae494041a1630781 Mon Sep 17 00:00:00 2001 From: Marc Alexander Date: Tue, 20 May 2025 20:54:31 +0200 Subject: [PATCH 01/14] [ticket/17514] Replace phpbb3 with phpbb in git-tools PHPBB-17514 --- git-tools/hooks/commit-msg | 2 +- git-tools/merge.php | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/git-tools/hooks/commit-msg b/git-tools/hooks/commit-msg index 6405d5b7c8..ab8db65d6d 100755 --- a/git-tools/hooks/commit-msg +++ b/git-tools/hooks/commit-msg @@ -1,6 +1,6 @@ #!/bin/sh # -# A hook to check syntax of a phpBB3 commit message, per: +# A hook to check syntax of a phpBB commit message, per: # * # * # diff --git a/git-tools/merge.php b/git-tools/merge.php index a9bb051401..7feda88933 100755 --- a/git-tools/merge.php +++ b/git-tools/merge.php @@ -56,7 +56,7 @@ catch (RuntimeException $e) function work($pull_id, $remote) { // Get some basic data - $pull = get_pull('phpbb', 'phpbb3', $pull_id); + $pull = get_pull('phpbb', 'phpbb', $pull_id); if (!$pull_id) { @@ -79,7 +79,7 @@ function work($pull_id, $remote) run("git checkout develop-olympus"); run("git pull $remote develop-olympus"); - add_remote($pull_user, 'phpbb3'); + add_remote($pull_user, 'phpbb'); run("git fetch $pull_user"); run("git merge --no-ff $pull_user/$pull_branch"); run("phpBB/vendor/bin/phpunit"); @@ -94,7 +94,7 @@ function work($pull_id, $remote) run("git checkout develop"); run("git pull $remote develop"); - add_remote($pull_user, 'phpbb3'); + add_remote($pull_user, 'phpbb'); run("git fetch $pull_user"); run("git merge --no-ff $pull_user/$pull_branch"); run("phpBB/vendor/bin/phpunit"); From 8427b43b3264e1cdd2e4babd094d88ca62cad551 Mon Sep 17 00:00:00 2001 From: Marc Alexander Date: Tue, 20 May 2025 20:55:49 +0200 Subject: [PATCH 02/14] [ticket/17514] Replace phpBB3 with phpBB in javascript PHPBB-17514 --- phpBB/adm/style/admin.js | 2 +- phpBB/styles/prosilver/template/forum_fn.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/phpBB/adm/style/admin.js b/phpBB/adm/style/admin.js index ff89458ca8..2655fa6d90 100644 --- a/phpBB/adm/style/admin.js +++ b/phpBB/adm/style/admin.js @@ -1,7 +1,7 @@ /* global phpbb */ /** -* phpBB3 ACP functions +* phpBB ACP functions */ /** diff --git a/phpBB/styles/prosilver/template/forum_fn.js b/phpBB/styles/prosilver/template/forum_fn.js index 7ac04a5f39..7f73d844e1 100644 --- a/phpBB/styles/prosilver/template/forum_fn.js +++ b/phpBB/styles/prosilver/template/forum_fn.js @@ -1,7 +1,7 @@ /* global phpbb */ /** -* phpBB3 forum functions +* phpBB forum functions */ /** From 4ef2a543afe22eb3009f1a112ce1139c0ce39cc6 Mon Sep 17 00:00:00 2001 From: Marc Alexander Date: Tue, 20 May 2025 20:56:23 +0200 Subject: [PATCH 03/14] [ticket/17514] Replace phpBB3 paths in docs PHPBB-17514 --- phpBB/docs/README.html | 4 ++-- phpBB/docs/assets/css/stylesheet.css | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/phpBB/docs/README.html b/phpBB/docs/README.html index 04dcad8e28..c3f02acf45 100644 --- a/phpBB/docs/README.html +++ b/phpBB/docs/README.html @@ -146,7 +146,7 @@

For more information about styles, please see: https://www.phpbb.com/styles/

-

Please note that 3rd party styles downloaded for versions of phpBB2 will not work in phpBB3. It is also important to ensure that the style is updated to match the current version of the phpBB software you are using.

+

Please note that 3rd party styles downloaded for older versions of phpBB might not work in the latest phpBB. It is also important to ensure that the style is updated to match the current version of the phpBB software you are using.

Once you have downloaded a style, the usual next step is to unarchive (or upload the unarchived contents of) the package into your styles/ directory. You then need to visit Administration Control Panel -> Customise tab -> Style management -> Install Styles where you should see the new style available. Click "Install style" to install the style.

@@ -250,7 +250,7 @@

The phpBB developers use a bug tracking system to store, list and manage all reported bugs, it can be found at the location listed below. Please DO NOT post bug reports to our forums. In addition please DO NOT use the bug tracker for support requests. Posting such a request will only see you directed to the support forums (while taking time away from working on real bugs).

-

http://tracker.phpbb.com/browse/PHPBB3

+

http://tracker.phpbb.com/browse/PHPBB

While we very much appreciate receiving bug reports (the more reports the more stable phpBB will be) we ask you carry out a few steps before adding new entries:

diff --git a/phpBB/docs/assets/css/stylesheet.css b/phpBB/docs/assets/css/stylesheet.css index b240a90d58..e4c743a958 100644 --- a/phpBB/docs/assets/css/stylesheet.css +++ b/phpBB/docs/assets/css/stylesheet.css @@ -1,5 +1,5 @@ /* - The original "prosilver" theme for phpBB3 + The original "prosilver" theme for phpBB Created by subBlue design :: http://www.subBlue.com */ From 705df48dff3a102595aaf070f3e3d0f7cdcbf2a4 Mon Sep 17 00:00:00 2001 From: Marc Alexander Date: Tue, 20 May 2025 20:56:51 +0200 Subject: [PATCH 04/14] [ticket/17514] Replace phpBB3 with phpBB in includes PHPBB-17514 --- phpBB/includes/acp/acp_groups.php | 2 +- phpBB/includes/functions.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/phpBB/includes/acp/acp_groups.php b/phpBB/includes/acp/acp_groups.php index bafeafbc06..8264611516 100644 --- a/phpBB/includes/acp/acp_groups.php +++ b/phpBB/includes/acp/acp_groups.php @@ -458,7 +458,7 @@ class acp_groups * Validate the length of "Maximum number of allowed recipients per * private message" setting. We use 16777215 as a maximum because it matches * MySQL unsigned mediumint maximum value which is the lowest amongst DBMSes - * supported by phpBB3. Also validate the submitted colour value. + * supported by phpBB. Also validate the submitted colour value. */ $validation_checks = array( 'max_recipients' => array('num', false, 0, 16777215), diff --git a/phpBB/includes/functions.php b/phpBB/includes/functions.php index c5e60b497d..f725d5f996 100644 --- a/phpBB/includes/functions.php +++ b/phpBB/includes/functions.php @@ -3194,7 +3194,7 @@ function msg_handler($errno, $msg_text, $errfile, $errline): bool * and converts backslashes to forward slashes. * * @param string $errfile Absolute file path -* (e.g. /var/www/phpbb3/phpBB/includes/functions.php) +* (e.g. /var/www/phpbb/phpBB/includes/functions.php) * Please note that if $errfile is outside of the phpBB root, * the root path will not be found and can not be filtered. * @return string Relative file path From dbc4f16cfa1cc15fdc30a76d6849adcabd864631 Mon Sep 17 00:00:00 2001 From: Marc Alexander Date: Tue, 20 May 2025 20:57:45 +0200 Subject: [PATCH 05/14] [ticket/17514] Replace phpBB3 with phpBB in installer PHPBB-17514 --- phpBB/install/convertors/convert_phpbb20.php | 4 ++-- phpBB/install/convertors/functions_phpbb20.php | 4 ++-- phpBB/install/schemas/schema_data.sql | 2 +- .../module/install_database/task/add_config_settings.php | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/phpBB/install/convertors/convert_phpbb20.php b/phpBB/install/convertors/convert_phpbb20.php index db5a38db1f..6576275d6a 100644 --- a/phpBB/install/convertors/convert_phpbb20.php +++ b/phpBB/install/convertors/convert_phpbb20.php @@ -103,7 +103,7 @@ $tables = array( * In either of the latter cases 'table_name' indicates the name of the table in the database * * 'settings' is an array which maps the name of the config directive in the source forum -* to the config directive in phpBB3. It can either be a direct mapping or use a function. +* to the config directive in phpBB. It can either be a direct mapping or use a function. * Please note that the contents of the old config value are passed to the function, therefore * an in-built function requiring the variable passed by reference is not able to be used. Since * empty() is such a function we created the function is_empty() to be used instead. @@ -332,7 +332,7 @@ if (!$get_info) // if (defined("MOD_ATTACHMENT")) { import_attachment_files(); phpbb_copy_thumbnails(); } // phpBB2 allowed some similar usernames to coexist which would have the same - // username_clean in phpBB3 which is not possible, so we'll give the admin a list + // username_clean in phpBB which is not possible, so we'll give the admin a list // of user ids and usernames and let him deicde what he wants to do with them 'execute_first' => ' phpbb_create_userconv_table(); diff --git a/phpBB/install/convertors/functions_phpbb20.php b/phpBB/install/convertors/functions_phpbb20.php index 168c6be348..450800c314 100644 --- a/phpBB/install/convertors/functions_phpbb20.php +++ b/phpBB/install/convertors/functions_phpbb20.php @@ -1176,7 +1176,7 @@ function phpbb_convert_group_type($group_type) break; } - // Never return GROUP_SPECIAL here, because only phpBB3's default groups are allowed to have this type set. + // Never return GROUP_SPECIAL here, because only phpBB's default groups are allowed to have this type set. return GROUP_HIDDEN; } @@ -1735,7 +1735,7 @@ function phpbb_disallowed_username($username) /** * Checks whether there are any usernames on the old board that would map to the same -* username_clean on phpBB3. Prints out a list if any exist and exits. +* username_clean on phpBB. Prints out a list if any exist and exits. */ function phpbb_create_userconv_table() { diff --git a/phpBB/install/schemas/schema_data.sql b/phpBB/install/schemas/schema_data.sql index 7f53a3adc4..0c4910fb78 100644 --- a/phpBB/install/schemas/schema_data.sql +++ b/phpBB/install/schemas/schema_data.sql @@ -86,7 +86,7 @@ INSERT INTO phpbb_config (config_name, config_value) VALUES ('chg_passforce', '0 INSERT INTO phpbb_config (config_name, config_value) VALUES ('confirm_refresh', '1'); INSERT INTO phpbb_config (config_name, config_value) VALUES ('contact_admin_form_enable', '1'); INSERT INTO phpbb_config (config_name, config_value) VALUES ('cookie_domain', ''); -INSERT INTO phpbb_config (config_name, config_value) VALUES ('cookie_name', 'phpbb3'); +INSERT INTO phpbb_config (config_name, config_value) VALUES ('cookie_name', 'phpbb'); INSERT INTO phpbb_config (config_name, config_value) VALUES ('cookie_notice', '0'); INSERT INTO phpbb_config (config_name, config_value) VALUES ('cookie_path', '/'); INSERT INTO phpbb_config (config_name, config_value) VALUES ('cookie_secure', '0'); diff --git a/phpBB/phpbb/install/module/install_database/task/add_config_settings.php b/phpBB/phpbb/install/module/install_database/task/add_config_settings.php index 14c88a04d3..9e3c8d38db 100644 --- a/phpBB/phpbb/install/module/install_database/task/add_config_settings.php +++ b/phpBB/phpbb/install/module/install_database/task/add_config_settings.php @@ -173,7 +173,7 @@ class add_config_settings extends database_task } // We set a (semi-)unique cookie name to bypass login issues related to the cookie name. - $cookie_name = 'phpbb3_'; + $cookie_name = 'phpbb_'; $rand_str = md5(mt_rand()); $rand_str = str_replace('0', 'z', base_convert($rand_str, 16, 35)); $rand_str = substr($rand_str, 0, 5); From ac233ce7abe1f32b7c1e9f10aaf06abece797226 Mon Sep 17 00:00:00 2001 From: Marc Alexander Date: Tue, 20 May 2025 20:58:24 +0200 Subject: [PATCH 06/14] [ticket/17514] Replace phpBB3 with phpBB in language variables PHPBB-17514 --- phpBB/language/en/acp/board.php | 2 +- phpBB/language/en/acp/forums.php | 2 +- phpBB/language/en/acp/permissions.php | 2 +- phpBB/language/en/install.php | 24 ++++++++++++------------ 4 files changed, 15 insertions(+), 15 deletions(-) diff --git a/phpBB/language/en/acp/board.php b/phpBB/language/en/acp/board.php index 4bdaa12796..3c1cc89d48 100644 --- a/phpBB/language/en/acp/board.php +++ b/phpBB/language/en/acp/board.php @@ -458,7 +458,7 @@ $lang = array_merge($lang, array( 'RANKS_PATH' => 'Rank image storage path', 'RANKS_PATH_EXPLAIN' => 'Path under your phpBB root directory, e.g. images/ranks.', 'SCRIPT_PATH' => 'Script path', - 'SCRIPT_PATH_EXPLAIN' => 'The path where phpBB is located relative to the domain name, e.g. /phpBB3.', + 'SCRIPT_PATH_EXPLAIN' => 'The path where phpBB is located relative to the domain name, e.g. /phpBB.', 'SERVER_NAME' => 'Domain name', 'SERVER_NAME_EXPLAIN' => 'The domain name this board runs from (for example: example.com).', 'SERVER_PORT' => 'Server port', diff --git a/phpBB/language/en/acp/forums.php b/phpBB/language/en/acp/forums.php index 3ab152345c..6810273f1d 100644 --- a/phpBB/language/en/acp/forums.php +++ b/phpBB/language/en/acp/forums.php @@ -77,7 +77,7 @@ $lang = array_merge($lang, array( 'ENABLE_TOPIC_ICONS' => 'Enable topic icons', 'FORUM_ADMIN' => 'Forum administration', - 'FORUM_ADMIN_EXPLAIN' => 'In phpBB3 everything is forum based. A category is just a special type of forum. Each forum can have an unlimited number of sub-forums and you can determine whether each may be posted to or not (i.e. whether it acts like an old category). Here you can add, edit, delete, lock, unlock individual forums as well as set certain additional controls. If your posts and topics have got out of sync you can also resynchronise a forum. You need to copy or set appropriate permissions for newly created forums to have them displayed.', + 'FORUM_ADMIN_EXPLAIN' => 'In phpBB everything is forum based. A category is just a special type of forum. Each forum can have an unlimited number of sub-forums and you can determine whether each may be posted to or not (i.e. whether it acts like an old category). Here you can add, edit, delete, lock, unlock individual forums as well as set certain additional controls. If your posts and topics have got out of sync you can also resynchronise a forum. You need to copy or set appropriate permissions for newly created forums to have them displayed.', 'FORUM_AUTO_PRUNE' => 'Enable auto-pruning', 'FORUM_AUTO_PRUNE_EXPLAIN' => 'Prunes the forum of topics, set the frequency/age parameters below.', 'FORUM_CREATED' => 'Forum created successfully.', diff --git a/phpBB/language/en/acp/permissions.php b/phpBB/language/en/acp/permissions.php index 693090139f..cd4085d746 100644 --- a/phpBB/language/en/acp/permissions.php +++ b/phpBB/language/en/acp/permissions.php @@ -54,7 +54,7 @@ $lang = array_merge($lang, array(
-

For further information on setting up and managing permissions on your phpBB3 board, please see the section on Setting permissions of our Quick Start Guide.

+

For further information on setting up and managing permissions on your phpBB board, please see the section on Setting permissions of our Quick Start Guide.

', 'ACL_NEVER' => 'Never', diff --git a/phpBB/language/en/install.php b/phpBB/language/en/install.php index 9a73b76c42..ff78e96522 100644 --- a/phpBB/language/en/install.php +++ b/phpBB/language/en/install.php @@ -45,18 +45,18 @@ $lang = array_merge($lang, array( // Introduction page 'INTRODUCTION_TITLE' => 'Introduction', - 'INTRODUCTION_BODY' => 'Welcome to phpBB3!

phpBB® is the most widely used open source bulletin board solution in the world. phpBB3 is the latest installment in a package line started in 2000. Like its predecessors, phpBB3 is feature-rich, user-friendly, and fully supported by the phpBB Team. phpBB3 greatly improves on what made phpBB2 popular, and adds commonly requested features that were not present in previous versions. We hope it exceeds your expectations.

This installation system will guide you through installing phpBB3, updating to the latest version of phpBB3 from past releases, as well as converting to phpBB3 from a different discussion board system (including phpBB2). For more information, we encourage you to read the installation guide.

To read the phpBB3 license or learn about obtaining support and our stance on it, please select the respective options from the side menu. To continue, please select the appropriate tab above.', + 'INTRODUCTION_BODY' => 'Welcome to phpBB!

phpBB® is the most widely used open source bulletin board solution in the world. phpBB is the latest installment in a package line started in 2000. Like its predecessors, phpBB is feature-rich, user-friendly, and fully supported by the phpBB Team. phpBB greatly improves on what made phpBB2 and phpBB3 popular, and adds commonly requested features that were not present in previous versions. We hope it exceeds your expectations.

This installation system will guide you through installing phpBB, updating to the latest version of phpBB from past releases, as well as converting to phpBB from a different discussion board system (including phpBB2). For more information, we encourage you to read the installation guide.

To read the phpBB license or learn about obtaining support and our stance on it, please select the respective options from the side menu. To continue, please select the appropriate tab above.', // Support page 'SUPPORT_TITLE' => 'Support', - 'SUPPORT_BODY' => 'Full support will be provided for the current stable release of phpBB3, free of charge. This includes:

  • installation
  • configuration
  • technical questions
  • problems relating to potential bugs in the software
  • updating from Release Candidate (RC) versions to the latest stable version
  • converting from phpBB 2.0.x to phpBB3
  • converting from other discussion board software to phpBB3 (please see the Convertors Forum)

We encourage users still running beta versions of phpBB3 to replace their installation with a fresh copy of the latest version.

Extensions / Styles

For issues relating to Extensions, please post in the appropriate Extensions Forum.
For issues relating to styles, templates and themes, please post in the appropriate Styles Forum.

If your question relates to a specific package, please post directly in the topic dedicated to the package.

Obtaining Support

Support Section
Quick Start Guide

To ensure you stay up to date with the latest news and releases, follow us on Twitter and Facebook

', + 'SUPPORT_BODY' => 'Full support will be provided for the current stable release of phpBB, free of charge. This includes:

  • installation
  • configuration
  • technical questions
  • problems relating to potential bugs in the software
  • updating from Release Candidate (RC) versions to the latest stable version
  • converting from phpBB 2.0.x to phpBB
  • converting from other discussion board software to phpBB (please see the Convertors Forum)

We encourage users still running pre-release versions of phpBB to replace their installation with a fresh copy of the latest version.

Extensions / Styles

For issues relating to Extensions, please post in the appropriate Extensions Forum.
For issues relating to styles, templates and themes, please post in the appropriate Styles Forum.

If your question relates to a specific package, please post directly in the topic dedicated to the package.

Obtaining Support

Support Section
Quick Start Guide

To ensure you stay up to date with the latest news and releases, follow us on Twitter and Facebook

', // License 'LICENSE_TITLE' => 'General Public License', // Install page 'INSTALL_INTRO' => 'Welcome to Installation', - 'INSTALL_INTRO_BODY' => 'With this option, it is possible to install phpBB3 onto your server.

In order to proceed, you will need your database settings. If you do not know your database settings, please contact your host and ask for them. You will not be able to continue without them. You need:

+ 'INSTALL_INTRO_BODY' => 'With this option, it is possible to install phpBB onto your server.

In order to proceed, you will need your database settings. If you do not know your database settings, please contact your host and ask for them. You will not be able to continue without them. You need:

  • The Database Type - the database you will be using.
    • @@ -68,7 +68,7 @@ $lang = array_merge($lang, array(

    Note: if you are installing using SQLite, you should enter the full path to your database file in the DSN field and leave the username and password fields blank. For security reasons, you should make sure that the database file is not stored in a location accessible from the web.

    -

    phpBB3 supports the following databases:

    +

    phpBB supports the following databases:

    • MySQL 4.1.3 or above (MySQLi required)
    • PostgreSQL 8.3+
      • @@ -235,7 +235,7 @@ $lang = array_merge($lang, array( 'UPGRADE_INSTRUCTIONS' => 'A new feature release %1$s is available. Please read the release announcement to learn about what it has to offer, and how to upgrade.', 'SERVER_CONFIG' => 'Server configuration', 'SCRIPT_PATH' => 'Script path', - 'SCRIPT_PATH_EXPLAIN' => 'The path where phpBB is located relative to the domain name, e.g. /phpBB3.', + 'SCRIPT_PATH_EXPLAIN' => 'The path where phpBB is located relative to the domain name, e.g. /phpBB.', )); // Default database schema entries... @@ -244,7 +244,7 @@ $lang = array_merge($lang, array( 'CONFIG_SITE_DESC' => 'A short text to describe your forum', 'CONFIG_SITENAME' => 'yourdomain.com', - 'DEFAULT_INSTALL_POST' => 'This is an example post in your phpBB3 installation. Everything seems to be working. You may delete this post if you like and continue to set up your board. During the installation process your first category and your first forum are assigned an appropriate set of permissions for the predefined usergroups administrators, bots, global moderators, guests, registered users and registered COPPA users. If you also choose to delete your first category and your first forum, do not forget to assign permissions for all these usergroups for all new categories and forums you create. It is recommended to rename your first category and your first forum and copy permissions from these while creating new categories and forums. Have fun!', + 'DEFAULT_INSTALL_POST' => 'This is an example post in your phpBB installation. Everything seems to be working. You may delete this post if you like and continue to set up your board. During the installation process your first category and your first forum are assigned an appropriate set of permissions for the predefined usergroups administrators, bots, global moderators, guests, registered users and registered COPPA users. If you also choose to delete your first category and your first forum, do not forget to assign permissions for all these usergroups for all new categories and forums you create. It is recommended to rename your first category and your first forum and copy permissions from these while creating new categories and forums. Have fun!', 'FORUMS_FIRST_CATEGORY' => 'Your first category', 'FORUMS_TEST_FORUM_DESC' => 'Description of your first forum.', @@ -281,7 +281,7 @@ $lang = array_merge($lang, array( 'SMILIES_VERY_HAPPY' => 'Very Happy', 'SMILIES_WINK' => 'Wink', - 'TOPICS_TOPIC_TITLE' => 'Welcome to phpBB3', + 'TOPICS_TOPIC_TITLE' => 'Welcome to phpBB', )); // Common navigation items' translation @@ -365,7 +365,7 @@ $lang = array_merge($lang, array(

      How to update your installation with the Full Package

      -

      The recommended way of updating your installation is using the full package. If core phpBB files have been modified in your installation you may wish to use the advanced update package in order to not lose these changes. You are also able to update your installation using the other methods listed within the INSTALL.html document. The steps for updating phpBB3 using the full package are:

      +

      The recommended way of updating your installation is using the full package. If core phpBB files have been modified in your installation you may wish to use the advanced update package in order to not lose these changes. You are also able to update your installation using the other methods listed within the INSTALL.html document. The steps for updating phpBB using the full package are:

      1. Backup all board files and the database.
        2. @@ -374,7 +374,7 @@ $lang = array_merge($lang, array(
      2. Remove (delete) the config.php file, and the /images, /store and /files folders from the package (not your site).
      3. Go to the ACP, Board settings, and make sure prosilver is set as the default style. If not, set it to prosilver.
      4. Delete the /vendor and /cache folders from the board’s root folder on the host.
        5. -
      5. Via FTP or SSH upload the remaining files and folders (that is, the remaining CONTENTS of the phpBB3 folder) to the root folder of your board installation on the server, overwriting the existing files. (Note: take care not to delete any extensions in your /ext folder when uploading the new phpBB3 contents.)
        6. +
      6. Via FTP or SSH upload the remaining files and folders (that is, the remaining CONTENTS of the phpBB folder) to the root folder of your board installation on the server, overwriting the existing files. (Note: take care not to delete any extensions in your /ext folder when uploading the new phpBB contents.)
      7. Now start the update process by pointing your browser to the install folder.
      8. Follow the steps to update the database and let that run to completion.
      9. Via FTP or SSH delete the /install folder from the root of your board installation.

        10. @@ -388,7 +388,7 @@ $lang = array_merge($lang, array(

        How to update your installation with the Advanced Update Package

        -

        The advanced update package is only recommended for expert users in case core phpBB files have been modified in your installation. You are also able to update your installation using the methods listed within the INSTALL.html document. The steps for updating phpBB3 using the advanced update package are:

        +

        The advanced update package is only recommended for expert users in case core phpBB files have been modified in your installation. You are also able to update your installation using the methods listed within the INSTALL.html document. The steps for updating phpBB using the advanced update package are:

        1. Go to the phpBB.com downloads page and download the "Advanced Update Package" archive.
          2. @@ -503,7 +503,7 @@ $lang = array_merge($lang, array( 'CONVERT_NOT_EXIST' => 'The specified convertor does not exist.', 'DEV_NO_TEST_FILE' => 'No value has been specified for the test_file variable in the convertor. If you are a user of this convertor, you should not be seeing this error, please report this message to the convertor author. If you are a convertor author, you must specify the name of a file which exists in the source board to allow the path to it to be verified.', 'COULD_NOT_FIND_PATH' => 'Could not find path to your former board. Please check your settings and try again.
          » %s was specified as the source path.', - 'CONFIG_PHPBB_EMPTY' => 'The phpBB3 config variable for “%s” is empty.', + 'CONFIG_PHPBB_EMPTY' => 'The phpBB config variable for “%s” is empty.', '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.', @@ -539,7 +539,7 @@ $lang = array_merge($lang, array( 'DEFAULT_PREFIX_IS' => 'The convertor was not able to find tables with the specified prefix. Please make sure you have entered the correct details for the board you are converting from. The default table prefix for %1$s is %2$s.', 'SPECIFY_OPTIONS' => 'Specify conversion options', 'FORUM_PATH' => 'Board path', - 'FORUM_PATH_EXPLAIN' => 'This is the relative path on disk to your former board from the root of this phpBB3 installation.', + 'FORUM_PATH_EXPLAIN' => 'This is the relative path on disk to your former board from the root of this phpBB installation.', 'REFRESH_PAGE' => 'Refresh page to continue conversion', 'REFRESH_PAGE_EXPLAIN' => 'If set to yes, the convertor will refresh the page to continue the conversion after having finished a step. If this is your first conversion for testing purposes and to determine any errors in advance, we suggest to set this to No.', From 24d4b26a82fd84e85621a9ec35063cd56c77ad6e Mon Sep 17 00:00:00 2001 From: Marc Alexander Date: Tue, 20 May 2025 20:58:51 +0200 Subject: [PATCH 07/14] [ticket/17514] Replace phpBB3 with phpBB in phpbb namespace PHPBB-17514 --- phpBB/phpbb/auth/provider/apache.php | 2 +- phpBB/phpbb/auth/provider/db.php | 2 +- phpBB/phpbb/auth/provider/ldap.php | 2 +- phpBB/phpbb/auth/provider/oauth/oauth.php | 2 +- phpBB/phpbb/db/driver/mssqlnative.php | 2 +- phpBB/phpbb/session.php | 4 ++-- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/phpBB/phpbb/auth/provider/apache.php b/phpBB/phpbb/auth/provider/apache.php index 4da0ec8637..1f3a9f86eb 100644 --- a/phpBB/phpbb/auth/provider/apache.php +++ b/phpBB/phpbb/auth/provider/apache.php @@ -21,7 +21,7 @@ use phpbb\request\type_cast_helper; use phpbb\user; /** -* Apache authentication provider for phpBB3 +* Apache authentication provider for phpBB */ class apache extends base { diff --git a/phpBB/phpbb/auth/provider/db.php b/phpBB/phpbb/auth/provider/db.php index 5f8ebd6ac3..2666a4768d 100644 --- a/phpBB/phpbb/auth/provider/db.php +++ b/phpBB/phpbb/auth/provider/db.php @@ -21,7 +21,7 @@ use phpbb\passwords\manager; use phpbb\user; /** - * Database authentication provider for phpBB3 + * Database authentication provider for phpBB * This is for authentication via the integrated user table */ class db extends base diff --git a/phpBB/phpbb/auth/provider/ldap.php b/phpBB/phpbb/auth/provider/ldap.php index 69c0952f1d..ce23714036 100644 --- a/phpBB/phpbb/auth/provider/ldap.php +++ b/phpBB/phpbb/auth/provider/ldap.php @@ -20,7 +20,7 @@ use phpbb\language\language; use phpbb\user; /** - * Database authentication provider for phpBB3 + * Database authentication provider for phpBB * This is for authentication via the integrated user table */ class ldap extends base diff --git a/phpBB/phpbb/auth/provider/oauth/oauth.php b/phpBB/phpbb/auth/provider/oauth/oauth.php index a9fd2783b6..ef98c2aad8 100644 --- a/phpBB/phpbb/auth/provider/oauth/oauth.php +++ b/phpBB/phpbb/auth/provider/oauth/oauth.php @@ -31,7 +31,7 @@ use phpbb\request\request_interface; use phpbb\user; /** - * OAuth authentication provider for phpBB3 + * OAuth authentication provider for phpBB */ class oauth extends base { diff --git a/phpBB/phpbb/db/driver/mssqlnative.php b/phpBB/phpbb/db/driver/mssqlnative.php index 9a90a4594c..402764104e 100644 --- a/phpBB/phpbb/db/driver/mssqlnative.php +++ b/phpBB/phpbb/db/driver/mssqlnative.php @@ -37,7 +37,7 @@ class mssqlnative extends \phpbb\db\driver\mssql_base // Test for driver support, to avoid suppressed fatal error if (!function_exists('sqlsrv_connect')) { - $this->connect_error = 'Native MS SQL Server driver for PHP is missing or needs to be updated. Version 1.1 or later is required to install phpBB3. You can download the driver from: http://www.microsoft.com/sqlserver/2005/en/us/PHP-Driver.aspx'; + $this->connect_error = 'Native MS SQL Server driver for PHP is missing or needs to be updated. Version 1.1 or later is required to install phpBB. You can download the driver from: http://www.microsoft.com/sqlserver/2005/en/us/PHP-Driver.aspx'; return $this->sql_error(''); } diff --git a/phpBB/phpbb/session.php b/phpBB/phpbb/session.php index cc86f6f3ce..5a1c2e872f 100644 --- a/phpBB/phpbb/session.php +++ b/phpBB/phpbb/session.php @@ -125,10 +125,10 @@ class session $page .= '?' . $query_string; } - // The script path from the webroot to the current directory (for example: /phpBB3/adm/) : always prefixed with / and ends in / + // The script path from the webroot to the current directory (for example: /phpBB/adm/) : always prefixed with / and ends in / $script_path = $symfony_request->getBasePath(); - // The script path from the webroot to the phpBB root (for example: /phpBB3/) + // The script path from the webroot to the phpBB root (for example: /phpBB/) $script_dirs = explode('/', $script_path); array_splice($script_dirs, -count($page_dirs)); $root_script_path = implode('/', $script_dirs) . (count($root_dirs) ? '/' . implode('/', $root_dirs) : ''); From 7fe8188b7814905ed59feae26e6126b9450cd355 Mon Sep 17 00:00:00 2001 From: Marc Alexander Date: Tue, 20 May 2025 20:59:16 +0200 Subject: [PATCH 08/14] [ticket/17514] Adjust style info for phpBB instead of phpBB3 PHPBB-17514 --- phpBB/styles/prosilver/template/overall_header.html | 2 +- phpBB/styles/prosilver/theme/stylesheet.css | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/phpBB/styles/prosilver/template/overall_header.html b/phpBB/styles/prosilver/template/overall_header.html index e12a1294bd..71df3ccd4d 100644 --- a/phpBB/styles/prosilver/template/overall_header.html +++ b/phpBB/styles/prosilver/template/overall_header.html @@ -26,7 +26,7 @@ diff --git a/phpBB/styles/prosilver/theme/stylesheet.css b/phpBB/styles/prosilver/theme/stylesheet.css index 3eccff693e..0f0cf4b667 100644 --- a/phpBB/styles/prosilver/theme/stylesheet.css +++ b/phpBB/styles/prosilver/theme/stylesheet.css @@ -1,6 +1,6 @@ -/* phpBB3 Style Sheet +/* phpBB Style Sheet -------------------------------------------------------------- - Style name: prosilver (the default phpBB 3.3.x style) + Style name: prosilver (the default phpBB style) Based on style: Original author: Tom Beddard ( http://www.subblue.com/ ) Modified by: phpBB Limited ( https://www.phpbb.com/ ) From 5d3f0cd482bf643241186d94a545d37f702f6f13 Mon Sep 17 00:00:00 2001 From: Marc Alexander Date: Tue, 20 May 2025 20:59:40 +0200 Subject: [PATCH 09/14] [ticket/17514] Replace phpBB3 with phpBB in tests PHPBB-17514 --- tests/RUNNING_TESTS.md | 4 +-- tests/controller/helper_route_slash_test.php | 6 ++--- tests/event/php_exporter_test.php | 4 +-- tests/functional/notification_test.php | 2 +- tests/functional/search/base.php | 8 +++--- tests/path_helper/path_helper_test.php | 28 ++++++++++---------- tests/regex/table_prefix_test.php | 2 +- tests/ucp/controller_webpush_test.php | 6 ++--- tests/ucp/fixtures/webpush.xml | 4 +-- 9 files changed, 32 insertions(+), 32 deletions(-) diff --git a/tests/RUNNING_TESTS.md b/tests/RUNNING_TESTS.md index 81d7516c0b..b047199e38 100644 --- a/tests/RUNNING_TESTS.md +++ b/tests/RUNNING_TESTS.md @@ -165,7 +165,7 @@ phpBB allows you to write such tests. Running ------- -Running the tests requires your phpBB3 repository to be accessible through a +Running the tests requires your phpBB repository to be accessible through a local web server. You will need to supply the URL to the webserver in the 'tests/test_config.php' file. This is as simple as defining the '$phpbb_functional_url' variable, which contains the URL for the directory containing @@ -173,7 +173,7 @@ the board. Make sure you include the trailing slash. Note that without extensive changes to the test framework, you cannot use a board outside of the repository on which to run tests. - $phpbb_functional_url = 'http://localhost/phpBB3/'; + $phpbb_functional_url = 'http://localhost/phpBB/'; Functional tests are automatically run, if '$phpbb_functional_url' is configured. If you only want the functional tests, run: diff --git a/tests/controller/helper_route_slash_test.php b/tests/controller/helper_route_slash_test.php index 3b3d66bb9e..5a37d3220f 100644 --- a/tests/controller/helper_route_slash_test.php +++ b/tests/controller/helper_route_slash_test.php @@ -22,12 +22,12 @@ class phpbb_controller_helper_route_slash_test extends phpbb_controller_common_h protected function get_uri() { - return '/phpBB3/app.php'; + return '/phpBB/app.php'; } protected function get_base_uri() { - return '/phpBB3/'; + return '/phpBB/'; } protected function get_script_name() @@ -37,6 +37,6 @@ class phpbb_controller_helper_route_slash_test extends phpbb_controller_common_h protected function path_to_app() { - return 'phpBB3/'; + return 'phpBB/'; } } diff --git a/tests/event/php_exporter_test.php b/tests/event/php_exporter_test.php index 3911f46ddd..f7b244544e 100644 --- a/tests/event/php_exporter_test.php +++ b/tests/event/php_exporter_test.php @@ -352,11 +352,11 @@ class phpbb_event_php_exporter_test extends phpbb_test_case array( "\t/**", "\t*/", - "\t\$vars = array('_Strange123', 'phpBB3_Test');", + "\t\$vars = array('_Strange123', 'phpBB_Test');", "\t\$this->dispatcher->dispatch('test');", ), 3, - array('_Strange123', 'phpBB3_Test'), + array('_Strange123', 'phpBB_Test'), ), ); } diff --git a/tests/functional/notification_test.php b/tests/functional/notification_test.php index 7eed7d371f..6d4ca21631 100644 --- a/tests/functional/notification_test.php +++ b/tests/functional/notification_test.php @@ -65,7 +65,7 @@ class phpbb_functional_notification_test extends phpbb_functional_test_case $this->login('notificationtestuser'); // Post a new post that needs approval - $this->create_post(2, 1, 'Re: Welcome to phpBB3', 'This is a test [b]post[/b] posted by notificationtestuser.', array(), 'POST_STORED_MOD'); + $this->create_post(2, 1, 'Re: Welcome to phpBB', 'This is a test [b]post[/b] posted by notificationtestuser.', array(), 'POST_STORED_MOD'); $crawler = self::request('GET', "viewtopic.php?t=1&sid={$this->sid}"); $this->assertStringNotContainsString('This is a test post posted by notificationtestuser.', $crawler->filter('html')->text()); diff --git a/tests/functional/search/base.php b/tests/functional/search/base.php index 14b4e631f6..53b251b208 100644 --- a/tests/functional/search/base.php +++ b/tests/functional/search/base.php @@ -193,13 +193,13 @@ abstract class phpbb_functional_search_base extends phpbb_functional_test_case foreach (['', 'a', 't', 'f', 'i', 's'] as $sort_key) { - $this->assert_search_found('phpbb3+installation', 1, 4, $sort_key); + $this->assert_search_found('phpbb+installation', 1, 4, $sort_key); $this->assert_search_found('foosubject+barsearch', 1, 2, $sort_key); $this->assert_search_found('barsearch-testing', 1, 2, $sort_key); // test hyphen ignored $this->assert_search_found('barsearch+-+testing', 1, 2, $sort_key); // test hyphen wrapped with space ignored $this->assert_search_found('multiple+results+count', 3, 15, $sort_key); // test multiple results count - posts $this->assert_search_found_topics('multiple+results+count', 2, $sort_key); // test multiple results count - topics - $this->assert_search_found_topics('phpbb3+installation', 1, $sort_key); + $this->assert_search_found_topics('phpbb+installation', 1, $sort_key); $this->assert_search_found_topics('foosubject+barsearch', 1, $sort_key); $this->assert_search_in_forum(2, 'multiple+search+results', 3, $sort_key); // test multiple results count - forum search - posts @@ -346,11 +346,11 @@ abstract class phpbb_functional_search_base extends phpbb_functional_test_case // Get cached post ids data $cache = $this->get_cache_driver(); $post_ids_cached = $cache->get($cache_varname); - + $cached_results_count = count($post_ids_cached) - 2; // Don't count '-1' and '-2' indexes $post_ids_cached_backup = $post_ids_cached; - + // Cached data still should have initial 'd' sort direction $this->assertTrue($post_ids_cached[-2] === 'd', $this->search_backend); diff --git a/tests/path_helper/path_helper_test.php b/tests/path_helper/path_helper_test.php index 86aaa3c734..5c41b33b97 100644 --- a/tests/path_helper/path_helper_test.php +++ b/tests/path_helper/path_helper_test.php @@ -141,22 +141,22 @@ class phpbb_path_helper_test extends phpbb_test_case array( $this->phpbb_root_path . 'test.php', '/foo/template', - '/phpbb3-fork/phpBB/app.php/foo/template', - '/phpbb3-fork/phpBB/app.php', + '/phpbb-fork/phpBB/app.php/foo/template', + '/phpbb-fork/phpBB/app.php', './../../', ), array( $this->phpbb_root_path . 'test.php', '/foo/template', - '/phpbb3-fork/phpBB/foo/template', - '/phpbb3-fork/phpBB/app.php', + '/phpbb-fork/phpBB/foo/template', + '/phpbb-fork/phpBB/app.php', './../', ), array( $this->phpbb_root_path . 'test.php', '/', - '/phpbb3-fork/phpBB/app.php/', - '/phpbb3-fork/phpBB/app.php', + '/phpbb-fork/phpBB/app.php/', + '/phpbb-fork/phpBB/app.php', './../', ), @@ -171,29 +171,29 @@ class phpbb_path_helper_test extends phpbb_test_case array( './../../' . $this->phpbb_root_path . 'test.php', '/foo/template', - '/phpbb3-fork/phpBB/app.php/foo/template', - '/phpbb3-fork/phpBB/app.php', + '/phpbb-fork/phpBB/app.php/foo/template', + '/phpbb-fork/phpBB/app.php', '', ), array( './../' . $this->phpbb_root_path . 'test.php', '/foo/template', - '/phpbb3-fork/phpBB/foo/template', - '/phpbb3-fork/phpBB/app.php', + '/phpbb-fork/phpBB/foo/template', + '/phpbb-fork/phpBB/app.php', '', ), array( './../'.$this->phpbb_root_path . 'test.php', '/', - '/phpbb3-fork/phpBB/app.php/', - '/phpbb3-fork/phpBB/app.php', + '/phpbb-fork/phpBB/app.php/', + '/phpbb-fork/phpBB/app.php', '', ), array( './../'.$this->phpbb_root_path . 'test.php', '', - '/phpbb3-fork/phpBB/foo', - '/phpbb3-fork/phpBB/app.php', + '/phpbb-fork/phpBB/foo', + '/phpbb-fork/phpBB/app.php', '', ), ); diff --git a/tests/regex/table_prefix_test.php b/tests/regex/table_prefix_test.php index bf7b59ccc6..f425041c94 100644 --- a/tests/regex/table_prefix_test.php +++ b/tests/regex/table_prefix_test.php @@ -17,7 +17,7 @@ class phpbb_regex_table_prefix_test extends phpbb_test_case { return array( array('phpbb_', 1), - array('phpBB3', 1), + array('phpBB', 1), array('a', 1), array('', 0), diff --git a/tests/ucp/controller_webpush_test.php b/tests/ucp/controller_webpush_test.php index e68d50341c..52356b6f69 100644 --- a/tests/ucp/controller_webpush_test.php +++ b/tests/ucp/controller_webpush_test.php @@ -227,7 +227,7 @@ class test_ucp_controller_webpush_test extends phpbb_database_test_case $this->assertEquals([ 'heading' => 'yourdomain.com', 'title' => 'Quoted by Guest in:', - 'text' => '"Welcome to phpBB3"', + 'text' => '"Welcome to phpBB"', 'url' => 'phpBB/viewtopic.php?p=1#p1', 'avatar' => [], ], $response_data); @@ -285,7 +285,7 @@ class test_ucp_controller_webpush_test extends phpbb_database_test_case $this->assertEquals([ 'heading' => 'yourdomain.com', 'title' => 'Quoted by Guest in:', - 'text' => '"Welcome to phpBB3"', + 'text' => '"Welcome to phpBB"', 'url' => 'phpBB/viewtopic.php?p=1#p1', 'avatar' => [], ], $response_data); @@ -393,7 +393,7 @@ class test_ucp_controller_webpush_test extends phpbb_database_test_case $this->assertEquals([ 'heading' => 'yourdomain.com', 'title' => 'Quoted by Guest in:', - 'text' => '"Welcome to phpBB3"', + 'text' => '"Welcome to phpBB"', 'url' => 'phpBB/viewtopic.php?p=1#p1', 'avatar' => [], ], $response_data); diff --git a/tests/ucp/fixtures/webpush.xml b/tests/ucp/fixtures/webpush.xml index 3e209be391..a94086b9c3 100644 --- a/tests/ucp/fixtures/webpush.xml +++ b/tests/ucp/fixtures/webpush.xml @@ -9,7 +9,7 @@ notification_time 1 - + 488c17afe4f18714c235b395e21b78df1c3d78bf1e13d0633ed9425d2eebf967 2 4 @@ -17,7 +17,7 @@ 2 - + 488c17afe4f18714c235b395e21b78df1c3d78bf1e13d0633ed9425d2eebf967 2 4 From df30f07e6d5cfcdaecc3ddd4d6cc472d3ae48e28 Mon Sep 17 00:00:00 2001 From: Marc Alexander Date: Wed, 21 May 2025 21:37:44 +0200 Subject: [PATCH 10/14] [ticket/17514] Remove auth api documentation from docs PHPBB-17514 --- phpBB/docs/auth_api.html | 293 --------------------------------------- 1 file changed, 293 deletions(-) delete mode 100644 phpBB/docs/auth_api.html diff --git a/phpBB/docs/auth_api.html b/phpBB/docs/auth_api.html deleted file mode 100644 index c011fdc27f..0000000000 --- a/phpBB/docs/auth_api.html +++ /dev/null @@ -1,293 +0,0 @@ - - - - - - - -phpBB3 • Auth API - - - - - - - -
          - -
          -
          -
          - -
          - -

          Auth API

          -

          This is an explanation of how to use the phpBB auth/acl API

          -

          Skip

          -
          - -
          -
          -
          - - - -
          - - - -

          This is an explanation of how to use the phpBB auth/acl API.

          - -

          Auth API

          - -
          -
          - -
          - -
            -
          1. Introduction
            2. -
          2. Methods -
              -
            1. acl
              2. -
            2. acl_get
              3. -
            3. acl_gets
              4. -
            4. acl_getf
              5. -
            5. acl_getf_global
              6. -
            6. acl_cache
              7. -
            7. acl_clear_prefetch
              8. -
            8. acl_get_list
              9. -
            9. Miscellaneous
              10. -
            -
            3. -
          3. Admin related functions
            4. -
          4. Copyright and disclaimer
            5. -
          - -
          - -
          -
          - -
          - -

          1. Introduction

          - -
          -
          - -
          - -

          What is it?

          - -

          The auth class contains methods related to authorisation users to access various board functions, e.g. posting, viewing, replying, logging in (and out), etc. If you need to check whether a user can carry out a task or handle user login/logouts this class is required.

          - -

          Initialisation

          - -

          To use any methods contained with the auth class it first needs to be instantiated. This is best achieved early in the execution of the script in the following manner:

          - - 
          -$auth = new phpbb\auth\auth();
          -
          - -

          Once an instance of the class has been created you are free to call the various methods it contains. Please note that should you wish to use the auth_admin methods you will need to instantiate this separately but in the same way.

          - -
          - -
          Back to Top
          - -
          -
          - -
          - -

          2. Methods

          - -
          -
          - -
          - -

          Following are the methods you are able to use.

          - -

          2.i. acl

          - -

          The acl method is the initialisation routine for all the acl functions. If you intend calling any acl method you must first call this. The method takes as its one and only required parameter an associative array containing user information as stored in the database. This array must contain at least the following information; user_id, user_permissions and user_type. It is called in the following way:

          - - 
          -$auth->acl(userdata);
          -
          - -

          Where userdata is the array containing the aforementioned data.

          - -

          2.ii. acl_get

          - -

          This method is the primary way of determining what a user can and cannot do for a given option globally or in a given forum. The method should be called in the following way:

          - - 
          -$result = $auth->acl_get(option[, forum]);
          -
          - -

          Where option is a string representing the required option, e.g. 'f_list', 'm_edit', 'a_adduser', etc. By adding a ! in front of the option, e.g. '!f_list' the result of this method will be negated. The optional forum term is the integer forum_id.

          - -

          The method returns a positive integer when the user is allowed to carry out the option and a zero if denied or the other way around if the option is prefixed with an exclamation mark.

          - -

          If you specify a forum and there is also a global setting for the specified option then this method will return a positive integer if one of them evaluates to a positive integer. An example would be the m_approve option which can be set per forum but also globally. If a user has the global option he will automatically have m_approve in every forum.

          - -

          There are some special options or flags which are used as prefixes for other options, e.g. 'f_' or 'm_'. These flags will automatically be set to a positive integer if the user has one or more permissions with the given prefix. A local setting will result in the flag being set only locally (so it will require a forum id to retrieve). If a user has one or more global permissions with the prefix acl_get will return a positive integer regardless of the forum id.

          - -

          2.iii. acl_gets

          - -

          This method is funtionally similar to acl_get in that it returns information on whether a user can or cannot carry out a given task. The difference here is the ability to test several different options in one go. This may be useful for testing whether a user is a moderator or an admin in one call. Rather than having to call and check acl_get twice.

          - -

          The method should be called thus:

          - - 
          -$result = $auth->acl_gets(option1[, option2, ..., optionN, forum]);
          -
          - -

          As with the acl_get method the options are strings representing the required permissions to check. The forum again is an integer representing a given forum_id.

          - -

          The method will return a positive integer if acl_get for one of the options evaluates to a positive integer (combines permissions with OR).

          - -

          2.iv. acl_getf

          - -

          This method is used to find out in which forums a user is allowed to carry out an operation or to find out in which forums he is not allowed to carry out an operation. The method should be called in the following way:

          - - 
          -$result = $auth->acl_getf(option[, clean]);
          -
          - -

          Just like in the acl_get method the option is a string specifying the permission which has to be checked (negation using ! is allowed). The second parameter is a boolean. If it is set to false this method returns all forums with either zero or a positive integer. If it is set to true only those forums with a positive integer as the result will be returned.

          - -

          The method returns an associative array of the form:

          - - 
          -array(forum_id1 => array(option => integer), forum_id2 => ...)
          -
          - -

          Where option is the option passed to the method and integer is either zero or a positive integer and the same acl_get(option, forum_id) would return.

          - -

          2.v. acl_getf_global

          - -

          This method is used to find out whether a user has a permission in at least one forum or globally. This method is similar to checking whether acl_getf(option, true) returned one or more forums but it's faster. It should be called in the following way:

          - - 
          -$result = $auth->acl_getf_global(option)
          -
          - -

          As with the previous methods option is a string specifying the permission which has to be checked.

          - -

          This method returns either zero or a positive integer.

          - -

          2.vi. acl_cache

          - -

          This should be considered a private method and not be called externally. It handles the generation of the user_permissions data from the basic user and group authorisation data. When necessary this method is called automatically by acl.

          - -

          2.vii. acl_clear_prefetch

          - -

          This method clears the user_permissions column in the users table for the given user. If the user ID passed is zero, the permissions cache is cleared for all users. This method should be called whenever permissions are set.

          - - 
          -// clear stored permissions for user 2
-$user_id = 2;
-$auth->acl_clear_prefetch($user_id);
-
          - -

          This method returns null.

          - -

          2.viii. acl_get_list

          - -

          This method returns an an array describing which users have permissions in given fora. The resultant array contains an entry for permission that every user has in every forum when no arguments are passed.

          - - 
          -$user_id = array(2, 53);
-$permissions = array('f_list', 'f_read');
-$forum_id = array(1, 2, 3);
-$result = $auth->acl_get_list($user_id, $permissions, $forum_id);
-
          - -

          The parameters may be of the following legal types:

          -
            -
          • $user_id: false, int, array(int, int, int, ...)
            • -
          • $permissions: false, string, array(string, string, ...)
            • -
          • $forum_id: false, int, array(int, int, int, ...)
            • -
          - -

          2.ix. Miscellaneous

          - -

          There are other methods defined in the auth class which serve mostly as private methods, but are available for use if needed. Each of them is used to pull data directly from the database tables. They are:

          -
            - 
          • function acl_group_raw_data($group_id = false, $opts = false, $forum_id = false)
            • - 
          • function acl_user_raw_data($user_id = false, $opts = false, $forum_id = false)
            • - 
          • function acl_raw_data_single_user($user_id)
            • - 
          • function acl_raw_data($user_id = false, $opts = false, $forum_id = false)
            • - 
          • function acl_role_data($user_type, $role_type, $ug_id = false, $forum_id = false)
            • -
          - -

          Of these, acl_raw_data is the most general, but the others will be faster if you need a smaller amount of data.

          - -
          - -
          Back to Top
          - -
          -
          - -
          - -

          3. Admin related functions

          - -
          -
          - -
          - -

          A number of additional methods are available related to auth. These handle more basic functions such as adding user and group permissions, new options and clearing the user cache. These methods are contained within a separate class, auth_admin. This can be found in includes/acp/auth.php.

          - -

          To use any methods this class contains it first needs to be instantiated separately from auth. This is achieved in the same way as auth:

          - - 
          -$auth_admin = new auth_admin();
          -
          - -

          This instance gives you access to both the methods of this specific class and that of auth.

          - -
          - -
          Back to Top
          - -
          -
          - -
          - -

          4. Copyright and disclaimer

          - -
          -
          - -
          - -

          phpBB is free software, released under the terms of the GNU General Public License, version 2 (GPL-2.0). Copyright © phpBB Limited. For full copyright and license information, please see the docs/CREDITS.txt file.

          - -
          - -
          Back to Top
          - -
          -
          - - - -
          -
           
          -
          -
          - -
          - -
          - - - From 105823b37601da6af79641ea2f572619e4fb61a9 Mon Sep 17 00:00:00 2001 From: Marc Alexander Date: Thu, 22 May 2025 21:03:40 +0200 Subject: [PATCH 11/14] [ticket/17514] Remove outdated FAQ page from docs folder PHPBB-17514 --- phpBB/docs/FAQ.html | 328 -------------------------------------------- 1 file changed, 328 deletions(-) delete mode 100644 phpBB/docs/FAQ.html diff --git a/phpBB/docs/FAQ.html b/phpBB/docs/FAQ.html deleted file mode 100644 index f8b93d55d4..0000000000 --- a/phpBB/docs/FAQ.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - -phpBB • FAQ - - - - - - - -
          - -
          -
          -
          - -
          - -

          phpBB 3.3.x FAQ

          -

          phpBB 3.3.x frequently asked questions

          -

          Skip

          -
          - -
          -
          -
          - - - -
          - - - -

          - This is a very basic Frequently Asked Questions (FAQ) page which attempts to answer some of the - more commonly asked questions. It is by no means exhaustive and should be used in combination with - the 'built-in' User FAQ within phpBB3, the community forums and our IRC channel - (see README for details). -

          - -

          FAQ

          - -
          -
          - -
          - - - - -
          - -
          -
          - -
          - -

          I am finding phpBB too difficult to install. Will you do it for me?

          - -
          -
          - -
          - -

          Simple answer, no we will not. We are not being difficult when we say this we are actually trying to help you. phpBB has a reputation for being easy to install, that reputation is we believe well deserved. It is a simple process of unarchiving a single file, uploading the resulting directory/files to their intended location and entering some data in a web based form. The sequence of events, what to type where, etc. is covered in detail in the accompanying INSTALL.html documentation. If you cannot install phpBB the chances are you will be unable to administer or update it.

          - -

          There are people, companies (unrelated to your hosting provider), etc. that will install your forum, either for free or for a payment. We do not recommend you make use of these offers. Unless the service is provided by your hosting company you will have to divulge passwords and other sensitive details. If you did not know how to use an ATM would you give a passer-by your bank card and PIN and ask them to show you what to do? No, probably not! The same applies to your hosting account details!

          - -

          We think a better solution is for you to carefully read the enclosed documentation, read through our knowledge base at www.phpbb.com and if necessary ask for help on any thing you get stuck on. However, the decision is yours but please note we may not offer support if we believe you have had the board installed by a third party. In such cases you should direct your questions to that company or person/s.

          - -
          - -
          Back to Top
          - -
          -
          - -
          - -

          I am having problems with the admin at a certain board, help!
          -A board has ripped off my graphics/software/etc., stop them!
          -A board is dealing in warez/porn/etc., you need to prevent them doing this!
          -I want to sue you because i think you host an illegal board!

          - -
          -
          - -
          - -

          We provide the software, we have absolutely nothing to do with any board that runs it (beyond phpbb.com of course!) and we also do not host any site. The GPL grants the user an unlimited right of use subject to their adherence of that license. Therefore we cannot prevent, dictate, control or otherwise limit the use of phpBB software. So please do not contact us for such matters.

          - -

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

          - -
          - -
          Back to Top
          - -
          -
          - -
          - -

          According to viewonline a user is doing/reading something they should not be able to!

          - -
          -
          - -
          - -

          No, they probably are not. phpBB uses sessions to keep track of users as they move between pages. The session information tells us who this user is. Therefore in order to determine what a user can do on a page we first need the session details. Once this data is available we can check whether the user is permitted to do whatever it is they are trying to do. This can result in it appearing as if a user is reading a topic in a forum they should not be able to access. Or perhaps viewing private messages when they are only guests, etc. In practice the user is not doing these things, they are viewing a "You are not permitted to do this" type message. The session data has simply been updated before we were able to determine what the user could or could not do.

          - -

          Of course this only applies where permissions have been set correctly!

          - -
          - -
          Back to Top
          - -
          -
          - -
          - -

          I keep getting Mail sending errors when I (or my users) post/send PM's/etc.!

          - -
          -
          - -
          - -

          This error will occur if phpBB cannot send mail. phpBB can send email two ways; using the PHP mail() function or directly via SMTP. Some hosting providers limit the mail() function to prevent its use in spamming, others may rename it or limit its functionality. If the mail() function got renamed, you are able to enter the correct name within the administration control panel. In either case you may need to make use of SMTP. This requires that you have access to such a facility, e.g. your hosting provider may provide one (perhaps requiring specific written authorisation), etc. Please see www.phpbb.com for additional help on this matter.

          - -

          If you do require SMTP services please do not ask (on our forums or elsewhere) for someone to provide you with one. Open relays are now things of the past thanks to the unthinking spammers out there. Therefore you are unlikely to find someone willing to offer you (free) services.

          - -
          - -
          Back to Top
          - -
          -
          - -
          - -

          My users are complaining that emails are not in their selected language!

          - -
          -
          - -
          - -

          You must have deleted a language pack or the language pack is incomplete. phpBB will try to send emails in the users selected language. If it cannot find a suitable email template it will switch to the boards default language.

          - - - -
          - -
          Back to Top
          - -
          -
          - -
          - -

          I am unable to upload avatars from my computer, regardless of the settings.

          - -
          -
          - -
          - -

          There are two possibilities here, the first is you have not created the directory you specified as the storage location for avatars, ie. as specified in the Admin -> General -> Board Configuration -> Avatar settings section. If the directory does not exist uploadeable avatars are automatically disabled. You should create the required directory (ensuring it has global write access or other appropriate permissions to allow the webserver to write files to it).

          - -

          The second possibility is that your provider has disabled file_upload support. You should contact your provider and ask them if this is the case. There is not a lot you can do, there are still three other avatar settings left to choose from including uploading via an URL which will work fine.

          - -
          - -
          Back to Top
          - -
          -
          - -
          - -

          I just cannot get gallery avatars to appear!

          - -
          -
          - -
          - -

          phpBB categorises gallery avatars and it does this by reading through folders contained in the location you specified as being the gallery path. For example, if you set the gallery path to images/avatars/gallery phpBB will expect to find a series of folders within that path, e.g. images/avatars/gallery/moviestars, images/avatars/gallery/cartoons, images/avatars/gallery/misc, etc. Placing images directly in images/avatars/gallery/ will result in nothing being listed in your gallery.

          - -
          - -
          Back to Top
          - -
          -
          - -
          - -

          How do I use/set permissions?

          - -
          -
          - -
          - -

          Please read the paragraph about permissions in our extensive online documentation.

          - -
          - -
          Back to Top
          - -
          -
          - -
          - -

          I (or my users) cannot stay logged in to the forum!

          - -
          -
          - -
          - -

          If you (or your users) are, after attempting a login, being returned to the index (or other page) without appearing to be logged in the most likely problem is incorrect cookie settings. phpBB uses cookies to store a session id and a small amount of user data. For this data to be stored correctly the cookie domain, name, path and secure settings must be correct. You can check this in Admin->General->Server Configuration->Cookie Settings. Typically the cookie domain can be left blank and the cookie path set to / (a single forward slash). Do not set the cookie as being secure unless your board is running over a secure sockets layer connection, ie. https://

          - -

          If you still have problems try setting the cookie domain to your full domain name, e.g. www.mysystem.tld, www.something.mydomain.tld. You must ensure the domain name contains at least two dots or browsers will be unlikely to recognise the cookie, e.g. .mydomain.com, mydomain.com. Do not add http:// or anything else to the domain name!

          - -
          - -
          Back to Top
          - -
          -
          - -
          - -

          My users are complaining about being logged out too quickly!

          - -
          -
          - -
          - -

          You can increase the default length of sessions (ie. how long before a users session is considered 'dead') in Admin->General->Server Configuration->Load Settings. Set it to whatever value your users feel comfortable with, remember that security issues may affect your decision (ie. having too long a session may allow non-users to abuse your board should a user forget to logout or otherwise leave a current session on a public workstation).

          - -
          - -
          Back to Top
          - -
          -
          - -
          - -

          My question isn't answered here!

          - -
          -
          - -
          - -

          Please read our extensive user documentation first, it may just explain what you want to know.

          - -

          Feel free to search our community forum for the information you require. PLEASE DO NOT post your question without having first used search, chances are someone has already asked and answered your question. You can find our board here:

          - -

          www.phpbb.com

          - -
          - -
          Back to Top
          - -
          -
          - -
          - -

          Copyright and disclaimer

          - -
          -
          - -
          - -

          phpBB is free software, released under the terms of the GNU General Public License, version 2 (GPL-2.0). Copyright © phpBB Limited. For full copyright and license information, please see the docs/CREDITS.txt file.

          - -
          - -
          Back to Top
          - -
          -
          - - - -
          -
           
          -
          -
          - -
          - -
          - - - From 788108daa9a059064943cfbfc0f516c234aab1b9 Mon Sep 17 00:00:00 2001 From: Marc Alexander Date: Tue, 27 May 2025 19:28:11 +0200 Subject: [PATCH 12/14] [ticket/17514] Update prosilver composer.json PHPBB-17514 --- phpBB/styles/prosilver/composer.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/phpBB/styles/prosilver/composer.json b/phpBB/styles/prosilver/composer.json index 51024f2285..a301df698d 100644 --- a/phpBB/styles/prosilver/composer.json +++ b/phpBB/styles/prosilver/composer.json @@ -15,8 +15,9 @@ "support": { "issues": "https://tracker.phpbb.com", "forum": "https://www.phpbb.com/community/", - "wiki": "https://wiki.phpbb.com", - "irc": "irc://irc.freenode.org/phpbb" + "docs": "https://www.phpbb.com/support/docs/", + "irc": "irc://irc.libera.chat/phpbb", + "chat": "https://www.phpbb.com/support/chat/" }, "extra": { "display-name": "prosilver", From d547c989b72701d9c003a75788c5ea1880ad0171 Mon Sep 17 00:00:00 2001 From: Marc Alexander Date: Tue, 27 May 2025 19:28:28 +0200 Subject: [PATCH 13/14] [ticket/17514] Remove coding guidelines from phpBB repo PHPBB-17514 --- phpBB/docs/coding-guidelines.html | 2555 ----------------------------- 1 file changed, 2555 deletions(-) delete mode 100644 phpBB/docs/coding-guidelines.html diff --git a/phpBB/docs/coding-guidelines.html b/phpBB/docs/coding-guidelines.html deleted file mode 100644 index a5b3528189..0000000000 --- a/phpBB/docs/coding-guidelines.html +++ /dev/null @@ -1,2555 +0,0 @@ - - - - - - - -phpBB3 • Coding Guidelines - - - - - - - -
          - -
          -
          -
          - -
          - -

          Coding Guidelines

          -

          Proteus coding guidelines document

          -

          Skip

          -
          - -
          -
          -
          - - - -
          - - - -

          - These are the phpBB Coding Guidelines for Proteus, all attempts should be made to follow them as closely as possible. -

          - -

          Coding Guidelines

          - -
          -
          - -
          - -
            -
          1. Defaults -
              -
            1. Editor Settings
              2. -
            2. File Header
              3. -
            3. File Locations
              4. -
            4. Special Constants
              5. -
            -
            2. -
          2. Code Layout/Guidelines -
              -
            1. Variable/Function/Class Naming
              2. -
            2. Code Layout
              3. -
            3. SQL/SQL Layout
              4. -
            4. Optimizations
              5. -
            5. General Guidelines
              6. -
            6. Restrictions on the Use of PHP
              7. -
            -
            3. -
          3. Styling -
              -
            1. Style Config Files
              2. -
            2. General Styling Rules
              3. -
            4. -
          4. Templating -
              -
            1. General Templating
              2. -
            2. Styles Tree
              3. -
            3. Template Events
              4. -
            5. -
          5. Character Sets and Encodings
            6. -
          6. Translation (i18n/L10n) Guidelines -
              -
            1. Standardisation
              2. -
            2. Other considerations
              3. -
            3. Working with placeholders
              4. -
            4. Using plurals
              5. -
            5. Writing Style
              6. -
            -
            7. -
          7. Copyright and disclaimer
            8. -
          - -
          - -
          -
          - -
          - -

          1. Defaults

          - -
          -
          - -
          - -

          1.i. Editor Settings

          - -

          Tabs vs Spaces:

          -

          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:

          - - 
          -{TAB}$mode{TAB}{TAB}= $request->variable('mode', '');
-{TAB}$search_id{TAB}= $request->variable('search_id', '');
          -
          - -

          If entered with tabs (replace the {TAB}) both equal signs need to be on the same column.

          - -

          Linefeeds:

          -

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

          - -

          1.ii. File Layout

          - -

          Standard header for new files:

          -

          This template of the header must be included at the start of all phpBB files:

          - - 
          -/**
-*
-* This file is part of the phpBB Forum Software package.
-*
-* @copyright (c) phpBB Limited <https://www.phpbb.com>
-* @license GNU General Public License, version 2 (GPL-2.0)
-*
-* For full copyright and license information, please see
-* the docs/CREDITS.txt file.
-*
-*/
          -
          - -

          Please see the File Locations section for the correct package name.

          - -

          PHP closing tags

          - -

          A file containg only PHP code should not end with the optional PHP closing tag ?> to avoid issues with whitespace following it.

          - -

          Newline at end of file

          - -

          All files should end in a newline so the last line does not appear as modified in diffs, when a line is appended to the file.

          - -

          Files containing inline code:

          - -

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

          - - 
          -/**
-* {HEADER}
-*/
-
-/**
-*/
-{CODE}
          -
          - -

          Files containing only functions:

          - -

          Do not forget to comment the functions (especially the first function following the header). Each function should have at least a comment of what this function does. For more complex functions it is recommended to document the parameters too.

          - -

          Files containing only classes:

          - -

          Do not forget to comment the class. Classes need a separate @package definition, it is the same as the header package name. Apart from this special case the above statement for files containing only functions needs to be applied to classes and it's methods too.

          - -

          Code following the header but only functions/classes file:

          - -

          If this case is true, the best method to avoid documentation confusions is adding an ignore command, for example:

          - - 
          -/**
-* {HEADER}
-*/
-
-/**
-* @ignore
-*/
-Small code snipped, mostly one or two defines or an if statement
-
-/**
-* {DOCUMENTATION}
-*/
-class ...
          -
          - -

          1.iii. File Locations

          - -

          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:

          - -
            -
          • phpBB3
            Core files and all files not assigned to a separate package
            • -
          • acm
            /phpbb/cache
            Cache System
            • -
          • acp
            /adm, /includes/acp, /includes/functions_admin.php
            Administration Control Panel
            • -
          • dbal
            /phpbb/db, /includes/db
            Database Abstraction Layer. -
              -
            • /phpbb/db/driver/
              Database Abstraction Layer classes
              • -
            • /phpbb/db/migration/
              Migrations are used for updating the database from one release to another
              • -
            -
            • -
          • diff
            /includes/diff
            Diff Engine
            • -
          • docs
            /docs
            phpBB Documentation
            • -
          • images
            /images
            All global images not connected to styles
            • -
          • install
            /install
            Installation System
            • -
          • language
            /language
            All language files
            • -
          • login
            /phpbb/auth
            Login Authentication Plugins
            • -
          • VC
            /includes/captcha
            CAPTCHA
            • -
          • mcp
            mcp.php, /includes/mcp, report.php
            Moderator Control Panel
            • -
          • ucp
            ucp.php, /includes/ucp
            User Control Panel
            • -
          • utf
            /includes/utf
            UTF8-related functions/classes
            • -
          • search
            /phpbb/search, search.php
            Search System
            • -
          • styles
            /styles
            phpBB Styles/Templates/Themes
            • -
          - -

          1.iv. Special Constants

          - -

          There are some special constants application developers are able to utilize to bend some of phpBB's internal functionality to suit their needs.

          - - 
          -PHPBB_MSG_HANDLER          (overwrite message handler)
-PHPBB_DB_NEW_LINK          (overwrite new_link parameter for sql_connect)
-PHPBB_ROOT_PATH            (overwrite $phpbb_root_path)
-PHPBB_ADMIN_PATH           (overwrite $phpbb_admin_path)
-PHPBB_USE_BOARD_URL_PATH   (use generate_board_url() for image paths instead of $phpbb_root_path)
-PHPBB_DISABLE_ACP_EDITOR   (disable ACP style editor for templates)
-PHPBB_DISABLE_CONFIG_CHECK (disable ACP config.php writeable check)
-
-PHPBB_ACM_MEMCACHED_PORT     (overwrite memcached port, default is 11211)
-PHPBB_ACM_MEMCACHED_COMPRESS (overwrite memcached compress setting, default is disabled)
-PHPBB_ACM_MEMCACHED_HOST     (overwrite memcached host name, default is localhost)
-
-PHPBB_ACM_REDIS_HOST        (overwrite redis host name, default is localhost)
-PHPBB_ACM_REDIS_PORT        (overwrite redis port, default is 6379)
-PHPBB_ACM_REDIS_PASSWORD    (overwrite redis password, default is empty)
-PHPBB_ACM_REDIS_DB          (overwrite redis default database)
-
-PHPBB_QA                   (Set board to QA-Mode, which means the updater also checks for RC-releases)
-
          - -

          PHPBB_USE_BOARD_URL_PATH

          - -

          If the PHPBB_USE_BOARD_URL_PATH constant is set to true, phpBB uses generate_board_url() (this will return the boards url with the script path included) on all instances where web-accessible images are loaded. The exact locations are:

          - -
            -
          • /phpbb/user.php - \phpbb\user::img()
            • -
          • /includes/functions_content.php - smiley_text()
            • -
          - -

          Path locations for the following template variables are affected by this too:

          - -
            -
          • {T_ASSETS_PATH} - assets (non-style specific, static resources)
            • -
          • {T_THEME_PATH} - styles/xxx/theme
            • -
          • {T_TEMPLATE_PATH} - styles/xxx/template
            • -
          • {T_SUPER_TEMPLATE_PATH} - styles/xxx/template
            • -
          • {T_IMAGES_PATH} - images/
            • -
          • {T_SMILIES_PATH} - $config['smilies_path']/
            • -
          • {T_AVATAR_GALLERY_PATH} - $config['avatar_gallery_path']/
            • -
          • {T_ICONS_PATH} - $config['icons_path']/
            • -
          • {T_RANKS_PATH} - $config['ranks_path']/
            • -
          • {T_UPLOAD_PATH} - $config['upload_path']/
            • -
          • {T_STYLESHEET_LINK} - styles/xxx/theme/stylesheet.css
            • -
          • New template variable {BOARD_URL} for the board url + script path.
            • -
          - -
          - -
          Back to Top
          - -
          -
          - -
          - -

          2. Code Layout/Guidelines

          - -
          -
          - -
          - -

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

          - -

          2.i. Variable/Function/Class Naming

          - -

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

          - -

          Variable Names:

          -

          In PHP, variable names should be in all lowercase, with words separated by an underscore, example:

          - -
          -

          $current_user is right, but $currentuser and $currentUser are not.

          -
          - -

          In JavaScript, variable names should use camel case:

          - -
          -

          currentUser is right, but currentuser and current_user are not.

          -
          - -

          Names should be descriptive, but concise. We don't want huge sentences as our variable names, but typing an extra couple of characters is always better than wondering what exactly a certain variable is for.

          - -

          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++)
-{
-   for ($j = 0; $j < $inner_size; $j++)
-   {
-      foo($i, $j);
-   }
-}
          -
          - -

          Function Names:

          -

          Functions should also be named descriptively. We're not programming in C here, we don't want to write functions called things like "stristr()". Again, all lower-case names with words separated by a single underscore character in PHP, and camel caps in JavaScript. Function names should be prefixed with "phpbb_" and preferably have a verb in them somewhere. Good function names are phpbb_print_login_status(), phpbb_get_user_data(), etc. Constructor functions in JavaScript should begin with a capital letter.

          - -

          Function Arguments:

          -

          Arguments are subject to the same guidelines as variable names. We don't want a bunch of functions like: do_stuff($a, $b, $c). In most cases, we'd like to be able to tell how to use a function by just looking at its declaration.

          - -

          Class Names:

          - -

          Apart from following the rules for function names, all classes should meet the following conditions:

          -
            -
          • Every class must be defined in a separate file.
            • -
          • The classes have to be located in a subdirectory of phpbb/.
            • -
          • Classnames must be namespaced with \phpbb\ to avoid name clashes.
            • -
          • Class names/namespaces have to reflect the location of the file they are defined in. The namespace must be the directory in which the file is located. So the directory names must not contain any underscores, but the filename may.
            • -
          • Directories should typically be a singular noun (e.g. dir in the example below, not dirs.
            • -
          - -

          So given the following example directory structure you would result in the below listed lookups

          - 
          -phpbb/
-  class_name.php
-  dir/
-    class_name.php
-      subdir/
-        class_name.php
          -
          - - 
          -\phpbb\class_name            - phpbb/class_name.php
-\phpbb\dir\class_name        - phpbb/dir/class_name.php
-\phpbb\dir\subdir\class_name - phpbb/dir/subdir/class_name.php
          -
          - - -

          Summary:

          -

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

          - -

          Special Namings:

          -

          For all emoticons use the term smiley in singular and smilies in plural. For emails we use the term email (without dash between “e” and “m”).

          - -

          2.ii. Code Layout

          - -

          Always include the braces:

          -

          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();
-
-if (condition)
-	do_stuff();
-
-while (condition)
-	do_stuff();
-
-for ($i = 0; $i < size; $i++)
-	do_stuff($i);
          -
          - -

          // These are all right.

          - 
          -if (condition)
-{
-	do_stuff();
-}
-
-while (condition)
-{
-	do_stuff();
-}
-
-for ($i = 0; $i < size; $i++)
-{
-	do_stuff();
-}
          -
          - -

          Where to put the braces:

          -

          In PHP code, braces always go on their own line. The closing brace should also always be at the same column as the corresponding opening brace, examples:

          - - 
          -if (condition)
-{
-	while (condition2)
-	{
-		...
-	}
-}
-else
-{
-	...
-}
-
-for ($i = 0; $i < $size; $i++)
-{
-	...
-}
-
-while (condition)
-{
-	...
-}
-
-function do_stuff()
-{
-	...
-}
          -
          - -

          In JavaScript code, braces always go on the same line:

          - - 
          -if (condition) {
-	while (condition2) {
-		...
-	}
-} else {
-	...
-}
-
-for (var i = 0; i < size; i++) {
-	...
-}
-
-while (condition) {
-	...
-}
-
-function do_stuff() {
-	...
-}
          -
          - -

          Use spaces between tokens:

          -

          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;
-
-if($i<7) ...
-if ($i < 7) ...
-
-if ( ($i < 7)&&($j > 8) ) ...
-if ($i < 7 && $j > 8) ...
-
-do_stuff( $i, 'foo', $b );
-do_stuff($i, 'foo', $b);
-
-for($i=0; $i<$size; $i++) ...
-for ($i = 0; $i < $size; $i++) ...
-
-$i=($j < $size)?0:1;
-$i = ($j < $size) ? 0 : 1;
          -
          - -

          Operator precedence:

          -

          Do you know the exact precedence of all the operators in PHP? Neither do I. Don't guess. Always make it obvious by using brackets to force the precedence of an equation so you know what it does. Remember to not over-use this, as it may harden the readability. Basically, do not enclose single expressions. Examples:

          - -

          // what's the result? who knows.

          -
          - 
          $bool = ($i < 7 && $j > 8 || $k == 4);
          -
          - -

          // now you can be certain what I'm doing here.

          -
          - 
          $bool = (($i < 7) && (($j < 8) || ($k == 4)));
          -
          - -

          // But this one is even better, because it is easier on the eye but the intention is preserved

          -
          - 
          $bool = ($i < 7 && ($j < 8 || $k == 4));
          -
          - -

          Quoting strings:

          -

          There are two different ways to quote strings in PHP - either with single quotes or with double quotes. The main difference is that the parser does variable interpolation in double-quoted strings, but not in single quoted strings. Because of this, you should always use single quotes unless you specifically need variable interpolation to be done on that string. This way, we can save the parser the trouble of parsing a bunch of strings where no interpolation needs to be done.

          -

          Also, if you are using a string variable as part of a function call, you do not need to enclose that variable in quotes. Again, this will just make unnecessary work for the parser. Note, however, that nearly all of the escape sequences that exist for double-quoted strings will not work with single-quoted strings. Be careful, and feel free to break this guideline if it's making your code easier to read, examples:

          - -

          // wrong

          - 
          -$str = "This is a really long string with no variables for the parser to find.";
-
-do_stuff("$str");
          -
          - -

          // right

          - 
          -$str = 'This is a really long string with no variables for the parser to find.';
-
-do_stuff($str);
          -
          - -

          // Sometimes single quotes are just not right

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

          // Double quotes are sometimes needed to not overcrowd the line with concatenations.

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

          In SQL statements mixing single and double quotes is partly allowed (following the guidelines listed here about SQL formatting), else one should try to only use one method - mostly single quotes.

          - -

          Commas after every array element:

          -

          If an array is defined with each element on its own line, you still have to modify the previous line to add a comma when appending a new element. PHP allows for trailing (useless) commas in array definitions. These should always be used so each element including the comma can be appended with a single line. In JavaScript, do not use the trailing comma, as it causes browsers to throw errors.

          - -

          // wrong

          - 
          -$foo = array(
-	'bar' => 42,
-	'boo' => 23
-);
          -
          - -

          // right

          - 
          -$foo = array(
-	'bar' => 42,
-	'boo' => 23,
-);
          -
          - - -

          Associative array keys:

          -

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

          - -

          // wrong

          -
          - 
          $foo = $assoc_array[blah];
          -
          - -

          // right

          -
          - 
          $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 - 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 keep a very close eye on it).

          - -

          Shortcut operators:

          -

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

          - -

          // wrong

          - 
          -$array[++$i] = $j;
-$array[$i++] = $k;
          -
          - -

          // right

          - 
          -$i++;
-$array[$i] = $j;
-
-$array[$i] = $k;
-$i++;
          -
          - -

          Inline conditionals:

          -

          Inline conditionals should only be used to do very simple things. Preferably, they will only be used to do assignments, and not for function calls or anything complex at all. They can be harmful to readability if used incorrectly, so don't fall in love with saving typing by using them, examples:

          - -

          // Bad place to use them

          - 
          -($i < $size && $j > $size) ? do_stuff($foo) : do_stuff($bar);
          -
          - -

          // OK place to use them

          - 
          -$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 - but preferably the variable is always existing. For checking if an array has a key set this can come in handy though, examples:

          - -

          // Wrong

          -
          - 
          if ($forum) ...
          -
          - -

          // Right

          -
          - 
          if (isset($forum)) ...
          - -

          // Also possible

          -
          - 
          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) && count($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:

          - -

          // Wrong

          - 
          -switch ($mode)
-{
-	case 'mode1':
-		// I am doing something here
-		break;
-	case 'mode2':
-		// I am doing something completely different here
-		break;
-}
          -
          - -

          // Good

          - 
          -switch ($mode)
-{
-	case 'mode1':
-		// I am doing something here
-	break;
-
-	case 'mode2':
-		// I am doing something completely different here
-	break;
-
-	default:
-		// Always assume that a case was not caught
-	break;
-}
          -
          - -

          // Also good, if you have more code between the case and the break

          - 
          -switch ($mode)
-{
-	case 'mode1':
-
-		// I am doing something here
-
-	break;
-
-	case 'mode2':
-
-		// I am doing something completely different here
-
-	break;
-
-	default:
-
-		// Always assume that a case was not caught
-
-	break;
-}
          -
          - -

          Even if the break for the default case is not needed, it is sometimes better to include it just for readability and completeness.

          - -

          If no break is intended, please add a comment instead. An example:

          - -

          // Example with no break

          - 
          -switch ($mode)
-{
-	case 'mode1':
-
-		// I am doing something here
-
-	// no break here
-
-	case 'mode2':
-
-		// I am doing something completely different here
-
-	break;
-
-	default:
-
-		// Always assume that a case was not caught
-
-	break;
-}
          -
          - -

          Class Members

          -

          Use the explicit visibility qualifiers public, private and protected for all properties instead of var. - -

          Place the static qualifier after the visibility qualifiers.

          - -

          //Wrong

          - 
          -var $x;
-static private function f()
          -
          - -

          // Right

          - 
          -public $x;
-private static function f()
          -
          - -

          Constants

          -

          Prefer class constants over global constants created with define().

          - -

          2.iii. SQL/SQL Layout

          - -

          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 (MySQL4/5, MSSQL (7.0 and 2000), PostgreSQL (8.3+), SQLite, Oracle8, ODBC (generalised if possible)).

          -

          All SQL commands should utilise the DataBase Abstraction Layer (DBAL)

          - -

          SQL code layout:

          -

          SQL Statements are often unreadable without some formatting, since they tend to be big at times. Though the formatting of sql statements adds a lot to the readability of code. SQL statements should be formatted in the following way, basically writing keywords:

          - - 
          -$sql = 'SELECT *
-<-one tab->FROM ' . SOME_TABLE . '
-<-one tab->WHERE a = 1
-<-two tabs->AND (b = 2
-<-three tabs->OR b = 3)
-<-one tab->ORDER BY b';
          -
          - -

          Here the example with the tabs applied:

          - - 
          -$sql = 'SELECT *
-	FROM ' . SOME_TABLE . '
-	WHERE a = 1
-		AND (b = 2
-			OR b = 3)
-	ORDER BY b';
          -
          - -

          SQL Quotes:

          -

          Use double quotes where applicable. (The variables in these examples are typecasted to integers beforehand.) Examples:

          - -

          // These are wrong.

          - 
          -"UPDATE " . SOME_TABLE . " SET something = something_else WHERE a = $b";
-
-'UPDATE ' . SOME_TABLE . ' SET something = ' . $user_id . ' WHERE a = ' . $something;
          -
          - -

          // These are right.

          - - 
          -'UPDATE ' . SOME_TABLE . " SET something = something_else WHERE a = $b";
-
-'UPDATE ' . SOME_TABLE . " SET something = $user_id WHERE a = $something";
          -
          - -

          In other words use single quotes where no variable substitution is required or where the variable involved shouldn't appear within double quotes. Otherwise use double quotes.

          - -

          Avoid DB specific SQL:

          -

          The "not equals operator", as defined by the SQL:2003 standard, is "<>"

          - -

          // This is wrong.

          - 
          -$sql = 'SELECT *
-	FROM ' . SOME_TABLE . '
-	WHERE a != 2';
          -
          - -

          // This is right.

          - 
          -$sql = 'SELECT *
-	FROM ' . SOME_TABLE . '
-	WHERE a <> 2';
          -
          - -

          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 cannot contain single quotes - never trust your input), for example:

          - - 
          -$sql = 'SELECT *
-	FROM ' . SOME_TABLE . "
-	WHERE username = '" . $db->sql_escape($username) . "'";
          -
          - -

          sql_query_limit():

          - -

          We do not add limit statements to the sql query, but instead use $db->sql_query_limit(). You basically pass the query, the total number of lines to retrieve and the offset.

          - -

          Note: Since Oracle handles limits differently and because of how we implemented this handling you need to take special care if you use sql_query_limit with an sql query retrieving data from more than one table.

          - -

          Make sure when using something like "SELECT x.*, y.jars" that there is not a column named jars in x; make sure that there is no overlap between an implicit column and the explicit columns.

          - -

          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 or two variables needs to be inserted/updated. An example of an insert statement would be:

          - - 
          -$sql_ary = array(
-	'somedata'		=> $my_string,
-	'otherdata'		=> $an_int,
-	'moredata'		=> $another_int,
-);
-
-$db->sql_query('INSERT INTO ' . SOME_TABLE . ' ' . $db->sql_build_array('INSERT', $sql_ary));
          -
          - -

          To complete the example, this is how an update statement would look like:

          - - 
          -$sql_ary = array(
-	'somedata'		=> $my_string,
-	'otherdata'		=> $an_int,
-	'moredata'		=> $another_int,
-);
-
-$sql = 'UPDATE ' . SOME_TABLE . '
-	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), UPDATE (example above) and SELECT (for building WHERE statement [AND logic]).

          - -

          sql_multi_insert():

          - -

          If you want to insert multiple statements at once, please use the separate sql_multi_insert() method. An example:

          - - 
          -$sql_ary = array();
-
-$sql_ary[] = array(
-	'somedata'		=> $my_string_1,
-	'otherdata'		=> $an_int_1,
-	'moredata'		=> $another_int_1,
-);
-
-$sql_ary[] = array(
-	'somedata'		=> $my_string_2,
-	'otherdata'		=> $an_int_2,
-	'moredata'		=> $another_int_2,
-);
-
-$db->sql_multi_insert(SOME_TABLE, $sql_ary);
          -
          - -

          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 retrieve 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);
          -
          - -

          2.iv. Optimizations

          - -

          Operations in loop definition:

          -

          Always try to optimize your loops if operations are going on at the comparing part, since this part is executed every time the loop is parsed through. For assignments a descriptive name should be chosen. Example:

          - -

          // On every iteration the count function is called

          - 
          -for ($i = 0; $i < count($post_data); $i++)
-{
-	do_something();
-}
          -
          - -

          // You are able to assign the (not changing) result within the loop itself

          - 
          -for ($i = 0, $size = count($post_data); $i < $size; $i++)
-{
-	do_something();
-}
          -
          - -

          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 noticeable, but if checked against a huge array within a loop those checks alone can take several 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.

          - - -

          2.v. General Guidelines

          - -

          General things:

          -

          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 \phpbb\request\request class for everything.

          -

          The $request->variable() method determines the type to set from the second parameter (which determines the default value too). If you need to get a scalar variable type, you need to tell this the variable() method explicitly. Examples:

          - -

          // Old method, do not use it

          - 
          -$start = (isset($HTTP_GET_VARS['start'])) ? intval($HTTP_GET_VARS['start']) : intval($HTTP_POST_VARS['start']);
-$submit = (isset($HTTP_POST_VARS['submit'])) ? true : false;
          -
          - -

          // Use request var and define a default variable (use the correct type)

          - 
          -$start = $request->variable('start', 0);
-$submit = $request->is_set_post('submit');
          -
          - -

          // $start is an int, the following use of $request->variable() therefore is not allowed

          - 
          -$start = $request->variable('start', '0');
          -
          - -

          // Getting an array, keys are integers, value defaults to 0

          - 
          -$mark_array = $request->variable('mark', array(0));
          -
          - -

          // Getting an array, keys are strings, value defaults to 0

          - 
          -$action_ary = $request->variable('action', array('' => 0));
          -
          - -

          Login checks/redirection:

          -

          To show a forum login box use login_forum_box($forum_data), else use the login_box() function.

          - -

          $forum_data should contain at least the forum_id and forum_password fields. If the field forum_name is available, then it is displayed on the forum login page.

          - -

          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.

          - -

          Altering Operations:

          -

          For operations altering the state of the database, for instance posting, always verify the form token, unless you are already using confirm_box(). To do so, make use of the add_form_key() and check_form_key() functions.

          - 
          -	add_form_key('my_form');
-
-	if ($submit)
-	{
-		if (!check_form_key('my_form'))
-		{
-			trigger_error('FORM_INVALID');
-		}
-	}
          -
          - -

          The string passed to add_form_key() needs to match the string passed to check_form_key(). Another requirement for this to work correctly is that all forms include the {S_FORM_TOKEN} template variable.

          - - -

          Sessions:

          -

          Sessions should be initiated on each page, as near the top as possible using the following code:

          - - 
          -$user->session_begin();
-$auth->acl($user->data);
-$user->setup();
          -
          - -

          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 outputted 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_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 (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 it 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&amp;g=' . $row['group_id'])
          -
          - -

          General function usage:

          - -

          Some of these functions are only chosen over others because of personal preference and have no benefit other than maintaining consistency throughout the code.

          - -
            -
          • -

            Use strpos instead of strstr

            -
            • -
          • -

            Use else if instead of elseif

            -
            • -
          • -

            Use false (lowercase) instead of FALSE

            -
            • -
          • -

            Use true (lowercase) instead of TRUE

            -
            • -
          - -

          Exiting

          - -

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

          - -

          2.vi. Restrictions on the Use of PHP

          - -

          Dynamic code execution:

          - -

          Never execute dynamic PHP code (generated or in a constant string) using any of the following PHP functions:

          - -
            -
          • eval
            • -
          • create_function
            • -
          • preg_replace with the e modifier in the pattern
            • -
          - -

          If absolutely necessary a file should be created, and a mechanism for creating this file prior to running phpBB should be provided as a setup process.

          - -

          The e modifier in preg_replace can be replaced by preg_replace_callback and objects to encapsulate state that is needed in the callback code.

          - -

          Other functions, operators, statements and keywords:

          - -

          The following PHP statements should also not be used in phpBB:

          - -
            -
          • goto
            • -
          - -
          - -
          Back to Top
          - -
          -
          - -
          - -

          3. Styling

          -
          -
          - -
          -

          3.i. Style Config Files

          -

          Style cfg files are simple name-value lists with the information necessary for installing a style. The important part of the style configuration file is assigning an unique name.

          - 
          -# General Information about this style
-name = prosilver_duplicate
-copyright = © phpBB Limited, 2007
-style_version = 3.3.0
-phpbb_version = 3.3.0
-
-# Defining a different template bitfield
-# template_bitfield = lNg=
-
-# Parent style
-# Set value to empty or to this style's name if this style does not have a parent style
-parent = prosilver
          -
          -

          3.2. General Styling Rules

          -

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

          -

          Each block level element should be indented by one tab, same for tabular elements, e.g. <tr> <td> etc., whereby the intendiation of <table> and the following/ending <tr> should be on the same line. This applies not to div elements of course.

          -

          Don't use <span> more than is essential ... the CSS is such that text sizes are dependent on the parent class. So writing <span class="gensmall"><span class="gensmall">TEST</span></span> will result in very very small text. Similarly don't use span at all if another element can contain the class definition, e.g.

          - -
          -<td><span class="gensmall">TEST</span></td>
-
          - -

          can just as well become:

          -
          -<td class="gensmall">TEST</td>
-
          - -

          Try to match text class types with existing usage, e.g. don't use the nav class where viewtopic uses gensmall for example.

          - -

          Row colours/classes are now defined by the template, use an IF S_ROW_COUNT switch, see viewtopic or viewforum for an example.

          - -

          Remember block level ordering is important.

          - -

          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/css for styling and table for data representation.

          - -

          The separate 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 usage, 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 correct

          -
          -<!-- BEGIN test -->
-	<tr>
-		<td>{test.TEXT}</td>
-	</tr>
-<!-- END test -->
-
          - -

          this is also correct:

          -
          -<!-- BEGIN test -->
-<tr>
-	<td>{test.TEXT}</td>
-</tr>
-<!-- END test -->
-
          - -

          it gives immediate feedback on exactly what is looping - decide which way to use based on the readability.

          - -
          - -
          Back to Top
          - -
          -
          - -
          - -

          4. Templating

          -
          -
          - -
          -

          4.i. General Templating

          - -

          File naming

          -

          Firstly templates now take the suffix ".html" rather than ".tpl". This was done simply to make the lives 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_, javascript urls with UA_, language to be put in javascript statements with LA_, all other variables should be presented 'as is'.

          - -

          L_* template variables are automatically mapped to the corresponding language entry if the code does not set (and therefore overwrite) this variable specifically and if the language entry exists. For example {L_USERNAME} maps to $user->lang['USERNAME']. The LA_* template variables are handled within the same way, but properly escaped so they can be put in javascript code. This should reduce the need to assign loads of new language variables in MODifications. -

          - -

          Blocks/Loops

          -

          The basic block level loop remains and takes the form:

          -
          -<!-- BEGIN loopname -->
-	markup, {loopname.X_YYYYY}, etc.
-<!-- END loopname -->
-
          - -

          A bit later loops will be explained further. To not irritate 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.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 -->
-
          - -

          You will note in the 3.x 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.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.

          - -

          Added in 3.0.6 is the ability to include a file using a template variable to specify the file, this functionality only works for root variables (i.e. not block variables).

          -
          -<!-- INCLUDE {FILE_VAR} -->
-
          - -

          Template defined variables can also be utilised.

          - -
          -<!-- DEFINE $SOME_VAR = 'my_file.html' -->
-<!-- INCLUDE {$SOME_VAR} -->
-
          - -

          Conditionals/Control structures

          -

          The most significant addition to 3.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 -->
-
          - -

          expr can take many forms, for example:

          - -
          -<!-- 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 (not, or, and, eq, neq, is should be used if possible for better readability):

          - -
          -== [eq]
-!= [neq, ne]
-<> (same as !=)
-!== (not equivalent in value and type)
-=== (equivalent in value and type)
-> [gt]
-< [lt]
->= [gte]
-<= [lte]
-&& [and]
-|| [or]
-% [mod]
-! [not]
-+
--
-*
-/
-,
-<< (bitwise shift left)
->> (bitwise shift right)
-| (bitwise or)
-^ (bitwise xor)
-& (bitwise and)
-~ (bitwise not)
-is (can be used to join comparison operations)
-
          - -

          Basic parenthesis can also be used to enforce good old BODMAS rules. Additionally some basic comparison types are defined:

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

          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.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 -->
-	<td>HELLO!</td>
-</tr>
-</table>
-
          - -

          This will cause the row cell to be output using class row1 when the row count is even, and class row2 otherwise. The S_ROW_COUNT parameter gets assigned to loops by default. Another example would be the following:

          - -
          -<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 -->
-	<td>hello!</td>
-</tr>
-</table>
-
          - -

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

          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 do 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 at 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 top to bottom.

          - -

          Forms

          -

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

          - 
          -<form method="post" id="mcp" action="{U_POST_ACTION}">
-
-	<fieldset class="submit-buttons">
-		<input type="reset" value="{L_RESET}" name="reset" class="button2" /> 
-		<input type="submit" name="action[add_warning]" value="{L_SUBMIT}" class="button1" />
-		{S_FORM_TOKEN}
-	</fieldset>
-</form>
-

          - -

          4.ii. Styles Tree

          -

          When basing a new style on an existing one, it is not necessary to provide all the template files. By declaring the base style name in the parent field in the style configuration file, the style can be set to reuse template files from the parent style.

          - -

          The effect of doing so is that the template engine will use the template files in the new style where they exist, but fall back to files in the parent style otherwise.

          - -

          We strongly encourage the use of parent styles for styles based on the bundled styles, as it will ease the update procedure.

          - - 
          -# General Information about this style
-name = Custom Style
-copyright = © phpBB Limited, 2007
-style_version = 3.2.0-b1
-phpbb_version = 3.2.0-b1
-
-# Defining a different template bitfield
-# template_bitfield = lNg=
-
-# Parent style
-# Set value to empty or to this style's name if this style does not have a parent style
-parent = prosilver
-
          - -

          4.iii. Template Events

          -

          Template events must follow this format: <!-- EVENT event_name -->

          -

          Using the above example, files named event_name.html located within extensions will be injected into the location of the event.

          - -

          Template event naming guidelines:

          -
            -
          • An event name must be all lowercase, with each word separated by an underscore.
            • -
          • An event name must briefly describe the location and purpose of the event.
            • -
          • - An event name must end with one of the following suffixes: -
              -
            • _prepend - This event adds an item to the beginning of a block of related items, or adds to the beginning of individual items in a block.
              • -
            • _append - This event adds an item to the end of a block of related items, or adds to the end of individual items in a block.
              • -
            • _before - This event adds content directly before the specified block
              • -
            • _after - This event adds content directly after the specified block
              • -
            -
            • -
          - -

          Template event documentation

          -

          Events must be documented in phpBB/docs/events.md in alphabetical order based on the event name. The format is as follows:

          - -
          • An event found in only one template file: - 
            event_name
-===
-* Location: styles/<style_name>/template/filename.html
-* Purpose: A brief description of what this event should be used for.
-This may span multiple lines.
-* Since: Version since when the event was added
-
            • -
          • An event found in multiple template files: - 
            event_name
-===
-* Locations:
-    + first/file/path.html
-    + second/file/path.html
-* Purpose: Same as above.
-* Since: 3.2.0-b1
-
            -
          • An event that is found multiple times in a file should have the number of instances in parenthesis next to the filename. - 
            event_name
-===
-* Locations:
-    + first/file/path.html (2)
-    + second/file/path.html
-* Purpose: Same as above.
-* Since: 3.2.0-b1
-
            • -
          • An actual example event documentation: - 
            forumlist_body_last_post_title_prepend
-====
-* Locations:
-    + styles/prosilver/template/forumlist_body.html
-    + styles/subsilver2/template/forumlist_body.html
-* Purpose: Add content before the post title of the latest post in a forum on the forum list.
-* Since: 3.2.0-a1
-

          - -
          - -
          Back to Top
          - -
          -
          - -
          - - - -

          5. Character Sets and Encodings

          - -
          -
          - -
          - - - -

          What are Unicode, UCS and UTF-8?

          -

          The Universal Character Set (UCS) described in ISO/IEC 10646 consists of a large amount of characters. Each of them has a unique name and a code point which is an integer number. Unicode - which is an industry standard - complements the Universal Character Set with further information about the characters' properties and alternative character encodings. More information on Unicode can be found on the Unicode Consortium's website. One of the Unicode encodings is the 8-bit Unicode Transformation Format (UTF-8). It encodes characters with up to four bytes aiming for maximum compatibility with the American Standard Code for Information Interchange which is a 7-bit encoding of a relatively small subset of the UCS.

          - -

          phpBB's use of Unicode

          -

          Unfortunately PHP does not facilitate the use of Unicode prior to version 6. Most functions simply treat strings as sequences of bytes assuming that each character takes up exactly one byte. This behaviour still allows for storing UTF-8 encoded text in PHP strings but many operations on strings have unexpected results. To circumvent this problem we have created some alternative functions to PHP's native string operations which use code points instead of bytes. These functions can be found in /includes/utf/utf_tools.php. They are also covered in the phpBB3 Sourcecode Documentation. A lot of native PHP functions still work with UTF-8 as long as you stick to certain restrictions. For example explode still works as long as the first and the last character of the delimiter string are ASCII characters.

          - -

          phpBB only uses the ASCII and the UTF-8 character encodings. Still all Strings are UTF-8 encoded because ASCII is a subset of UTF-8. The only exceptions to this rule are code sections which deal with external systems which use other encodings and character sets. Such external data should be converted to UTF-8 using the utf8_recode() function supplied with phpBB. It supports a variety of other character sets and encodings, a full list can be found below.

          - -

          With $request->variable() you can either allow all UCS characters in user input or restrict user input to ASCII characters. This feature is controlled by the method's third parameter called $multibyte. You should allow multibyte characters in posts, PMs, topic titles, forum names, etc. but it's not necessary for internal uses like a $mode variable which should only hold a predefined list of ASCII strings anyway.

          - -
          -// an input string containing a multibyte character
-$_REQUEST['multibyte_string'] = 'Käse';
-
-// print request variable as a UTF-8 string allowing multibyte characters
-echo $request->variable('multibyte_string', '', true);
-// print request variable as ASCII string
-echo $request->variable('multibyte_string', '');
-
          - -

          This code snippet will generate the following output:

          - -
          -Käse
-K??se
-
          - -

          Case Folding

          - -

          Case insensitive comparison of strings is no longer possible with strtolower or strtoupper as some characters have multiple lower case or multiple upper case forms depending on their position in a word. The utf8_strtolower and the utf8_strtoupper functions suffer from the same problem so they can only be used to display upper/lower case versions of a string but they cannot be used for case insensitive comparisons either. So instead you should use case folding which gives you a case insensitive version of the string which can be used for case insensitive comparisons. An NFC normalized string can be case folded using utf8_case_fold_nfc().

          - -

          // Bad - The strings might be the same even if strtolower differs

          - -
          -if (strtolower($string1) == strtolower($string2))
-{
-	echo '$string1 and $string2 are equal or differ in case';
-}
-
          - -

          // Good - Case folding is really case insensitive

          - -
          -if (utf8_case_fold_nfc($string1) == utf8_case_fold_nfc($string2))
-{
-	echo '$string1 and $string2 are equal or differ in case';
-}
-
          - -

          Confusables Detection

          - -

          phpBB offers a special method utf8_clean_string which can be used to make sure string identifiers are unique. This method uses Normalization Form Compatibility Composition (NFKC) instead of NFC and replaces similarly looking characters with a particular representative of the equivalence class. This method is currently used for usernames and group names to avoid confusion with similarly looking names.

          - -
          - -
          Back to Top
          - -
          -
          - -
          - -

          6. Translation (i18n/L10n) Guidelines

          - -
          -
          - -
          - -

          6.i. Standardisation

          - -

          Reason:

          - -

          phpBB is one of the most translated open-source projects, with the current stable version being available in over 60 localisations. Whilst the ad hoc approach to the naming of language packs has worked, for phpBB3 and beyond we hope to make this process saner which will allow for better interoperation with current and future web browsers.

          - -

          Encoding:

          - -

          With phpBB3, the output encoding for the forum in now UTF-8, a Universal Character Encoding by the Unicode Consortium that is by design a superset to US-ASCII and ISO-8859-1. By using one character set which simultaenously supports all scripts which previously would have required different encodings (eg: ISO-8859-1 to ISO-8859-15 (Latin, Greek, Cyrillic, Thai, Hebrew, Arabic); GB2312 (Simplified Chinese); Big5 (Traditional Chinese), EUC-JP (Japanese), EUC-KR (Korean), VISCII (Vietnamese); et cetera), we remove the need to convert between encodings and improves the accessibility of multilingual forums.

          - -

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

          - -

          Language Tag:

          - -

          The IETF recently published RFC 4646 for tags used to identify languages, which in combination with RFC 4647 obseletes the older RFC 3006 and older-still RFC 1766. RFC 4646 uses ISO 639-1/ISO 639-2, ISO 3166-1 alpha-2, ISO 15924 and UN M.49 to define a language tag. Each complete tag is composed of subtags which are not case sensitive and can also be empty.

          - -

          Ordering of the subtags in the case that they are all non-empty is: language-script-region-variant-extension-privateuse. Should any subtag be empty, its corresponding hyphen would also be omitted. Thus, the language tag for English will be en and not en-----.

          - -

          Most language tags consist of a two- or three-letter language subtag (from ISO 639-1/ISO 639-2). Sometimes, this is followed by a two-letter or three-digit region subtag (from ISO 3166-1 alpha-2 or UN M.49). Some examples are:

          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          Examples of various possible language tags as described by RFC 4646 and RFC 4647
          Language tagDescriptionComponent subtags
          enEnglishlanguage
          masMasailanguage
          fr-CAFrench as used in Canadalanguage+region
          en-833English as used in the Isle of Manlanguage+region
          zh-HansChinese written with Simplified scriptlanguage+script
          zh-Hant-HKChinese written with Traditional script as used in Hong Konglanguage+script+region
          de-AT-1996German as used in Austria with 1996 orthographylanguage+region+variant
          - -

          The ultimate aim of a language tag is to convey the needed useful distingushing information, whilst keeping it as short as possible. So for example, use en, fr and ja as opposed to en-GB, fr-FR and ja-JP, since we know English, French and Japanese are the native language of Great Britain, France and Japan respectively.

          - -

          Next is the ISO 15924 language script code and when one should or shouldn't use it. For example, whilst en-Latn is syntaxically correct for describing English written with Latin script, real world English writing is more-or-less exclusively in the Latin script. For such languages like English that are written in a single script, the IANA Language Subtag Registry has a "Suppress-Script" field meaning the script code should be omitted unless a specific language tag requires a specific script code. Some languages are written in more than one script and in such cases, the script code is encouraged since an end-user may be able to read their language in one script, but not the other. Some examples are:

          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          Examples of using a language subtag in combination with a script subtag
          Language tagDescriptionComponent subtags
          en-BraiEnglish written in Braille scriptlanguage+script
          en-DsrtEnglish written in Deseret (Mormon) scriptlanguage+script
          sr-LatnSerbian written in Latin scriptlanguage+script
          sr-CyrlSerbian written in Cyrillic scriptlanguage+script
          mn-MongMongolian written in Mongolian scriptlanguage+script
          mn-CyrlMongolian written in Cyrillic scriptlanguage+script
          mn-PhagMongolian written in Phags-pa scriptlanguage+script
          az-Cyrl-AZAzerbaijani written in Cyrillic script as used in Azerbaijanlanguage+script+region
          az-Latn-AZAzerbaijani written in Latin script as used in Azerbaijanlanguage+script+region
          az-Arab-IRAzerbaijani written in Arabic script as used in Iranlanguage+script+region
          - -

          Usage of the three-digit UN M.49 code over the two-letter ISO 3166-1 alpha-2 code should happen if a macro-geographical entity is required and/or the ISO 3166-1 alpha-2 is ambiguous.

          - -

          Examples of English using marco-geographical regions:

          - - - - - - - - - - - - - - - - - - - - - - - -
          Coding for English using macro-geographical regions (examples for English of ISO 3166-1 alpha-2 vs. UN M.49 code)
          ISO 639-1/ISO 639-2 + ISO 3166-1 alpha-2ISO 639-1/ISO 639-2 + UN M.49 (Example macro regions)
          en-AU
          English as used in Australia
          en-053
          English as used in Australia & New Zealand
          en-009
          English as used in Oceania
          en-NZ
          English as used in New Zealand
          en-FJ
          English as used in Fiji
          en-054
          English as used in Melanesia
          - -

          Examples of Spanish using marco-geographical regions:

          - - - - - - - - - - - - - - - - - - - - - - - - - - -
          Coding for Spanish macro-geographical regions (examples for Spanish of ISO 3166-1 alpha-2 vs. UN M.49 code)
          ISO 639-1/ISO 639-2 + ISO 3166-1 alpha-2ISO 639-1/ISO 639-2 + UN M.49 (Example macro regions)
          es-PR
          Spanish as used in Puerto Rico
          es-419
          Spanish as used in Latin America & the Caribbean
          es-019
          Spanish as used in the Americas
          es-HN
          Spanish as used in Honduras
          es-AR
          Spanish as used in Argentina
          es-US
          Spanish as used in United States of America
          es-021
          Spanish as used in North America
          - -

          Example of where the ISO 3166-1 alpha-2 is ambiguous and why UN M.49 might be preferred:

          - - - - - - - - - - - - - - - - - - - - - -
          Coding for ambiguous ISO 3166-1 alpha-2 regions
          CS assignment pre-1994CS assignment post-1994
          -
          -
          CS
          Czechoslovakia (ISO 3166-1)
          -
          200
          Czechoslovakia (UN M.49)
          -
          -           		-
          -
          CS
          Serbian & Montenegro (ISO 3166-1)
          -
          891
          Serbian & Montenegro (UN M.49)
          -
          -
          -
          -
          CZ
          Czech Republic (ISO 3166-1)
          -
          203
          Czech Republic (UN M.49)
          -
          -           		-
          -
          SK
          Slovakia (ISO 3166-1)
          -
          703
          Slovakia (UN M.49)
          -
          -           		-
          -
          RS
          Serbia (ISO 3166-1)
          -
          688
          Serbia (UN M.49)
          -
          -           		-
          -
          ME
          Montenegro (ISO 3166-1)
          -
          499
          Montenegro (UN M.49)
          -
          -
          - -

          Macro-languages & Topolects:

          - -

          RFC 4646 anticipates features which shall be available in (currently draft) ISO 639-3 which aims to provide as complete enumeration of languages as possible, including living, extinct, ancient and constructed languages, whether majour, minor or unwritten. A new feature of ISO 639-3 compared to the previous two revisions is the concept of macrolanguages where Arabic and Chinese are two such examples. In such cases, their respective codes of ar and zh is very vague as to which dialect/topolect is used or perhaps some terse classical variant which may be difficult for all but very educated users. For such macrolanguages, it is recommended that the sub-language tag is used as a suffix to the macrolanguage tag, eg:

          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          Macrolanguage subtag + sub-language subtag examples
          Language tagDescriptionComponent subtags
          zh-cmnMandarin (Putonghau/Guoyu) Chinesemacrolanguage+sublanguage
          zh-yueYue (Cantonese) Chinesemacrolanguage+sublanguage
          zh-cmn-HansMandarin (Putonghau/Guoyu) Chinese written in Simplified scriptmacrolanguage+sublanguage+script
          zh-cmn-HantMandarin (Putonghau/Guoyu) Chinese written in Traditional scriptmacrolanguage+sublanguage+script
          zh-nan-Latn-TWMinnan (Hoklo) Chinese written in Latin script (POJ Romanisation) as used in Taiwanmacrolanguage+sublanguage+script+region
          - -

          6.ii. Other considerations

          - -

          Normalisation of language tags for phpBB:

          - -

          For phpBB, the language tags are not used in their raw form and instead converted to all lower-case and have the hyphen - replaced with an underscore _ where appropriate, with some examples below:

          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          Language tag normalisation examples
          Raw language tagDescriptionValue of USER_LANG
          in ./common.php          		Language pack directory
          name in /language/
          enBritish Englishenen
          de-ATGerman as used in Austriade-atde_at
          es-419Spanish as used in Latin America & Caribbeanen-419en_419
          zh-yue-Hant-HKCantonese written in Traditional script as used in Hong Kongzh-yue-hant-hkzh_yue_hant_hk
          - -

          How to use iso.txt:

          - -

          The iso.txt file is a small UTF-8 encoded plain-text file which consists of three lines:

          - -
            -
          1. Language's English name
            2. -
          2. Language's local name
            3. -
          3. Authors information
            4. -
          - -

          iso.txt is automatically generated by the language pack submission system on phpBB.com. You don't have to create this file yourself if you plan on releasing your language pack on phpBB.com, but do keep in mind that phpBB itself does require this file to be present.

          - -

          Because language tags themselves are meant to be machine read, they can be rather obtuse to humans and why descriptive strings as provided by iso.txt are needed. Whilst en-US could be fairly easily deduced to be "English as used in the United States", de-CH is more difficult less one happens to know that de is from "Deutsch", German for "German" and CH is the abbreviation of the official Latin name for Switzerland, "Confoederatio Helvetica".

          - -

          For the English language description, the language name is always first and any additional attributes required to describe the subtags within the language code are then listed in order separated with commas and enclosed within parentheses, eg:

          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          English language description examples for iso.txt
          Raw language tagEnglish description within iso.txt
          enBritish English
          en-USEnglish (United States)
          en-053English (Australia & New Zealand)
          deGerman
          de-CH-1996German (Switzerland, 1996 orthography)
          gws-1996Swiss German (1996 orthography)
          zh-cmn-Hans-CNMandarin Chinese (Simplified, Mainland China)
          zh-yue-Hant-HKCantonese Chinese (Traditional, Hong Kong)
          - -

          For the localised language description, just translate the English version though use whatever appropriate punctuation typical for your own locale, assuming the language uses punctuation at all.

          - -

          Unicode bi-directional considerations:

          - -

          Because phpBB is now UTF-8, all translators must take into account that certain strings may be shown when the directionality of the document is either opposite to normal or is ambiguous.

          - -

          The various Unicode control characters for bi-directional text and their HTML enquivalents where appropriate are as follows:

          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          Unicode bidirectional control characters & HTML elements/entities
          Unicode character
          abbreviation          		Unicode
          code-point          		Unicode character
          name          		Equivalent HTML
          markup/entity          		Raw character
          (enclosed between '')
          LRMU+200ELeft-to-Right Mark&lrm;'‎'
          RLMU+200FRight-to-Left Mark&rlm;'‏'
          LREU+202ALeft-to-Right Embeddingdir="ltr"'‪'
          RLEU+202BRight-to-Left Embeddingdir="rtl"'‫'
          PDFU+202CPop Directional Formatting</bdo>'‬'
          LROU+202DLeft-to-Right Override<bdo dir="ltr">'‭'
          RLOU+202ERight-to-Left Override<bdo dir="rtl">'‮'
          - -

          For iso.txt, the directionality of the text can be explicitly set using special Unicode characters via any of the three methods provided by left-to-right/right-to-left markers/embeds/overrides, as without them, the ordering of characters will be incorrect, eg:

          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          Unicode bidirectional control characters iso.txt
          DirectionalityRaw character viewDisplay of localised
          description in iso.txt          		Ordering
          dir="ltr"English (Australia & New Zealand)English (Australia & New Zealand)Correct
          dir="rtl"English (Australia & New Zealand)English (Australia & New Zealand)Incorrect
          dir="rtl" with LRMEnglish (Australia & New Zealand)U+200EEnglish (Australia & New Zealand)‎Correct
          dir="rtl" with LRE & PDFU+202AEnglish (Australia & New Zealand)U+202C‪English (Australia & New Zealand)‬Correct
          dir="rtl" with LRO & PDFU+202DEnglish (Australia & New Zealand)U+202C‭English (Australia & New Zealand)‬Correct
          - -

          In choosing which of the three methods to use, in the majority of cases, the LRM or RLM to put a "strong" character to fully enclose an ambiguous punctuation character and thus make it inherit the correct directionality is sufficient.

          -

          Within some cases, there may be mixed scripts of a left-to-right and right-to-left direction, so using LRE & RLE with PDF may be more appropriate. Lastly, in very rare instances where directionality must be forced, then use LRO & RLO with PDF.

          -

          For further information on authoring techniques of bi-directional text, please see the W3C tutorial on authoring techniques for XHTML pages with bi-directional text.

          - -

          6.iii. Working with placeholders

          - -

          As phpBB is translated into languages with different ordering rules to that of English, it is possible to show specific values in any order deemed appropriate. Take for example the extremely simple "Page X of Y", whilst in English this could just be coded as:

          - - 
          -	...
-'PAGE_OF'	=>	'Page %s of %s',
-		/* Just grabbing the replacements as they
-		come and hope they are in the right order */
-	...
          -
          - -

          … a clearer way to show explicit replacement ordering is to do:

          - - 
          -	...
-'PAGE_OF'	=>	'Page %1$s of %2$s',
-		/* Explicit ordering of the replacements,
-		even if they are the same order as English */
-	...
          -
          - -

          Why bother at all? Because some languages, the string transliterated back to English might read something like:

          - - 
          -	...
-'PAGE_OF'	=>	'Total of %2$s pages, currently on page %1$s',
-		/* Explicit ordering of the replacements,
-		reversed compared to English as the total comes first */
-	...
          -
          - -

          6.iv. Using plurals

          - -

          - The english language is very simple when it comes to plurals.
          - You have 0 elephants, 1 elephant, or 2+ elephants. So basically you have 2 different forms: one singular and one plural.
          - But for some other languages this is quite more difficult. Let's take the Bosnian language as another example:
          - You have [1/21/31] slon, [2/3/4] slona, [0/5/6] slonova and [7/8/9/11] ... and some more difficult rules. -

          - -

          The plural system takes care of this and can be used as follows:

          - -

          The PHP code will basically look like this:

          - - 
          -	...
-	$user->lang('NUMBER_OF_ELEPHANTS', $number_of_elephants);
-	...
          -
          - -

          And the English translation would be:

          - - 
          -	...
-	'NUMBER_OF_ELEPHANTS'	=> array(
-		0	=> 'You have no elephants', // Optional special case for 0
-		1	=> 'You have 1 elephant', // Singular
-		2	=> 'You have %d elephants', // Plural
-	),
-	...
          -
          - -

          While the Bosnian translation can have more cases:

          - - 
          -	...
-	'NUMBER_OF_ELEPHANTS'	=> array(
-		0	=> 'You have no slonova', // Optional special case for 0
-		1	=> 'You have %d slon', // Used for 1, 21, 31, ..
-		2	=> 'You have %d slona', // Used for 5, 6,
-		3	=> ...
-	),
-	...
          -
          - -

          NOTE: It is okay to use plurals for an unknown number compared to a single item, when the number is not known and displayed:

          - 
          -	...
-	'MODERATOR'	=> 'Moderator',  // Your board has 1 moderator
-	'MODERATORS'	=> 'Moderators', // Your board has multiple moderators
-	...
          -
          - -

          6.v. Writing Style

          - -

          Miscellaneous tips & hints:

          - -

          As the language files are PHP files, where the various strings for phpBB are stored within an array which in turn are used for display within an HTML page, rules of syntax for both must be considered. Potentially problematic characters are: ' (straight quote/apostrophe), " (straight double quote), < (less-than sign), > (greater-than sign) and & (ampersand).

          - -

          // Bad - The un-escapsed straight-quote/apostrophe will throw a PHP parse error

          - - 
          -	...
-'CONV_ERROR_NO_AVATAR_PATH'
-	=>	'Note to developer: you must specify $convertor['avatar_path'] to use %s.',
-	...
          -
          - -

          // Good - Literal straight quotes should be escaped with a backslash, ie: \

          - - 
          -	...
-'CONV_ERROR_NO_AVATAR_PATH'
-	=>	'Note to developer: you must specify $convertor[\'avatar_path\'] to use %s.',
-	...
          -
          - -

          However, because phpBB3 now uses UTF-8 as its sole encoding, we can actually use this to our advantage and not have to remember to escape a straight quote when we don't have to:

          - -

          // Bad - The un-escapsed straight-quote/apostrophe will throw a PHP parse error

          - - 
          -	...
-'USE_PERMISSIONS'	=>	'Test out user's permissions',
-	...
          -
          - -

          // Okay - However, non-programmers wouldn't type "user\'s" automatically

          - - 
          -	...
-'USE_PERMISSIONS'	=>	'Test out user\'s permissions',
-	...
          -
          - -

          // Best - Use the Unicode Right-Single-Quotation-Mark character

          - - 
          -	...
-'USE_PERMISSIONS'	=>	'Test out user’s permissions',
-	...
          -
          - -

          The " (straight double quote), < (less-than sign) and > (greater-than sign) characters can all be used as displayed glyphs or as part of HTML markup, for example:

          - -

          // Bad - Invalid HTML, as segments not part of elements are not entitised

          - - 
          -	...
-'FOO_BAR'	=>	'PHP version < 5.3.3.<br />
-	Visit "Downloads" at <a href="http://www.php.net/">www.php.net</a>.',
-	...
          -
          - -

          // Okay - No more invalid HTML, but "&quot;" is rather clumsy

          - - 
          -	...
-'FOO_BAR'	=>	'PHP version &lt; 5.3.3.<br />
-	Visit &quot;Downloads&quot; at <a href="http://www.php.net/">www.php.net</a>.',
-	...
          -
          - -

          // Best - No more invalid HTML, and usage of correct typographical quotation marks

          - - 
          -	...
-'FOO_BAR'	=>	'PHP version &lt; 5.3.3.<br />
-	Visit “Downloads” at <a href="http://www.php.net/">www.php.net</a>.',
-	...
          -
          - -

          Lastly, the & (ampersand) must always be entitised regardless of where it is used:

          - -

          // Bad - Invalid HTML, none of the ampersands are entitised

          - - 
          -	...
-'FOO_BAR'	=>	'<a href="http://somedomain.tld/?foo=1&bar=2">Foo & Bar</a>.',
-	...
          -
          - -

          // Good - Valid HTML, amperands are correctly entitised in all cases

          - - 
          -	...
-'FOO_BAR'	=>	'<a href="http://somedomain.tld/?foo=1&amp;bar=2">Foo &amp; Bar</a>.',
-	...
          -
          - -

          As for how these charcters are entered depends very much on choice of Operating System, current language locale/keyboard configuration and native abilities of the text editor used to edit phpBB language files. Please see http://en.wikipedia.org/wiki/Unicode#Input_methods for more information.

          - -

          Spelling, punctuation, grammar, et cetera:

          - -

          The default language pack bundled with phpBB is British English using Cambridge University Press spelling and is assigned the language code en. The style and tone of writing tends towards formal and translations should emulate this style, at least for the variant using the most compact language code. Less formal translations or those with colloquialisms must be denoted as such via either an extension or privateuse tag within its language code.

          - -
          - -
          Back to Top
          - -
          -
          - -
          - -

          7. Copyright and disclaimer

          - -
          -
          - -
          - -

          phpBB is free software, released under the terms of the GNU General Public License, version 2 (GPL-2.0). Copyright © phpBB Limited. For full copyright and license information, please see the docs/CREDITS.txt file.

          - -
          - -
          Back to Top
          - -
          -
          - - - -
          -
           
          -
          -
          - -
          - -
          - - - From 14f055c25b94d876ef8d7317d652ddb96212cf50 Mon Sep 17 00:00:00 2001 From: Marc Alexander Date: Tue, 27 May 2025 19:40:08 +0200 Subject: [PATCH 14/14] [ticket/17514] Remove some more mentions of phpBB3 / 3.3.x PHPBB-17514 --- phpBB/docs/CHANGELOG.html | 6 +++--- phpBB/docs/INSTALL.html | 16 ++++++++-------- phpBB/docs/README.html | 4 ++-- phpBB/phpbb/composer.json | 4 ++-- .../task/create_config_file.php | 2 +- 5 files changed, 16 insertions(+), 16 deletions(-) diff --git a/phpBB/docs/CHANGELOG.html b/phpBB/docs/CHANGELOG.html index 3b4a42bed3..0935611a29 100644 --- a/phpBB/docs/CHANGELOG.html +++ b/phpBB/docs/CHANGELOG.html @@ -4,7 +4,7 @@ - + phpBB • Changelog @@ -21,7 +21,7 @@
          -

          phpBB 3.3.x Changelog

          +

          phpBB Changelog

          Skip

          @@ -36,7 +36,7 @@

          - This is a non-exhaustive (but still near complete) changelog for phpBB 3.3.x including release candidate versions. + This is a non-exhaustive (but still near complete) changelog for phpBB including release candidate versions. Our thanks to all those people who've contributed bug reports and code fixes.

          diff --git a/phpBB/docs/INSTALL.html b/phpBB/docs/INSTALL.html index 15ce5a032d..6d5b976aa4 100644 --- a/phpBB/docs/INSTALL.html +++ b/phpBB/docs/INSTALL.html @@ -4,7 +4,7 @@ - + phpBB • Install @@ -21,8 +21,8 @@
          -

          phpBB 3.3.x Install

          -

          phpBB 3.3.x Installation, updating and conversion information

          +

          phpBB Install

          +

          phpBB Installation, updating and conversion information

          Skip

          @@ -109,7 +109,7 @@
        2. Change the permissions on config.php to be writable by all (666 or -rw-rw-rw- within your FTP Client)
        3. Change the permissions on the following directories to be writable by all (777 or -rwxrwxrwx within your FTP Client):
          store/, cache/, files/ and images/avatars/upload/.
          4. -
        4. Point your web browser to the location where you uploaded the phpBB files with the addition of install/app.php or simply install/, e.g. http://www.example.com/phpBB3/install/app.php, http://www.example.com/forum/install/.
          5. +
        5. Point your web browser to the location where you uploaded the phpBB files with the addition of install/app.php or simply install/, e.g. http://www.example.com/phpBB/install/app.php, http://www.example.com/forum/install/.
        6. Click the INSTALL tab, follow the steps and fill out all the requested information.
        7. Change the permissions on config.php to be writable only by yourself (644 or -rw-r--r-- within your FTP Client)
        8. phpBB should now be available, please MAKE SURE you read at least Section 6 below for important, security related post-installation instructions, and also take note of Section 7 regarding anti-spam measures.
          9. @@ -191,7 +191,7 @@

          phpBB comes supplied with British English as its standard language. However, a number of separate packs for different languages are available. If you are not a native English speaker you may wish to install one or more of these packages before continuing. The installation process below will allow you to select a default language from those available (you can, of course, change this default at a later stage). For more details on language packs, where to obtain them and how to install them please see the README.

          -

          Once all the files have been uploaded to your site, you should point your browser at this location with the addition of /install/. For example, if your domain name is www.example.com and you placed the phpBB files in the directory /phpBB3 off your web root you would enter http://www.example.com/phpBB3/install/ or (alternatively) http://www.example.com/phpBB3/install/app.php into your browser. When you have done this, you should see the phpBB Introduction screen appear.

          +

          Once all the files have been uploaded to your site, you should point your browser at this location with the addition of /install/. For example, if your domain name is www.example.com and you placed the phpBB files in the directory /phpBB off your web root you would enter http://www.example.com/phpBB/install/ or (alternatively) http://www.example.com/phpBB/install/app.php into your browser. When you have done this, you should see the phpBB Introduction screen appear.

          Introduction:

          @@ -313,7 +313,7 @@
        9. Go to the downloads page and download the latest update package listed there, matching your current version.
        10. Upload the uncompressed archive contents to your phpBB installation - only the install/ and vendor/ folders are required. Upload these folders in their entirety, retaining the file structure.
        11. After the install folder is present, phpBB will go offline automatically.
          12. -
        12. Point your browser to the install directory, for example http://www.example.com/phpBB3/install/
          13. +
        13. Point your browser to the install directory, for example http://www.example.com/phpBB/install/
        14. Choose the "Update" Tab and follow the instructions
    @@ -407,7 +407,7 @@

    After verifying the settings in the ACP, you can delete the install directory to enable the board. The board will stay disabled until you do so.

    -

    Once you are pleased with your new installation, you may want to give it the name of your old installation, changing the directory name. With phpBB3 this is possible without any problems, but you may still want to check your cookie settings within the administration panel; in case your cookie path needs to be adjusted prior to renaming.

    +

    Once you are pleased with your new installation, you may want to give it the name of your old installation, changing the directory name. With phpBB this is possible without any problems, but you may still want to check your cookie settings within the administration panel; in case your cookie path needs to be adjusted prior to renaming.

    5.iv. Common conversion problems

    @@ -417,7 +417,7 @@

    Password conversion Due to the utf-8 based handling of passwords in phpBB 3.x, it is not always possible to transfer all passwords. For passwords "lost in translation" the easiest workaround is to use the I forgot my password link on the login page.

    -

    Path to your former board The convertor expects the relative path to your old board's files. So, for instance, if the old board is located at http://www.yourdomain.com/forum and the phpBB 3.x installation is located at http://www.yourdomain.com/phpBB3, then the correct value would be ../forum. Note that the webserver user must be able to access the source installation's files.

    +

    Path to your former board The convertor expects the relative path to your old board's files. So, for instance, if the old board is located at http://www.yourdomain.com/forum and the phpBB installation is located at http://www.yourdomain.com/phpBB, then the correct value would be ../forum. Note that the webserver user must be able to access the source installation's files.

    Missing images If your default board language's language pack does not include all images, then some images might be missing in your installation. Always use a complete language pack as default language.

    diff --git a/phpBB/docs/README.html b/phpBB/docs/README.html index c3f02acf45..e8cc96342c 100644 --- a/phpBB/docs/README.html +++ b/phpBB/docs/README.html @@ -4,7 +4,7 @@ - + phpBB • Readme @@ -21,7 +21,7 @@
    -

    phpBB 3.3.x Readme

    +

    phpBB Readme

    Skip

    diff --git a/phpBB/phpbb/composer.json b/phpBB/phpbb/composer.json index ab2b9601fa..ef3dc4e629 100644 --- a/phpBB/phpbb/composer.json +++ b/phpBB/phpbb/composer.json @@ -23,11 +23,11 @@ "classmap": [""] }, "require": { - "php": ">=5.4" + "php": "^8.1" }, "extra": { "branch-alias": { - "dev-master": "3.3.x-dev" + "dev-master": "4.0.x-dev" } } } diff --git a/phpBB/phpbb/install/module/install_filesystem/task/create_config_file.php b/phpBB/phpbb/install/module/install_filesystem/task/create_config_file.php index 8913b6a923..3a0aeb60d9 100644 --- a/phpBB/phpbb/install/module/install_filesystem/task/create_config_file.php +++ b/phpBB/phpbb/install/module/install_filesystem/task/create_config_file.php @@ -165,7 +165,7 @@ class create_config_file extends \phpbb\install\task_base protected function get_config_data($debug = false, $debug_container = false, $environment = null) { $config_content = "install_config->get('dbms'); $db_driver = $this->db_helper->get_available_dbms($dbms);