Util\ObjectDeclarations: add findExtendedInterfaceNames() method #31
Conversation
This file contains hidden or 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
Interfaces can extend more than one interface (in contrast to classes) and both the PHPCS native, as well as the `Util\ObjectDeclarations` `findExtendedClassName()` method does not allow for that. See: http://php.net/manual/en/language.oop5.interfaces.php#example-208 To allow for this from within the existing `findExtendedClassName()` method would change the function signature from `@return string|false` to `@return string|array|false`, thus breaking the API. So, instead, a new `ObjectDeclarations::findExtendedInterfaceNames()` method has been added and it is now explicitly recommended in the documentation of the `findExtendedClassName()` method to use the new method when examining interface declarations. Includes dedicated unit tests for the new method. This commit supersedes upstream PR 2128.
jrfnl
deleted the
feature/new-objectdecl-findextendedinterfacenames-method
branch
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.
Interfaces can extend more than one interface (in contrast to classes) and both the PHPCS native, as well as the
Util\ObjectDeclarationsfindExtendedClassName()method does not allow for that.See: http://php.net/manual/en/language.oop5.interfaces.php#example-208
To allow for this from within the existing
findExtendedClassName()method would change the function signature from@return string|falseto@return string|array|false, thus breaking the API.So, instead, a new
ObjectDeclarations::findExtendedInterfaceNames()method has been added and it is now explicitly recommended in the documentation of thefindExtendedClassName()method to use the new method when examining interface declarations.Includes dedicated unit tests for the new method.
This commit supersedes upstream PR squizlabs/PHP_CodeSniffer#2128.