• Home
• Laravel
• Envoy
• TaskContainer

PHP Class Laravel\Envoy\TaskContainer

Show file Open project: laravel/envoy Class Usage Examples

Protected Properties

Property	Type	Description
$after	array	All of the "after" callbacks.
$error	array	All of the "error" callbacks.
$finished	array	All of the "finished" callbacks.
$macroOptions	array	All of the options for each macro.
$macroStack	array	The stack of macro being rendered.
$macros	array	All of the registered macros.
$servers	array	All of the registered servers.
$sharedData	array	All of the shared data.
$taskOptions	array	All of the options for each task.
$taskStack	array	The stack of tasks being rendered.
$tasks	array	All of the evaluated tasks.

Public Methods

Method	Description
after ( Closure $callback ) : void	Register an after-task callback.
endMacro ( ) : void	Stop defining a macro.
endTask ( ) : void	Stop defining a task.
error ( Closure $callback ) : void	Register an error-task callback.
finished ( Closure $callback ) : void	Register an finished-task callback.
getAfterCallbacks ( ) : array	Get all of the after-task callbacks.
getErrorCallbacks ( ) : array	Get all of the error-task callbacks.
getFinishedCallbacks ( ) : array	Get all of the finished-task callbacks.
getFirstServer ( ) : string	Get the first registered server IP address.
getMacro ( string $macro ) : array | null	Get the given macro from the container.
getMacroOptions ( string $macro ) : array	Get the macro options for the given macro.
getMacros ( ) : array	Getter for macros.
getServer ( string $server ) : string | null	Get the IP address for a server.
getTask ( string $task, array $macroOptions = [] ) : Task	Get a Task instance by the given name.
getTaskOptions ( string $task ) : array	Get the task options for the given task.
getTasks ( ) : array	Getter for tasks.
hasOneServer ( ) : boolean	Determine if the container only has one registered server.
import ( string $file, array $data = [] ) : void	Import the given file into the container.
load ( string $__path, Compiler $__compiler, array $__data = [], boolean $__serversOnly = false ) : void	Load the Envoy file into the container.
loadServers ( string $path, Compiler $compiler ) : void	Silently load the Envoy file into the container.
servers ( array $servers ) : void	Register the array of servers with the container.
share ( string $key, mixed $value ) : void	Share the given piece of data across all tasks.
startMacro ( string $macro, array $options = [] ) : void	Begin defining a macro.
startTask ( string $task, array $options = [] ) : void	Begin defining a task.

Protected Methods

Method	Description
getServers ( array $options ) : array	Get the IP addresses of the servers specified on the options.
mergeDefaultOptions ( array $options ) : array	Merge the option array over the default options.
replaceSubTasks ( ) : void	Replace all of the sub tasks and trim leading spaces.
resolveImportPath ( string $file ) : string | boolean	Resolve the import path for the given file.
trimSpaces ( string $value ) : string	Remove the leading space from the lines of a value.
writeCompiledEnvoyFile ( Compiler $compiler, string $path, boolean $serversOnly ) : string	Write the compiled Envoy file to disk.

Method Details

Property Details