Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe StreamOutput
+ Graphe d'héritage de StreamOutput:

Fonctions membres publiques

 __construct ($stream, int $verbosity=self::VERBOSITY_NORMAL, bool $decorated=null, OutputFormatterInterface $formatter=null)
 
 getStream ()
 
- Fonctions membres publiques hérités de Output
 __construct (?int $verbosity=self::VERBOSITY_NORMAL, bool $decorated=false, OutputFormatterInterface $formatter=null)
 
 setFormatter (OutputFormatterInterface $formatter)
 
 getFormatter ()
 
 setDecorated (bool $decorated)
 
 isDecorated ()
 
 setVerbosity (int $level)
 
 getVerbosity ()
 
 isQuiet ()
 
 isVerbose ()
 
 isVeryVerbose ()
 
 isDebug ()
 
 writeln ($messages, int $options=self::OUTPUT_NORMAL)
 
 write ($messages, bool $newline=false, int $options=self::OUTPUT_NORMAL)
 

Fonctions membres protégées

 doWrite (string $message, bool $newline)
 
 hasColorSupport ()
 
- Fonctions membres protégées hérités de Output
 doWrite (string $message, bool $newline)
 

Attributs privés

 $stream
 

Membres hérités additionnels

- Champs de données hérités de OutputInterface
const VERBOSITY_QUIET = 16
 
const VERBOSITY_NORMAL = 32
 
const VERBOSITY_VERBOSE = 64
 
const VERBOSITY_VERY_VERBOSE = 128
 
const VERBOSITY_DEBUG = 256
 
const OUTPUT_NORMAL = 1
 
const OUTPUT_RAW = 2
 
const OUTPUT_PLAIN = 4
 

Description détaillée

StreamOutput writes the output to a given stream.

Usage:

$output = new StreamOutput(fopen('php://stdout', 'w'));

As StreamOutput can use any stream, you can also use a file:

$output = new StreamOutput(fopen('/path/to/output.log', 'a', false));
Auteur
Fabien Potencier fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $stream,
int  $verbosity = self::VERBOSITY_NORMAL,
bool  $decorated = null,
OutputFormatterInterface  $formatter = null 
)
Paramètres
resource$streamA stream resource
int$verbosityThe verbosity level (one of the VERBOSITY constants in OutputInterface)
bool | null$decoratedWhether to decorate messages (null for auto-guessing)
OutputFormatterInterface | null$formatterOutput formatter instance (null to use default OutputFormatter)
Exceptions
InvalidArgumentExceptionWhen first argument is not a real stream

Références Output\$formatter, StreamOutput\$stream, Output\$verbosity, Symfony\Contracts\Service\__construct(), StreamOutput\hasColorSupport(), et null.

Documentation des fonctions membres

◆ doWrite()

doWrite ( string  $message,
bool  $newline 
)
protected

{}

Références $message.

◆ getStream()

getStream ( )

Gets the stream attached to this StreamOutput instance.

Renvoie
resource

Références StreamOutput\$stream.

Référencé par ConsoleOutput\section().

◆ hasColorSupport()

hasColorSupport ( )
protected

Returns true if the stream supports colorization.

Colorization is disabled if not supported by the stream:

This is tricky on Windows, because Cygwin, Msys2 etc emulate pseudo terminals via named pipes, so we can only check the environment.

Reference: Composer::supportsColor https://github.com/composer/xdebug-handler

Renvoie
bool true if the stream supports colorization, false otherwise

Référencé par StreamOutput\__construct().

Documentation des champs

◆ $stream


La documentation de cette classe a été générée à partir du fichier suivant :