Skip to content

Commit

Permalink
Merge branch '3.4' into 4.4
Browse files Browse the repository at this point in the history 
* 3.4:
  [FrameworkBundle] remove redundant PHPDoc in console Descriptor and subclass
  [Form] Handle false as empty value on expanded choices
  • Loading branch information
@nicolas-grekas
nicolas-grekas committed Mar 12, 2020
2 parents 741b249 + aaddef3 commit c3eb70d
Show file tree
Hide file tree
Showing 9 changed files with 54 additions and 178 deletions.
27 changes: 0 additions & 27 deletions src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/Descriptor.php
View file
Expand Up @@ -94,24 +94,12 @@ protected function write(string $content, bool $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 @@ -132,24 +120,12 @@ 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 = []);

/**
* Describes container environment variables.
*/
abstract protected function describeContainerEnvVars(array $envs, array $options = []);

/**
Expand Down Expand Up @@ -305,9 +281,6 @@ protected function sortByPriority(array $tag): array
return $tag;
}

/**
* Gets class description from a docblock.
*/
public static function getClassDescription(string $class, string &$resolvedClass = null): string
{
$resolvedClass = $class;
Expand Down
39 changes: 0 additions & 39 deletions src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/JsonDescriptor.php
View file
Expand Up @@ -30,9 +30,6 @@
*/
class JsonDescriptor extends Descriptor
{
/**
* {@inheritdoc}
*/
protected function describeRouteCollection(RouteCollection $routes, array $options = [])
{
$data = [];
Expand All @@ -43,25 +40,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 = [])
{
$showHidden = isset($options['show_hidden']) && $options['show_hidden'];
Expand All @@ -77,9 +65,6 @@ protected function describeContainerTags(ContainerBuilder $builder, array $optio
$this->writeData($data, $options);
}

/**
* {@inheritdoc}
*/
protected function describeContainerService($service, array $options = [], ContainerBuilder $builder = null)
{
if (!isset($options['id'])) {
Expand All @@ -95,9 +80,6 @@ protected function describeContainerService($service, array $options = [], Conta
}
}

/**
* {@inheritdoc}
*/
protected function describeContainerServices(ContainerBuilder $builder, array $options = [])
{
$serviceIds = isset($options['tag']) && $options['tag']
Expand Down Expand Up @@ -131,17 +113,11 @@ protected function describeContainerServices(ContainerBuilder $builder, array $o
$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) {
Expand All @@ -156,43 +132,28 @@ protected function describeContainerAlias(Alias $alias, array $options = [], Con
);
}

/**
* {@inheritdoc}
*/
protected function describeEventDispatcherListeners(EventDispatcherInterface $eventDispatcher, array $options = [])
{
$this->writeData($this->getEventDispatcherListenersData($eventDispatcher, \array_key_exists('event', $options) ? $options['event'] : null), $options);
}

/**
* {@inheritdoc}
*/
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'] : '';

$this->writeData([$key => $parameter], $options);
}

/**
* {@inheritdoc}
*/
protected function describeContainerEnvVars(array $envs, array $options = [])
{
throw new LogicException('Using the JSON format to debug environment variables is not supported.');
}

/**
* Writes data as json.
*/
private function writeData(array $data, array $options)
{
$flags = isset($options['json_encoding']) ? $options['json_encoding'] : 0;
Expand Down
36 changes: 0 additions & 36 deletions src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/MarkdownDescriptor.php
View file
Expand Up @@ -28,9 +28,6 @@
*/
class MarkdownDescriptor extends Descriptor
{
/**
* {@inheritdoc}
*/
protected function describeRouteCollection(RouteCollection $routes, array $options = [])
{
$first = true;
Expand All @@ -45,9 +42,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 @@ -71,9 +65,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 @@ -82,9 +73,6 @@ protected function describeContainerParameters(ParameterBag $parameters, array $
}
}

/**
* {@inheritdoc}
*/
protected function describeContainerTags(ContainerBuilder $builder, array $options = [])
{
$showHidden = isset($options['show_hidden']) && $options['show_hidden'];
Expand All @@ -99,9 +87,6 @@ protected function describeContainerTags(ContainerBuilder $builder, array $optio
}
}

/**
* {@inheritdoc}
*/
protected function describeContainerService($service, array $options = [], ContainerBuilder $builder = null)
{
if (!isset($options['id'])) {
Expand All @@ -119,9 +104,6 @@ protected function describeContainerService($service, array $options = [], Conta
}
}

/**
* {@inheritdoc}
*/
protected function describeContainerServices(ContainerBuilder $builder, array $options = [])
{
$showHidden = isset($options['show_hidden']) && $options['show_hidden'];
Expand Down Expand Up @@ -183,9 +165,6 @@ protected function describeContainerServices(ContainerBuilder $builder, array $o
}
}

/**
* {@inheritdoc}
*/
protected function describeContainerDefinition(Definition $definition, array $options = [])
{
$output = '';
Expand Down Expand Up @@ -246,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 @@ -270,25 +246,16 @@ 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);
}

/**
* {@inheritdoc}
*/
protected function describeContainerEnvVars(array $envs, array $options = [])
{
throw new LogicException('Using the markdown format to debug environment variables is not supported.');
}

/**
* {@inheritdoc}
*/
protected function describeEventDispatcherListeners(EventDispatcherInterface $eventDispatcher, array $options = [])
{
$event = \array_key_exists('event', $options) ? $options['event'] : null;
Expand Down Expand Up @@ -322,9 +289,6 @@ protected function describeEventDispatcherListeners(EventDispatcherInterface $ev
}
}

/**
* {@inheritdoc}
*/
protected function describeCallable($callable, array $options = [])
{
$string = '';
Expand Down

0 comments on commit c3eb70d

Please sign in to comment.