forked from cakephp/cakephp
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathConsoleInputSubcommand.php
More file actions
125 lines (116 loc) · 3.42 KB
/
Copy pathConsoleInputSubcommand.php
File metadata and controls
125 lines (116 loc) · 3.42 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
<?php
/**
* ConsoleInputSubcommand file
*
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://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. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @since 2.0.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Console;
/**
* An object to represent a single subcommand used in the command line.
* Created when you call ConsoleOptionParser::addSubcommand()
*
* @see 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 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;
}
/**
* 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 $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;
}
}