Stricter input/output type declaration, matching original type signatures from 2.0.0-beta5 release
#23
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Carnage <t.carnage@gmail.com>
carnage
force-pushed
the
fix-strict-type-bc
branch
from
42646ad
to
b877686
Compare
Ocramius
changed the title
|
Marked for Effectively, this is an improvement that mitigates the problems found in #20, and if call-site consumers of the code use In addition to that, I decided to not mark this as
|
|
I'll merge this manually after having applied some cleanup operations (CS/QA checks, mostly) |
Since the constructor of `Escaper` now asserts the input to be of type `string|null`, we no longer need to assert by hand on mis-behavior, and therefore can remove an exception scenario, as well as the associated test case.
Since we now use native parameter type declarations, we no longer need to have `@param string $param` declarations. Also, `is_string()` and `gettype()` are no longer in use (were used when throwing an exception based on invalid input). Note that `@return string` is preserved: we cannot introduce native return type declarations, as that would lead to downstream crashes in inheritance scenarios, when the consumer didn't declare `: string` return types themselves too.
Ocramius
changed the title
2.0.0-beta5 release
|
Thanks @carnage! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Carnage t.carnage@gmail.com
Description
The introduction of strict types in the file heading is propagated to calling code as the required types are missing from the method signatures. This PR adds the types and resolves the BC break.
While adding types to the methods could be considered a BC break in itself, I cannot conceive of any sensible use case that this change would impact.