Skip to content

Commit c3bba01

Browse files
committed
Completely rephrase upgrade guide docs
1 parent f6bca28 commit c3bba01

File tree

2 files changed

+27
-21
lines changed

2 files changed

+27
-21
lines changed

development/development/upgrade.rst

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,11 @@
22
Upgrade Guide
33
=============
44

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.
5+
This guide summarizes code-level changes introduced in various phpBB versions that may require updates to your custom PHP code, extensions, or styles during an upgrade.
86

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.
7+
It is intended primarily for core developers, extension authors, and style creators. **It does not cover instructions for end users performing a board upgrade.**
8+
9+
Unless otherwise noted, each upgrade entry documents changes relative to the immediately preceding major or minor release.
1210

1311
Contents:
1412

development/development/upgrade/400.rst

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
phpBB 3.3 to 4.0
33
================
44

5-
phpBB 4.0 is a major release that contains backward compatibility breaks and also introduces some deprecations.
5+
phpBB 4.0 is a major release that includes backward-incompatible changes and new deprecations.
6+
This guide highlights the most important changes and resources to help extension and style developers adapt their code.
67

78
.. contents:: Table of Contents
89
:depth: 2
@@ -14,42 +15,49 @@ Basics
1415

1516
PHP
1617
---
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
18+
phpBB 4.0 requires PHP 8.1 or higher. Most PHP code compatible with phpBB 3.3 should work in phpBB 4.0 with minimal changes,
19+
but you may need to make adjustments depending on deprecated or changed functionality.
1920

2021
Symfony
2122
-------
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:
23+
phpBB 4.0 uses Symfony 6.4, a significant upgrade from the version bundled with phpBB 3.3. As Symfony introduced breaking
24+
changes across versions, we recommend reviewing the following Symfony upgrade guides when updating custom code or extensions:
2525

2626
- `Upgrade Symfony from 3.x to 4.0 <https://github.com/symfony/symfony/blob/4.4/UPGRADE-4.0.md>`_
2727
- `Upgrade Symfony from 4.4 to 5.0 <https://github.com/symfony/symfony/blob/5.4/UPGRADE-5.0.md>`_
2828
- `Upgrade Symfony from 5.x to 6.0 <https://github.com/symfony/symfony/blob/6.4/UPGRADE-6.0.md>`_
2929

30-
You can find more upgrade guides in the `Symfony Repository <https://github.com/symfony/symfony/tree/6.4>`_ on GitHub.
30+
Additional guides are available in the `Symfony GitHub repository <https://github.com/symfony/symfony/tree/6.4>`_.
3131

3232
Major changes
3333
=============
3434

3535
Ban system
3636
----------
37-
The ban system has been greatly refactored for phpBB 4.0. As part of this, the following changes were introduced:
37+
The ban system has been significantly refactored in phpBB 4.0. Key changes include:
3838

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
39+
- `CIDR block <https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_blocks>`_ support for banning IP ranges.
40+
- IPv6 banning is now supported.
41+
- “Exclude” functionality has been removed due to ambiguity and inconsistent behavior.
4242

4343
Removal of Jabber/XMPP
4444
----------------------
45-
The Jabber/XMPP functionality has been removed from phpBB 4.0. This includes the Jabber/XMPP settings in the ACP and the Jabber/XMPP notification system.
46-
Users with Jabber/XMPP accounts will no longer receive notifications via Jabber/XMPP and have instead been migrated to email notifications.
47-
The Jabber/XMPP functionality was removed due to the lack of support for the XMPP protocol in modern browsers and the fact that it was not widely used by phpBB users.
45+
All Jabber/XMPP features have been removed in phpBB 4.0:
46+
47+
- Jabber/XMPP settings in the ACP are gone.
48+
- XMPP-based notifications have been discontinued.
49+
- Users who previously used Jabber/XMPP will now receive notifications via email.
50+
51+
This removal was driven by lack of browser support for XMPP and limited adoption within the phpBB community.
4852

4953
Class and function changes
5054
==========================
55+
Several classes and functions have been changed or removed. If your extension or code uses phpBB internals, you’ll want to:
56+
57+
- Review the updated `phpBB 4.0 API documentation <https://area51.phpbb.com/docs/code/master/>`_
58+
- Audit your code for usages of deprecated or removed methods/classes
59+
5160
The following table lists class and function changes that might affect custom PHP or Extension code.
52-
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.
5361

5462
.. list-table::
5563
:widths: 15 15 10 10 50

0 commit comments

Comments
 (0)