JsonDescriptor
class JsonDescriptor extends Descriptor
Properties
| protected OutputInterface | $output | from Descriptor |
Methods
| describe(OutputInterface $output, object $object, array $options = array()) Describes an object if supported. | from Descriptor | |
| OutputInterface | getOutput() Returns the output. | from Descriptor |
| write(string $content, bool $decorated = false) Writes content to output. | from Descriptor | |
| describeRouteCollection(RouteCollection $routes, array $options = array()) Describes an InputArgument instance. | ||
| describeRoute(Route $route, array $options = array()) Describes an InputOption instance. | ||
| describeContainerParameters(ParameterBag $parameters, array $options = array()) Describes container parameters. | ||
| describeContainerTags(ContainerBuilder $builder, array $options = array()) Describes container tags. | ||
| describeContainerService(Definition|Alias|object $service, array $options = array(), ContainerBuilder $builder = null) Describes a container service by its name. | ||
| describeContainerServices(ContainerBuilder $builder, array $options = array()) Describes container services. | ||
| describeContainerDefinition(Definition $definition, array $options = array()) Describes a service definition. | ||
| describeContainerAlias(Alias $alias, array $options = array(), ContainerBuilder $builder = null) Describes a service alias. | ||
| describeContainerParameter($parameter, array $options = array()) Describes a container parameter. | ||
| describeEventDispatcherListeners(EventDispatcherInterface $eventDispatcher, array $options = array()) Describes event dispatcher listeners. | ||
| describeCallable(callable $callable, array $options = array()) Describes a callable. | ||
| string | formatValue(mixed $value) Formats a value as string. | from Descriptor |
| string | formatParameter(mixed $value) Formats a parameter. | from Descriptor |
| mixed | resolveServiceDefinition(ContainerBuilder $builder, string $serviceId) | from Descriptor |
| array | findDefinitionsByTag(ContainerBuilder $builder, bool $showHidden) | from Descriptor |
| sortParameters(ParameterBag $parameters) | from Descriptor | |
| sortServiceIds(array $serviceIds) | from Descriptor | |
| array | getRouteData(Route $route) |
Details
describe(OutputInterface $output, object $object, array $options = array())
Describes an object if supported.
Parameters
| OutputInterface | $output | |
| object | $object | |
| array | $options |
protected OutputInterface getOutput()
Returns the output.
Return Value
| OutputInterface | The output |
protected write(string $content, bool $decorated = false)
Writes content to output.
Parameters
| string | $content | |
| bool | $decorated |
protected describeRouteCollection(RouteCollection $routes, array $options = array())
Describes an InputArgument instance.
Parameters
| RouteCollection | $routes | |
| array | $options |
protected describeRoute(Route $route, array $options = array())
Describes an InputOption instance.
Parameters
| Route | $route | |
| array | $options |
protected describeContainerParameters(ParameterBag $parameters, array $options = array())
Describes container parameters.
Parameters
| ParameterBag | $parameters | |
| array | $options |
protected describeContainerTags(ContainerBuilder $builder, array $options = array())
Describes container tags.
Parameters
| ContainerBuilder | $builder | |
| array | $options |
protected describeContainerService(Definition|Alias|object $service, array $options = array(), 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 |
protected describeContainerServices(ContainerBuilder $builder, array $options = array())
Describes container services.
Common options are: * tag: filters described services by given tag
Parameters
| ContainerBuilder | $builder | |
| array | $options |
protected describeContainerDefinition(Definition $definition, array $options = array())
Describes a service definition.
Parameters
| Definition | $definition | |
| array | $options |
protected describeContainerAlias(Alias $alias, array $options = array(), ContainerBuilder $builder = null)
Describes a service alias.
Parameters
| Alias | $alias | |
| array | $options | |
| ContainerBuilder | $builder |
protected describeContainerParameter($parameter, array $options = array())
Describes a container parameter.
Parameters
| $parameter | ||
| array | $options |
protected describeEventDispatcherListeners(EventDispatcherInterface $eventDispatcher, array $options = array())
Describes event dispatcher listeners.
Common options are: * name: name of listened event
Parameters
| EventDispatcherInterface | $eventDispatcher | |
| array | $options |
protected describeCallable(callable $callable, array $options = array())
Describes a callable.
Parameters
| callable | $callable | |
| array | $options |
protected string formatValue(mixed $value)
Formats a value as string.
Parameters
| mixed | $value |
Return Value
| string |
protected string formatParameter(mixed $value)
Formats a parameter.
Parameters
| mixed | $value |
Return Value
| string |
protected mixed resolveServiceDefinition(ContainerBuilder $builder, string $serviceId)
Parameters
| ContainerBuilder | $builder | |
| string | $serviceId |
Return Value
| mixed |
protected array findDefinitionsByTag(ContainerBuilder $builder, bool $showHidden)
Parameters
| ContainerBuilder | $builder | |
| bool | $showHidden |
Return Value
| array |
protected sortParameters(ParameterBag $parameters)
Parameters
| ParameterBag | $parameters |
protected sortServiceIds(array $serviceIds)
Parameters
| array | $serviceIds |
protected array getRouteData(Route $route)
Parameters
| Route | $route |
Return Value
| array |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Bundle/FrameworkBundle/Console/Descriptor/JsonDescriptor.html