-
-
Notifications
You must be signed in to change notification settings - Fork 9.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ff4d446
commit 8308aea
Showing
7 changed files
with
182 additions
and
2 deletions.
There are no files selected for viewing
41 changes: 41 additions & 0 deletions
41
src/Symfony/Component/Config/Definition/Builder/EnumNodeDefinition.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
<?php | ||
|
||
namespace Symfony\Component\Config\Definition\Builder; | ||
|
||
use Symfony\Component\Config\Definition\EnumNode; | ||
use Symfony\Component\Config\Definition\Builder\ScalarNodeDefinition; | ||
|
||
/** | ||
* Enum Node Definition. | ||
* | ||
* @author Johannes M. Schmitt <schmittjoh@gmail.com> | ||
*/ | ||
class EnumNodeDefinition extends ScalarNodeDefinition | ||
{ | ||
private $values; | ||
|
||
public function values(array $values) | ||
{ | ||
$values = array_unique($values); | ||
|
||
if (count($values) <= 1) { | ||
throw new \InvalidArgumentException('->values() must be called with at least two distinct values.'); | ||
} | ||
|
||
$this->values = $values; | ||
} | ||
|
||
/** | ||
* Instantiate a Node | ||
* | ||
* @return EnumNode The node | ||
*/ | ||
protected function instantiateNode() | ||
{ | ||
if (null === $this->values) { | ||
throw new \RuntimeException('You must call ->values() on enum nodes.'); | ||
} | ||
|
||
return new EnumNode($this->name, $this->parent, $this->values); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -29,5 +29,4 @@ protected function instantiateNode() | |
{ | ||
return new ScalarNode($this->name, $this->parent); | ||
} | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
<?php | ||
|
||
namespace Symfony\Component\Config\Definition; | ||
|
||
use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException; | ||
use Symfony\Component\Config\Definition\ScalarNode; | ||
|
||
/** | ||
* Node which only allows a finite set of values. | ||
* | ||
* @author Johannes M. Schmitt <schmittjoh@gmail.com> | ||
*/ | ||
class EnumNode extends ScalarNode | ||
{ | ||
private $values; | ||
|
||
public function __construct($name, NodeInterface $parent = null, array $values = array()) | ||
{ | ||
$values = array_unique($values); | ||
if (count($values) <= 1) { | ||
throw new \InvalidArgumentException('$values must contain at least two distinct elements.'); | ||
} | ||
|
||
parent::__construct($name, $parent); | ||
$this->values = $values; | ||
} | ||
|
||
public function getValues() | ||
{ | ||
return $this->values; | ||
} | ||
|
||
protected function finalizeValue($value) | ||
{ | ||
$value = parent::finalizeValue($value); | ||
|
||
if (!in_array($value, $this->values, true)) { | ||
$ex = new InvalidConfigurationException(sprintf( | ||
'The value %s is not allowed for path "%s". Permissible values: %s', | ||
json_encode($value), | ||
$this->getPath(), | ||
implode(', ', array_map('json_encode', $this->values)))); | ||
$ex->setPath($this->getPath()); | ||
|
||
throw $ex; | ||
} | ||
|
||
return $value; | ||
} | ||
} |
37 changes: 37 additions & 0 deletions
37
src/Symfony/Component/Config/Tests/Definition/Builder/EnumNodeDefinitionTest.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
<?php | ||
|
||
namespace Symfony\Component\Config\Tests\Definition\Builder; | ||
|
||
use Symfony\Component\Config\Definition\Builder\EnumNodeDefinition; | ||
|
||
class EnumNodeDefinitionTest extends \PHPUnit_Framework_TestCase | ||
{ | ||
/** | ||
* @expectedException \InvalidArgumentException | ||
* @expectedExceptionMessage ->values() must be called with at least two distinct values. | ||
*/ | ||
public function testNoDistinctValues() | ||
{ | ||
$def = new EnumNodeDefinition('foo'); | ||
$def->values(array('foo', 'foo')); | ||
} | ||
|
||
/** | ||
* @expectedException \RuntimeException | ||
* @expectedExceptionMessage You must call ->values() on enum nodes. | ||
*/ | ||
public function testNoValuesPassed() | ||
{ | ||
$def = new EnumNodeDefinition('foo'); | ||
$def->getNode(); | ||
} | ||
|
||
public function testGetNode() | ||
{ | ||
$def = new EnumNodeDefinition('foo'); | ||
$def->values(array('foo', 'bar')); | ||
|
||
$node = $def->getNode(); | ||
$this->assertEquals(array('foo', 'bar'), $node->getValues()); | ||
} | ||
} |
41 changes: 41 additions & 0 deletions
41
src/Symfony/Component/Config/Tests/Definition/EnumNodeTest.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
<?php | ||
|
||
/* | ||
* This file is part of the Symfony package. | ||
* | ||
* (c) Fabien Potencier <fabien@symfony.com> | ||
* | ||
* For the full copyright and license information, please view the LICENSE | ||
* file that was distributed with this source code. | ||
*/ | ||
|
||
namespace Symfony\Component\Config\Tests\Definition; | ||
|
||
use Symfony\Component\Config\Definition\EnumNode; | ||
|
||
class EnumNodeTest extends \PHPUnit_Framework_TestCase | ||
{ | ||
public function testFinalizeValue() | ||
{ | ||
$node = new EnumNode('foo', null, array('foo', 'bar')); | ||
$this->assertSame('foo', $node->finalize('foo')); | ||
} | ||
|
||
/** | ||
* @expectedException \InvalidArgumentException | ||
*/ | ||
public function testConstructionWithOneValue() | ||
{ | ||
new EnumNode('foo', null, array('foo', 'foo')); | ||
} | ||
|
||
/** | ||
* @expectedException Symfony\Component\Config\Definition\Exception\InvalidConfigurationException | ||
* @expectedExceptionMessage The value "foobar" is not allowed for path "foo". Permissible values: "foo", "bar" | ||
*/ | ||
public function testFinalizeWithInvalidValue() | ||
{ | ||
$node = new EnumNode('foo', null, array('foo', 'bar')); | ||
$node->finalize('foobar'); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters