Skip to content

Commit 4752f40

Browse files
committed
PHPLIB-601: Document upcoming typing changes
1 parent 61a3975 commit 4752f40

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

UPGRADE-1.14.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# UPGRADE FROM 1.x to 1.14
2+
3+
## Method signature changes
4+
5+
### Parameter types
6+
7+
Starting with 1.14, methods now declare types for their arguments. This will not
8+
cause BC breaks unless you've passed a type that was incompatible with the type
9+
documented in the PHPDoc comment.
10+
11+
### Return types
12+
13+
Return types will be added in version 2.0. These types are documented in a
14+
PHPDoc comment, which will become the new return type. You can prepare for this
15+
change (which will trigger a BC break in any class you may extend) by adding the
16+
correct return type to your class at this time.
17+
18+
## Internal classes
19+
20+
Internal classes will become final where possible in a future release. At the
21+
same time, we will add return types to these internal classes. Note that
22+
internal classes are not covered by our backward compatibility promise, and you
23+
should not instantiate such classes directly.

0 commit comments

Comments
 (0)