PHP Class Laravel\Envoy\Console\RunCommand

Inheritance: extends Symfony\Component\Console\Command\Command, use trait Command
Show file Open project: laravel/envoy

Protected Properties

Property Type Description
$ignoreOptions array Command line options that should not be gathered dynamically.

Protected Methods

Method Description
configure ( ) : void Configure the command options.
displayOutput ( integer $type, string $host, string $line ) : void Display the given output line.
fire ( ) : integer Execute the command.
getOptions ( ) : array Gather the dynamic options for the command.
getRemoteProcessor ( Task $task ) : Laravel\Envoy\RemoteProcessor Get the SSH processor for the task.
getTasks ( TaskContainer $container ) : void Get the tasks from the container based on user input.
loadTaskContainer ( ) : TaskContainer Load the task container instance with the Envoy file.
passToRemoteProcessor ( Task $task ) : integer Run the given task and return the exit code.
pretending ( ) : boolean Determine if the SSH command should be dumped.
runTask ( TaskContainer $container, string $task ) : null | integer | void Run the given task out of the container.
runTaskOverSSH ( Task $task ) : integer Run the given task and return the exit code.

Method Details

configure() protected method

Configure the command options.
protected configure ( ) : void
return void

displayOutput() protected method

Display the given output line.
protected displayOutput ( integer $type, string $host, string $line ) : void
$type integer
$host string
$line string
return void

fire() protected method

Execute the command.
protected fire ( ) : integer
return integer

getOptions() protected method

Gather the dynamic options for the command.
protected getOptions ( ) : array
return array

getRemoteProcessor() protected method

Get the SSH processor for the task.
protected getRemoteProcessor ( Task $task ) : Laravel\Envoy\RemoteProcessor
$task Laravel\Envoy\Task
return Laravel\Envoy\RemoteProcessor

getTasks() protected method

Get the tasks from the container based on user input.
protected getTasks ( TaskContainer $container ) : void
$container Laravel\Envoy\TaskContainer
return void

loadTaskContainer() protected method

Load the task container instance with the Envoy file.
protected loadTaskContainer ( ) : TaskContainer
return Laravel\Envoy\TaskContainer

passToRemoteProcessor() protected method

Run the given task and return the exit code.
protected passToRemoteProcessor ( Task $task ) : integer
$task Laravel\Envoy\Task
return integer

pretending() protected method

Determine if the SSH command should be dumped.
protected pretending ( ) : boolean
return boolean

runTask() protected method

Run the given task out of the container.
protected runTask ( TaskContainer $container, string $task ) : null | integer | void
$container Laravel\Envoy\TaskContainer
$task string
return null | integer | void

runTaskOverSSH() protected method

Run the given task and return the exit code.
protected runTaskOverSSH ( Task $task ) : integer
$task Laravel\Envoy\Task
return integer

Property Details

$ignoreOptions protected property

Command line options that should not be gathered dynamically.
protected array $ignoreOptions
return array