Server : ApacheSystem : Linux host.digitalbabaji.in 4.18.0-513.11.1.el8_9.x86_64 #1 SMP Wed Jan 17 02:00:40 EST 2024 x86_64 User : addictionfreeind ( 1003) PHP Version : 7.2.34 Disable Function : exec,passthru,shell_exec,system Directory : /home/addictionfreeind/www/vendor/cakephp/cakephp/src/Console/ |
Upload File : |
<?php
/**
* ConsoleInputSubcommand file
*
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 2.0.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Console;
use SimpleXMLElement;
/**
* An object to represent a single subcommand used in the command line.
* Created when you call ConsoleOptionParser::addSubcommand()
*
* @see \Cake\Console\ConsoleOptionParser::addSubcommand()
*/
class ConsoleInputSubcommand
{
/**
* Name of the subcommand
*
* @var string
*/
protected $_name = '';
/**
* Help string for the subcommand
*
* @var string
*/
protected $_help = '';
/**
* The ConsoleOptionParser for this subcommand.
*
* @var \Cake\Console\ConsoleOptionParser
*/
protected $_parser;
/**
* Make a new Subcommand
*
* @param string|array $name The long name of the subcommand, or an array with all the properties.
* @param string $help The help text for this option.
* @param \Cake\Console\ConsoleOptionParser|array|null $parser A parser for this subcommand. Either a ConsoleOptionParser, or an
* array that can be used with ConsoleOptionParser::buildFromArray().
*/
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 value of the name attribute.
*
* @return string Value of this->_name.
*/
public function name()
{
return $this->_name;
}
/**
* Get the raw help string for this command
*
* @return string
*/
public function getRawHelp()
{
return $this->_help;
}
/**
* 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 \Cake\Console\ConsoleOptionParser|bool 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 $parent 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;
}
}