PHP Class Neos\Flow\Cli\Command

Datei anzeigen Open project: neos/flow-development-collection Class Usage Examples

Protected Properties

Property	Type	Description
$commandIdentifier	string
$commandMethodReflection	Neos\Flow\Reflection\MethodReflection
$controllerClassName	string
$controllerCommandName	string
$objectManager	Neos\Flow\ObjectManagement\ObjectManagerInterface
$reflectionService	Neos\Flow\Reflection\ReflectionService

Public Methods

Method	Description
__construct ( string $controllerClassName, string $controllerCommandName )	Constructor
getArgumentDefinitions ( ) : array	Returns an array of CommandArgumentDefinition that contains information about required/optional arguments of this command.
getCommandIdentifier ( ) : string	Returns the command identifier for this command
getControllerClassName ( ) : string
getControllerCommandName ( ) : string
getDescription ( ) : string	Returns a longer description of this command This is the complete method description except for the first line which can be retrieved via getShortDescription() If The command description only consists of one line, an empty string is returned
getRelatedCommandIdentifiers ( ) : array	Returns an array of command identifiers which were specified in the "@see" annotation of a command method.
getShortDescription ( ) : string	Returns a short description of this command
hasArguments ( ) : boolean	Returns TRUE if this command expects required and/or optional arguments, otherwise FALSE
injectObjectManager ( Neos\Flow\ObjectManagement\ObjectManagerInterface $objectManager )
injectReflectionService ( ReflectionService $reflectionService )
isDeprecated ( ) : boolean	Tells if this command is deprecated and thus should be marked as such in help texts, user documentation etc.
isFlushingCaches ( ) : boolean	Tells if this command flushes all caches and thus needs special attention in the interactive shell.
isInternal ( ) : boolean	Tells if this command is internal and thus should not be exposed through help texts, user documentation etc.

Protected Methods

Method	Description
getCommandMethodReflection ( ) : MethodReflection

Method Details

__construct() public method

Constructor

public __construct ( string $controllerClassName, string $controllerCommandName )
$controllerClassName	string	Class name of the controller providing the command
$controllerCommandName	string	Command name, i.e. the method name of the command, without the "Command" suffix

getArgumentDefinitions() public method

If the command does not expect any arguments, an empty array is returned

public getArgumentDefinitions ( ) : array
return	array

getCommandIdentifier() public method

Returns the command identifier for this command

public getCommandIdentifier ( ) : string
return	string	The command identifier for this command, following the pattern packagekey:controllername:commandname

getCommandMethodReflection() protected method

protected getCommandMethodReflection ( ) : MethodReflection
return	Neos\Flow\Reflection\MethodReflection

getControllerClassName() public method

public getControllerClassName ( ) : string
return	string

getControllerCommandName() public method

public getControllerCommandName ( ) : string
return	string

getDescription() public method

Returns a longer description of this command This is the complete method description except for the first line which can be retrieved via getShortDescription() If The command description only consists of one line, an empty string is returned

public getDescription ( ) : string
return	string	A longer description of this command

getRelatedCommandIdentifiers() public method

Returns an array of command identifiers which were specified in the "@see" annotation of a command method.

public getRelatedCommandIdentifiers ( ) : array
return	array

getShortDescription() public method

Returns a short description of this command

public getShortDescription ( ) : string
return	string	A short description

hasArguments() public method

Returns TRUE if this command expects required and/or optional arguments, otherwise FALSE

public hasArguments ( ) : boolean
return	boolean

injectObjectManager() public method

public injectObjectManager ( Neos\Flow\ObjectManagement\ObjectManagerInterface $objectManager )
$objectManager	Neos\Flow\ObjectManagement\ObjectManagerInterface

injectReflectionService() public method

public injectReflectionService ( ReflectionService $reflectionService )
$reflectionService	Neos\Flow\Reflection\ReflectionService	Reflection service

isDeprecated() public method

Deprecated commands are still accessible through the regular command line interface, but should not be used by users anymore.

public isDeprecated ( ) : boolean
return	boolean

isFlushingCaches() public method

Note that neither this method nor the @Flow\FlushesCaches annotation is currently part of the official API.

public isFlushingCaches ( ) : boolean
return	boolean

isInternal() public method

Internal commands are still accessible through the regular command line interface, but should not be used by users.

public isInternal ( ) : boolean
return	boolean

Property Details

$commandIdentifier protected_oe property

protected string $commandIdentifier
return	string

$commandMethodReflection protected_oe property

protected MethodReflection,Neos\Flow\Reflection $commandMethodReflection
return	Neos\Flow\Reflection\MethodReflection

$controllerClassName protected_oe property

protected string $controllerClassName
return	string

$controllerCommandName protected_oe property

protected string $controllerCommandName
return	string

$objectManager protected_oe property

protected ObjectManagerInterface,Neos\Flow\ObjectManagement $objectManager
return	Neos\Flow\ObjectManagement\ObjectManagerInterface

$reflectionService protected_oe property

protected ReflectionService,Neos\Flow\Reflection $reflectionService
return	Neos\Flow\Reflection\ReflectionService