Skip to content
Permalink
Browse files

Extracting subcommand as a separate object.

This allows the internals of ConsoleOptionParser to be more uniform and consistent.
  • Loading branch information...
markstory committed Oct 10, 2010
1 parent 8261581 commit dc9a05d49c55a9e6e3c87795819ce12bbaaeb689
Showing with 91 additions and 23 deletions.
  1. +84 −0 cake/console/console_input_subcommand.php
  2. +7 −23 cake/console/console_option_parser.php
@@ -0,0 +1,84 @@
<?php
/**
* ConsoleInputSubcommand file
*
* PHP 5
*
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @package cake
* @subpackage cake.cake.console
* @since CakePHP(tm) v 2.0
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
/**
* An object to represent a single subcommand used in the command line.
* ConsoleOptionParser creates these when you use addSubcommand()
*
* @see ConsoleOptionParser::addSubcommand()
* @package cake.console
*/
class ConsoleInputSubcommand {
/**
* Make a new Subcommand
*
* @param mixed $name The long name of the subcommand, or an array with all the properites.
* @param string $help The help text for this option
* @param ConsoleOptionParser $parser A parser for this subcommand.
* @return void
*/
public function __construct($name, $help = '', $parser = null) {
if (is_array($name) && isset($name['name'])) {
foreach ($name as $key => $value) {
$this->{$key} = $value;
}
} else {
$this->name = $name;
$this->help = $help;
$this->parser = $parser;
}
}
/**
* Get the name of the subcommand
*
* @return string
*/
public function name() {
return $this->name;
}
/**
* Generate the help for this this subcommand.
*
* @param int $width The width to make the name of the subcommand.
* @return string
*/
public function help($width = 0) {
$name = $this->name;
if (strlen($name) < $width) {
$name = str_pad($name, $width, ' ');
}
return $name . $this->help;
}
/**
* Get the usage value for this option
*
* @return string
*/
public function parser() {
if ($this->parser instanceof ConsoleOptionParser) {
return $this->parser;
}
return false;
}
}
@@ -19,6 +19,7 @@
*/
require_once 'console_input_option.php';
require_once 'console_input_argument.php';
require_once 'console_input_subcommand.php';
/**
* Handles parsing the ARGV in the command line and provides support
@@ -297,7 +298,7 @@ public function addSubcommand($name, $params = array()) {
'parser' => null
);
$options = array_merge($defaults, $params);
$this->_subcommands[$name] = $options;
$this->_subcommands[$name] = new ConsoleInputSubcommand($options);
return $this;
}
@@ -361,9 +362,9 @@ public function parse($argv) {
public function help($subcommand = null) {
if (
isset($this->_subcommands[$subcommand]) &&
$this->_subcommands[$subcommand]['parser'] instanceof self
$this->_subcommands[$subcommand]->parser() instanceof self
) {
$subparser = $this->_subcommands[$subcommand]['parser'];
$subparser = $this->_subcommands[$subcommand]->parser();
$subparser->command($this->command() . ' ' . $subparser->command());
return $subparser->help();
}
@@ -378,13 +379,9 @@ public function help($subcommand = null) {
if (!empty($this->_subcommands)) {
$out[] = '<info>Subcommands:</info>';
$out[] = '';
$max = 0;
foreach ($this->_subcommands as $description) {
$max = (strlen($description['name']) > $max) ? strlen($description['name']) : $max;
}
$max += 2;
foreach ($this->_subcommands as $description) {
$out[] = $this->_subcommandHelp($description, $max);
$max = $this->_getMaxLength($this->_subcommands) + 2;
foreach ($this->_subcommands as $command) {
$out[] = $command->help($max);
}
$out[] = '';
}
@@ -434,19 +431,6 @@ protected function _generateUsage() {
return implode(' ', $usage);
}
/**
* Generate help for a single subcommand.
*
* @return string
*/
protected function _subcommandHelp($definition, $width) {
$name = $definition['name'];
if (strlen($name) < $width) {
$name = str_pad($name, $width, ' ');
}
return $name . $definition['help'];
}
/**
* Parse the value for a long option out of $this->_tokens. Will handle
* options with an `=` in them.

0 comments on commit dc9a05d

Please sign in to comment.
You can’t perform that action at this time.