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

Fonctions membres publiques

 __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)
 

Attributs privés

 $verbosity
 
 $formatter
 

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

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)
Auteur
Fabien Potencier fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( ?int  $verbosity = self::VERBOSITY_NORMAL,
bool  $decorated = false,
OutputFormatterInterface  $formatter = null 
)
Paramètres
int | null$verbosityThe verbosity level (one of the VERBOSITY constants in OutputInterface)
bool$decoratedWhether to decorate messages
OutputFormatterInterface | null$formatterOutput formatter instance (null to use default OutputFormatter)

Références Output\$formatter, et Output\$verbosity.

Documentation des fonctions membres

◆ doWrite()

doWrite ( string  $message,
bool  $newline 
)
abstractprotected

Writes a message to the output.

Référencé par Output\write().

◆ getFormatter()

getFormatter ( )

{Returns current output formatter instance.

Renvoie
OutputFormatterInterface
}

Implémente OutputInterface.

Références Output\$formatter.

Référencé par ConsoleOutput\__construct(), ConsoleSectionOutput\getDisplayLength(), et ConsoleOutput\section().

◆ getVerbosity()

getVerbosity ( )

{Gets the current verbosity of the output.

Renvoie
int
}

Implémente OutputInterface.

Références Output\$verbosity.

Référencé par ConsoleOutput\section(), et Output\write().

◆ isDebug()

isDebug ( )

{Returns whether verbosity is debug (-vvv).

Renvoie
bool
}

Implémente OutputInterface.

Références Output\$verbosity.

◆ isDecorated()

isDecorated ( )

{Gets the decorated flag.

Renvoie
bool
}

Implémente OutputInterface.

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

◆ isQuiet()

isQuiet ( )

{Returns whether verbosity is quiet (-q).

Renvoie
bool
}

Implémente OutputInterface.

Références Output\$verbosity.

◆ isVerbose()

isVerbose ( )

{Returns whether verbosity is verbose (-v).

Renvoie
bool
}

Implémente OutputInterface.

Références Output\$verbosity.

◆ isVeryVerbose()

isVeryVerbose ( )

{Returns whether verbosity is very verbose (-vv).

Renvoie
bool
}

Implémente OutputInterface.

Références Output\$verbosity.

◆ setDecorated()

setDecorated ( bool  $decorated)

{Sets the decorated flag.}

Implémente OutputInterface.

◆ setFormatter()

setFormatter ( OutputFormatterInterface  $formatter)

{}

Implémente OutputInterface.

Références Output\$formatter.

◆ setVerbosity()

setVerbosity ( int  $level)

{Sets the verbosity of the output.}

Implémente OutputInterface.

◆ write()

write (   $messages,
bool  $newline = false,
int  $options = self::OUTPUT_NORMAL 
)

{Writes a message to the output.

Paramètres
string | iterable$messagesThe message as an iterable of strings or a single string
bool$newlineWhether to add a newline
int$optionsA bitmask of options (one of the OUTPUT or VERBOSITY constants), 0 is considered the same as self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL
}

Implémente OutputInterface.

Références $message, $messages, $options, $type, Output\$verbosity, Output\doWrite(), Output\getVerbosity(), OutputInterface\OUTPUT_NORMAL, OutputInterface\OUTPUT_PLAIN, et OutputInterface\OUTPUT_RAW.

Référencé par Output\writeln().

◆ writeln()

writeln (   $messages,
int  $options = self::OUTPUT_NORMAL 
)

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

Paramètres
string | iterable$messagesThe message as an iterable of strings or a single string
int$optionsA bitmask of options (one of the OUTPUT or VERBOSITY constants), 0 is considered the same as self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL
}

Implémente OutputInterface.

Références $messages, $options, et Output\write().

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

Documentation des champs

◆ $formatter

◆ $verbosity


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