From 1c5e0353c11fd5a9f1e1f0ae5cf58040907f5a01 Mon Sep 17 00:00:00 2001 From: Marc Alexander Date: Sun, 12 May 2024 17:41:59 +0200 Subject: [PATCH 1/7] Start implementing page for changes in phpBB --- development/development/changes.rst | 29 +++++++++++++++++++++++++++++ development/index.rst | 1 + 2 files changed, 30 insertions(+) create mode 100644 development/development/changes.rst diff --git a/development/development/changes.rst b/development/development/changes.rst new file mode 100644 index 00000000..659579e6 --- /dev/null +++ b/development/development/changes.rst @@ -0,0 +1,29 @@ +================ +Changes in phpBB +================ + +This document outlines changes introduced in different versions of phpBB. These changes may require adjustments to your existing code. + +.. list-table:: + :widths: 25 10 10 55 + :header-rows: 1 + + * - Feature/Function + - Introduced in + - Deprecated in + - Recommendation + * - feature_name + - X.X.X + - 3.3.10 + - Use alternative_function + * - Row 2, column 1 + - Row 2, column 2 + - Row 2, column 3 + - Migrate to new_approach + +**Explanation of columns:** + +* **Feature/Function:** The name of the feature or function that has a version update. +* **Introduced (phpBB):** The phpBB version where the change was introduced. +* **Deprecated (phpBB) (if applicable):** The phpBB version where the feature or function was marked as deprecated (if applicable). If not applicable, use a hyphen (`-`). +* **Recommendation:** The suggested approach to handle the update. This could involve using an alternative function, migrating code to a new approach, or providing additional information. diff --git a/development/index.rst b/development/index.rst index 732ce7e6..04a080cf 100644 --- a/development/index.rst +++ b/development/index.rst @@ -8,6 +8,7 @@ Contents: start/install start/getting_started + development/changes development/processes development/git development/index From f8f5ba560bd34f74895b5e07cc30cc87b5df5775 Mon Sep 17 00:00:00 2001 From: Marc Alexander Date: Sun, 2 Jun 2024 10:46:00 +0200 Subject: [PATCH 2/7] Start adding documentation for changes in phpBB 4.0 --- development/development/changes.rst | 25 +----- development/development/changes/400.rst | 103 ++++++++++++++++++++++++ 2 files changed, 107 insertions(+), 21 deletions(-) create mode 100644 development/development/changes/400.rst diff --git a/development/development/changes.rst b/development/development/changes.rst index 659579e6..09926dc8 100644 --- a/development/development/changes.rst +++ b/development/development/changes.rst @@ -4,26 +4,9 @@ Changes in phpBB This document outlines changes introduced in different versions of phpBB. These changes may require adjustments to your existing code. -.. list-table:: - :widths: 25 10 10 55 - :header-rows: 1 +Contents: - * - Feature/Function - - Introduced in - - Deprecated in - - Recommendation - * - feature_name - - X.X.X - - 3.3.10 - - Use alternative_function - * - Row 2, column 1 - - Row 2, column 2 - - Row 2, column 3 - - Migrate to new_approach +.. toctree:: + :maxdepth: 3 -**Explanation of columns:** - -* **Feature/Function:** The name of the feature or function that has a version update. -* **Introduced (phpBB):** The phpBB version where the change was introduced. -* **Deprecated (phpBB) (if applicable):** The phpBB version where the feature or function was marked as deprecated (if applicable). If not applicable, use a hyphen (`-`). -* **Recommendation:** The suggested approach to handle the update. This could involve using an alternative function, migrating code to a new approach, or providing additional information. + changes/400 diff --git a/development/development/changes/400.rst b/development/development/changes/400.rst new file mode 100644 index 00000000..7d89dd23 --- /dev/null +++ b/development/development/changes/400.rst @@ -0,0 +1,103 @@ +========= +phpBB 4.0 +========= + +phpBB 4.0 is a major release that contains backward compatibility breaks and also introduces some deprecations. + +.. contents:: Table of Contents + :depth: 2 + :local: + :backlinks: none + +Basics +====== + +PHP +--- +The minimum required version of PHP for phpBB 4.0 is ``8.1`` with full support for versions ``8.2`` and ``8.3``. +PHP code that worked with the supported versions of phpBB 3.3 should work with phpBB 4.0 as well but might require minor adjustments.Recommendation + +Symfony +------- +phpBB 4.0 ships with Symfony 6.4. There are quite a few changes to the standard Symfony version that came with phpBB 3.3. +The following upgrade guides provides by Symfony might help with resolving some of the issues you might encounter when upgrading +custom PHP or Extension code for phpBB 4.0: + +- `Upgrade Symfony from 3.x to 4.0 `_ +- `Upgrade Symfony from 4.4 to 5.0 `_ +- `Upgrade Symfony from 5.x to 6.0 `_ + +You can find more upgrade guides in the `Symfony Repository `_ on GitHub. + +Class and function changes +========================== +The following table lists class and function changes that might affect custom PHP or Extension code. +Also have a look at the `phpBB API documentation `_ for further insight into the class and function API in phpBB 4.0. + +.. list-table:: + :widths: 15 15 10 10 50 + :header-rows: 1 + + * - Class or function + - Path + - Type of change + - Version + - Recommendation + * - ``\phpbb\avatar\driver\remote`` + - ``phpbb/avatar/driver/remote.php`` + - Removed + - ``4.0.0-a1`` + - Use alternative avatar like gravatar or upload avatar. + * - ``\phpbb\captcha\plugins\incomplete`` + - ``phpbb/captcha/plugins/incomplete.php`` + - Added + - ``4.0.0-a1`` + - Placeholder CAPTCHA that prevents e.g. registration until safer captcha like reCAPTCHA or QA is enabled. + * - ``\phpbb\captcha\plugins\gd`` + - ``phpbb/captcha/plugins/gd.php`` + - Removed + - ``4.0.0-a1`` + - Use safer captcha like reCAPTCHA or QA. + * - ``\phpbb\captcha\plugins\gd_wave`` + - ``phpbb/captcha/plugins/gd_wave.php`` + - Removed + - ``4.0.0-a1`` + - Use safer captcha like reCAPTCHA or QA. + * - ``\phpbb\captcha\plugins\nogd`` + - ``phpbb/captcha/plugins/nogd.php`` + - Removed + - ``4.0.0-a1`` + - Use safer captcha like reCAPTCHA or QA. + * - ``\phpbb\captcha\char_cube3d`` + - ``phpbb/captcha/char_cube3d.php`` + - Removed + - ``4.0.0-a1`` + - No longer used due to removal of gd & nogd CAPTCHAs. + * - ``\phpbb\captcha\colour_manager`` + - ``phpbb/captcha/colour_manager.php`` + - Removed + - ``4.0.0-a1`` + - No longer used due to removal of gd & nogd CAPTCHAs. + * - ``\phpbb\captcha\gd`` + - ``phpbb/captcha/gd.php`` + - Removed + - ``4.0.0-a1`` + - No longer used due to removal of gd & nogd CAPTCHAs. + * - ``\phpbb\captcha\gd_wave`` + - ``phpbb/captcha/gd_wave.php`` + - Removed + - ``4.0.0-a1`` + - No longer used due to removal of gd & nogd CAPTCHAs. + * - ``\phpbb\captcha\non_gd`` + - ``phpbb/captcha/non_gd.php`` + - Removed + - ``4.0.0-a1`` + - No longer used due to removal of gd & nogd CAPTCHAs. + +**Explanation of columns:** + +* **Class or function:** The name of the class or function that was added, changed, deprecated, or removed in this version. +* **Path:** Path to file. +* **Type of change:** The type of change, e.g. added, changed, deprecated, or removed in this version. +* **Version:** Version in which this change was introduced. +* **Recommendation:** The suggested approach to handle the change. This could involve using an alternative function, migrating code to a new approach, or providing additional information. From c2d373bbe8d2077b665cb46c455619137b770c6b Mon Sep 17 00:00:00 2001 From: Marc Alexander Date: Sun, 2 Jun 2024 15:12:37 +0200 Subject: [PATCH 3/7] Adjust wording and add info for form_helper --- development/development/changes/400.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/development/development/changes/400.rst b/development/development/changes/400.rst index 7d89dd23..a7cd7d5e 100644 --- a/development/development/changes/400.rst +++ b/development/development/changes/400.rst @@ -42,7 +42,7 @@ Also have a look at the `phpBB API documentation Date: Sun, 2 Jun 2024 15:25:02 +0200 Subject: [PATCH 4/7] Add some info about ban system refactoring --- development/development/changes/400.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/development/development/changes/400.rst b/development/development/changes/400.rst index a7cd7d5e..7365fab8 100644 --- a/development/development/changes/400.rst +++ b/development/development/changes/400.rst @@ -29,6 +29,17 @@ custom PHP or Extension code for phpBB 4.0: You can find more upgrade guides in the `Symfony Repository `_ on GitHub. +Major changes +============= + +Ban system +---------- +The ban system has been greatly refactored for phpBB 4.0. As part of this, the following changes were introduced: + +- Added support for banning `CIDR blocks `_ +- Added support for IPv6 banning +- Removed "exclude" functionality which resulted in ambiguous settings + Class and function changes ========================== The following table lists class and function changes that might affect custom PHP or Extension code. @@ -48,6 +59,11 @@ Also have a look at the `phpBB API documentation `_ namespace. * - ``\phpbb\captcha\plugins\incomplete`` - ``phpbb/captcha/plugins/incomplete.php`` - Added From 2b20d51d48d43cca53a05b7bb64dfbc22d0de0a1 Mon Sep 17 00:00:00 2001 From: Marc Alexander Date: Sun, 2 Jun 2024 16:54:31 +0200 Subject: [PATCH 5/7] Rename to upgrade guide --- development/development/changes.rst | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/development/development/changes.rst b/development/development/changes.rst index 09926dc8..ccf5f408 100644 --- a/development/development/changes.rst +++ b/development/development/changes.rst @@ -1,8 +1,14 @@ -================ -Changes in phpBB -================ +============= +Upgrade Guide +============= -This document outlines changes introduced in different versions of phpBB. These changes may require adjustments to your existing code. +This document outlines changes introduced in different versions of phpBB. These changes may require adjustments to your +existing custom PHP code or Extension code when upgrading to specific versions from a prior versions of phpBB. +It is mainly meant to be used by core and Extension developers and does not provide end user documentation for upgrading. + +Unless explicitly stated otherwise, each version describes the changes compared to the previous major or minor version +that directly preceded it. For example the upgrade guide for 4.0 will describe the changes compared to 3.3 whereas an upgrade guide +for 4.1 will describe the changes compared to 4.0. Contents: From 3499e6a89a727c259119b6913fa39737b0739f2f Mon Sep 17 00:00:00 2001 From: Marc Alexander Date: Sun, 2 Jun 2024 16:56:26 +0200 Subject: [PATCH 6/7] Rename to upgrade instead of changes --- development/development/{changes.rst => upgrade.rst} | 2 +- development/development/{changes => upgrade}/400.rst | 0 development/index.rst | 2 +- 3 files changed, 2 insertions(+), 2 deletions(-) rename development/development/{changes.rst => upgrade.rst} (98%) rename development/development/{changes => upgrade}/400.rst (100%) diff --git a/development/development/changes.rst b/development/development/upgrade.rst similarity index 98% rename from development/development/changes.rst rename to development/development/upgrade.rst index ccf5f408..87e6bfc0 100644 --- a/development/development/changes.rst +++ b/development/development/upgrade.rst @@ -15,4 +15,4 @@ Contents: .. toctree:: :maxdepth: 3 - changes/400 + upgrade/400 diff --git a/development/development/changes/400.rst b/development/development/upgrade/400.rst similarity index 100% rename from development/development/changes/400.rst rename to development/development/upgrade/400.rst diff --git a/development/index.rst b/development/index.rst index 04a080cf..e28bdcf2 100644 --- a/development/index.rst +++ b/development/index.rst @@ -8,7 +8,7 @@ Contents: start/install start/getting_started - development/changes + development/upgrade development/processes development/git development/index From b043dda5069a9d96419ccdaa84260ec8b6f6c695 Mon Sep 17 00:00:00 2001 From: Marc Alexander Date: Sun, 2 Jun 2024 17:37:54 +0200 Subject: [PATCH 7/7] Change to state from which version the upgrade guide is --- development/development/upgrade/400.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/development/development/upgrade/400.rst b/development/development/upgrade/400.rst index 7365fab8..740c5a9a 100644 --- a/development/development/upgrade/400.rst +++ b/development/development/upgrade/400.rst @@ -1,6 +1,6 @@ -========= -phpBB 4.0 -========= +================ +phpBB 3.3 to 4.0 +================ phpBB 4.0 is a major release that contains backward compatibility breaks and also introduces some deprecations.