PHP Class Neos\Flow\Cli\Command

Afficher le fichier Open project: neos/flow-development-collection Class Usage Examples

Protected Properties

Свойство Type Description
$commandIdentifier string
$commandMethodReflection Neos\Flow\Reflection\MethodReflection
$controllerClassName string
$controllerCommandName string
$objectManager Neos\Flow\ObjectManagement\ObjectManagerInterface
$reflectionService Neos\Flow\Reflection\ReflectionService

Méthodes publiques

Méthode 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.

Méthodes protégées

Méthode Description
getCommandMethodReflection ( ) : MethodReflection

Method Details

__construct() public méthode

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 méthode

If the command does not expect any arguments, an empty array is returned
public getArgumentDefinitions ( ) : array
Résultat array

getCommandIdentifier() public méthode

Returns the command identifier for this command
public getCommandIdentifier ( ) : string
Résultat string The command identifier for this command, following the pattern packagekey:controllername:commandname

getCommandMethodReflection() protected méthode

protected getCommandMethodReflection ( ) : MethodReflection
Résultat Neos\Flow\Reflection\MethodReflection

getControllerClassName() public méthode

public getControllerClassName ( ) : string
Résultat string

getControllerCommandName() public méthode

public getControllerCommandName ( ) : string
Résultat string

getDescription() public méthode

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
Résultat string A longer description of this command

getRelatedCommandIdentifiers() public méthode

Returns an array of command identifiers which were specified in the "@see" annotation of a command method.
public getRelatedCommandIdentifiers ( ) : array
Résultat array

getShortDescription() public méthode

Returns a short description of this command
public getShortDescription ( ) : string
Résultat string A short description

hasArguments() public méthode

Returns TRUE if this command expects required and/or optional arguments, otherwise FALSE
public hasArguments ( ) : boolean
Résultat boolean

injectObjectManager() public méthode

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

injectReflectionService() public méthode

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

isDeprecated() public méthode

Deprecated commands are still accessible through the regular command line interface, but should not be used by users anymore.
public isDeprecated ( ) : boolean
Résultat boolean

isFlushingCaches() public méthode

Note that neither this method nor the @Flow\FlushesCaches annotation is currently part of the official API.
public isFlushingCaches ( ) : boolean
Résultat boolean

isInternal() public méthode

Internal commands are still accessible through the regular command line interface, but should not be used by users.
public isInternal ( ) : boolean
Résultat boolean

Property Details

$commandIdentifier protected_oe property

protected string $commandIdentifier
Résultat string

$commandMethodReflection protected_oe property

protected MethodReflection,Neos\Flow\Reflection $commandMethodReflection
Résultat Neos\Flow\Reflection\MethodReflection

$controllerClassName protected_oe property

protected string $controllerClassName
Résultat string

$controllerCommandName protected_oe property

protected string $controllerCommandName
Résultat string

$objectManager protected_oe property

protected ObjectManagerInterface,Neos\Flow\ObjectManagement $objectManager
Résultat Neos\Flow\ObjectManagement\ObjectManagerInterface

$reflectionService protected_oe property

protected ReflectionService,Neos\Flow\Reflection $reflectionService
Résultat Neos\Flow\Reflection\ReflectionService