api/laravel/Process/ProcessResult.yaml
2024-09-26 02:03:21 -07:00

140 lines
2.9 KiB
YAML

name: ProcessResult
class_comment: null
dependencies:
- name: ProcessResultContract
type: class
source: Illuminate\Contracts\Process\ProcessResult
- name: ProcessFailedException
type: class
source: Illuminate\Process\Exceptions\ProcessFailedException
- name: Process
type: class
source: Symfony\Component\Process\Process
properties:
- name: process
visibility: protected
comment: '# * The underlying process instance.
# *
# * @var \Symfony\Component\Process\Process'
methods:
- name: __construct
visibility: public
parameters:
- name: process
comment: "# * The underlying process instance.\n# *\n# * @var \\Symfony\\Component\\\
Process\\Process\n# */\n# protected $process;\n# \n# /**\n# * Create a new process\
\ result instance.\n# *\n# * @param \\Symfony\\Component\\Process\\Process $process\n\
# * @return void"
- name: command
visibility: public
parameters: []
comment: '# * Get the original command executed by the process.
# *
# * @return string'
- name: successful
visibility: public
parameters: []
comment: '# * Determine if the process was successful.
# *
# * @return bool'
- name: failed
visibility: public
parameters: []
comment: '# * Determine if the process failed.
# *
# * @return bool'
- name: exitCode
visibility: public
parameters: []
comment: '# * Get the exit code of the process.
# *
# * @return int|null'
- name: output
visibility: public
parameters: []
comment: '# * Get the standard output of the process.
# *
# * @return string'
- name: seeInOutput
visibility: public
parameters:
- name: output
comment: '# * Determine if the output contains the given string.
# *
# * @param string $output
# * @return bool'
- name: errorOutput
visibility: public
parameters: []
comment: '# * Get the error output of the process.
# *
# * @return string'
- name: seeInErrorOutput
visibility: public
parameters:
- name: output
comment: '# * Determine if the error output contains the given string.
# *
# * @param string $output
# * @return bool'
- name: throw
visibility: public
parameters:
- name: callback
default: 'null'
comment: '# * Throw an exception if the process failed.
# *
# * @param callable|null $callback
# * @return $this
# *
# * @throws \Illuminate\Process\Exceptions\ProcessFailedException'
- name: throwIf
visibility: public
parameters:
- name: condition
- name: callback
default: 'null'
comment: '# * Throw an exception if the process failed and the given condition is
true.
# *
# * @param bool $condition
# * @param callable|null $callback
# * @return $this
# *
# * @throws \Throwable'
traits:
- Illuminate\Process\Exceptions\ProcessFailedException
- Symfony\Component\Process\Process
interfaces:
- ProcessResultContract