platform/api/laravel/Foundation/Testing/Concerns/InteractsWithConsole.yaml
2024-09-02 10:44:11 -07:00

112 lines
3.3 KiB
YAML

name: InteractsWithConsole
class_comment: null
dependencies:
- name: OutputStyle
type: class
source: Illuminate\Console\OutputStyle
- name: Kernel
type: class
source: Illuminate\Contracts\Console\Kernel
- name: PendingCommand
type: class
source: Illuminate\Testing\PendingCommand
properties:
- name: mockConsoleOutput
visibility: public
comment: '# * Indicates if the console output should be mocked.
# *
# * @var bool'
- name: expectsOutput
visibility: public
comment: '# * Indicates if the command is expected to output anything.
# *
# * @var bool|null'
- name: expectedOutput
visibility: public
comment: '# * All of the expected output lines.
# *
# * @var array'
- name: expectedOutputSubstrings
visibility: public
comment: '# * All of the expected text to be present in the output.
# *
# * @var array'
- name: unexpectedOutput
visibility: public
comment: '# * All of the output lines that aren''t expected to be displayed.
# *
# * @var array'
- name: unexpectedOutputSubstrings
visibility: public
comment: '# * All of the text that is not expected to be present in the output.
# *
# * @var array'
- name: expectedTables
visibility: public
comment: '# * All of the expected output tables.
# *
# * @var array'
- name: expectedQuestions
visibility: public
comment: '# * All of the expected questions.
# *
# * @var array'
- name: expectedChoices
visibility: public
comment: '# * All of the expected choice questions.
# *
# * @var array'
methods:
- name: artisan
visibility: public
parameters:
- name: command
- name: parameters
default: '[]'
comment: "# * Indicates if the console output should be mocked.\n# *\n# * @var bool\n\
# */\n# public $mockConsoleOutput = true;\n# \n# /**\n# * Indicates if the command\
\ is expected to output anything.\n# *\n# * @var bool|null\n# */\n# public $expectsOutput;\n\
# \n# /**\n# * All of the expected output lines.\n# *\n# * @var array\n# */\n\
# public $expectedOutput = [];\n# \n# /**\n# * All of the expected text to be\
\ present in the output.\n# *\n# * @var array\n# */\n# public $expectedOutputSubstrings\
\ = [];\n# \n# /**\n# * All of the output lines that aren't expected to be displayed.\n\
# *\n# * @var array\n# */\n# public $unexpectedOutput = [];\n# \n# /**\n# * All\
\ of the text that is not expected to be present in the output.\n# *\n# * @var\
\ array\n# */\n# public $unexpectedOutputSubstrings = [];\n# \n# /**\n# * All\
\ of the expected output tables.\n# *\n# * @var array\n# */\n# public $expectedTables\
\ = [];\n# \n# /**\n# * All of the expected questions.\n# *\n# * @var array\n\
# */\n# public $expectedQuestions = [];\n# \n# /**\n# * All of the expected choice\
\ questions.\n# *\n# * @var array\n# */\n# public $expectedChoices = [];\n# \n\
# /**\n# * Call artisan command and return code.\n# *\n# * @param string $command\n\
# * @param array $parameters\n# * @return \\Illuminate\\Testing\\PendingCommand|int"
- name: withoutMockingConsoleOutput
visibility: protected
parameters: []
comment: '# * Disable mocking the console output.
# *
# * @return $this'
traits:
- Illuminate\Console\OutputStyle
- Illuminate\Contracts\Console\Kernel
- Illuminate\Testing\PendingCommand
interfaces: []