DebugFormatterHelper
class DebugFormatterHelper extends Helper
Helps outputting debug information when running an external program from a command.
An external program can be a Process, an HTTP request, or anything else.
Methods
setHelperSet(HelperSet $helperSet = null) Sets the helper set associated with this helper. | from Helper | |
HelperSet | getHelperSet() Gets the helper set associated with this helper. | from Helper |
static int | strlen(string $string) Returns the length of a string, using mb_strwidth if it is available. | from Helper |
static | formatTime($secs) | from Helper |
static | formatMemory($memory) | from Helper |
static | strlenWithoutDecoration(OutputFormatterInterface $formatter, $string) | from Helper |
string | start(string $id, string $message, string $prefix = 'RUN') Starts a debug formatting session. | |
string | progress(string $id, string $buffer, bool $error = false, string $prefix = 'OUT', string $errorPrefix = 'ERR') Adds progress to a formatting session. | |
string | stop(string $id, string $message, bool $successful, string $prefix = 'RES') Stops a formatting session. | |
string | getName() Returns the canonical name of this helper. |
Details
setHelperSet(HelperSet $helperSet = null)
Sets the helper set associated with this helper.
Parameters
HelperSet | $helperSet | A HelperSet instance |
HelperSet getHelperSet()
Gets the helper set associated with this helper.
Return Value
HelperSet | A HelperSet instance |
static int strlen(string $string)
Returns the length of a string, using mb_strwidth if it is available.
Parameters
string | $string | The string to check its length |
Return Value
int | The length of the string |
static formatTime($secs)
Parameters
$secs |
static formatMemory($memory)
Parameters
$memory |
static strlenWithoutDecoration(OutputFormatterInterface $formatter, $string)
Parameters
OutputFormatterInterface | $formatter | |
$string |
string start(string $id, string $message, string $prefix = 'RUN')
Starts a debug formatting session.
Parameters
string | $id | The id of the formatting session |
string | $message | The message to display |
string | $prefix | The prefix to use |
Return Value
string |
string progress(string $id, string $buffer, bool $error = false, string $prefix = 'OUT', string $errorPrefix = 'ERR')
Adds progress to a formatting session.
Parameters
string | $id | The id of the formatting session |
string | $buffer | The message to display |
bool | $error | Whether to consider the buffer as error |
string | $prefix | The prefix for output |
string | $errorPrefix | The prefix for error output |
Return Value
string |
string stop(string $id, string $message, bool $successful, string $prefix = 'RES')
Stops a formatting session.
Parameters
string | $id | The id of the formatting session |
string | $message | The message to display |
bool | $successful | Whether to consider the result as success |
string | $prefix | The prefix for the end output |
Return Value
string |
string getName()
Returns the canonical name of this helper.
Return Value
string | The canonical name |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Console/Helper/DebugFormatterHelper.html