• Accueil
• Webmozart
• Console
• Api
• Config
• ApplicationConfig

PHP Class Webmozart\Console\Api\Config\ApplicationConfig

Afficher le fichier Open project: webmozart/console Class Usage Examples

Méthodes publiques

Méthode	Description
__construct ( string $name = null, string $version = null )	Creates a new console application.
addCommandConfig ( CommandConfig $config ) : static	Adds a command configuration to the application.
addCommandConfigs ( array $configs ) : static	Adds command configurations to the application.
addEventListener ( string $eventName, callable $listener, integer $priority ) : static	Adds a listener for the given event name.
addEventSubscriber ( Symfony\Component\EventDispatcher\EventSubscriberInterface $subscriber ) : static	Adds an event subscriber to the dispatcher.
addStyle ( Style $style ) : static	Adds a style to the style set.
addStyles ( array $styles ) : static	Adds multiple styles to the style set.
beginCommand ( string $name ) : CommandConfig	Starts a configuration block for a command.
create ( string $name = null, string $version = null ) : static	Creates a new console application.
editCommand ( string $name ) : CommandConfig	Alias for {@link getCommandConfig()}.
getCommandConfig ( string $name ) : CommandConfig	Returns the command configuration for a given name.
getCommandConfigs ( ) : CommandConfig[]	Returns all registered command configurations.
getCommandResolver ( ) : Webmozart\Console\Api\Resolver\CommandResolver	Returns the used command resolver.
getDisplayName ( ) : string	Returns the application name as it is displayed in the help.
getEventDispatcher ( ) : Symfony\Component\EventDispatcher\EventDispatcherInterface	Returns the event dispatcher used to dispatch the console events.
getHelp ( ) : string	Returns the help text of the application.
getIOFactory ( ) : callable	Returns the callable used to create {@link IO} instances.
getName ( ) : string	Returns the name of the application.
getStyleSet ( ) : StyleSet	Returns the configured style set.
getVersion ( ) : string	Returns the version of the application.
hasCommandConfig ( string $name ) : boolean	Returns whether the application has a command with a given name.
hasCommandConfigs ( ) : boolean	Returns whether the application has any registered command configurations.
isDebug ( ) : boolean	Returns whether the application is in debug mode.
isExceptionCaught ( ) : boolean	Returns whether the application catches and displays exceptions thrown while running a command.
isTerminatedAfterRun ( ) : boolean	Returns whether the PHP process is terminated after running a command.
removeEventListener ( string $eventName, callable $listener ) : static	Removes an event listener for the given event name.
removeEventSubscriber ( Symfony\Component\EventDispatcher\EventSubscriberInterface $subscriber ) : static	Removes an event subscriber from the dispatcher.
removeStyle ( string $tag ) : static	Removes a style from the style set.
setCatchExceptions ( boolean $catch ) : static	Sets whether the application catches and displays exceptions thrown while running a command.
setCommandConfigs ( array $configs ) : static	Sets the command configurations of the application.
setCommandResolver ( Webmozart\Console\Api\Resolver\CommandResolver $commandResolver ) : static	Sets the used command resolver.
setDebug ( boolean $debug ) : static	Sets whether the application is in debug mode.
setDisplayName ( string $displayName ) : static	Sets the application name as it is displayed in the help.
setEventDispatcher ( Symfony\Component\EventDispatcher\EventDispatcherInterface $dispatcher = null ) : static	Sets the event dispatcher for dispatching the console events.
setHelp ( string $help ) : static	Sets the help text of the application.
setIOFactory ( callable $ioFactory ) : static	Sets the callable used to create {@link IO} instances.
setName ( string $name ) : static	Sets the name of the application.
setStyleSet ( StyleSet $styleSet ) : static	Sets the used style set.
setTerminateAfterRun ( boolean $terminate ) : static	Sets whether to terminate the PHP process after running a command.
setVersion ( string $version ) : static	Sets the version of the application.

Méthodes protégées

Méthode	Description
getDefaultDisplayName ( ) : string	Returns the default display name used if no display name is set.

Method Details