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

Fonctions membres publiques

 __construct ($stream, array &$sections, int $verbosity, bool $decorated, OutputFormatterInterface $formatter)
 
 clear (int $lines=null)
 
 overwrite ($message)
 
 getContent ()
 
 addContent (string $input)
 
- Fonctions membres publiques hérités de StreamOutput
 __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)
 
- Fonctions membres protégées hérités de StreamOutput
 doWrite (string $message, bool $newline)
 
 hasColorSupport ()
 
- Fonctions membres protégées hérités de Output
 doWrite (string $message, bool $newline)
 

Fonctions membres privées

 popStreamContentUntilCurrentSection (int $numberOfLinesToClearFromCurrentSection=0)
 
 getDisplayLength (string $text)
 

Attributs privés

 $content = []
 
 $lines = 0
 
 $sections
 
 $terminal
 

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

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $stream,
array &  $sections,
int  $verbosity,
bool  $decorated,
OutputFormatterInterface  $formatter 
)
Paramètres
resource$stream
ConsoleSectionOutput[]$sections

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

Documentation des fonctions membres

◆ addContent()

addContent ( string  $input)

◆ clear()

clear ( int  $lines = null)

Clears previous output for this section.

Paramètres
int$linesNumber of lines to clear. If null, then the entire output of this section is cleared

Références ConsoleSectionOutput\$lines, content, Output\isDecorated(), et ConsoleSectionOutput\popStreamContentUntilCurrentSection().

Référencé par ConsoleSectionOutput\overwrite().

◆ doWrite()

doWrite ( string  $message,
bool  $newline 
)
protected

◆ getContent()

getContent ( )

Références content.

◆ getDisplayLength()

getDisplayLength ( string  $text)
private

◆ overwrite()

overwrite (   $message)

Overwrites the previous output with a new message.

Paramètres
array | string$message

Références $message, ConsoleSectionOutput\clear(), et Output\writeln().

◆ popStreamContentUntilCurrentSection()

popStreamContentUntilCurrentSection ( int  $numberOfLinesToClearFromCurrentSection = 0)
private

At initial stage, cursor is at the end of stream output. This method makes cursor crawl upwards until it hits current section. Then it erases content it crawled through. Optionally, it erases part of current section too.

Références $section, et $this.

Référencé par ConsoleSectionOutput\clear(), et ConsoleSectionOutput\doWrite().

Documentation des champs

◆ $content

$content = []
private

◆ $lines

$lines = 0
private

Référencé par ConsoleSectionOutput\clear().

◆ $sections

$sections
private

◆ $terminal

$terminal
private

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