Documentation

Output
in package
implements OutputInterface

AbstractYes

Base class for output classes.

There are five levels of verbosity:

  • normal: no option passed (normal output)
  • verbose: -v (more output)
  • very verbose: -vv (highly extended output)
  • debug: -vvv (all debug output)
  • quiet: -q (no output)
Tags
author

Fabien Potencier fabien@symfony.com

Table of Contents

Interfaces

OutputInterface
OutputInterface is the interface implemented by all Output classes.

Properties

$formatter  : OutputFormatterInterface
$verbosity  : int

Methods

__construct()  : mixed
getFormatter()  : OutputFormatterInterface
Returns current output formatter instance.
getVerbosity()  : self::VERBOSITY_*
Gets the current verbosity of the output.
isDebug()  : bool
Returns whether verbosity is debug (-vvv).
isDecorated()  : bool
Gets the decorated flag.
isQuiet()  : bool
Returns whether verbosity is quiet (-q).
isVerbose()  : bool
Returns whether verbosity is verbose (-v).
isVeryVerbose()  : bool
Returns whether verbosity is very verbose (-vv).
setDecorated()  : void
Sets the decorated flag.
setFormatter()  : void
setVerbosity()  : void
Sets the verbosity of the output.
write()  : void
Writes a message to the output.
writeln()  : void
Writes a message to the output and adds a newline at the end.
doWrite()  : void
Writes a message to the output.

Properties

$verbosity

private int $verbosity

Methods

__construct()

public __construct([int|null $verbosity = self::VERBOSITY_NORMAL ][, bool $decorated = false ][, OutputFormatterInterface|null $formatter = null ]) : mixed
Parameters
$verbosity : int|null = self::VERBOSITY_NORMAL

The verbosity level (one of the VERBOSITY constants in OutputInterface)

$decorated : bool = false

Whether to decorate messages

$formatter : OutputFormatterInterface|null = null

Output formatter instance (null to use default OutputFormatter)

getVerbosity()

Gets the current verbosity of the output.

public getVerbosity() : self::VERBOSITY_*
Return values
self::VERBOSITY_*

isDebug()

Returns whether verbosity is debug (-vvv).

public isDebug() : bool
Return values
bool

isDecorated()

Gets the decorated flag.

public isDecorated() : bool
Return values
bool

isQuiet()

Returns whether verbosity is quiet (-q).

public isQuiet() : bool
Return values
bool

isVerbose()

Returns whether verbosity is verbose (-v).

public isVerbose() : bool
Return values
bool

isVeryVerbose()

Returns whether verbosity is very verbose (-vv).

public isVeryVerbose() : bool
Return values
bool

setDecorated()

Sets the decorated flag.

public setDecorated(bool $decorated) : void
Parameters
$decorated : bool

setVerbosity()

Sets the verbosity of the output.

public setVerbosity(int $level) : void
Parameters
$level : int

write()

Writes a message to the output.

public write(string|iterable<string|int, mixed> $messages[, bool $newline = false ][, int $options = self::OUTPUT_NORMAL ]) : void
Parameters
$messages : string|iterable<string|int, mixed>
$newline : bool = false

Whether to add a newline

$options : int = self::OUTPUT_NORMAL

A bitmask of options (one of the OUTPUT or VERBOSITY constants), 0 is considered the same as self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL

writeln()

Writes a message to the output and adds a newline at the end.

public writeln(string|iterable<string|int, mixed> $messages[, int $options = self::OUTPUT_NORMAL ]) : void
Parameters
$messages : string|iterable<string|int, mixed>
$options : int = self::OUTPUT_NORMAL

A bitmask of options (one of the OUTPUT or VERBOSITY constants), 0 is considered the same as self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL

doWrite()

Writes a message to the output.

protected abstract doWrite(string $message, bool $newline) : void
Parameters
$message : string
$newline : bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results