Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
feature #19326 [Serializer][FrameworkBundle] Add a YAML encoder (dung…
…las) This PR was squashed before being merged into the 3.2-dev branch (closes #19326). Discussion ---------- [Serializer][FrameworkBundle] Add a YAML encoder | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | todo Add YAML support to the Serializer. Commits ------- 9366a7d [Serializer][FrameworkBundle] Add a YAML encoder
- Loading branch information
Showing
4 changed files
with
152 additions
and
2 deletions.
There are no files selected for viewing
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 |
---|---|---|
@@ -0,0 +1,73 @@ | ||
<?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\Serializer\Encoder; | ||
|
||
use Symfony\Component\Yaml\Dumper; | ||
use Symfony\Component\Yaml\Parser; | ||
use Symfony\Component\Yaml\Yaml; | ||
|
||
/** | ||
* Encodes YAML data. | ||
* | ||
* @author Kévin Dunglas <dunglas@gmail.com> | ||
*/ | ||
class YamlEncoder implements EncoderInterface, DecoderInterface | ||
{ | ||
const FORMAT = 'yaml'; | ||
|
||
private $dumper; | ||
private $parser; | ||
private $defaultContext = array('yaml_inline' => 0, 'yaml_indent' => 0, 'yaml_flags' => 0); | ||
|
||
public function __construct(Dumper $dumper = null, Parser $parser = null, array $defaultContext = array()) | ||
{ | ||
$this->dumper = $dumper ?: new Dumper(); | ||
$this->parser = $parser ?: new Parser(); | ||
$this->defaultContext = array_merge($this->defaultContext, $defaultContext); | ||
} | ||
|
||
/** | ||
* {@inheritdoc} | ||
*/ | ||
public function encode($data, $format, array $context = array()) | ||
{ | ||
$context = array_merge($this->defaultContext, $context); | ||
|
||
return $this->dumper->dump($data, $context['yaml_inline'], $context['yaml_indent'], $context['yaml_flags']); | ||
} | ||
|
||
/** | ||
* {@inheritdoc} | ||
*/ | ||
public function supportsEncoding($format) | ||
{ | ||
return self::FORMAT === $format; | ||
} | ||
|
||
/** | ||
* {@inheritdoc} | ||
*/ | ||
public function decode($data, $format, array $context = array()) | ||
{ | ||
$context = array_merge($this->defaultContext, $context); | ||
|
||
return Yaml::parse($data, $context['yaml_flags']); | ||
} | ||
|
||
/** | ||
* {@inheritdoc} | ||
*/ | ||
public function supportsDecoding($format) | ||
{ | ||
return self::FORMAT === $format; | ||
} | ||
} |
68 changes: 68 additions & 0 deletions
68
src/Symfony/Component/Serializer/Tests/Encoder/YamlEncoderTest.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,68 @@ | ||
<?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\Serializer\Tests\Encoder; | ||
|
||
use Symfony\Component\Serializer\Encoder\YamlEncoder; | ||
use Symfony\Component\Yaml\Dumper; | ||
use Symfony\Component\Yaml\Parser; | ||
use Symfony\Component\Yaml\Yaml; | ||
|
||
/** | ||
* @author Kévin Dunglas <dunglas@gmail.com> | ||
*/ | ||
class YamlEncoderTest extends \PHPUnit_Framework_TestCase | ||
{ | ||
public function testEncode() | ||
{ | ||
$encoder = new YamlEncoder(); | ||
|
||
$this->assertEquals('foo', $encoder->encode('foo', 'yaml')); | ||
$this->assertEquals('{ foo: 1 }', $encoder->encode(array('foo' => 1), 'yaml')); | ||
} | ||
|
||
public function testSupportsEncoding() | ||
{ | ||
$encoder = new YamlEncoder(); | ||
|
||
$this->assertTrue($encoder->supportsEncoding('yaml')); | ||
$this->assertFalse($encoder->supportsEncoding('json')); | ||
} | ||
|
||
public function testDecode() | ||
{ | ||
$encoder = new YamlEncoder(); | ||
|
||
$this->assertEquals('foo', $encoder->decode('foo', 'yaml')); | ||
$this->assertEquals(array('foo' => 1), $encoder->decode('{ foo: 1 }', 'yaml')); | ||
} | ||
|
||
public function testSupportsDecoding() | ||
{ | ||
$encoder = new YamlEncoder(); | ||
|
||
$this->assertTrue($encoder->supportsDecoding('yaml')); | ||
$this->assertFalse($encoder->supportsDecoding('json')); | ||
} | ||
|
||
public function testContext() | ||
{ | ||
$encoder = new YamlEncoder(new Dumper(), new Parser(), array('yaml_inline' => 1, 'yaml_indent' => 4, 'yaml_flags' => Yaml::DUMP_OBJECT | Yaml::PARSE_OBJECT)); | ||
|
||
$obj = new \stdClass(); | ||
$obj->bar = 2; | ||
|
||
$this->assertEquals(" foo: !php/object:O:8:\"stdClass\":1:{s:3:\"bar\";i:2;}\n", $encoder->encode(array('foo' => $obj), 'yaml')); | ||
$this->assertEquals(' { foo: null }', $encoder->encode(array('foo' => $obj), 'yaml', array('yaml_inline' => 0, 'yaml_indent' => 2, 'yaml_flags' => 0))); | ||
$this->assertEquals(array('foo' => $obj), $encoder->decode('foo: !php/object:O:8:"stdClass":1:{s:3:"bar";i:2;}', 'yaml')); | ||
$this->assertEquals(array('foo' => null), $encoder->decode('foo: !php/object:O:8:"stdClass":1:{s:3:"bar";i:2;}', 'yaml', array('yaml_flags' => 0))); | ||
} | ||
} |
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