-
Notifications
You must be signed in to change notification settings - Fork 9.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MAGETWO-81153: Backward incompatible changes of 2.2.1 release
- Loading branch information
Showing
4 changed files
with
184 additions
and
107 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,71 @@ | ||
<?php | ||
/** | ||
* Copyright © Magento, Inc. All rights reserved. | ||
* See COPYING.txt for license details. | ||
*/ | ||
namespace Magento\Customer\Helper; | ||
|
||
use Magento\Customer\Api\AddressMetadataInterface; | ||
use Magento\Customer\Api\AddressMetadataManagementInterface; | ||
use Magento\Customer\Model\Attribute; | ||
use Magento\Customer\Model\Metadata\AttributeResolver; | ||
use Magento\Framework\App\Helper\AbstractHelper; | ||
use Magento\Framework\App\Helper\Context; | ||
|
||
/** | ||
* Customer attribute checker. | ||
*/ | ||
class AttributeChecker extends AbstractHelper | ||
{ | ||
/** | ||
* @var AddressMetadataInterface | ||
*/ | ||
private $addressMetadata; | ||
|
||
/** | ||
* @var AttributeResolver | ||
*/ | ||
private $attributeResolver; | ||
|
||
/** | ||
* @param Context $context | ||
* @param AddressMetadataInterface $addressMetadata | ||
* @param AttributeResolver $attributeResolver | ||
*/ | ||
public function __construct( | ||
Context $context, | ||
AddressMetadataInterface $addressMetadata, | ||
AttributeResolver $attributeResolver | ||
) { | ||
$this->addressMetadata = $addressMetadata; | ||
$this->attributeResolver = $attributeResolver; | ||
parent::__construct($context); | ||
} | ||
|
||
/** | ||
* Checks whether it is allowed to show an attribute on the form | ||
* | ||
* This check relies on the attribute's property 'getUsedInForms' which contains a list of forms | ||
* where allowed to render specified attribute. | ||
* | ||
* @param string $attributeCode | ||
* @param string $formName | ||
* @return bool | ||
*/ | ||
public function isAttributeAllowedOnForm($attributeCode, $formName) | ||
{ | ||
$isAllowed = false; | ||
$attributeMetadata = $this->addressMetadata->getAttributeMetadata($attributeCode); | ||
if ($attributeMetadata) { | ||
/** @var Attribute $attribute */ | ||
$attribute = $this->attributeResolver->getModelByAttribute( | ||
AddressMetadataManagementInterface::ENTITY_TYPE_ADDRESS, | ||
$attributeMetadata | ||
); | ||
$usedInForms = $attribute->getUsedInForms(); | ||
$isAllowed = in_array($formName, $usedInForms, true); | ||
} | ||
|
||
return $isAllowed; | ||
} | ||
} |
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
112 changes: 112 additions & 0 deletions
112
app/code/Magento/Customer/Test/Unit/Helper/AttributeCheckerTest.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,112 @@ | ||
<?php | ||
/** | ||
* Copyright © Magento, Inc. All rights reserved. | ||
* See COPYING.txt for license details. | ||
*/ | ||
|
||
namespace Magento\Customer\Test\Unit\Helper; | ||
|
||
use Magento\Customer\Api\AddressMetadataInterface; | ||
use Magento\Customer\Api\AddressMetadataManagementInterface; | ||
use Magento\Customer\Api\Data\AttributeMetadataInterface; | ||
use Magento\Customer\Helper\AttributeChecker; | ||
use Magento\Customer\Model\Attribute; | ||
use Magento\Customer\Model\Metadata\AttributeResolver; | ||
use Magento\Framework\App\Helper\Context; | ||
|
||
class AttributeCheckerTest extends \PHPUnit\Framework\TestCase | ||
{ | ||
/** @var AttributeChecker|\PHPUnit_Framework_MockObject_MockObject */ | ||
private $model; | ||
|
||
/** @var Context */ | ||
private $context; | ||
|
||
/** @var AttributeResolver|\PHPUnit_Framework_MockObject_MockObject */ | ||
private $attributeResolver; | ||
|
||
/** @var AddressMetadataInterface|\PHPUnit_Framework_MockObject_MockObject */ | ||
private $addressMetadataService; | ||
|
||
protected function setUp() | ||
{ | ||
$this->context = $this->getMockBuilder(Context::class) | ||
->disableOriginalConstructor() | ||
->getMock(); | ||
$this->addressMetadataService = $this->getMockForAbstractClass(AddressMetadataInterface::class); | ||
$this->attributeResolver = $this->getMockBuilder(AttributeResolver::class) | ||
->disableOriginalConstructor() | ||
->getMock(); | ||
|
||
$this->model = new AttributeChecker( | ||
$this->context, | ||
$this->addressMetadataService, | ||
$this->attributeResolver | ||
); | ||
} | ||
|
||
/** | ||
* @param bool $isAllowed | ||
* @param bool $isMetadataExists | ||
* @param string $attributeCode | ||
* @param string $formName | ||
* @param array $attributeFormsList | ||
* | ||
* @dataProvider attributeOnFormDataProvider | ||
*/ | ||
public function testIsAttributeAllowedOnForm( | ||
$isAllowed, | ||
$isMetadataExists, | ||
$attributeCode, | ||
$formName, | ||
array $attributeFormsList | ||
) { | ||
$attributeMetadata = null; | ||
if ($isMetadataExists) { | ||
$attributeMetadata = $this->getMockForAbstractClass(AttributeMetadataInterface::class); | ||
$attribute = $this->getMockBuilder(Attribute::class) | ||
->disableOriginalConstructor() | ||
->getMock(); | ||
$this->attributeResolver->expects($this->once()) | ||
->method('getModelByAttribute') | ||
->with(AddressMetadataManagementInterface::ENTITY_TYPE_ADDRESS, $attributeMetadata) | ||
->willReturn($attribute); | ||
$attribute->expects($this->once()) | ||
->method('getUsedInForms') | ||
->willReturn($attributeFormsList); | ||
} | ||
$this->addressMetadataService->expects($this->once()) | ||
->method('getAttributeMetadata') | ||
->with($attributeCode) | ||
->willReturn($attributeMetadata); | ||
|
||
$this->assertEquals($isAllowed, $this->model->isAttributeAllowedOnForm($attributeCode, $formName)); | ||
} | ||
|
||
public function attributeOnFormDataProvider() | ||
{ | ||
return [ | ||
'metadata not exists' => [ | ||
'isAllowed' => false, | ||
'isMetadataExists' => false, | ||
'attributeCode' => 'attribute_code', | ||
'formName' => 'form_name', | ||
'attributeFormsList' => [], | ||
], | ||
'form not in the list' => [ | ||
'isAllowed' => false, | ||
'isMetadataExists' => true, | ||
'attributeCode' => 'attribute_code', | ||
'formName' => 'form_name', | ||
'attributeFormsList' => ['form_1', 'form_2'], | ||
], | ||
'allowed' => [ | ||
'isAllowed' => true, | ||
'isMetadataExists' => true, | ||
'attributeCode' => 'attribute_code', | ||
'formName' => 'form_name', | ||
'attributeFormsList' => ['form_name', 'form_1', 'form_2'], | ||
], | ||
]; | ||
} | ||
} |