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: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439: 440: 441: 442: 443: 444: 445: 446: 447: 448: 449: 450: 451: 452: 453: 454: 455: 456: 457: 458: 459: 460: 461: 462: 463: 464: 465: 466: 467: 468: 469: 470: 471: 472: 473: 474: 475: 476: 477: 478: 479: 480: 481: 482: 483: 484: 485: 486: 487: 488: 489: 490: 491: 492: 493: 494: 495: 496: 497: 498: 499: 500: 501: 502: 503: 504: 505: 506: 507: 508: 509: 510: 511: 512: 513: 514: 515: 516: 517: 518: 519: 520: 521: 522: 523: 524: 525: 526: 527: 528: 529: 530: 531: 532: 533: 534: 535: 536: 537: 538: 539: 540: 541: 542: 543: 544: 545: 546: 547: 548: 549: 550: 551: 552: 553: 554: 555: 556: 557: 558: 559: 560: 561: 562: 563: 564: 565: 566: 567: 568: 569: 570: 571: 572: 573: 574: 575: 576: 577: 578: 579: 580: 581: 582: 583: 584: 585: 586: 587: 588: 589: 590: 591: 592: 593: 594: 595: 596: 597: 598: 599: 600: 601: 602: 603: 604: 605: 606: 607: 608: 609: 610: 611: 612: 613: 614: 615: 616: 617: 618: 619: 620: 621: 622: 623: 624: 625: 626: 627: 628: 629: 630: 631: 632: 633: 634: 635: 636: 637: 638: 639: 640: 641: 642: 643: 644: 645: 646: 647: 648: 649: 650: 651: 652: 653: 654: 655: 656: 657: 658: 659: 660: 661: 662: 663: 664: 665: 666: 667: 668: 669: 670: 671: 672: 673: 674: 675: 676: 677: 678: 679: 680: 681: 682: 683: 684: 685: 686: 687: 688: 689: 690: 691: 692: 693: 694: 695: 696: 697: 698: 699: 700: 701: 702: 703: 704: 705: 706: 707: 708: 709: 710: 711: 712: 713: 714: 715: 716: 717: 718: 719: 720: 721: 722: 723: 724: 725: 726: 727: 728: 729: 730: 731: 732: 733: 734: 735: 736: 737: 738: 739: 740: 741: 742: 743: 744: 745: 746: 747: 748: 749: 750: 751: 752: 753: 754: 755: 756: 757: 758: 759: 760: 761: 762: 763: 764: 765: 766: 767: 768: 769: 770: 771: 772: 773: 774: 775: 776: 777: 778: 779: 780: 781: 782: 783: 784: 785: 786: 787: 788: 789: 790: 791: 792: 793: 794: 795: 796: 797: 798: 799: 800: 801: 802: 803: 804: 805: 806: 807: 808: 809: 810: 811: 812: 813: 814: 815: 816: 817: 818: 819: 820: 821: 822: 823: 824: 825: 826: 827: <?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\Config;
use Symfony\Component\EventDispatcher\EventDispatcher;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Webmozart\Assert\Assert;
use Webmozart\Console\Api\Command\NoSuchCommandException;
use Webmozart\Console\Api\Formatter\Style;
use Webmozart\Console\Api\Formatter\StyleSet;
use Webmozart\Console\Api\Resolver\CommandResolver;
use Webmozart\Console\Formatter\DefaultStyleSet;
use Webmozart\Console\Resolver\DefaultResolver;
/**
* The configuration of a console application.
*
* @since 1.0
*
* @author Bernhard Schussek <bschussek@gmail.com>
*/
class ApplicationConfig extends Config
{
/**
* @var string
*/
private $name;
/**
* @var string
*/
private $displayName;
/**
* @var string
*/
private $version;
/**
* @var string
*/
private $help;
/**
* @var CommandConfig[]
*/
private $commandConfigs = array();
/**
* @var EventDispatcherInterface
*/
private $dispatcher;
/**
* @var bool
*/
private $catchExceptions = true;
/**
* @var bool
*/
private $terminateAfterRun = true;
/**
* @var CommandResolver
*/
private $commandResolver;
/**
* @var callable
*/
private $ioFactory;
/**
* @var bool
*/
private $debug = false;
/**
* @var StyleSet
*/
private $styleSet;
/**
* Creates a new console application.
*
* @param string $name The name of the application.
* @param string $version The application version.
*
* @return static The created instance.
*/
public static function create($name = null, $version = null)
{
return new static($name, $version);
}
/**
* Creates a new console application.
*
* @param string $name The name of the application.
* @param string $version The application version.
*/
public function __construct($name = null, $version = null)
{
$this->name = $name;
$this->version = $version;
parent::__construct();
}
/**
* Returns the name of the application.
*
* @return string The application name.
*
* @see setName()
*/
public function getName()
{
return $this->name;
}
/**
* Sets the name of the application.
*
* @param string $name The application name.
*
* @return static The current instance.
*
* @see getName()
*/
public function setName($name)
{
if (null !== $name) {
Assert::string($name, 'The application name must be a string. Got: %s');
Assert::notEmpty($name, 'The application name must not be empty.');
Assert::regex($name, '~^[a-zA-Z0-9\-]+$~', 'The application name must contain letters, numbers and hyphens only. Did you mean to call setDisplayName()?');
}
$this->name = $name;
return $this;
}
/**
* Returns the application name as it is displayed in the help.
*
* If no display name is set with {@link setDisplayName()}, the humanized
* application name is returned.
*
* @return string The display name.
*
* @see setDisplayName()
*/
public function getDisplayName()
{
return $this->displayName ?: $this->getDefaultDisplayName();
}
/**
* Sets the application name as it is displayed in the help.
*
* @param string $displayName The display name.
*
* @return static The current instance.
*
* @see getDisplayName()
*/
public function setDisplayName($displayName)
{
if (null !== $displayName) {
Assert::string($displayName, 'The display name must be a string. Got: %s');
Assert::notEmpty($displayName, 'The display name must not be empty.');
}
$this->displayName = $displayName;
return $this;
}
/**
* Returns the version of the application.
*
* @return string The application version.
*/
public function getVersion()
{
return $this->version;
}
/**
* Sets the version of the application.
*
* @param string $version The application version.
*
* @return static The current instance.
*/
public function setVersion($version)
{
if (null !== $version) {
Assert::string($version, 'The application version must be a string. Got: %s');
Assert::notEmpty($version, 'The application version must not be empty.');
}
$this->version = $version;
return $this;
}
/**
* Returns the help text of the application.
*
* @return string The help text.
*/
public function getHelp()
{
return $this->help;
}
/**
* Sets the help text of the application.
*
* @param string $help The help text.
*
* @return static The current instance.
*/
public function setHelp($help)
{
if (null !== $help) {
Assert::string($help, 'The help text must be a string. Got: %s');
Assert::notEmpty($help, 'The help text must not be empty.');
}
$this->help = $help;
return $this;
}
/**
* Returns the event dispatcher used to dispatch the console events.
*
* @return EventDispatcherInterface The event dispatcher.
*/
public function getEventDispatcher()
{
return $this->dispatcher;
}
/**
* Sets the event dispatcher for dispatching the console events.
*
* @param EventDispatcherInterface $dispatcher The event dispatcher.
*
* @return static The current instance.
*/
public function setEventDispatcher(EventDispatcherInterface $dispatcher = null)
{
$this->dispatcher = $dispatcher;
return $this;
}
/**
* Adds a listener for the given event name.
*
* See {@link ConsoleEvents} for the supported event names.
*
* @param string $eventName The event to listen to.
* @param callable $listener The callback to execute when the event is
* dispatched.
* @param int $priority The event priority.
*
* @return static The current instance.
*
* @see EventDispatcherInterface::addListener()
*/
public function addEventListener($eventName, $listener, $priority = 0)
{
if (!$this->dispatcher) {
$this->dispatcher = new EventDispatcher();
}
$this->dispatcher->addListener($eventName, $listener, $priority);
return $this;
}
/**
* Adds an event subscriber to the dispatcher.
*
* @param EventSubscriberInterface $subscriber The subscriber to add.
*
* @return static The current instance.
*
* @see EventDispatcherInterface::addSubscriber()
*/
public function addEventSubscriber(EventSubscriberInterface $subscriber)
{
if (!$this->dispatcher) {
$this->dispatcher = new EventDispatcher();
}
$this->dispatcher->addSubscriber($subscriber);
return $this;
}
/**
* Removes an event listener for the given event name.
*
* @param string $eventName The event name.
* @param callable $listener The callback to remove.
*
* @return static The current instance.
*
* @see EventDispatcherInterface::removeListener()
*/
public function removeEventListener($eventName, $listener)
{
if (!$this->dispatcher) {
$this->dispatcher = new EventDispatcher();
}
$this->dispatcher->removeListener($eventName, $listener);
return $this;
}
/**
* Removes an event subscriber from the dispatcher.
*
* @param EventSubscriberInterface $subscriber The subscriber to remove.
*
* @return static The current instance.
*
* @see EventDispatcherInterface::removeSubscriber()
*/
public function removeEventSubscriber(EventSubscriberInterface $subscriber)
{
if (!$this->dispatcher) {
$this->dispatcher = new EventDispatcher();
}
$this->dispatcher->removeSubscriber($subscriber);
return $this;
}
/**
* Returns whether the application catches and displays exceptions thrown
* while running a command.
*
* @return bool Returns `true` if exceptions are caught and `false`
* otherwise.
*
* @see setCatchExceptions()
*/
public function isExceptionCaught()
{
return $this->catchExceptions;
}
/**
* Sets whether the application catches and displays exceptions thrown
* while running a command.
*
* @param bool $catch Whether to catch and display exceptions thrown
* while running a command.
*
* @return static The current instance.
*
* @see isExceptionCaught()
*/
public function setCatchExceptions($catch)
{
Assert::boolean($catch);
$this->catchExceptions = $catch;
return $this;
}
/**
* Returns whether the PHP process is terminated after running a command.
*
* @return bool Returns `true` if the PHP process is terminated after
* {@link run()} and `false` otherwise.
*
* @see setTerminateAfterRun()
*/
public function isTerminatedAfterRun()
{
return $this->terminateAfterRun;
}
/**
* Sets whether to terminate the PHP process after running a command.
*
* @param bool $terminate Whether to terminate the PHP process after
* running a command.
*
* @return static The current instance.
*
* @see isTerminatedAfterRun()
*/
public function setTerminateAfterRun($terminate)
{
Assert::boolean($terminate);
$this->terminateAfterRun = $terminate;
return $this;
}
/**
* Returns the used command resolver.
*
* @return CommandResolver The command resolver.
*
* @see setCommandResolver()
*/
public function getCommandResolver()
{
if (!$this->commandResolver) {
$this->commandResolver = new DefaultResolver();
}
return $this->commandResolver;
}
/**
* Sets the used command resolver.
*
* @param CommandResolver $commandResolver The command resolver.
*
* @return static The current instance.
*
* @see getCommandResolver()
*/
public function setCommandResolver(CommandResolver $commandResolver)
{
$this->commandResolver = $commandResolver;
return $this;
}
/**
* Returns the callable used to create {@link IO} instances.
*
* @return callable The callable or `null` if none was set.
*
* @see setIOFactory()
*/
public function getIOFactory()
{
return $this->ioFactory;
}
/**
* Sets the callable used to create {@link IO} instances.
*
* The callable receives four arguments:
*
* * {@link RawArgs}: The raw console arguments.
* * {@link Input}: The input.
* * {@link Output}: The output.
* * {@link Output}: The error output.
*
* The input and output instances may be `null` if none were passed to
* {@link Application::run()}.
*
* @param callable $ioFactory The {@link IO} factory callable.
*
* @return static The current instance.
*/
public function setIOFactory($ioFactory)
{
Assert::nullOrIsCallable($ioFactory, 'The IO factory must be a callable or null. Got: %s');
$this->ioFactory = $ioFactory;
return $this;
}
/**
* Returns whether the application is in debug mode.
*
* In debug mode, the verbosity is always {@link IO::DEBUG}.
*
* @return bool Returns `true` if the application is in debug mode.
*
* @see setDebug()
*/
public function isDebug()
{
return $this->debug;
}
/**
* Sets whether the application is in debug mode.
*
* In debug mode, the verbosity is always {@link IO::DEBUG}.
*
* @param bool $debug Set to `true` to activate the debug mode.
*
* @return static The current instance.
*
* @see isDebug()
*/
public function setDebug($debug)
{
Assert::boolean($debug);
$this->debug = $debug;
return $this;
}
/**
* Returns the configured style set.
*
* @return StyleSet The style set.
*
* @see setStyleSet()
*/
public function getStyleSet()
{
if (!$this->styleSet) {
$this->styleSet = new DefaultStyleSet();
}
return $this->styleSet;
}
/**
* Sets the used style set.
*
* @param StyleSet $styleSet The style set to use.
*
* @return static The current instance.
*
* @see getStyleSet()
*/
public function setStyleSet(StyleSet $styleSet)
{
$this->styleSet = $styleSet;
return $this;
}
/**
* Adds a style to the style set.
*
* @param Style $style The style to add.
*
* @return static The current instance.
*
* @see StyleSet::add()
*/
public function addStyle(Style $style)
{
if (!$this->styleSet) {
$this->styleSet = new DefaultStyleSet();
}
$this->styleSet->add($style);
return $this;
}
/**
* Adds multiple styles to the style set.
*
* @param Style[] $styles The styles to add.
*
* @return static The current instance.
*
* @see StyleSet::merge()
*/
public function addStyles(array $styles)
{
if (!$this->styleSet) {
$this->styleSet = new DefaultStyleSet();
}
$this->styleSet->merge($styles);
return $this;
}
/**
* Removes a style from the style set.
*
* @param string $tag The tag of the style to remove.
*
* @return static The current instance.
*
* @see StyleSet::remove()
*/
public function removeStyle($tag)
{
if ($this->styleSet) {
$this->styleSet->remove($tag);
}
return $this;
}
/**
* Starts a configuration block for a command.
*
* The configuration of the command is returned by this method. You can use
* the fluent interface to configure the sub-command before jumping back to
* this configuration with {@link CommandConfig::end()}:
*
* ```php
* protected function configure()
* {
* $this
* ->setName('server')
* ->setDescription('List and manage servers')
*
* ->beginCommand('add')
* ->setDescription('Add a server')
* ->addArgument('host', Argument::REQUIRED)
* ->addOption('port', 'p', Option::VALUE_OPTIONAL, null, 80)
* ->end()
*
* // ...
* ;
* }
* ```
*
* @param string $name The name of the command.
*
* @return CommandConfig The command configuration.
*
* @see editCommand()
*/
public function beginCommand($name)
{
$commandConfig = new CommandConfig($name, $this);
// The name is dynamic, so don't store by name
$this->commandConfigs[] = $commandConfig;
return $commandConfig;
}
/**
* Alias for {@link getCommandConfig()}.
*
* This method can be used to nicely edit a command inherited from a
* parent configuration using the fluent API:
*
* ```php
* protected function configure()
* {
* parent::configure();
*
* $this
* ->editCommand('add')
* // ...
* ->end()
*
* // ...
* ;
* }
* ```
*
* @param string $name The name of the command to edit.
*
* @return CommandConfig The command configuration.
*
* @see beginCommand()
*/
public function editCommand($name)
{
return $this->getCommandConfig($name);
}
/**
* Adds a command configuration to the application.
*
* @param CommandConfig $config The command configuration.
*
* @return static The current instance.
*
* @see beginCommand()
*/
public function addCommandConfig(CommandConfig $config)
{
// The name is dynamic, so don't store by name
$this->commandConfigs[] = $config;
return $this;
}
/**
* Adds command configurations to the application.
*
* @param CommandConfig[] $configs The command configurations.
*
* @return static The current instance.
*
* @see beginCommand()
*/
public function addCommandConfigs(array $configs)
{
foreach ($configs as $command) {
$this->addCommandConfig($command);
}
return $this;
}
/**
* Sets the command configurations of the application.
*
* @param CommandConfig[] $configs The command configurations.
*
* @return static The current instance.
*
* @see beginCommand()
*/
public function setCommandConfigs(array $configs)
{
$this->commandConfigs = array();
$this->addCommandConfigs($configs);
return $this;
}
/**
* Returns the command configuration for a given name.
*
* @param string $name The name of the command.
*
* @return CommandConfig The command configuration.
*
* @throws NoSuchCommandException If the command configuration is not found.
*
* @see beginCommand()
*/
public function getCommandConfig($name)
{
foreach ($this->commandConfigs as $commandConfig) {
if ($name === $commandConfig->getName()) {
return $commandConfig;
}
}
throw NoSuchCommandException::forCommandName($name);
}
/**
* Returns all registered command configurations.
*
* @return CommandConfig[] The command configurations.
*
* @see beginCommand()
*/
public function getCommandConfigs()
{
return $this->commandConfigs;
}
/**
* Returns whether the application has a command with a given name.
*
* @param string $name The name of the command.
*
* @return bool Returns `true` if the command configuration with the given
* name exists and `false` otherwise.
*
* @see beginCommand()
*/
public function hasCommandConfig($name)
{
foreach ($this->commandConfigs as $commandConfig) {
if ($name === $commandConfig->getName()) {
return true;
}
}
return false;
}
/**
* Returns whether the application has any registered command configurations.
*
* @return bool Returns `true` if command configurations were added to the
* application and `false` otherwise.
*
* @see beginCommand()
*/
public function hasCommandConfigs()
{
return count($this->commandConfigs) > 0;
}
/**
* Returns the default display name used if no display name is set.
*
* @return string The default display name.
*/
protected function getDefaultDisplayName()
{
if (!$this->name) {
return null;
}
return ucwords(preg_replace('~[\s-_]+~', ' ', $this->name));
}
}