From e535e7d2ff922f1f010a96f5b43570778790e726 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?No=C3=A9mi=20Sala=C3=BCn?= Date: Mon, 9 Mar 2020 19:12:25 +0100 Subject: [PATCH] [FrameworkBundle] remove redundant PHPDoc in console Descriptor and subclass The PHPDoc for some describeXXX methods in the abstract Descriptor was inacurate or redundant. --- .../Console/Descriptor/Descriptor.php | 21 ------------------- .../Console/Descriptor/JsonDescriptor.php | 21 ------------------- .../Console/Descriptor/MarkdownDescriptor.php | 21 ------------------- .../Console/Descriptor/TextDescriptor.php | 21 ------------------- .../Console/Descriptor/XmlDescriptor.php | 21 ------------------- 5 files changed, 105 deletions(-) diff --git a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/Descriptor.php b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/Descriptor.php index 23d9ccc777..a28ca356d8 100644 --- a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/Descriptor.php +++ b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/Descriptor.php @@ -100,24 +100,12 @@ abstract class Descriptor implements DescriptorInterface $this->output->write($content, false, $decorated ? OutputInterface::OUTPUT_NORMAL : OutputInterface::OUTPUT_RAW); } - /** - * Describes an InputArgument instance. - */ abstract protected function describeRouteCollection(RouteCollection $routes, array $options = []); - /** - * Describes an InputOption instance. - */ abstract protected function describeRoute(Route $route, array $options = []); - /** - * Describes container parameters. - */ abstract protected function describeContainerParameters(ParameterBag $parameters, array $options = []); - /** - * Describes container tags. - */ abstract protected function describeContainerTags(ContainerBuilder $builder, array $options = []); /** @@ -138,19 +126,10 @@ abstract class Descriptor implements DescriptorInterface */ abstract protected function describeContainerServices(ContainerBuilder $builder, array $options = []); - /** - * Describes a service definition. - */ abstract protected function describeContainerDefinition(Definition $definition, array $options = []); - /** - * Describes a service alias. - */ abstract protected function describeContainerAlias(Alias $alias, array $options = [], ContainerBuilder $builder = null); - /** - * Describes a container parameter. - */ abstract protected function describeContainerParameter($parameter, array $options = []); /** diff --git a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/JsonDescriptor.php b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/JsonDescriptor.php index 197db657f0..74d9b0c61a 100644 --- a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/JsonDescriptor.php +++ b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/JsonDescriptor.php @@ -29,9 +29,6 @@ use Symfony\Component\Routing\RouteCollection; */ class JsonDescriptor extends Descriptor { - /** - * {@inheritdoc} - */ protected function describeRouteCollection(RouteCollection $routes, array $options = []) { $data = []; @@ -42,25 +39,16 @@ class JsonDescriptor extends Descriptor $this->writeData($data, $options); } - /** - * {@inheritdoc} - */ protected function describeRoute(Route $route, array $options = []) { $this->writeData($this->getRouteData($route), $options); } - /** - * {@inheritdoc} - */ protected function describeContainerParameters(ParameterBag $parameters, array $options = []) { $this->writeData($this->sortParameters($parameters), $options); } - /** - * {@inheritdoc} - */ protected function describeContainerTags(ContainerBuilder $builder, array $options = []) { $showPrivate = isset($options['show_private']) && $options['show_private']; @@ -128,17 +116,11 @@ class JsonDescriptor extends Descriptor $this->writeData($data, $options); } - /** - * {@inheritdoc} - */ protected function describeContainerDefinition(Definition $definition, array $options = []) { $this->writeData($this->getContainerDefinitionData($definition, isset($options['omit_tags']) && $options['omit_tags'], isset($options['show_arguments']) && $options['show_arguments']), $options); } - /** - * {@inheritdoc} - */ protected function describeContainerAlias(Alias $alias, array $options = [], ContainerBuilder $builder = null) { if (!$builder) { @@ -169,9 +151,6 @@ class JsonDescriptor extends Descriptor $this->writeData($this->getCallableData($callable), $options); } - /** - * {@inheritdoc} - */ protected function describeContainerParameter($parameter, array $options = []) { $key = isset($options['parameter']) ? $options['parameter'] : ''; diff --git a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/MarkdownDescriptor.php b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/MarkdownDescriptor.php index 2c31bdc19d..5ebaed0248 100644 --- a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/MarkdownDescriptor.php +++ b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/MarkdownDescriptor.php @@ -27,9 +27,6 @@ use Symfony\Component\Routing\RouteCollection; */ class MarkdownDescriptor extends Descriptor { - /** - * {@inheritdoc} - */ protected function describeRouteCollection(RouteCollection $routes, array $options = []) { $first = true; @@ -44,9 +41,6 @@ class MarkdownDescriptor extends Descriptor $this->write("\n"); } - /** - * {@inheritdoc} - */ protected function describeRoute(Route $route, array $options = []) { $output = '- Path: '.$route->getPath() @@ -66,9 +60,6 @@ class MarkdownDescriptor extends Descriptor $this->write("\n"); } - /** - * {@inheritdoc} - */ protected function describeContainerParameters(ParameterBag $parameters, array $options = []) { $this->write("Container parameters\n====================\n"); @@ -77,9 +68,6 @@ class MarkdownDescriptor extends Descriptor } } - /** - * {@inheritdoc} - */ protected function describeContainerTags(ContainerBuilder $builder, array $options = []) { $showPrivate = isset($options['show_private']) && $options['show_private']; @@ -176,9 +164,6 @@ class MarkdownDescriptor extends Descriptor } } - /** - * {@inheritdoc} - */ protected function describeContainerDefinition(Definition $definition, array $options = []) { $output = '- Class: `'.$definition->getClass().'`' @@ -240,9 +225,6 @@ class MarkdownDescriptor extends Descriptor $this->write(isset($options['id']) ? sprintf("### %s\n\n%s\n", $options['id'], $output) : $output); } - /** - * {@inheritdoc} - */ protected function describeContainerAlias(Alias $alias, array $options = [], ContainerBuilder $builder = null) { $output = '- Service: `'.$alias.'`' @@ -264,9 +246,6 @@ class MarkdownDescriptor extends Descriptor $this->describeContainerDefinition($builder->getDefinition((string) $alias), array_merge($options, ['id' => (string) $alias])); } - /** - * {@inheritdoc} - */ protected function describeContainerParameter($parameter, array $options = []) { $this->write(isset($options['parameter']) ? sprintf("%s\n%s\n\n%s", $options['parameter'], str_repeat('=', \strlen($options['parameter'])), $this->formatParameter($parameter)) : $parameter); diff --git a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/TextDescriptor.php b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/TextDescriptor.php index f17a1bba21..a32a2128e2 100644 --- a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/TextDescriptor.php +++ b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/TextDescriptor.php @@ -33,9 +33,6 @@ use Symfony\Component\Routing\RouteCollection; */ class TextDescriptor extends Descriptor { - /** - * {@inheritdoc} - */ protected function describeRouteCollection(RouteCollection $routes, array $options = []) { $showControllers = isset($options['show_controllers']) && $options['show_controllers']; @@ -72,9 +69,6 @@ class TextDescriptor extends Descriptor } } - /** - * {@inheritdoc} - */ protected function describeRoute(Route $route, array $options = []) { $tableHeaders = ['Property', 'Value']; @@ -100,9 +94,6 @@ class TextDescriptor extends Descriptor $table->render(); } - /** - * {@inheritdoc} - */ protected function describeContainerParameters(ParameterBag $parameters, array $options = []) { $tableHeaders = ['Parameter', 'Value']; @@ -116,9 +107,6 @@ class TextDescriptor extends Descriptor $options['output']->table($tableHeaders, $tableRows); } - /** - * {@inheritdoc} - */ protected function describeContainerTags(ContainerBuilder $builder, array $options = []) { $showPrivate = isset($options['show_private']) && $options['show_private']; @@ -252,9 +240,6 @@ class TextDescriptor extends Descriptor $options['output']->table($tableHeaders, $tableRows); } - /** - * {@inheritdoc} - */ protected function describeContainerDefinition(Definition $definition, array $options = []) { if (isset($options['id'])) { @@ -358,9 +343,6 @@ class TextDescriptor extends Descriptor $options['output']->table($tableHeaders, $tableRows); } - /** - * {@inheritdoc} - */ protected function describeContainerAlias(Alias $alias, array $options = [], ContainerBuilder $builder = null) { $options['output']->comment(sprintf('This service is an alias for the service %s', (string) $alias)); @@ -372,9 +354,6 @@ class TextDescriptor extends Descriptor $this->describeContainerDefinition($builder->getDefinition((string) $alias), array_merge($options, ['id' => (string) $alias])); } - /** - * {@inheritdoc} - */ protected function describeContainerParameter($parameter, array $options = []) { $options['output']->table( diff --git a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/XmlDescriptor.php b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/XmlDescriptor.php index 96b9a261ae..996ac11c7b 100644 --- a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/XmlDescriptor.php +++ b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/XmlDescriptor.php @@ -29,33 +29,21 @@ use Symfony\Component\Routing\RouteCollection; */ class XmlDescriptor extends Descriptor { - /** - * {@inheritdoc} - */ protected function describeRouteCollection(RouteCollection $routes, array $options = []) { $this->writeDocument($this->getRouteCollectionDocument($routes)); } - /** - * {@inheritdoc} - */ protected function describeRoute(Route $route, array $options = []) { $this->writeDocument($this->getRouteDocument($route, isset($options['name']) ? $options['name'] : null)); } - /** - * {@inheritdoc} - */ protected function describeContainerParameters(ParameterBag $parameters, array $options = []) { $this->writeDocument($this->getContainerParametersDocument($parameters)); } - /** - * {@inheritdoc} - */ protected function describeContainerTags(ContainerBuilder $builder, array $options = []) { $this->writeDocument($this->getContainerTagsDocument($builder, isset($options['show_private']) && $options['show_private'])); @@ -81,17 +69,11 @@ class XmlDescriptor extends Descriptor $this->writeDocument($this->getContainerServicesDocument($builder, isset($options['tag']) ? $options['tag'] : null, isset($options['show_private']) && $options['show_private'], isset($options['show_arguments']) && $options['show_arguments'], isset($options['filter']) ? $options['filter'] : null)); } - /** - * {@inheritdoc} - */ protected function describeContainerDefinition(Definition $definition, array $options = []) { $this->writeDocument($this->getContainerDefinitionDocument($definition, isset($options['id']) ? $options['id'] : null, isset($options['omit_tags']) && $options['omit_tags'], isset($options['show_arguments']) && $options['show_arguments'])); } - /** - * {@inheritdoc} - */ protected function describeContainerAlias(Alias $alias, array $options = [], ContainerBuilder $builder = null) { $dom = new \DOMDocument('1.0', 'UTF-8'); @@ -124,9 +106,6 @@ class XmlDescriptor extends Descriptor $this->writeDocument($this->getCallableDocument($callable)); } - /** - * {@inheritdoc} - */ protected function describeContainerParameter($parameter, array $options = []) { $this->writeDocument($this->getContainerParameterDocument($parameter, $options));