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: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: <?php
/*
* This file is part of the webmozart/console package.
*
* (c) Bernhard Schussek <bschussek@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Webmozart\Console\Api\Command;
use ArrayAccess;
use ArrayIterator;
use Countable;
use IteratorAggregate;
use LogicException;
/**
* A collection of named commands.
*
* @since 1.0
*
* @author Bernhard Schussek <bschussek@gmail.com>
*/
class CommandCollection implements ArrayAccess, IteratorAggregate, Countable
{
/**
* @var Command[]
*/
private $commands = array();
/**
* @var string[]
*/
private $shortNameIndex = array();
/**
* @var string[]
*/
private $aliasIndex = array();
/**
* Creates a new command collection.
*
* @param Command[] $commands The commands to initially add to the
* collection.
*/
public function __construct(array $commands = array())
{
$this->merge($commands);
}
/**
* Adds a command to the collection.
*
* If a command exists with the same name in the collection, that command
* is overwritten.
*
* @param Command $command The command to add.
*
* @see merge(), replace()
*/
public function add(Command $command)
{
$name = $command->getName();
$this->commands[$name] = $command;
if ($shortName = $command->getShortName()) {
$this->shortNameIndex[$shortName] = $name;
}
foreach ($command->getAliases() as $alias) {
$this->aliasIndex[$alias] = $name;
}
ksort($this->aliasIndex);
}
/**
* Adds multiple commands to the collection.
*
* Existing commands are preserved. Commands with the same names as the
* passed commands are overwritten.
*
* @param Command[] $commands The commands to add.
*
* @see add(), replace()
*/
public function merge(array $commands)
{
foreach ($commands as $command) {
$this->add($command);
}
}
/**
* Sets the commands in the collection.
*
* Existing commands are replaced.
*
* @param Command[] $commands The commands to set.
*
* @see add(), merge()
*/
public function replace(array $commands)
{
$this->clear();
$this->merge($commands);
}
/**
* Returns a command by its name.
*
* @param string $name The name of the command.
*
* @return Command The command.
*
* @throws NoSuchCommandException If no command with that name exists in the
* collection.
*/
public function get($name)
{
if (isset($this->commands[$name])) {
return $this->commands[$name];
}
if (isset($this->shortNameIndex[$name])) {
return $this->commands[$this->shortNameIndex[$name]];
}
if (isset($this->aliasIndex[$name])) {
return $this->commands[$this->aliasIndex[$name]];
}
throw NoSuchCommandException::forCommandName($name);
}
/**
* Removes the command with the given name from the collection.
*
* If no such command can be found, the method does nothing.
*
* @param string $name The name of the command.
*/
public function remove($name)
{
if (isset($this->aliasIndex[$name])) {
$this->remove($this->aliasIndex[$name]);
return;
}
if (isset($this->shortNameIndex[$name])) {
$this->remove($this->shortNameIndex[$name]);
return;
}
unset($this->commands[$name]);
foreach ($this->shortNameIndex as $shortName => $targetName) {
if ($name === $targetName) {
unset($this->shortNameIndex[$shortName]);
}
}
foreach ($this->aliasIndex as $alias => $targetName) {
if ($name === $targetName) {
unset($this->aliasIndex[$alias]);
}
}
}
/**
* Returns whether the collection contains a command with the given name.
*
* @param string $name The name of the command.
*
* @return bool Returns `true` if the collection contains a command with
* that name and `false` otherwise.
*/
public function contains($name)
{
return isset($this->commands[$name]) || isset($this->shortNameIndex[$name]) || isset($this->aliasIndex[$name]);
}
/**
* Removes all commands from the collection.
*/
public function clear()
{
$this->commands = array();
$this->shortNameIndex = array();
$this->aliasIndex = array();
}
/**
* Returns whether the collection is empty.
*
* @return bool Returns `true` if the collection is empty and `false`
* otherwise.
*/
public function isEmpty()
{
return !$this->commands;
}
/**
* Returns the contents of the collection as array.
*
* The commands in the collection are returned indexed by their names. The
* result is sorted in the order in which the commands were added to the
* collection.
*
* @return Command[] The commands indexed by their names.
*/
public function toArray()
{
return $this->commands;
}
public function filterDefault()
{
}
public function filterNonDefault()
{
}
public function filterAnonymous()
{
}
public function filterNonAnonymous()
{
}
/**
* Returns the names of all commands in the collection.
*
* The names are sorted alphabetically in ascending order. If you set
* `$includeAliases` to `true`, the alias names are included in the result.
*
* @param bool $includeAliases Whether to include alias names in the result.
*
* @return string[] The sorted command names.
*/
public function getNames($includeAliases = false)
{
$names = array_keys($this->commands);
if ($includeAliases) {
$names = array_merge($names, array_keys($this->aliasIndex));
}
sort($names);
return $names;
}
/**
* Returns the aliases of all commands in the collection.
*
* The aliases are sorted alphabetically in ascending order.
*
* @return string[] The command names indexed and sorted by their aliases.
*/
public function getAliases()
{
return $this->aliasIndex;
}
/**
* {@inheritdoc}
*/
public function offsetExists($name)
{
return $this->contains($name);
}
/**
* {@inheritdoc}
*/
public function offsetGet($name)
{
return $this->get($name);
}
/**
* {@inheritdoc}
*/
public function offsetSet($offset, $command)
{
if ($offset) {
throw new LogicException('Passing of offsets is not supported');
}
$this->add($command);
}
/**
* {@inheritdoc}
*/
public function offsetUnset($name)
{
$this->remove($name);
}
/**
* {@inheritdoc}
*/
public function getIterator()
{
return new ArrayIterator($this->commands);
}
/**
* {@inheritdoc}
*/
public function count()
{
return count($this->commands);
}
}