Skip to content

Added support serialization the nested form errors. #17

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

Merged
merged 2 commits into from
Aug 16, 2011
Merged
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
66 changes: 56 additions & 10 deletions Serializer/Handler/FormErrorHandler.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@

namespace JMS\SerializerBundle\Serializer\Handler;

use Symfony\Component\Form\Form;
use Symfony\Component\Form\FormError;
use Symfony\Component\Translation\TranslatorInterface;
use JMS\SerializerBundle\Serializer\Handler\SerializationHandlerInterface;
Expand All @@ -35,21 +36,66 @@ public function __construct(TranslatorInterface $translator)

public function serialize(VisitorInterface $visitor, $data, $type, &$handled)
{
if (!$data instanceof FormError) {
return;
if ($data instanceof Form) {
$handled = true;

if ($visitor instanceof XmlSerializationVisitor) {
if (null === $visitor->document) {
$visitor->document = $visitor->createDocument(null, null, false);
}

$formNode = $visitor->document->createElement('form');
$formNode->setAttribute('name', $data->getName());

if (null === $visitor->getCurrentNode()) {
$visitor->document->appendChild($formNode);
}
else {
$visitor->getCurrentNode()->appendChild($formNode);
}

// append errors node
$formNode->appendChild($errorsNode = $visitor->document->createElement('errors'));
$visitor->setCurrentNode($errorsNode);
$visitor->visitArray($data->getErrors(), $type);
$visitor->revertCurrentNode();

if ($data->hasChildren()) {
$visitor->setCurrentNode($formNode);

foreach ($data->getChildren() as $child) {
$this->serialize($visitor, $child, $type, $visited);
}

$visitor->revertCurrentNode();
}

return $formNode;
}
else {
$form = array('errors' => $data->getErrors());
if ($data->hasChildren()) {
$form['children'] = $data->getChildren();
}

return $visitor->visitArray($form, $type);
}
}
else if ($data instanceof FormError) {
$handled = true;
$message = $this->translator->trans($data->getMessageTemplate(), $data->getMessageParameters(), 'validators');

$handled = true;
$message = $this->translator->trans($data->getMessageTemplate(), $data->getMessageParameters(), 'validators');
if ($visitor instanceof XmlSerializationVisitor) {
if (null === $visitor->document) {
$visitor->document = $visitor->createDocument(null, null, true);
}

if ($visitor instanceof XmlSerializationVisitor) {
if (null === $visitor->document) {
$visitor->document = $visitor->createDocument(null, null, true);
return $visitor->document->createCDATASection($message);
}

return $visitor->document->createCDATASection($message);
return $message;
}

return $message;
return null;
}
}
}
15 changes: 15 additions & 0 deletions Tests/Serializer/BaseSerializationTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
namespace JMS\SerializerBundle\Tests\Serializer;

use Doctrine\Common\Collections\ArrayCollection;
use Symfony\Component\Form\Form;
use Symfony\Component\Form\FormError;
use JMS\SerializerBundle\Serializer\Handler\DeserializationHandlerInterface;
use JMS\SerializerBundle\Tests\Fixtures\AuthorList;
Expand Down Expand Up @@ -199,6 +200,20 @@ public function testFormErrors()
$this->assertEquals($this->getContent('form_errors'), $this->serialize($errors));
}

public function testNestedFormErrors()
{
$dispather = $this->getMock('Symfony\Component\EventDispatcher\EventDispatcherInterface');

$form = new Form('foo', $dispather);
$form->addError(new FormError('This is the form error'));

$child = new Form('bar', $dispather);
$child->addError(new FormError('Error of the child form'));
$form->add($child);

$this->assertEquals($this->getContent('nested_form_errors'), $this->serialize($form));
}

abstract protected function getContent($key);
abstract protected function getFormat();

Expand Down
1 change: 1 addition & 0 deletions Tests/Serializer/JsonSerializationTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ protected function getContent($key)
$outputs['log'] = '{"author_list":[{"full_name":"Johannes Schmitt"},{"full_name":"John Doe"}],"comments":[{"author":{"full_name":"Foo Bar"},"text":"foo"},{"author":{"full_name":"Foo Bar"},"text":"bar"},{"author":{"full_name":"Foo Bar"},"text":"baz"}]}';
$outputs['lifecycle_callbacks'] = '{"name":"Foo Bar"}';
$outputs['form_errors'] = '["This is the form error","Another error"]';
$outputs['nested_form_errors'] = '{"errors":["This is the form error"],"children":{"bar":{"errors":["Error of the child form"]}}}';
}

if (!isset($outputs[$key])) {
Expand Down
11 changes: 11 additions & 0 deletions Tests/Serializer/xml/nested_form_errors.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<form name="foo">
<errors>
<entry><![CDATA[This is the form error]]></entry>
</errors>
<form name="bar">
<errors>
<entry><![CDATA[Error of the child form]]></entry>
</errors>
</form>
</form>