minor #7611 [BC] Allow more changes when the class/method is final (GuilhemN)

weaverryan · weaverryan · commit 7b7ce88c55dc · 2017-10-28T22:36:52.000-04:00
This PR was squashed before being merged into the 2.7 branch (closes #7611). Discussion ---------- [BC] Allow more changes when the class/method is final Fixes #7597 Commits ------- f5b8dd4 Improve notes 936200c Update 4a3fbed Fix comments a5f6d24 [BC] Allow more changes when the class/method is final
diff --git a/contributing/code/bc.rst b/contributing/code/bc.rst
@@ -181,7 +181,7 @@ Symfony's classes:
 Type of Change                                      Change Allowed
 ==================================================  ==============
 Remove entirely                                     No
-Make final                                          No
+Make final                                          No [6]_
 Make abstract                                       No
 Change name or namespace                            No
 Change parent class                                 Yes [4]_
@@ -194,8 +194,8 @@ Reduce visibility                                   No
 Move to parent class                                Yes
 **Protected Properties**
 Add protected property                              Yes
-Remove protected property                           No
-Reduce visibility                                   No
+Remove protected property                           No [7]_
+Reduce visibility                                   No [7]_
 Move to parent class                                Yes
 **Private Properties**
 Add private property                                Yes
@@ -204,7 +204,7 @@ Remove private property                             Yes
 Add constructor without mandatory arguments         Yes [1]_
 Remove constructor                                  No
 Reduce visibility of a public constructor           No
-Reduce visibility of a protected constructor        No
+Reduce visibility of a protected constructor        No [7]_
 Move to parent class                                Yes
 **Public Methods**
 Add public method                                   Yes
@@ -213,29 +213,29 @@ Change name                                         No
 Reduce visibility                                   No
 Move to parent class                                Yes
 Add argument without a default value                No
-Add argument with a default value                   No
+Add argument with a default value                   No [7]_ [8]_
 Remove argument                                     Yes [3]_
-Add default value to an argument                    No
+Add default value to an argument                    No [7]_ [8]_
 Remove default value of an argument                 No
-Add type hint to an argument                        No
-Remove type hint of an argument                     No
-Change argument type                                No
-Change return type                                  No
+Add type hint to an argument                        No [7]_ [8]_
+Remove type hint of an argument                     No [7]_ [8]_
+Change argument type                                No [7]_ [8]_
+Change return type                                  No [7]_ [8]_
 **Protected Methods**
 Add protected method                                Yes
-Remove protected method                             No
-Change name                                         No
-Reduce visibility                                   No
+Remove protected method                             No [7]_
+Change name                                         No [7]_
+Reduce visibility                                   No [7]_
 Move to parent class                                Yes
-Add argument without a default value                No
-Add argument with a default value                   No
+Add argument without a default value                No [7]_
+Add argument with a default value                   No [7]_ [8]_
 Remove argument                                     Yes [3]_
-Add default value to an argument                    No
-Remove default value of an argument                 No
-Add type hint to an argument                        No
-Remove type hint of an argument                     No
-Change argument type                                No
-Change return type                                  No
+Add default value to an argument                    No [7]_ [8]_
+Remove default value of an argument                 No [7]_
+Add type hint to an argument                        No [7]_ [8]_
+Remove type hint of an argument                     No [7]_ [8]_
+Change argument type                                No [7]_ [8]_
+Change return type                                  No [7]_ [8]_
 **Private Methods**
 Add private method                                  Yes
 Remove private method                               Yes
@@ -250,7 +250,7 @@ Remove type hint of an argument                     Yes
 Change argument type                                Yes
 Change return type                                  Yes
 **Static Methods**
-Turn non static into static                         No
+Turn non static into static                         No [7]_ [8]_
 Turn static into non static                         No
 **Constants**
 Add constant                                        Yes
@@ -277,6 +277,20 @@ Change value of a constant                          Yes [1]_ [5]_
        Additionally, if a constant will likely be used in objects that are
        serialized, the value of a constant should not be changed.
 
+.. [6] Allowed using the ``@final`` annotation.
+
+.. [7] Allowed if the class is final. Classes that received the ``@final``
+       annotation after their first release are considered final in their
+       next major version.
+       Changing an argument type is only possible with a parent type.
+       Changing a return type is only possible with a child type.
+
+.. [8] Allowed if the method is final. Methods that received the ``@final``
+       annotation after their first release are considered final in their
+       next major version.
+       Changing an argument type is only possible with a parent type.
+       Changing a return type is only possible with a child type.
+
 .. _Semantic Versioning: http://semver.org/
 .. _scalar type: http://php.net/manual/en/function.is-scalar.php
 .. _boolean values: http://php.net/manual/en/function.boolval.php
