PHP Класс Neos\Flow\Cli\Command

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$commandIdentifier string
$commandMethodReflection Neos\Flow\Reflection\MethodReflection
$controllerClassName string
$controllerCommandName string
$objectManager Neos\Flow\ObjectManagement\ObjectManagerInterface
$reflectionService Neos\Flow\Reflection\ReflectionService

Открытые методы

Метод Описание
__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.

Защищенные методы

Метод Описание
getCommandMethodReflection ( ) : MethodReflection

Описание методов

__construct() публичный Метод

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() публичный Метод

If the command does not expect any arguments, an empty array is returned
public getArgumentDefinitions ( ) : array
Результат array

getCommandIdentifier() публичный Метод

Returns the command identifier for this command
public getCommandIdentifier ( ) : string
Результат string The command identifier for this command, following the pattern packagekey:controllername:commandname

getCommandMethodReflection() защищенный Метод

protected getCommandMethodReflection ( ) : MethodReflection
Результат Neos\Flow\Reflection\MethodReflection

getControllerClassName() публичный Метод

public getControllerClassName ( ) : string
Результат string

getControllerCommandName() публичный Метод

public getControllerCommandName ( ) : string
Результат string

getDescription() публичный Метод

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
Результат string A longer description of this command

getRelatedCommandIdentifiers() публичный Метод

Returns an array of command identifiers which were specified in the "@see" annotation of a command method.
public getRelatedCommandIdentifiers ( ) : array
Результат array

getShortDescription() публичный Метод

Returns a short description of this command
public getShortDescription ( ) : string
Результат string A short description

hasArguments() публичный Метод

Returns TRUE if this command expects required and/or optional arguments, otherwise FALSE
public hasArguments ( ) : boolean
Результат boolean

injectObjectManager() публичный Метод

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

injectReflectionService() публичный Метод

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

isDeprecated() публичный Метод

Deprecated commands are still accessible through the regular command line interface, but should not be used by users anymore.
public isDeprecated ( ) : boolean
Результат boolean

isFlushingCaches() публичный Метод

Note that neither this method nor the @Flow\FlushesCaches annotation is currently part of the official API.
public isFlushingCaches ( ) : boolean
Результат boolean

isInternal() публичный Метод

Internal commands are still accessible through the regular command line interface, but should not be used by users.
public isInternal ( ) : boolean
Результат boolean

Описание свойств

$commandIdentifier защищенное свойство

protected string $commandIdentifier
Результат string

$commandMethodReflection защищенное свойство

protected MethodReflection,Neos\Flow\Reflection $commandMethodReflection
Результат Neos\Flow\Reflection\MethodReflection

$controllerClassName защищенное свойство

protected string $controllerClassName
Результат string

$controllerCommandName защищенное свойство

protected string $controllerCommandName
Результат string

$objectManager защищенное свойство

protected ObjectManagerInterface,Neos\Flow\ObjectManagement $objectManager
Результат Neos\Flow\ObjectManagement\ObjectManagerInterface

$reflectionService защищенное свойство

protected ReflectionService,Neos\Flow\Reflection $reflectionService
Результат Neos\Flow\Reflection\ReflectionService