Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

381 lines (348 sloc) 9.889 kb
<?php
/**
* Lithium: the most rad php framework
*
* @copyright Copyright 2011, Union of RAD (http://union-of-rad.org)
* @license http://opensource.org/licenses/bsd-license.php The BSD License
*/
namespace lithium\console;
use Exception;
use lithium\console\command\Help;
/**
* All Commands to be run from the Lithium console must extend this class.
* The `run` method is automatically called if it exists. Otherwise, if a method does not exist
* the `Help` command will be run.
*
* {{{
* $ li3 example
* $ li3 example --format=json
* }}}
*
*/
class Command extends \lithium\core\Object {
/**
* If -h or --help param exists a help screen will be returned.
* Similar to running `li3 help COMMAND`.
*
* @var boolean
*/
public $help = false;
/**
* A Request object.
*
* @see lithium\console\Request
* @var object
*/
public $request;
/**
* A Response object.
*
* @see lithium\console\Response
* @var object
*/
public $response;
/**
* Dynamic dependencies.
*
* @var array
*/
protected $_classes = array(
'response' => 'lithium\console\Response'
);
/**
* Auto configuration.
*
* @var array
*/
protected $_autoConfig = array('classes' => 'merge');
/**
* Constructor.
* @param array $config
*/
public function __construct(array $config = array()) {
$defaults = array('request' => null, 'response' => array(), 'classes' => $this->_classes);
parent::__construct($config + $defaults);
}
/**
* Initializer. Populates the `response` property with a new instance of the `Response`
* class passing it configuration and assigns the values from named parameters of the
* request (if applicable) to properties of the command.
*
* @return void
*/
protected function _init() {
parent::_init();
$this->request = $this->_config['request'];
$resp = $this->_config['response'];
$this->response = is_object($resp) ? $resp : $this->_instance('response', $resp);
if (!is_object($this->request) || !$this->request->params) {
return;
}
$default = array('command' => null, 'action' => null, 'args' => null);
$params = array_diff_key((array) $this->request->params, $default);
foreach ($params as $key => $param) {
$this->{$key} = $param;
}
}
/**
* Called by the `Dispatcher` class to invoke an action.
*
* @see lithium\console\Dispatcher
* @see lithium\console\Response
* @param string $action name of the method to run
* @param array $args the args from the request
* @param array $options
* @return object The response object associated with this command.
* @todo Implement filters.
*/
public function __invoke($action, $args = array(), $options = array()) {
try {
$this->response->status = 1;
$result = $this->invokeMethod($action, $args);
if (is_int($result)) {
$this->response->status = $result;
} elseif ($result || $result === null) {
$this->response->status = 0;
}
} catch (Exception $e) {
$this->error($e->getMessage());
}
return $this->response;
}
/**
*
* The invoked Help command will take over request and response objects of
* the originally invoked command. Thus the response of the Help command
* becomes the response of the original one.
*
* @return boolean
*/
protected function _help() {
$help = new Help(array(
'request' => $this->request,
'response' => $this->response,
'classes' => $this->_classes
));
return $help->run(get_class($this));
}
/**
* Writes string to output stream.
*
* @param string $output
* @param integer|string|array $options
* integer as the number of new lines.
* string as the style
* array as :
* - nl : number of new lines to add at the end
* - style : the style name to wrap around the
* @return integer
*/
public function out($output = null, $options = array('nl' => 1)) {
$options = is_int($options) ? array('nl' => $options) : $options;
return $this->_response('output', $output, $options);
}
/**
* Writes string to error stream.
*
* @param string $error
* @param integer|string|array $options
* integer as the number of new lines.
* string as the style
* array as :
* - nl : number of new lines to add at the end
* - style : the style name to wrap around the
* @return integer
*/
public function error($error = null, $options = array('nl' => 1)) {
return $this->_response('error', $error, $options);
}
/**
* Handles input. Will continue to loop until `$options['quit']` or
* result is part of `$options['choices']`.
*
* @param string $prompt
* @param array $options
* @return string Returns the result of the input data. If the input is equal to the `quit`
* option boolean `false` is returned
*/
public function in($prompt = null, array $options = array()) {
$defaults = array('choices' => null, 'default' => null, 'quit' => 'q');
$options += $defaults;
$choices = null;
if (is_array($options['choices'])) {
$choices = '(' . implode('/', $options['choices']) . ')';
}
$default = $options['default'] ? "[{$options['default']}] " : '';
do {
$this->out("{$prompt} {$choices} \n {$default}> ", false);
$result = trim($this->request->input());
} while (
!empty($options['choices']) && !in_array($result, $options['choices'], true)
&& (empty($options['quit']) || $result !== $options['quit'])
&& ($options['default'] == null || $result !== '')
);
if ($result == $options['quit']) {
return false;
}
if ($options['default'] !== null && $result == '') {
return $options['default'];
}
return $result;
}
/**
* Add text with horizontal line before and after stream.
*
* @param string $text
* @param integer $line
* @return void
*/
public function header($text, $line = 80) {
$this->hr($line);
$this->out($text, 1, 'heading');
$this->hr($line);
}
/**
* Writes rows of columns.
*
* This method expects asceding integer values as the keys, which map to the
* appropriate columns. Currently, there is no special "header" option, but you
* can define them for your own.
*
* Example Usage:
*
* {{{
* $output = array(
* array('Name', 'Age'),
* array('----', '---'),
* );
* foreach($users as $user) {
* $output[] = array($user->name, $user->age);
* }
* $this->columns($output);
* }}}
*
* Would render something similar to:
*
* {{{
* Name Age
* ---- ---
* Jane Doe 22
* Foo Bar 18
* }}}
*
* This method also calculates the needed space between the columns. All option
* params given also get passed down to the `out()` method, which allow custom
* formatting. Passing something like `$this->columns($output, array('style' => 'red)`
* would print the table in red.
*
* @see \lithium\console\Response::styles()
* @param array $rows The rows to print, with each column as an array element.
* @param array $options Optional params:
* - separator : Different column separator, defaults to `\t`
* - style : the style name to wrap around the columns output
* @return void
*/
public function columns($rows, $options = array()) {
$defaults = array('separator' => "\t");
$config = $options + $defaults;
$lengths = array_reduce($rows, function($columns, $row) {
foreach ((array) $row as $key => $val) {
if (!isset($columns[$key]) || strlen($val) > $columns[$key]) {
$columns[$key] = strlen($val);
}
}
return $columns;
});
$rows = array_reduce($rows, function($rows, $row) use ($lengths, $config) {
$text = '';
foreach ((array) $row as $key => $val) {
$text = $text . str_pad($val, $lengths[$key]) . $config['separator'];
}
$rows[] = $text;
return $rows;
});
$this->out($rows, $config);
}
/**
* Add newlines ("\n") to output stream.
*
* @param integer $number
* @return integer
*/
public function nl($number = 1) {
return str_repeat("\n", $number);
}
/**
* Add horizontal line to output stream
*
* @param integer $length
* @param integer $newlines
* @return integer
*/
public function hr($length = 80, $newlines = 1) {
return $this->out(str_repeat('-', $length), $newlines);
}
/**
* Clears the entire screen.
*
* @return void
*/
public function clear() {
passthru(strtoupper(substr(PHP_OS, 0, 3)) == 'WIN' ? 'cls' : 'clear');
}
/**
* Stop execution, by exiting the script.
*
* @param integer $status
* @param boolean $message
* @return void
*/
public function stop($status = 0, $message = null) {
if ($message) {
($status == 0) ? $this->out($message) : $this->error($message);
}
exit($status);
}
/**
* Handles the response that is sent to the stream.
*
* @param string $type the stream either output or error
* @param string $string the message to render
* @param integer|string|array $options
* integer as the number of new lines.
* string as the style
* array as :
* - nl : number of new lines to add at the end
* - style : the style name to wrap around the
* @return void
*/
protected function _response($type, $string, $options) {
$defaults = array('nl' => 1, 'style' => null);
if (!is_array($options)) {
if (!$options || is_int($options)) {
$options = array('nl' => $options);
} else if (is_string($options)) {
$options = array('style' => $options);
} else {
$options = array();
}
}
$options += $defaults;
if (is_array($string)) {
$method = ($type == 'error' ? $type : 'out');
foreach ($string as $out) {
$this->{$method}($out, $options);
}
return;
}
extract($options);
if ($style !== null) {
$string = "{:{$style}}{$string}{:end}";
}
if ($nl) {
$string = $string . $this->nl($nl);
}
return $this->response->{$type}($string);
}
}
?>
Jump to Line
Something went wrong with that request. Please try again.