[Console] Don't pass null to preg_replace() #42381
Merged
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
Signed-off-by: Alexander M. Turek <me@derrabus.de>
|
NullOutputFormatter has a void return type. Seems wrong to me. Shouldn't this be null? |
I believe so: #42382 |
kaznovac
reviewed
Aug 5, 2021
| @@ -170,7 +170,7 @@ public static function removeDecoration(OutputFormatterInterface $formatter, ?st | |||
| // remove <...> formatting | |||
| $string = $formatter->format($string ?? ''); | |||
| // remove already formatted characters | |||
| $string = preg_replace("/\033\[[^m]*m/", '', $string); | |||
| $string = preg_replace("/\033\[[^m]*m/", '', $string ?? ''); | |||
There was a problem hiding this comment.
why call preg_replace on an empty string?
Suggested change
| $string = preg_replace("/\033\[[^m]*m/", '', $string ?? ''); | |
| $string = $string ? preg_replace("/\033\[[^m]*m/", '', $string) : ''; |
There was a problem hiding this comment.
Right, we can save the call here.
fabpot
added a commit
that referenced
this pull request
Aug 6, 2021
…mat() (derrabus) This PR was merged into the 5.4 branch. Discussion ---------- [Console] Add return type to OutputFormatterInterface::format() | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | N/A | License | MIT | Doc PR | N/A Spotted while working on #42381. If we look at how `OutputFormatterInterface::format()` is used in the codebase, we can see that an implementation of that method is supposed to return something. Yet the interface does not declare a return value and the `NullOutputFormatter` implementation even has a `void` return type which does not make sense at all, imho. This PR attempts to fix that. Commits ------- d75f5e6 Add return type to OutputFormatterInterface::format()
fabpot
approved these changes
Aug 6, 2021
|
Thank you @derrabus. |
Merged
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.
An output formatter might return
null(seeNullOutputFormatter). In this case, we would passnulltopreg_replace()which would trigger a deprecation warning in PHP 8.1. Let's not do that.