Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

[Console] Add return type to OutputFormatterInterface::format() #42382

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 6, 2021
Merged

[Console] Add return type to OutputFormatterInterface::format() #42382

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Add return type to OutputFormatterInterface::format() 
Signed-off-by: Alexander M. Turek <me@derrabus.de>
  • Loading branch information
@derrabus
derrabus committed Aug 5, 2021
commit d75f5e62df880b7f0b68e0b27f7f9de76a0a3dbe
4 changes: 2 additions & 2 deletions 4 src/Symfony/Component/Console/Formatter/NullOutputFormatter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ final class NullOutputFormatter implements OutputFormatterInterface
/**
* {@inheritdoc}
*/
public function format(?string $message): void
public function format(?string $message): ?string
{
// do nothing
return null;
}

/**
Expand Down
2 changes: 2 additions & 0 deletions 2 src/Symfony/Component/Console/Formatter/OutputFormatterInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ public function getStyle(string $name);

/**
* Formats a message according to the given styles.
*
* @return string|null
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this must be @return string and the null formatter should be return $message; instead.

symfony/src/Symfony/Component/Console/Output/Output.php

Line 157 in 49a076a

$message = $this->formatter->format($message);

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keep in mind that this is not an internal class. You are suggesting to significantly change its behavior here while I'm merely documenting the status quo.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, indeed. I'm not sure what is the best way forward.

If we officially document this contract as returning string|null, we have to update all code using this function to take care of the null return. Honestly, returning null (void actually) in NullOutputFormatter seems like a mistake and bug to me.

In fact, if code is build to use the normal OutputFormatter, it would be broken if NullOutputFormatter is used in the test. I can't think of any reasonable approach to build code to only work with NullOutputFormatter.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand. But string|null is what currently is returned from the implementations. Once this PR is merged, we can think about how we could narrow it down to just string in 6.0. By the way, I'd also like to do this for the $message parameter.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we depreciate null in 5.4 then? Then we can keep the implied contract, which is string IMHO

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that the real issue is the implementation of NullOutputFormatter which was written before void was introduced. Conceptually, doing nothing was the same as returning null back then. Let's merge this one as is and see if we can deprecate null in a followup PR (same for *message).

*/
public function format(?string $message);
}
5 changes: 1 addition & 4 deletions 5 src/Symfony/Component/Console/Tests/Formatter/NullOutputFormatterTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,7 @@ public function testFormat()
{
$formatter = new NullOutputFormatter();

$message = 'this message will not be changed';
$formatter->format($message);

$this->assertSame('this message will not be changed', $message);
$this->assertNull($formatter->format('this message will be destroyed'));
}

public function testGetStyle()
Expand Down
Morty Proxy This is a proxified and sanitized view of the page, visit original site.