Merge pull request #1333 from magento-south/MAGETWO-69521

[south] MAGETWO-69521: Customer attribute with "Show on Storefront" set to No does not appear in backend

Author: Sergii Kovalenko

app/code/Magento/Customer/Model/Customer/DataProvider.php

@@ -9,23 +9,24 @@
 use Magento\Customer\Api\CustomerMetadataInterface;
 use Magento\Customer\Api\Data\AddressInterface;
 use Magento\Customer\Api\Data\CustomerInterface;
+use Magento\Customer\Model\Address;
 use Magento\Customer\Model\Attribute;
+use Magento\Customer\Model\Customer;
 use Magento\Customer\Model\FileProcessor;
 use Magento\Customer\Model\FileProcessorFactory;
 use Magento\Customer\Model\ResourceModel\Address\Attribute\Source\CountryWithWebsites;
+use Magento\Customer\Model\ResourceModel\Customer\Collection;
+use Magento\Customer\Model\ResourceModel\Customer\CollectionFactory as CustomerCollectionFactory;
 use Magento\Eav\Api\Data\AttributeInterface;
 use Magento\Eav\Model\Config;
 use Magento\Eav\Model\Entity\Attribute\AbstractAttribute;
 use Magento\Eav\Model\Entity\Type;
-use Magento\Customer\Model\Address;
-use Magento\Customer\Model\Customer;
 use Magento\Framework\App\ObjectManager;
 use Magento\Framework\Session\SessionManagerInterface;
+use Magento\Framework\View\Element\UiComponent\ContextInterface;
+use Magento\Framework\View\Element\UiComponent\DataProvider\FilterPool;
 use Magento\Ui\Component\Form\Field;
 use Magento\Ui\DataProvider\EavValidationRules;
-use Magento\Customer\Model\ResourceModel\Customer\Collection;
-use Magento\Customer\Model\ResourceModel\Customer\CollectionFactory as CustomerCollectionFactory;
-use Magento\Framework\View\Element\UiComponent\DataProvider\FilterPool;
 
 /**
  * Class DataProvider
@@ -121,6 +122,18 @@ class DataProvider extends \Magento\Ui\DataProvider\AbstractDataProvider
         'file',
     ];
 
+    /**
+     * @var ContextInterface
+     */
+    private $context;
+
+    /**
+     * Allow to manage attributes, even they are hidden on storefront
+     *
+     * @var bool
+     */
+    private $allowToShowHiddenAttributes;
+
     /**
      * @param string $name
      * @param string $primaryFieldName
@@ -130,8 +143,10 @@ class DataProvider extends \Magento\Ui\DataProvider\AbstractDataProvider
      * @param Config $eavConfig
      * @param FilterPool $filterPool
      * @param FileProcessorFactory $fileProcessorFactory
+     * @param ContextInterface $context
      * @param array $meta
      * @param array $data
+     * @param bool $allowToShowHiddenAttributes
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
@@ -144,7 +159,9 @@ public function __construct(
         FilterPool $filterPool,
         FileProcessorFactory $fileProcessorFactory = null,
         array $meta = [],
-        array $data = []
+        array $data = [],
+        ContextInterface $context = null,
+        $allowToShowHiddenAttributes = true
     ) {
         parent::__construct($name, $primaryFieldName, $requestFieldName, $meta, $data);
         $this->eavValidationRules = $eavValidationRules;
@@ -153,6 +170,8 @@ public function __construct(
         $this->eavConfig = $eavConfig;
         $this->filterPool = $filterPool;
         $this->fileProcessorFactory = $fileProcessorFactory ?: $this->getFileProcessorFactory();
+        $this->context = $context ?: ObjectManager::getInstance()->get(ContextInterface::class);
+        $this->allowToShowHiddenAttributes = $allowToShowHiddenAttributes;
         $this->meta['customer']['children'] = $this->getAttributesMeta(
             $this->eavConfig->getEntityType('customer')
         );
@@ -329,7 +348,9 @@ protected function getAttributesMeta(Type $entityType)
             if (!empty($rules)) {
                 $meta[$code]['arguments']['data']['config']['validation'] = $rules;
             }
+
             $meta[$code]['arguments']['data']['config']['componentType'] = Field::NAME;
+            $meta[$code]['arguments']['data']['config']['visible'] = $this->canShowAttribute($attribute);
 
             $this->overrideFileUploaderMetadata($entityType, $attribute, $meta[$code]['arguments']['data']['config']);
         }
@@ -338,6 +359,47 @@ protected function getAttributesMeta(Type $entityType)
         return $meta;
     }
 
+    /**
+     * Check whether the specific attribute can be shown in form: customer registration, customer edit, etc...
+     *
+     * @param Attribute $customerAttribute
+     * @return bool
+     */
+    private function canShowAttributeInForm(AbstractAttribute $customerAttribute)
+    {
+        $isRegistration = $this->context->getRequestParam($this->getRequestFieldName()) === null;
+
+        if ($customerAttribute->getEntityType()->getEntityTypeCode() === 'customer') {
+            return is_array($customerAttribute->getUsedInForms()) &&
+                (
+                    (in_array('customer_account_create', $customerAttribute->getUsedInForms()) && $isRegistration) ||
+                    (in_array('customer_account_edit', $customerAttribute->getUsedInForms()) && !$isRegistration)
+                );
+        } else {
+            return is_array($customerAttribute->getUsedInForms()) &&
+                in_array('customer_address_edit', $customerAttribute->getUsedInForms());
+        }
+    }
+
+    /**
+     * Detect can we show attribute on specific form or not
+     *
+     * @param Attribute $customerAttribute
+     * @return bool
+     */
+    private function canShowAttribute(AbstractAttribute $customerAttribute)
+    {
+        $userDefined = (bool) $customerAttribute->getIsUserDefined();
+        if (!$userDefined) {
+            return $customerAttribute->getIsVisible();
+        }
+
+        $canShowOnForm = $this->canShowAttributeInForm($customerAttribute);
+
+        return ($this->allowToShowHiddenAttributes && $canShowOnForm) ||
+            (!$this->allowToShowHiddenAttributes && $canShowOnForm && $customerAttribute->getIsVisible());
+    }
+
     /**
      * Retrieve Country With Websites Source
      *