1. class
  2. Windwalker
  3. Console
  4. Descriptor
  5. Text
  6. TextDescriptorHelper

TextDescriptorHelper

class TextDescriptorHelper extends AbstractDescriptorHelper (View source)

A descriptor helper to get different descriptor and render it.

Methods

__construct(DescriptorInterface $CommandDescriptor = null, DescriptorInterface $optionDescriptor = null)

The class constructor.

from AbstractDescriptorHelper
DescriptorInterface
getCommandDescriptor()

Command descriptor getter.

from AbstractDescriptorHelper
$this
setCommandDescriptor(DescriptorInterface $CommandDescriptor)

Command descriptor setter.

from AbstractDescriptorHelper
DescriptorInterface
getOptionDescriptor()

Option descriptor getter.

from AbstractDescriptorHelper
$this
setOptionDescriptor(DescriptorInterface $optionDescriptor)

Option descriptor setter.

from AbstractDescriptorHelper
string
describe(AbstractCommand $command)

Describe a command detail.

Details

in AbstractDescriptorHelper at line line 44
__construct(DescriptorInterface $CommandDescriptor = null, DescriptorInterface $optionDescriptor = null)

The class constructor.

Parameters

DescriptorInterface $CommandDescriptor Command descriptor.
DescriptorInterface $optionDescriptor Option descriptor.

in AbstractDescriptorHelper at line line 57
DescriptorInterface getCommandDescriptor()

Command descriptor getter.

Return Value

DescriptorInterface

in AbstractDescriptorHelper at line line 71
$this setCommandDescriptor(DescriptorInterface $CommandDescriptor)

Command descriptor setter.

Parameters

DescriptorInterface $CommandDescriptor Command descriptor.

Return Value

$this Support chaining.

in AbstractDescriptorHelper at line line 85
DescriptorInterface getOptionDescriptor()

Option descriptor getter.

Return Value

DescriptorInterface

in AbstractDescriptorHelper at line line 99
$this setOptionDescriptor(DescriptorInterface $optionDescriptor)

Option descriptor setter.

Parameters

DescriptorInterface $optionDescriptor Option descriptor.

Return Value

$this Support chaining.

at line line 56
string describe(AbstractCommand $command)

Describe a command detail.

Parameters

AbstractCommand $command The command to described.

Return Value

string Return the described text.

Exceptions

RuntimeException