<?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 {

	protected $_name;
	protected $_help;
	protected $_parser;

/**
 * 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;
		}
		if (is_array($this->_parser)) {
			$this->_parser['command'] = $this->_name;
			$this->_parser = ConsoleOptionParser::buildFromArray($this->_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 mixed Either false or a ConsoleOptionParser
 */
	public function parser() {
		if ($this->_parser instanceof ConsoleOptionParser) {
			return $this->_parser;
		}
		return false;
	}

/**
 * Append this subcommand to the Parent element
 *
 * @param SimpleXmlElement The parent element.
 * @return SimpleXmlElement The parent with this subcommand appended.
 */
	public function xml(SimpleXmlElement $parent) {
		$command = $parent->addChild('command');
		$command->addAttribute('name', $this->_name);
		$command->addAttribute('help', $this->_help);
		return $parent;
	}
}