rfc:magic-methods-signature
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
rfc:magic-methods-signature [2020/04/15 23:18] – Grammar carusogabriel | rfc:magic-methods-signature [2020/05/29 16:38] – Open for voting carusogabriel | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== PHP RFC: Ensure correct magic methods' signatures when typed ====== | + | ====== PHP RFC: Ensure correct |
* Version: 1.0 | * Version: 1.0 | ||
* Date: 2020-04-05 | * Date: 2020-04-05 | ||
* Author: Gabriel Caruso (< | * Author: Gabriel Caruso (< | ||
- | * Status: | + | * Status: |
* Target Version: PHP 8.0 | * Target Version: PHP 8.0 | ||
* Implementation: | * Implementation: | ||
Line 9: | Line 9: | ||
===== Introduction ===== | ===== Introduction ===== | ||
- | This RFC is inspired by [[https:// | + | It is currently possible to write magic methods that have signatures that don't match the signature |
- | However, this implementation is not as simple as just check for the methods' | + | This behavior of allowing incorrect |
- | Nowadays, PHP already checks the signature for the following methods: | + | As ensuring magic methods have correct signatures is a backward compatible break for code that currently has incorrect signatures, this change would only be appropriate in a major PHP release. |
- | + | ||
- | * clone return type: https:// | + | |
- | * construct return type: https:// | + | |
- | * destruct return type: https:// | + | |
===== Motivation ===== | ===== Motivation ===== | ||
- | Since the introduction of types in PHP 7.0, only the 3 checks listed above were introduced to make sure that developers | + | PHP's Magic Methods is something that PHP provides allowing developers to track and act on specific changes of behavior of a certain class. Given that fact, the same should ensure |
- | For PHP 8, this RFC aims to expand these checks, making their usage standard across different projects and applications. | + | Since the introduction of types in PHP 7.0, only the checks |
- | ===== Proposal ===== | + | * // |
+ | * // | ||
+ | * // | ||
+ | * // | ||
- | This RFC proposes | + | For PHP 8, this RFC aims to expand these checks. |
- | **Important: | + | ===== Proposal ===== |
+ | |||
+ | This RFC proposes to add parameter | ||
The proposal follows the [[https:// | The proposal follows the [[https:// | ||
<code php> | <code php> | ||
- | /** @return mixed */ | + | Foo:: |
- | Foo:: | + | |
- | /** @return mixed */ | + | Foo:: |
- | Foo:: | + | |
Foo:: | Foo:: | ||
- | /** @return mixed */ | + | Foo:: |
- | Foo:: | + | |
+ | Foo:: | ||
Foo:: | Foo:: | ||
- | /** @param mixed $value */ | + | Foo:: |
- | Foo:: | + | |
+ | Foo:: | ||
+ | |||
+ | Foo:: | ||
+ | |||
+ | Foo:: | ||
+ | |||
+ | Foo:: | ||
Foo:: | Foo:: | ||
+ | |||
+ | Foo:: | ||
</ | </ | ||
- | **Note:** The // | + | **Note:** The // |
| | ||
===== Backward Incompatible Changes ===== | ===== Backward Incompatible Changes ===== | ||
- | |||
- | An important note here is that if one of the listed magic methods is directly called, and it has the wrong signatures, the error will be thrown regardless. | ||
- | |||
- | For example https:// | ||
==== To Magic Methods without types declared ==== | ==== To Magic Methods without types declared ==== | ||
Line 71: | Line 76: | ||
===== RFC Impact ===== | ===== RFC Impact ===== | ||
- | Scraping the top 1000 Composer packages (using Nikita' | + | Scraping the top 1000 Composer packages (using Nikita' |
- | Luckily, none of them is a problem as // | + | Luckily, none of them is a problem as // |
Even with a //mixed// RFC that wouldn' | Even with a //mixed// RFC that wouldn' | ||
Line 79: | Line 84: | ||
===== Future Scope ===== | ===== Future Scope ===== | ||
- | This RFC only aims to add checks for the methods' | + | This RFC only aims to add checks for the methods' |
+ | |||
+ | * // | ||
+ | * // | ||
+ | * // | ||
+ | * // | ||
+ | |||
+ | ===== Voting ===== | ||
+ | |||
+ | Voting started at 2020-05-29 18h (CEST) and ends 2020-06-19 18h (CEST). | ||
+ | |||
+ | <doodle title=" | ||
+ | * Yes | ||
+ | * No | ||
+ | </ | ||
+ | |||
+ | ===== External resources ===== | ||
- | ===== Proposed Voting Choices ===== | + | - Discussion thread: https:// |
- | Yes/No. |
rfc/magic-methods-signature.txt · Last modified: 2020/08/01 23:34 by carusogabriel