class MarkdownDescriptor extends Descriptor

Properties

protected OutputInterface $output from Descriptor

Methods

describe(OutputInterface $output, object $object, array $options = [])

Describes an object if supported.

getOutput()

Returns the output.

write(string $content, bool $decorated = false)

Writes content to output.

describeRouteCollection(RouteCollection $routes, array $options = [])

Describes an InputArgument instance.

describeRoute(Route $route, array $options = [])

Describes an InputOption instance.

describeContainerParameters(ParameterBag $parameters, array $options = [])

Describes container parameters.

describeContainerTags(ContainerBuilder $builder, array $options = [])

Describes container tags.

describeContainerService(Definition|Alias|object $service, array $options = [], ContainerBuilder $builder = null)

Describes a container service by its name.

describeContainerServices(ContainerBuilder $builder, array $options = [])

Describes container services.

describeContainerDefinition(Definition $definition, array $options = [])

Describes a service definition.

describeContainerAlias(Alias $alias, array $options = [], ContainerBuilder $builder = null)

Describes a service alias.

describeContainerParameter($parameter, array $options = [])

Describes a container parameter.

describeEventDispatcherListeners(EventDispatcherInterface $eventDispatcher, array $options = [])

Describes event dispatcher listeners.

describeCallable(callable $callable, array $options = [])

Describes a callable.

string
formatValue(mixed $value)

Formats a value as string.

string
formatParameter(mixed $value)

Formats a parameter.

mixed
resolveServiceDefinition(ContainerBuilder $builder, string $serviceId)

No description

array
findDefinitionsByTag(ContainerBuilder $builder, bool $showHidden)

No description

sortParameters(ParameterBag $parameters)

No description

sortServiceIds(array $serviceIds)

No description

static string
getClassDescription(string $class, string $resolvedClass = null)

Gets class description from a docblock.

Details

in Descriptor at line 41
describe(OutputInterface $output, object $object, array $options = [])

Describes an object if supported.

Parameters

OutputInterface $output
object $object
array $options

in Descriptor at line 89
protected OutputInterface getOutput()

Returns the output.

Return Value

OutputInterface The output

in Descriptor at line 100
protected write(string $content, bool $decorated = false)

Writes content to output.

Parameters

string $content
bool $decorated

at line 33
protected describeRouteCollection(RouteCollection $routes, array $options = [])

Describes an InputArgument instance.

Parameters

RouteCollection $routes
array $options

at line 50
protected describeRoute(Route $route, array $options = [])

Describes an InputOption instance.

Parameters

Route $route
array $options

at line 76
protected describeContainerParameters(ParameterBag $parameters, array $options = [])

Describes container parameters.

Parameters

ParameterBag $parameters
array $options

at line 87
protected describeContainerTags(ContainerBuilder $builder, array $options = [])

Describes container tags.

Parameters

ContainerBuilder $builder
array $options

at line 104
protected describeContainerService(Definition|Alias|object $service, array $options = [], ContainerBuilder $builder = null)

Describes a container service by its name.

Common options are: * name: name of described service

Parameters

Definition|Alias|object $service
array $options
ContainerBuilder $builder

at line 124
protected describeContainerServices(ContainerBuilder $builder, array $options = [])

Describes container services.

Common options are: * tag: filters described services by given tag

Parameters

ContainerBuilder $builder
array $options

at line 186
protected describeContainerDefinition(Definition $definition, array $options = [])

Describes a service definition.

Parameters

Definition $definition
array $options

at line 249
protected describeContainerAlias(Alias $alias, array $options = [], ContainerBuilder $builder = null)

Describes a service alias.

Parameters

Alias $alias
array $options
ContainerBuilder $builder

at line 271
protected describeContainerParameter($parameter, array $options = [])

Describes a container parameter.

Parameters

$parameter
array $options

at line 279
protected describeEventDispatcherListeners(EventDispatcherInterface $eventDispatcher, array $options = [])

Describes event dispatcher listeners.

Common options are: * name: name of listened event

Parameters

EventDispatcherInterface $eventDispatcher
array $options

at line 315
protected describeCallable(callable $callable, array $options = [])

Describes a callable.

Parameters

callable $callable
array $options

in Descriptor at line 183
protected string formatValue(mixed $value)

Formats a value as string.

Parameters

mixed $value

Return Value

string

in Descriptor at line 203
protected string formatParameter(mixed $value)

Formats a parameter.

Parameters

mixed $value

Return Value

string

in Descriptor at line 224
protected mixed resolveServiceDefinition(ContainerBuilder $builder, string $serviceId)

Parameters

ContainerBuilder $builder
string $serviceId

Return Value

mixed

in Descriptor at line 249
protected array findDefinitionsByTag(ContainerBuilder $builder, bool $showHidden)

Parameters

ContainerBuilder $builder
bool $showHidden

Return Value

array

in Descriptor at line 274
protected sortParameters(ParameterBag $parameters)

Parameters

ParameterBag $parameters

in Descriptor at line 282
protected sortServiceIds(array $serviceIds)

Parameters

array $serviceIds

in Descriptor at line 292
static string getClassDescription(string $class, string $resolvedClass = null)

Gets class description from a docblock.

Parameters

string $class
string $resolvedClass

Return Value

string