Skip to content

[Form] Add default transformer to TextType field (and related) #2421

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.

Sign up for GitHub

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 1 commit into from
Dec 21, 2011
Merged

[Form] Add default transformer to TextType field (and related) #2421

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
67 changes: 67 additions & 0 deletions src/Symfony/Component/Form/Extension/Core/DataTransformer/ValueToStringTransformer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
<?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\Form\Extension\Core\DataTransformer;

use Symfony\Component\Form\DataTransformerInterface;
use Symfony\Component\Form\Exception\UnexpectedTypeException;

/**
* Transforms between a given value and a string.
*
* @author Joseph Bielawski <stloyd@gmail.com>
*/
class ValueToStringTransformer implements DataTransformerInterface
{
/**
* Transforms a value into a string.
*
* @param mixed $value Mixed value.
*
* @return string String value.
*
* @throws UnexpectedTypeException if the given value is not a string or number
*/
public function transform($value)
{
if (null === $value) {
return '';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't know if that's expected, but there is a little behavior change here.

Before adding this data transformer, empty strings were converted to NULL. It's not the case anymore.

Form::clientToNorm() returns NULL if the value is an empty string, if there is no client transformer.

Now that this client transformer is added by default on TextType, empty strings are not longer transformed to NULL.

}

if (!is_string($value) && !is_numeric($value)) {
throw new UnexpectedTypeException($value, 'string or number');
}

return $value;
}

/**
* Transforms a value into a string.
*
* @param string $value String value.
*
* @return string String value.
*
* @throws UnexpectedTypeException if the given value is not a string
*/
public function reverseTransform($value)
{
if (null === $value) {
return '';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is actually not correct. The method should return null if $value is null or an empty string.

}

if (!is_string($value)) {
throw new UnexpectedTypeException($value, 'string');
}

return $value;
}
}
12 changes: 12 additions & 0 deletions src/Symfony/Component/Form/Extension/Core/Type/TextType.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,21 @@
namespace Symfony\Component\Form\Extension\Core\Type;

use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\FormBuilder;
use Symfony\Component\Form\Extension\Core\DataTransformer\ValueToStringTransformer;

class TextType extends AbstractType
{
/**
* {@inheritdoc}
*/
public function buildForm(FormBuilder $builder, array $options)
{
$builder
->appendClientTransformer(new ValueToStringTransformer())
;
}

/**
* {@inheritdoc}
*/
Expand Down
90 changes: 90 additions & 0 deletions ...fony/Tests/Component/Form/Extension/Core/DataTransformer/ValueToStringTransformerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
<?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\Tests\Component\Form\Extension\Core\DataTransformer;

use Symfony\Component\Form\Extension\Core\DataTransformer\ValueToStringTransformer;

class ValueToStringTransformerTest extends \PHPUnit_Framework_TestCase
{
protected $transformer;

protected function setUp()
{
$this->transformer = new ValueToStringTransformer();
}

protected function tearDown()
{
$this->transformer = null;
}

/**
* @dataProvider validDataProvider
*/
public function testTransform($value, $transformed)
{
$this->assertEquals($transformed, $this->transformer->transform($value));
}

/**
* @dataProvider validDataProvider
*/
public function testReverseTransform($value, $transformed)
{
$this->assertEquals($transformed, $this->transformer->reverseTransform($transformed));
}

public function validDataProvider()
{
return array(
array('test', 'test'),
array('', null),
array(null, null),

array(0, '0'),
array('0', '0'),
array(1, '1'),
array('123', '123'),
array(1.23, '1.23'),
);
}

/**
* @dataProvider invalidDataProvider
*/
public function testTransformExpectsStringOrNumber($value)
{
$this->setExpectedException('Symfony\Component\Form\Exception\UnexpectedTypeException');

$this->transformer->transform($value);
}

/**
* @dataProvider invalidDataProvider
*/
public function testReverseTransformExpectsString($value)
{
$this->setExpectedException('Symfony\Component\Form\Exception\UnexpectedTypeException');

$this->transformer->reverseTransform($value);
}

public function invalidDataProvider()
{
return array(
array(true),
array(false),
array(new \stdClass),
array(array()),
);
}
}
2 changes: 1 addition & 1 deletion tests/Symfony/Tests/Component/Form/Extension/Core/Type/UrlTypeTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ public function testSubmitAddsNoDefaultProtocolIfEmpty()

$form->bind('');

$this->assertNull($form->getData());
$this->assertSame('', $form->getData());
$this->assertSame('', $form->getClientData());
}

Expand Down