minor #22342 [Console] Inherit phpdoc from OutputFormatterInterface (ro0NL)
This PR was merged into the 2.7 branch.
Discussion
----------
[Console] Inherit phpdoc from OutputFormatterInterface
| Q | A
| ------------- | ---
| Branch? | 2.7
| Bug fix? | yes
| New feature? | no
| BC breaks? | no
| Deprecations? | no
| Tests pass? | yes
| Fixed tickets | https://github.com/symfony/symfony/pull/22225#discussion_r109361374
| License | MIT
| Doc PR | symfony/symfony-docs#... <!--highly recommended for new features-->
Commits
-------
ff3cb9cb27
[Console] Inherit phpdoc from OutputFormatterInterface
This commit is contained in:
commit
f8e1098712
@ -79,9 +79,7 @@ class OutputFormatter implements OutputFormatterInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sets the decorated flag.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @param bool $decorated Whether to decorate the messages or not
|
|
||||||
*/
|
*/
|
||||||
public function setDecorated($decorated)
|
public function setDecorated($decorated)
|
||||||
{
|
{
|
||||||
@ -89,9 +87,7 @@ class OutputFormatter implements OutputFormatterInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets the decorated flag.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @return bool true if the output will decorate messages, false otherwise
|
|
||||||
*/
|
*/
|
||||||
public function isDecorated()
|
public function isDecorated()
|
||||||
{
|
{
|
||||||
@ -99,10 +95,7 @@ class OutputFormatter implements OutputFormatterInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sets a new style.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @param string $name The style name
|
|
||||||
* @param OutputFormatterStyleInterface $style The style instance
|
|
||||||
*/
|
*/
|
||||||
public function setStyle($name, OutputFormatterStyleInterface $style)
|
public function setStyle($name, OutputFormatterStyleInterface $style)
|
||||||
{
|
{
|
||||||
@ -110,11 +103,7 @@ class OutputFormatter implements OutputFormatterInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Checks if output formatter has style with specified name.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @param string $name
|
|
||||||
*
|
|
||||||
* @return bool
|
|
||||||
*/
|
*/
|
||||||
public function hasStyle($name)
|
public function hasStyle($name)
|
||||||
{
|
{
|
||||||
@ -122,13 +111,7 @@ class OutputFormatter implements OutputFormatterInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets style options from style with specified name.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @param string $name
|
|
||||||
*
|
|
||||||
* @return OutputFormatterStyleInterface
|
|
||||||
*
|
|
||||||
* @throws \InvalidArgumentException When style isn't defined
|
|
||||||
*/
|
*/
|
||||||
public function getStyle($name)
|
public function getStyle($name)
|
||||||
{
|
{
|
||||||
@ -140,11 +123,7 @@ class OutputFormatter implements OutputFormatterInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Formats a message according to the given styles.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @param string $message The message to style
|
|
||||||
*
|
|
||||||
* @return string The styled message
|
|
||||||
*/
|
*/
|
||||||
public function format($message)
|
public function format($message)
|
||||||
{
|
{
|
||||||
|
@ -55,6 +55,8 @@ interface OutputFormatterInterface
|
|||||||
* @param string $name
|
* @param string $name
|
||||||
*
|
*
|
||||||
* @return OutputFormatterStyleInterface
|
* @return OutputFormatterStyleInterface
|
||||||
|
*
|
||||||
|
* @throws \InvalidArgumentException When style isn't defined
|
||||||
*/
|
*/
|
||||||
public function getStyle($name);
|
public function getStyle($name);
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user