Add explicit Stringable interface to UuidInterface
#491
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
Even tho, the `Stringable` interface is implicit on all objects containing the method `__toString`, it is recommended by PHP to explicitly setting that interface. From php.net documentation: > [...] Unlike most interfaces, **Stringable** is implicitly present on any class that has the magic `__toString()` method defined, although it can and should be declared explicitly. Signed-off-by: Maximilian Bösing <2189546+boesing@users.noreply.github.com>
…e` interface NOTE: The test will not fail even if the interface is being removed. This is due to the fact that PHP starting with 8.0 adds the interface implicitly whenever a `__toString` method is available. This might change in the future as per the php.net documentation. Signed-off-by: Maximilian Bösing <2189546+boesing@users.noreply.github.com>
|
I'm not sure why phpcs is failing the build for warnings. That's odd. Can you break those assertions across multiple lines so they don't go over 120 characters? In the meantime, I'll figure out how to tell PHP CodeSniffer that warnings aren't failures. 😄 |
Signed-off-by: Maximilian Bösing <2189546+boesing@users.noreply.github.com>
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## 4.x #491 +/- ##
=========================================
Coverage 95.57% 95.57%
Complexity 584 584
=========================================
Files 70 70
Lines 1561 1561
=========================================
Hits 1492 1492
Misses 69 69 |
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.
Description
Even tho, the
Stringableinterface is implicit on all objects containing the method__toString, it is recommended by PHP to explicitly setting that interface.From php.net documentation:
Motivation and context
I've used
Stringablenotation recently in an upstream project and then realized that theUuidInterfacedoes not explicitly implements the interface. Due to the magic PHP provides starting with PHP 8.0, it still implementsStringableand thus I was able to use it but to avoid future issues with i.e. PHP 9 where this behavior might change, I wanted to add this here.How has this been tested?
I've added 2 new checks to the existing tests.
Please note that these tests won't fail even if we remove the interface again due to the fact that PHP adds it implicitly whenever a
__toStringmethod is available.Types of changes
PR checklist