Class Iri: add input validation #602
Merged
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
The documented accepted parameter type for the constructor of the `Iri` class is `string|null`, but no input validation was done on the parameter, which could lead to various PHP errors. This commit adds input validation to the class constructor, allowing only for strings or null. As for the other methods: * The `public` magic methods should not need input validation as they should not be called directly, but only indirectly and when called that way, will receive the correct input type. * The `public static` `Iri::absolutize()` method takes two parameters, both of type `\WpOrg\Requests\Iri|string` and already validates these parameters to be an instance of `Iri` and if not, invokes the class constructor, which will now automatically validate the input as `string|null`. * The other `public` non-static methods do not take parameters. Includes adding perfunctory tests for the new exception.
schlessera
approved these changes
Nov 8, 2021
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.
The documented accepted parameter type for the constructor of the
Iriclass isstring|null, but no input validation was done on the parameter, which could lead to various PHP errors.This commit adds input validation to the class constructor, allowing only for strings or null.
As for the other methods:
publicmagic methods should not need input validation as they should not be called directly, but only indirectly and when called that way, will receive the correct input type.public staticIri::absolutize()method takes two parameters, both of type\WpOrg\Requests\Iri|stringand already validates these parameters to be an instance ofIriand if not, invokes the class constructor, which will now automatically validate the input asstring|null.publicnon-static methods do not take parameters.Includes adding perfunctory tests for the new exception.