8000 [FrameworkBundle] remove redundant PHPDoc in console Descriptor by noemi-salaun · Pull Request #36008 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

[FrameworkBundle] remove redundant PHPDoc in console Descriptor #36008

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 12, 2020
Merged

[FrameworkBundle] remove redundant PHPDoc in console Descriptor #36008

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 0 additions & 21 deletions src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/Descriptor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,24 +100,12 @@ protected function write($content, $decorated = false)
$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 = []);

/**
Expand All @@ -138,19 +126,10 @@ abstract protected function describeContainerService($service, array $options =
*/
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 = []);

/**
Expand Down
21 changes: 0 additions & 21 deletions src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/JsonDescriptor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,6 @@
*/
class JsonDescriptor extends Descriptor
{
/**
* {@inheritdoc}
*/
protected function describeRouteCollection(RouteCollection $routes, array $options = [])
{
$data = [];
Expand All @@ -42,25 +39,16 @@ protected function describeRouteCollection(RouteCollection $routes, array $optio
$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'];
Expand Down Expand Up @@ -128,17 +116,11 @@ protected function describeContainerServices(ContainerBuilder $builder, array $o
$this->writeData($data, $options);
}

/**
* {@inheritdoc}
*/
protected function descr 10000 ibeContainerDefinition(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) {
Expand Down Expand Up @@ -169,9 +151,6 @@ protected function describeCallable($callable, array $options = [])
$this->writeData($this->getCallableData($callable), $options);
}

/**
* {@inheritdoc}
*/
protected function describeContainerParameter($parameter, array $options = [])
{
$key = isset($options['parameter']) ? $options['parameter'] : '';
Expand Down
21 changes: 0 additions & 21 deletions src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/MarkdownDescriptor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,6 @@
*/
class MarkdownDescriptor extends Descriptor
{
/**
* {@inheritdoc}
*/
protected function describeRouteCollection(RouteCollection $routes, array $options = [])
{
$first = true;
Expand All @@ -44,9 +41,6 @@ protected function describeRouteCollection(RouteCollection $routes, array $optio
$this->write("\n");
}

/**
* {@inheritdoc}
*/
protected function describeRoute(Route $route, array $options = [])
{
$output = '- Path: '.$route->getPath()
Expand All @@ -66,9 +60,6 @@ protected function describeRoute(Route $route, array $options = [])
$this->write("\n");
}

/**
* {@inheritdoc}
*/
protected function describeContainerParameters(ParameterBag $parameters, array $options = [])
{
$this->write("Container parameters\n====================\n");
Expand All @@ -77,9 +68,6 @@ protected function describeContainerParameters(ParameterBag $parameters, array $
}
}

/**
* {@inheritdoc}
*/
protected function describeContainerTags(ContainerBuilder $builder, array $options = [])
{
$showPrivate = isset($options['show_private']) && $options['show_private'];
Expand Down Expand Up @@ -176,9 +164,6 @@ protected function describeContainerServices(ContainerBuilder $builder, array $o
}
}

/**
* {@inheritdoc}
*/
protected function describeContainerDefinition(Definition $definition, array $options = [])
{
$output = '- Class: `'.$definition->getClass().'`'
Expand Down Expand Up @@ -240,9 +225,6 @@ protected function describeContainerDefinition(Definition $definition, array $op
$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.'`'
Expand All @@ -264,9 +246,6 @@ protected function describeContainerAlias(Alias $alias, array $options = [], Con
$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);
Expand Down
21 changes: 0 additions & 21 deletions src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/TextDescriptor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,6 @@
*/
class TextDescriptor extends Descriptor
{
/**
* {@inheritdoc}
*/
protected function describeRouteCollection(RouteCollection $routes, array $options = [])
{
$showControllers = isset($options['show_controllers']) && $options['show_controllers'];
Expand Down Expand Up @@ -72,9 +69,6 @@ protected function describeRouteCollection(RouteCollection $routes, array $optio
}
}

/**
* {@inheritdoc}
*/
protected function describeRoute(Route $route, array $options = [])
{
$tableHeaders = ['Property', 'Value'];
Expand All @@ -100,9 +94,6 @@ protected function describeRoute(Route $route, array $options = [])
A36C $table->render();
}

/**
* {@inheritdoc}
*/
protected function describeContainerParameters(ParameterBag $parameters, array $options = [])
{
$tableHeaders = ['Parameter', 'Value'];
Expand All @@ -116,9 +107,6 @@ protected function describeContainerParameters(ParameterBag $parameters, array $
$options['output']->table($tableHeaders, $tableRows);
}

/**
* {@inheritdoc}
*/
protected function describeContainerTags(ContainerBuilder $builder, array $options = [])
{
$showPrivate = isset($options['show_private']) && $options['show_private'];
Expand Down Expand Up @@ -252,9 +240,6 @@ protected function describeContainerServices(ContainerBuilder $builder, array $o
$options['output']->table($tableHeaders, $tableRows);
}

/**
* {@inheritdoc}
*/
protected function describeContainerDefinition(Definition $definition, array $options = [])
{
if (isset($options['id'])) {
Expand Down Expand Up @@ -358,9 +343,6 @@ protected function describeContainerDefinition(Definition $definition, array $op
$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 <info>%s</info>', (string) $alias));
Expand All @@ -372,9 +354,6 @@ protected function describeContainerAlias(Alias $alias, array $options = [], Con
$this->describeContainerDefinition($builder->getDefinition((string) $alias), array_merge($options, ['id' => (string) $alias]));
}

/**
* {@inheritdoc}
*/
protected function describeContainerParameter($parameter, array $options = [])
{
$options['output']->table(
Expand Down
21 changes: 0 additions & 21 deletions src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/XmlDescriptor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,33 +29,21 @@
*/
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']));
Expand All @@ -81,17 +69,11 @@ protected function describeContainerServices(ContainerBuilder $builder, array $o
$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');
Expand Down Expand Up @@ -124,9 +106,6 @@ protected function describeCallable($callable, array $options = [])
$this->writeDocument($this->getCallableDocument($callable));
}

/**
* {@inheritdoc}
*/
protected function describeContainerParameter($parameter, array $options = [])
{
$this->writeDocument($this->getContainerParameterDocument($parameter, $options));
Expand Down
0