platform/api/symfony/Component/Console/Style/SymfonyStyle.yaml

name: SymfonyStyle
class_comment: '# * Output decorator helpers for the Symfony Style Guide.

  # *

  # * @author Kevin Bond <kevinbond@gmail.com>'
dependencies:
- name: InvalidArgumentException
  type: class
  source: Symfony\Component\Console\Exception\InvalidArgumentException
- name: RuntimeException
  type: class
  source: Symfony\Component\Console\Exception\RuntimeException
- name: OutputFormatter
  type: class
  source: Symfony\Component\Console\Formatter\OutputFormatter
- name: Helper
  type: class
  source: Symfony\Component\Console\Helper\Helper
- name: OutputWrapper
  type: class
  source: Symfony\Component\Console\Helper\OutputWrapper
- name: ProgressBar
  type: class
  source: Symfony\Component\Console\Helper\ProgressBar
- name: SymfonyQuestionHelper
  type: class
  source: Symfony\Component\Console\Helper\SymfonyQuestionHelper
- name: Table
  type: class
  source: Symfony\Component\Console\Helper\Table
- name: TableCell
  type: class
  source: Symfony\Component\Console\Helper\TableCell
- name: TableSeparator
  type: class
  source: Symfony\Component\Console\Helper\TableSeparator
- name: InputInterface
  type: class
  source: Symfony\Component\Console\Input\InputInterface
- name: ConsoleOutputInterface
  type: class
  source: Symfony\Component\Console\Output\ConsoleOutputInterface
- name: ConsoleSectionOutput
  type: class
  source: Symfony\Component\Console\Output\ConsoleSectionOutput
- name: OutputInterface
  type: class
  source: Symfony\Component\Console\Output\OutputInterface
- name: TrimmedBufferOutput
  type: class
  source: Symfony\Component\Console\Output\TrimmedBufferOutput
- name: ChoiceQuestion
  type: class
  source: Symfony\Component\Console\Question\ChoiceQuestion
- name: ConfirmationQuestion
  type: class
  source: Symfony\Component\Console\Question\ConfirmationQuestion
- name: Question
  type: class
  source: Symfony\Component\Console\Question\Question
- name: Terminal
  type: class
  source: Symfony\Component\Console\Terminal
properties: []
methods:
- name: block
  visibility: public
  parameters:
  - name: messages
  - name: type
    default: 'null'
  - name: style
    default: 'null'
  - name: prefix
    default: ''' '''
  - name: padding
    default: 'false'
  - name: escape
    default: 'true'
  comment: "# * Output decorator helpers for the Symfony Style Guide.\n# *\n# * @author\
    \ Kevin Bond <kevinbond@gmail.com>\n# */\n# class SymfonyStyle extends OutputStyle\n\
    # {\n# public const MAX_LINE_LENGTH = 120;\n# \n# private SymfonyQuestionHelper\
    \ $questionHelper;\n# private ProgressBar $progressBar;\n# private int $lineLength;\n\
    # private TrimmedBufferOutput $bufferedOutput;\n# \n# public function __construct(\n\
    # private InputInterface $input,\n# private OutputInterface $output,\n# ) {\n\
    # $this->bufferedOutput = new TrimmedBufferOutput(\\DIRECTORY_SEPARATOR === '\\\
    \\' ? 4 : 2, $output->getVerbosity(), false, clone $output->getFormatter());\n\
    # // Windows cmd wraps lines as soon as the terminal width is reached, whether\
    \ there are following chars or not.\n# $width = (new Terminal())->getWidth() ?:\
    \ self::MAX_LINE_LENGTH;\n# $this->lineLength = min($width - (int) (\\DIRECTORY_SEPARATOR\
    \ === '\\\\'), self::MAX_LINE_LENGTH);\n# \n# parent::__construct($output);\n\
    # }\n# \n# /**\n# * Formats a message as a block of text."
- name: title
  visibility: public
  parameters:
  - name: message
  comment: null
- name: section
  visibility: public
  parameters:
  - name: message
  comment: null
- name: listing
  visibility: public
  parameters:
  - name: elements
  comment: null
- name: text
  visibility: public
  parameters:
  - name: message
  comment: null
- name: comment
  visibility: public
  parameters:
  - name: message
  comment: '# * Formats a command comment.'
- name: success
  visibility: public
  parameters:
  - name: message
  comment: null
- name: error
  visibility: public
  parameters:
  - name: message
  comment: null
- name: warning
  visibility: public
  parameters:
  - name: message
  comment: null
- name: note
  visibility: public
  parameters:
  - name: message
  comment: null
- name: info
  visibility: public
  parameters:
  - name: message
  comment: '# * Formats an info message.'
- name: caution
  visibility: public
  parameters:
  - name: message
  comment: null
- name: table
  visibility: public
  parameters:
  - name: headers
  - name: rows
  comment: null
- name: horizontalTable
  visibility: public
  parameters:
  - name: headers
  - name: rows
  comment: '# * Formats a horizontal table.'
- name: definitionList
  visibility: public
  parameters:
  - name: '...$list'
  comment: '# * Formats a list of key/value horizontally.

    # *

    # * Each row can be one of:

    # * * ''A title''

    # * * [''key'' => ''value'']

    # * * new TableSeparator()'
- name: ask
  visibility: public
  parameters:
  - name: question
  - name: default
    default: 'null'
  - name: validator
    default: 'null'
  comment: null
- name: askHidden
  visibility: public
  parameters:
  - name: question
  - name: validator
    default: 'null'
  comment: null
- name: confirm
  visibility: public
  parameters:
  - name: question
  - name: default
    default: 'true'
  comment: null
- name: choice
  visibility: public
  parameters:
  - name: question
  - name: choices
  - name: default
    default: 'null'
  - name: multiSelect
    default: 'false'
  comment: null
- name: progressStart
  visibility: public
  parameters:
  - name: max
    default: '0'
  comment: null
- name: progressAdvance
  visibility: public
  parameters:
  - name: step
    default: '1'
  comment: null
- name: progressFinish
  visibility: public
  parameters: []
  comment: null
- name: createProgressBar
  visibility: public
  parameters:
  - name: max
    default: '0'
  comment: null
- name: progressIterate
  visibility: public
  parameters:
  - name: iterable
  - name: max
    default: 'null'
  comment: '# * @see ProgressBar::iterate()

    # *

    # * @template TKey

    # * @template TValue

    # *

    # * @param iterable<TKey, TValue> $iterable

    # * @param int|null               $max      Number of steps to complete the bar
    (0 if indeterminate), if null it will be inferred from $iterable

    # *

    # * @return iterable<TKey, TValue>'
- name: askQuestion
  visibility: public
  parameters:
  - name: question
  comment: null
- name: writeln
  visibility: public
  parameters:
  - name: messages
  - name: type
    default: self::OUTPUT_NORMAL
  comment: null
- name: write
  visibility: public
  parameters:
  - name: messages
  - name: newline
    default: 'false'
  - name: type
    default: self::OUTPUT_NORMAL
  comment: null
- name: newLine
  visibility: public
  parameters:
  - name: count
    default: '1'
  comment: null
- name: getErrorStyle
  visibility: public
  parameters: []
  comment: '# * Returns a new instance which makes use of stderr if available.'
- name: createTable
  visibility: public
  parameters: []
  comment: null
- name: getProgressBar
  visibility: private
  parameters: []
  comment: null
- name: autoPrependBlock
  visibility: private
  parameters: []
  comment: null
- name: autoPrependText
  visibility: private
  parameters: []
  comment: null
- name: writeBuffer
  visibility: private
  parameters:
  - name: message
  - name: newLine
  - name: type
  comment: null
- name: createBlock
  visibility: private
  parameters:
  - name: messages
  - name: type
    default: 'null'
  - name: style
    default: 'null'
  - name: prefix
    default: ''' '''
  - name: padding
    default: 'false'
  - name: escape
    default: 'false'
  comment: null
traits:
- Symfony\Component\Console\Exception\InvalidArgumentException
- Symfony\Component\Console\Exception\RuntimeException
- Symfony\Component\Console\Formatter\OutputFormatter
- Symfony\Component\Console\Helper\Helper
- Symfony\Component\Console\Helper\OutputWrapper
- Symfony\Component\Console\Helper\ProgressBar
- Symfony\Component\Console\Helper\SymfonyQuestionHelper
- Symfony\Component\Console\Helper\Table
- Symfony\Component\Console\Helper\TableCell
- Symfony\Component\Console\Helper\TableSeparator
- Symfony\Component\Console\Input\InputInterface
- Symfony\Component\Console\Output\ConsoleOutputInterface
- Symfony\Component\Console\Output\ConsoleSectionOutput
- Symfony\Component\Console\Output\OutputInterface
- Symfony\Component\Console\Output\TrimmedBufferOutput
- Symfony\Component\Console\Question\ChoiceQuestion
- Symfony\Component\Console\Question\ConfirmationQuestion
- Symfony\Component\Console\Question\Question
- Symfony\Component\Console\Terminal
interfaces: []