• Home
• Clinner
• Command
• Command

PHP Class Clinner\Command\Command

Command abstraction class that allows running any command with a given set of arguments. Usage examples: Run ls -l -a in the current directory $command = new \Clinner\Command\Command( 'ls', array('-l', '-a') ); $command->run(); echo $command->getExitCode(); echo $command->getOutput(); This example is equivalent to the one above $command = \Clinner\Command\Command::create( 'ls', array('-l', '-a') ) ->run(); echo $command->getExitCode(); echo $command->getOutput(); You can also pipe commands, just like in a command-line interface: use \Clinner\Command\Command; $grepCommand = Command::create( 'grep', array('-v' => '^#'), array('delimiter' => ' ') ); $cutCommand = Command::create( 'cut', array('-d' => ':', '-f' => 1), array('delimiter' => '') ); $systemUsers = Command::create( 'cat', array('/etc/passwd') ) ->pipe( $grepCommand->pipe( $cutCommand ) ) ->run() ->getOutputAsArray("\n"); This class may take the following options: * delimiter (string): A string that will be put in key-value pairs of arguments to separate the key from its value. Defaults to '='. Show file Open project: ncuesta/clinner Class Usage Examples

Public Methods

Method	Description
__construct ( string $name, array | ValueHolder $arguments = [], array | ValueHolder $options = [] )	Constructor.
__toString ( ) : string	Get the string representation of this command.
create ( string $name, array | ValueHolder $arguments = [], array | ValueHolder $options = [] ) : Command	Factory method for creating new Commands and allowing to take advantage of the fluent API provided by this class.
fromString ( string $commandString ) : Clinner\Command\CommandInterface	Factory method for creating new Commands from their string representation, as if they were being run from the command line. If no valid commands are found, a NullCommand will be returned.
getArguments ( ) : ValueHolder	Get the arguments for this command as a ValueHolder.
getErrorOutput ( ) : string	Get the error output for this command.
getExitCode ( ) : integer	Get the exit code for this command.
getName ( ) : string	Get the name of this command.
getOption ( string $name, mixed $default = null ) : mixed	Get a single option value for this command, optionally providing a default value for it.
getOptions ( ) : ValueHolder	Get the options for this command as a ValueHolder.
getOutput ( ) : string	Get this command's output.
getOutputAsArray ( string $delimiter = ' ' ) : array	Get the output of this command as an array, splitting it with a given $delimiter.
getPipedCommand ( ) : Clinner\Command\PipeableCommandInterface	Get the command piped to this one, if any.
hasPipedCommand ( ) : boolean	Answer whether this command has a command piped to it.
pipe ( PipeableCommandInterface $anotherCommand, boolean $appendToPipe = true ) : Clinner\Command\PipingCommandInterface	Pipe $anotherCommand to this one, so that this command's output is directly sent to $anotherCommand's standard input.
run ( string $input = null ) : Command	Run this command with the given $input.
setArguments ( ValueHolder | array $arguments ) : Command	Set this command's arguments as a whole.
setName ( string $name ) : Command	Set the name of this command to $name.
setOption ( string $name, mixed $value ) : Command	Set a single option for this command.
setOptions ( ValueHolder | array $options ) : Command	Set this command's options as a whole.
toCommandString ( boolean $includePiped = false ) : string	Get a string representation of this command with its arguments, as if it would be written in a command-line interface when run.

Protected Methods

Method	Description
_run ( string $input ) : integer	Actually run this command and its piped commands chain, if applicable.
parse ( string $commandString, array $options = [] ) : Clinner\Command\CommandInterface	Parse a command from a string representation and return the resulting object.

Method Details