platform/api/laravel/Contracts/Process/ProcessResult.yaml
2024-09-02 10:44:11 -07:00

105 lines
1.9 KiB
YAML

name: ProcessResult
class_comment: null
dependencies: []
properties: []
methods:
- 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'
- 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'
traits: []
interfaces: []