Skip to content

Commit 64d6724

Browse files
marc1706marc1706
authored
Merge pull request #287 from phpbb/document/changes
Document/changes
2 parents 9a15e9d + b043dda commit 64d6724

File tree

3 files changed

+143
-0
lines changed

3 files changed

+143
-0
lines changed

‎development/development/upgrade.rst

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
=============
2+
Upgrade Guide
3+
=============
4+
5+
This document outlines changes introduced in different versions of phpBB. These changes may require adjustments to your
6+
existing custom PHP code or Extension code when upgrading to specific versions from a prior versions of phpBB.
7+
It is mainly meant to be used by core and Extension developers and does not provide end user documentation for upgrading.
8+
9+
Unless explicitly stated otherwise, each version describes the changes compared to the previous major or minor version
10+
that directly preceded it. For example the upgrade guide for 4.0 will describe the changes compared to 3.3 whereas an upgrade guide
11+
for 4.1 will describe the changes compared to 4.0.
12+
13+
Contents:
14+
15+
.. toctree::
16+
:maxdepth: 3
17+
18+
upgrade/400

‎development/development/upgrade/400.rst

+124
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
================
2+
phpBB 3.3 to 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+
Major changes
33+
=============
34+
35+
Ban system
36+
----------
37+
The ban system has been greatly refactored for phpBB 4.0. As part of this, the following changes were introduced:
38+
39+
- Added support for banning `CIDR blocks <https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_blocks>`_
40+
- Added support for IPv6 banning
41+
- Removed "exclude" functionality which resulted in ambiguous settings
42+
43+
Class and function changes
44+
==========================
45+
The following table lists class and function changes that might affect custom PHP or Extension code.
46+
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.
47+
48+
.. list-table::
49+
:widths: 15 15 10 10 50
50+
:header-rows: 1
51+
52+
* - Class or function
53+
- Path
54+
- Type of change
55+
- Version
56+
- Explanation
57+
* - ``\phpbb\avatar\driver\remote``
58+
- ``phpbb/avatar/driver/remote.php``
59+
- Removed
60+
- ``4.0.0-a1``
61+
- Use alternative avatar like gravatar or upload avatar.
62+
* - ``\phpbb\ban\*``
63+
- ``phpbb/ban/*``
64+
- Added
65+
- ``4.0.0-a1``
66+
- Added new refactored banning system. See the API docs for `\\phpbb\\ban <https://area51.phpbb.com/docs/code/master/phpbb/ban.html>`_ namespace.
67+
* - ``\phpbb\captcha\plugins\incomplete``
68+
- ``phpbb/captcha/plugins/incomplete.php``
69+
- Added
70+
- ``4.0.0-a1``
71+
- Placeholder CAPTCHA that prevents e.g. registration until safer captcha like reCAPTCHA or QA is enabled.
72+
* - ``\phpbb\captcha\plugins\gd``
73+
- ``phpbb/captcha/plugins/gd.php``
74+
- Removed
75+
- ``4.0.0-a1``
76+
- Use safer captcha like reCAPTCHA or QA.
77+
* - ``\phpbb\captcha\plugins\gd_wave``
78+
- ``phpbb/captcha/plugins/gd_wave.php``
79+
- Removed
80+
- ``4.0.0-a1``
81+
- Use safer captcha like reCAPTCHA or QA.
82+
* - ``\phpbb\captcha\plugins\nogd``
83+
- ``phpbb/captcha/plugins/nogd.php``
84+
- Removed
85+
- ``4.0.0-a1``
86+
- Use safer captcha like reCAPTCHA or QA.
87+
* - ``\phpbb\captcha\char_cube3d``
88+
- ``phpbb/captcha/char_cube3d.php``
89+
- Removed
90+
- ``4.0.0-a1``
91+
- No longer used due to removal of gd & nogd CAPTCHAs.
92+
* - ``\phpbb\captcha\colour_manager``
93+
- ``phpbb/captcha/colour_manager.php``
94+
- Removed
95+
- ``4.0.0-a1``
96+
- No longer used due to removal of gd & nogd CAPTCHAs.
97+
* - ``\phpbb\captcha\gd``
98+
- ``phpbb/captcha/gd.php``
99+
- Removed
100+
- ``4.0.0-a1``
101+
- No longer used due to removal of gd & nogd CAPTCHAs.
102+
* - ``\phpbb\captcha\gd_wave``
103+
- ``phpbb/captcha/gd_wave.php``
104+
- Removed
105+
- ``4.0.0-a1``
106+
- No longer used due to removal of gd & nogd CAPTCHAs.
107+
* - ``\phpbb\captcha\non_gd``
108+
- ``phpbb/captcha/non_gd.php``
109+
- Removed
110+
- ``4.0.0-a1``
111+
- No longer used due to removal of gd & nogd CAPTCHAs.
112+
* - ``\phpbb\form\form_helper``
113+
- ``phpbb/form/form_helper.php``
114+
- Added
115+
- ``4.0.0-a1``
116+
- Introduced form_helper for generating and checking form tokens.
117+
118+
**Explanation of columns:**
119+
120+
* **Class or function:** The name of the class or function that was added, changed, deprecated, or removed in this version.
121+
* **Path:** Path to file.
122+
* **Type of change:** The type of change, e.g. added, changed, deprecated, or removed in this version.
123+
* **Version:** Version in which this change was introduced.
124+
* **Explanation:** The suggested approach to handle the change. This could involve using an alternative function, migrating code to a new approach, or providing additional information.

‎development/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Contents:
88

99
start/install
1010
start/getting_started
11+
development/upgrade
1112
development/processes
1213
development/git
1314
development/index

0 commit comments

Comments
 (0)