Skip to content

[Form] moved data trimming logic of TrimListener into StringUtil #14660

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

Closed
wants to merge 2 commits into from
Closed

[Form] moved data trimming logic of TrimListener into StringUtil #14660

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b48d877
[Form] moved data trimming logic of TrimListener into StringUtil
issei-m Jun 20, 2015
bba264d
[Form] updated CHANGELOG.md
issei-m Jun 20, 2015
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
1 change: 1 addition & 0 deletions src/Symfony/Component/Form/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ CHANGELOG
* added the html5 "range" FormType
* deprecated the "cascade_validation" option in favor of setting "constraints"
with the Valid constraint
* moved data trimming logic of TrimListener into StringUtil

2.7.0
-----
Expand Down
7 changes: 2 additions & 5 deletions src/Symfony/Component/Form/Extension/Core/EventListener/TrimListener.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
use Symfony\Component\Form\FormEvents;
use Symfony\Component\Form\FormEvent;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\Form\Util\StringUtil;

/**
* Trims string data.
Expand All @@ -30,11 +31,7 @@ public function preSubmit(FormEvent $event)
return;
}

if (null !== $result = @preg_replace('/^[\pZ\p{Cc}]+|[\pZ\p{Cc}]+$/u', '', $data)) {
$event->setData($result);
} else {
$event->setData(trim($data));
}
$event->setData(StringUtil::trim($data));
}

/**
Expand Down
63 changes: 0 additions & 63 deletions src/Symfony/Component/Form/Tests/Extension/Core/EventListener/TrimListenerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,67 +39,4 @@ public function testTrimSkipNonStrings()

$this->assertSame(1234, $event->getData());
}

/**
* @dataProvider spaceProvider
*/
public function testTrimUtf8Separators($hex)
{
if (!function_exists('mb_convert_encoding')) {
$this->markTestSkipped('The "mb_convert_encoding" function is not available');
}

// Convert hexadecimal representation into binary
// H: hex string, high nibble first (UCS-2BE)
// *: repeat until end of string
$binary = pack('H*', $hex);

// Convert UCS-2BE to UTF-8
$symbol = mb_convert_encoding($binary, 'UTF-8', 'UCS-2BE');
$symbol = $symbol."ab\ncd".$symbol;

$form = $this->getMock('Symfony\Component\Form\Test\FormInterface');
$event = new FormEvent($form, $symbol);

$filter = new TrimListener();
$filter->preSubmit($event);

$this->assertSame("ab\ncd", $event->getData());
}

public function spaceProvider()
{
return array(
// separators
array('0020'),
array('00A0'),
array('1680'),
// array('180E'),
array('2000'),
array('2001'),
array('2002'),
array('2003'),
array('2004'),
array('2005'),
array('2006'),
array('2007'),
array('2008'),
array('2009'),
array('200A'),
array('2028'),
array('2029'),
array('202F'),
array('205F'),
array('3000'),
// controls
array('0009'),
array('000A'),
array('000B'),
array('000C'),
array('000D'),
array('0085'),
// zero width space
// array('200B'),
);
}
}
72 changes: 72 additions & 0 deletions src/Symfony/Component/Form/Tests/Util/StringUtilTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
<?php

namespace Symfony\Component\Form\Tests\Util;

use Symfony\Component\Form\Util\StringUtil;

class StringUtilTest extends \PHPUnit_Framework_TestCase
{
public function testTrim()
{
$data = ' Foo! ';

$this->assertEquals('Foo!', StringUtil::trim($data));
}

/**
* @dataProvider spaceProvider
*/
public function testTrimUtf8Separators($hex)
{
if (!function_exists('mb_convert_encoding')) {
$this->markTestSkipped('The "mb_convert_encoding" function is not available');
}

// Convert hexadecimal representation into binary
// H: hex string, high nibble first (UCS-2BE)
// *: repeat until end of string
$binary = pack('H*', $hex);

// Convert UCS-2BE to UTF-8
$symbol = mb_convert_encoding($binary, 'UTF-8', 'UCS-2BE');
$symbol = $symbol."ab\ncd".$symbol;

$this->assertSame("ab\ncd", StringUtil::trim($symbol));
}

public function spaceProvider()
{
return array(
// separators
array('0020'),
array('00A0'),
array('1680'),
// array('180E'),
array('2000'),
array('2001'),
array('2002'),
array('2003'),
array('2004'),
array('2005'),
array('2006'),
array('2007'),
array('2008'),
array('2009'),
array('200A'),
array('2028'),
array('2029'),
array('202F'),
array('205F'),
array('3000'),
// controls
array('0009'),
array('000A'),
array('000B'),
array('000C'),
array('000D'),
array('0085'),
// zero width space
// array('200B'),
);
}
}
42 changes: 42 additions & 0 deletions src/Symfony/Component/Form/Util/StringUtil.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
<?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\Util;

/**
* @author Issei Murasawa <issei.m7@gmail.com>
* @author Bernhard Schussek <bschussek@gmail.com>
*/
class StringUtil
{
/**
* This class should not be instantiated.
*/
private function __construct()
Copy link
Contributor

Choose a reason for hiding this comment

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

Private methods should go after public methods.

Copy link
Member

Choose a reason for hiding this comment

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

Not in this case IMHO. Constructor are always first.

Copy link
Contributor

Choose a reason for hiding this comment

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

Even before static methods?

Copy link
Member

Choose a reason for hiding this comment

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

Yes, that's what we are doing in Symfony.

Copy link
Contributor

Choose a reason for hiding this comment

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

i think the most important should be first (which are the constructor and public methods). since the constructor is private it doesn't need to be first in this case as this is not what is of interest.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Actually I think private constructor should be after too, but some util classes' constructor is first. (e.g. classes in Security/Core, FormUtil as well).

{
}

/**
* Returns the trimmed data.
*
* @param string $string
*
* @return string
*/
public static function trim($string)
{
if (null !== $result = @preg_replace('/^[\pZ\p{Cc}]+|[\pZ\p{Cc}]+$/u', '', $string)) {
return $result;
}

return trim($string);
}
}