Skip to content

Add trim filter to first, middle and lastname. #12964

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 3 commits into from
Jan 9, 2018
Merged

Add trim filter to first, middle and lastname. #12964

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
207fdb0
Add trim filter to first, middle and lastname.
wardcapp Jan 2, 2018
2a23a94
Add new line to end of file
wardcapp Jan 3, 2018
1a77bfc
Fix customer metadata integration test
mzeis Jan 7, 2018
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
36 changes: 36 additions & 0 deletions app/code/Magento/Customer/Setup/UpgradeData.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,10 @@ public function upgrade(ModuleDataSetupInterface $setup, ModuleContextInterface
$this->upgradeVersionTwoZeroTwelve($customerSetup);
}

if (version_compare($context->getVersion(), '2.0.13', '<')) {
$this->upgradeVersionTwoZeroThirteen($customerSetup);
}

$indexer = $this->indexerRegistry->get(Customer::CUSTOMER_GRID_INDEXER_ID);
$indexer->reindexAll();
$this->eavConfig->clear();
Expand Down Expand Up @@ -663,4 +667,36 @@ private function upgradeCustomerPasswordResetlinkExpirationPeriodConfig($setup)
['path = ?' => \Magento\Customer\Model\Customer::XML_PATH_CUSTOMER_RESET_PASSWORD_LINK_EXPIRATION_PERIOD]
);
}

/**
* @param CustomerSetup $customerSetup
*/
private function upgradeVersionTwoZeroThirteen(CustomerSetup $customerSetup)
{
$entityAttributes = [
'customer_address' => [
'firstname' => [
'input_filter' => 'trim'
],
'lastname' => [
'input_filter' => 'trim'
],
'middlename' => [
'input_filter' => 'trim'
],
],
'customer' => [
'firstname' => [
'input_filter' => 'trim'
],
'lastname' => [
'input_filter' => 'trim'
],
'middlename' => [
'input_filter' => 'trim'
],
],
];
$this->upgradeAttributes($entityAttributes, $customerSetup);
}
}
2 changes: 1 addition & 1 deletion app/code/Magento/Customer/etc/module.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
*/
-->
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
<module name="Magento_Customer" setup_version="2.0.12">
<module name="Magento_Customer" setup_version="2.0.13">
<sequence>
<module name="Magento_Eav"/>
<module name="Magento_Directory"/>
Expand Down
2 changes: 1 addition & 1 deletion dev/tests/api-functional/testsuite/Magento/Customer/Api/CustomerMetadataTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ public function getAttributeMetadataDataProvider()
Customer::FIRSTNAME,
[
AttributeMetadata::FRONTEND_INPUT => 'text',
AttributeMetadata::INPUT_FILTER => '',
AttributeMetadata::INPUT_FILTER => 'trim',
AttributeMetadata::STORE_LABEL => 'First Name',
AttributeMetadata::MULTILINE_COUNT => 0,
AttributeMetadata::VALIDATION_RULES => [
Expand Down
37 changes: 37 additions & 0 deletions lib/internal/Magento/Framework/Data/Form/Filter/Trim.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/

/**
* Form Input/Output Trim Filter
*
* @author Magento Core Team <[email protected]>
*/
namespace Magento\Framework\Data\Form\Filter;

class Trim implements \Magento\Framework\Data\Form\Filter\FilterInterface
{
/**
* Returns the result of filtering $value
*
* @param string $value
* @return string
*/
public function inputFilter($value)
{
return trim($value, ' ');
Copy link
Contributor

Choose a reason for hiding this comment

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

Did you find a reason to not remove other whitespaces as done by trim() by default?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I could be wrong of course, but I indeed filtered ordinary spaces only on purpose, to make sure the trim-function remains strict (matching the expected behaviour stated within the original ticket) and to avoiding unwanted removal of other characters (for example, when text area inputs should accept and store newlines, but redundant whitespaces dropped).

Other than that, no real reason to deviate from the trim() default behaviour indeed :) Let me know if you'd prefer the default behaviour after all, I'll gladly correct the PR.

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for your explanation! Let's keep it like that for now. If demand shows we should trim for other whitespaces, this still can be done in the future.

}

/**
* Returns the result of filtering $value
*
* @param string $value
* @return string
*/
public function outputFilter($value)
{
return $value;
}
}