api/symfony/Component/Console/Output/OutputInterface.yaml
2024-09-26 02:03:21 -07:00

93 lines
2.8 KiB
YAML

name: OutputInterface
class_comment: null
dependencies:
- name: OutputFormatterInterface
type: class
source: Symfony\Component\Console\Formatter\OutputFormatterInterface
properties: []
methods:
- name: write
visibility: public
parameters:
- name: messages
- name: newline
default: 'false'
- name: options
default: '0'
comment: "# * OutputInterface is the interface implemented by all Output classes.\n\
# *\n# * @author Fabien Potencier <fabien@symfony.com>\n# */\n# interface OutputInterface\n\
# {\n# public const VERBOSITY_QUIET = 16;\n# public const VERBOSITY_NORMAL = 32;\n\
# public const VERBOSITY_VERBOSE = 64;\n# public const VERBOSITY_VERY_VERBOSE\
\ = 128;\n# public const VERBOSITY_DEBUG = 256;\n# \n# public const OUTPUT_NORMAL\
\ = 1;\n# public const OUTPUT_RAW = 2;\n# public const OUTPUT_PLAIN = 4;\n# \n\
# /**\n# * Writes a message to the output.\n# *\n# * @param bool $newline Whether\
\ to add a newline\n# * @param int $options A bitmask of options (one of the\
\ OUTPUT or VERBOSITY constants),\n# * 0 is considered the\
\ same as self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL"
- name: writeln
visibility: public
parameters:
- name: messages
- name: options
default: '0'
comment: '# * Writes a message to the output and adds a newline at the end.
# *
# * @param int $options A bitmask of options (one of the OUTPUT or VERBOSITY constants),
# * 0 is considered the same as self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL'
- name: setVerbosity
visibility: public
parameters:
- name: level
comment: '# * Sets the verbosity of the output.
# *
# * @param self::VERBOSITY_* $level'
- name: getVerbosity
visibility: public
parameters: []
comment: '# * Gets the current verbosity of the output.
# *
# * @return self::VERBOSITY_*'
- name: isQuiet
visibility: public
parameters: []
comment: '# * Returns whether verbosity is quiet (-q).'
- name: isVerbose
visibility: public
parameters: []
comment: '# * Returns whether verbosity is verbose (-v).'
- name: isVeryVerbose
visibility: public
parameters: []
comment: '# * Returns whether verbosity is very verbose (-vv).'
- name: isDebug
visibility: public
parameters: []
comment: '# * Returns whether verbosity is debug (-vvv).'
- name: setDecorated
visibility: public
parameters:
- name: decorated
comment: '# * Sets the decorated flag.'
- name: isDecorated
visibility: public
parameters: []
comment: '# * Gets the decorated flag.'
- name: setFormatter
visibility: public
parameters:
- name: formatter
comment: null
- name: getFormatter
visibility: public
parameters: []
comment: '# * Returns current output formatter instance.'
traits:
- Symfony\Component\Console\Formatter\OutputFormatterInterface
interfaces: []