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

60 lines
1.6 KiB
YAML

name: DebugFormatterHelper
class_comment: '# * Helps outputting debug information when running an external program
from a command.
# *
# * An external program can be a Process, an HTTP request, or anything else.
# *
# * @author Fabien Potencier <fabien@symfony.com>'
dependencies: []
properties: []
methods:
- name: start
visibility: public
parameters:
- name: id
- name: message
- name: prefix
default: '''RUN'''
comment: "# * Helps outputting debug information when running an external program\
\ from a command.\n# *\n# * An external program can be a Process, an HTTP request,\
\ or anything else.\n# *\n# * @author Fabien Potencier <fabien@symfony.com>\n\
# */\n# class DebugFormatterHelper extends Helper\n# {\n# private const COLORS\
\ = ['black', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'white', 'default'];\n\
# private array $started = [];\n# private int $count = -1;\n# \n# /**\n# * Starts\
\ a debug formatting session."
- name: progress
visibility: public
parameters:
- name: id
- name: buffer
- name: error
default: 'false'
- name: prefix
default: '''OUT'''
- name: errorPrefix
default: '''ERR'''
comment: '# * Adds progress to a formatting session.'
- name: stop
visibility: public
parameters:
- name: id
- name: message
- name: successful
- name: prefix
default: '''RES'''
comment: '# * Stops a formatting session.'
- name: getBorder
visibility: private
parameters:
- name: id
comment: null
- name: getName
visibility: public
parameters: []
comment: null
traits: []
interfaces: []