1. interface
  2. Neos
  3. \
  4. Flow
  5. \
  6. Cli
  7. \
  8. DescriptionAwareCommandControllerInterface

DescriptionAwareCommandControllerInterface

interface DescriptionAwareCommandControllerInterface (View source)

An interface which allows a CommandController to tweak command descriptions before they are displayed to the user.

Methods

static string
processShortDescription(string $controllerCommandName, string $shortDescription, ObjectManagerInterface $objectManager)

Processes the given short description of the specified command.

static string
processDescription(string $controllerCommandName, string $description, ObjectManagerInterface $objectManager)

Processes the given description of the specified command.

Details

at line 32
static string processShortDescription(string $controllerCommandName, string $shortDescription, ObjectManagerInterface $objectManager)

Processes the given short description of the specified command.

Parameters

string $controllerCommandName

Name of the command the description is referring to, for example "flush"
string $shortDescription

The short command description so far
ObjectManagerInterface $objectManager

The object manager, can be used to access further information necessary for rendering the description

Return Value

string

the possibly modified short command description

at line 43
static string processDescription(string $controllerCommandName, string $description, ObjectManagerInterface $objectManager)

Processes the given description of the specified command.

Parameters

string $controllerCommandName

Name of the command the description is referring to, for example "flush"
string $description

The command description so far
ObjectManagerInterface $objectManager

The object manager, can be used to access further information necessary for rendering the description

Return Value

string

the possibly modified command description