Skip to content

[FrameworkBundle][Console] Add parameter descriptors #10370

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.

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

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -114,17 +114,6 @@ abstract protected function describeRouteCollection(RouteCollection $routes, arr
*/
abstract protected function describeRoute(Route $route, array $options = array());

/**
* Describes a specific container parameter.
*
* @param mixed $parameterValue
* @param array $options
*/
protected function describeContainerParameter($parameterValue, array $options = array())
{
$this->write($this->formatParameter($parameterValue));
}

/**
* Describes container parameters.
*
Expand Down Expand Up @@ -179,6 +168,14 @@ abstract protected function describeContainerDefinition(Definition $definition,
*/
abstract protected function describeContainerAlias(Alias $alias, array $options = array());

/**
* Describes a container parameter.
*
* @param parameter
* @param array $options
*/
abstract protected function describeContainerParameter($parameter, array $options = array());

/**
* Formats a value as string.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,16 @@ protected function describeContainerAlias(Alias $alias, array $options = array()
$this->writeData($this->getContainerAliasData($alias), $options);
}

/**
* {@inheritdoc}
*/
protected function describeContainerParameter($parameter, array $options = array())
{
$key = isset($options['parameter']) ? $options['parameter'] : '';

$this->writeData(array($key => $this->formatParameter($parameter)), $options);
}

/**
* Writes data as json.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,14 @@ protected function describeContainerAlias(Alias $alias, array $options = array()
$this->write(isset($options['id']) ? sprintf("%s\n%s\n\n%s\n", $options['id'], str_repeat('~', strlen($options['id'])), $output) : $output);
}

/**
* {@inheritdoc}
*/
protected function describeContainerParameter($parameter, array $options = array())
{
$this->write(isset($options['parameter']) ? sprintf("%s\n%s\n\n%s", $options['parameter'], str_repeat('=', strlen($options['parameter'])), $this->formatParameter($parameter)): $parameter);
}

private function formatRouterConfig(array $array)
{
if (!count($array)) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,14 @@ protected function describeContainerAlias(Alias $alias, array $options = array()
$this->writeText(sprintf('This service is an alias for the service <info>%s</info>', (string) $alias), $options);
}

/**
* {@inheritdoc}
*/
protected function describeContainerParameter($parameter, array $options = array())
{
$this->writeText($this->formatParameter($parameter), $options);
}

/**
* @param array $array
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,14 @@ protected function describeContainerAlias(Alias $alias, array $options = array()
$this->writeDocument($this->getContainerAliasDocument($alias, isset($options['id']) ? $options['id'] : null));
}

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

/**
* Writes DOM document.
*
Expand Down Expand Up @@ -365,4 +373,24 @@ private function getContainerAliasDocument(Alias $alias, $id = null)

return $dom;
}

/**
* @param $parameter
* @param array $options
*
* @return \DOMDocument
*/
private function getContainerParameterDocument($parameter, $options = array())
{
$dom = new \DOMDocument('1.0', 'UTF-8');
$dom->appendChild($parameterXML = $dom->createElement('parameter'));

if (isset($options['parameter'])) {
$parameterXML->setAttribute('key', $options['parameter']);
}

$parameterXML->appendChild(new \DOMText($this->formatParameter($parameter)));

return $dom;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,21 @@ public function getDescribeContainerAliasTestData()
return $this->getDescriptionTestData(ObjectsProvider::getContainerAliases());
}

/** @dataProvider getDescribeContainerParameterTestData */
public function testDescribeContainerParameter($parameter, $expectedDescription, array $options)
{
$this->assertDescription($expectedDescription, $parameter, $options);
}

public function getDescribeContainerParameterTestData()
{
$data = $this->getDescriptionTestData(ObjectsProvider::getContainerParameter());

array_push($data[0], array('parameter' => 'database_name'));

return $data;
}

abstract protected function getDescriptor();
abstract protected function getFormat();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,16 @@ public static function getContainerParameters()
);
}

public static function getContainerParameter()
{
$builder = new ContainerBuilder();
$builder->setParameter('database_name', 'symfony');

return array(
'parameter' => $builder
);
}

public static function getContainerBuilders()
{
$builder1 = new ContainerBuilder();
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"database_name": "symfony"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
database_name
=============

symfony
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
symfony
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<?xml version="1.0" encoding="UTF-8"?>
<parameter key="database_name">symfony</parameter>