Skip to content

Commit f8f5ba5

Browse files
committed
Start adding documentation for changes in phpBB 4.0
1 parent 1c5e035 commit f8f5ba5

File tree

2 files changed

+107
-21
lines changed

2 files changed

+107
-21
lines changed

development/development/changes.rst

Lines changed: 4 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,9 @@ Changes in phpBB
44

55
This document outlines changes introduced in different versions of phpBB. These changes may require adjustments to your existing code.
66

7-
.. list-table::
8-
:widths: 25 10 10 55
9-
:header-rows: 1
7+
Contents:
108

11-
* - Feature/Function
12-
- Introduced in
13-
- Deprecated in
14-
- Recommendation
15-
* - feature_name
16-
- X.X.X
17-
- 3.3.10
18-
- Use alternative_function
19-
* - Row 2, column 1
20-
- Row 2, column 2
21-
- Row 2, column 3
22-
- Migrate to new_approach
9+
.. toctree::
10+
:maxdepth: 3
2311

24-
**Explanation of columns:**
25-
26-
* **Feature/Function:** The name of the feature or function that has a version update.
27-
* **Introduced (phpBB):** The phpBB version where the change was introduced.
28-
* **Deprecated (phpBB) (if applicable):** The phpBB version where the feature or function was marked as deprecated (if applicable). If not applicable, use a hyphen (`-`).
29-
* **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.
12+
changes/400
Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
=========
2+
phpBB 4.0
3+
=========
4+
5+
phpBB 4.0 is a major release that contains backward compatibility breaks and also introduces some deprecations.
6+
7+
.. contents:: Table of Contents
8+
:depth: 2
9+
:local:
10+
:backlinks: none
11+
12+
Basics
13+
======
14+
15+
PHP
16+
---
17+
The minimum required version of PHP for phpBB 4.0 is ``8.1`` with full support for versions ``8.2`` and ``8.3``.
18+
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
19+
20+
Symfony
21+
-------
22+
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.
23+
The following upgrade guides provides by Symfony might help with resolving some of the issues you might encounter when upgrading
24+
custom PHP or Extension code for phpBB 4.0:
25+
26+
- `Upgrade Symfony from 3.x to 4.0 <https://github.com/symfony/symfony/blob/4.4/UPGRADE-4.0.md>`_
27+
- `Upgrade Symfony from 4.4 to 5.0 <https://github.com/symfony/symfony/blob/5.4/UPGRADE-5.0.md>`_
28+
- `Upgrade Symfony from 5.x to 6.0 <https://github.com/symfony/symfony/blob/6.4/UPGRADE-6.0.md>`_
29+
30+
You can find more upgrade guides in the `Symfony Repository <https://github.com/symfony/symfony/tree/6.4>`_ on GitHub.
31+
32+
Class and function changes
33+
==========================
34+
The following table lists class and function changes that might affect custom PHP or Extension code.
35+
Also have a look at the `phpBB API documentation <https://area51.phpbb.com/docs/code/master/>`_ for further insight into the class and function API in phpBB 4.0.
36+
37+
.. list-table::
38+
:widths: 15 15 10 10 50
39+
:header-rows: 1
40+
41+
* - Class or function
42+
- Path
43+
- Type of change
44+
- Version
45+
- Recommendation
46+
* - ``\phpbb\avatar\driver\remote``
47+
- ``phpbb/avatar/driver/remote.php``
48+
- Removed
49+
- ``4.0.0-a1``
50+
- Use alternative avatar like gravatar or upload avatar.
51+
* - ``\phpbb\captcha\plugins\incomplete``
52+
- ``phpbb/captcha/plugins/incomplete.php``
53+
- Added
54+
- ``4.0.0-a1``
55+
- Placeholder CAPTCHA that prevents e.g. registration until safer captcha like reCAPTCHA or QA is enabled.
56+
* - ``\phpbb\captcha\plugins\gd``
57+
- ``phpbb/captcha/plugins/gd.php``
58+
- Removed
59+
- ``4.0.0-a1``
60+
- Use safer captcha like reCAPTCHA or QA.
61+
* - ``\phpbb\captcha\plugins\gd_wave``
62+
- ``phpbb/captcha/plugins/gd_wave.php``
63+
- Removed
64+
- ``4.0.0-a1``
65+
- Use safer captcha like reCAPTCHA or QA.
66+
* - ``\phpbb\captcha\plugins\nogd``
67+
- ``phpbb/captcha/plugins/nogd.php``
68+
- Removed
69+
- ``4.0.0-a1``
70+
- Use safer captcha like reCAPTCHA or QA.
71+
* - ``\phpbb\captcha\char_cube3d``
72+
- ``phpbb/captcha/char_cube3d.php``
73+
- Removed
74+
- ``4.0.0-a1``
75+
- No longer used due to removal of gd & nogd CAPTCHAs.
76+
* - ``\phpbb\captcha\colour_manager``
77+
- ``phpbb/captcha/colour_manager.php``
78+
- Removed
79+
- ``4.0.0-a1``
80+
- No longer used due to removal of gd & nogd CAPTCHAs.
81+
* - ``\phpbb\captcha\gd``
82+
- ``phpbb/captcha/gd.php``
83+
- Removed
84+
- ``4.0.0-a1``
85+
- No longer used due to removal of gd & nogd CAPTCHAs.
86+
* - ``\phpbb\captcha\gd_wave``
87+
- ``phpbb/captcha/gd_wave.php``
88+
- Removed
89+
- ``4.0.0-a1``
90+
- No longer used due to removal of gd & nogd CAPTCHAs.
91+
* - ``\phpbb\captcha\non_gd``
92+
- ``phpbb/captcha/non_gd.php``
93+
- Removed
94+
- ``4.0.0-a1``
95+
- No longer used due to removal of gd & nogd CAPTCHAs.
96+
97+
**Explanation of columns:**
98+
99+
* **Class or function:** The name of the class or function that was added, changed, deprecated, or removed in this version.
100+
* **Path:** Path to file.
101+
* **Type of change:** The type of change, e.g. added, changed, deprecated, or removed in this version.
102+
* **Version:** Version in which this change was introduced.
103+
* **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.

0 commit comments

Comments
 (0)