MAGETWO-32442: Data object plugin fails when docblock is not found

Bryant Luk · Bryant Luk · commit 48ac9d9248a3 · 2015-01-09T14:31:10.000-06:00
- Make all DataProcessorObject client usages specify the type to serialize
diff --git a/app/code/Magento/Checkout/Model/Type/Onepage.php b/app/code/Magento/Checkout/Model/Type/Onepage.php
@@ -529,7 +529,7 @@ protected function _validateCustomerData(array $data)
         $quote = $this->getQuote();
         $isCustomerNew = !$quote->getCustomerId();
         $customer = $quote->getCustomer();
-        $customerData = $this->extensibleDataObjectConverter->toFlatArray($customer);
+        $customerData = $this->extensibleDataObjectConverter->toFlatArray($customer, [], '\Magento\Customer\Api\Data\CustomerInterface');
 
         /** @var Form $customerForm */
         $customerForm = $this->_formFactory->create(
@@ -593,7 +593,7 @@ protected function _validateCustomerData(array $data)
         $this->_objectCopyService->copyFieldsetToTarget(
             'customer_account',
             'to_quote',
-            $this->extensibleDataObjectConverter->toFlatArray($customer),
+            $this->extensibleDataObjectConverter->toFlatArray($customer, [], '\Magento\Customer\Api\Data\CustomerInterface'),
             $quote
         );
 
diff --git a/app/code/Magento/Customer/Block/Adminhtml/Edit/Form.php b/app/code/Magento/Customer/Block/Adminhtml/Edit/Form.php
@@ -71,7 +71,11 @@ protected function _prepareForm()
             $form->addField('id', 'hidden', ['name' => 'customer_id']);
             $customer = $this->_customerRepository->getById($customerId);
             $form->setValues(
-                $this->_extensibleDataObjectConverter->toFlatArray($customer)
+                $this->_extensibleDataObjectConverter->toFlatArray(
+                    $customer,
+                    [],
+                    '\Magento\Customer\Api\Data\CustomerInterface'
+                )
             )->addValues(
                 ['customer_id' => $customerId]
             );
diff --git a/app/code/Magento/Customer/Block/Adminhtml/Edit/Tab/Account.php b/app/code/Magento/Customer/Block/Adminhtml/Edit/Tab/Account.php
@@ -171,7 +171,11 @@ protected function _customizeFieldset($fieldset)
         );
         $form->getElement('website_id')->setRenderer($renderer);
 
-        $accountData = $this->_extensibleDataObjectConverter->toFlatArray($this->_getCustomerDataObject());
+        $accountData = $this->_extensibleDataObjectConverter->toFlatArray(
+            $this->_getCustomerDataObject(),
+            [],
+            '\Magento\Customer\Api\Data\CustomerInterface'
+        );
 
         if ($this->_getCustomerDataObject()->getId()) {
             $customerFormFields = $this->_addEditCustomerFormFields($fieldset);
diff --git a/app/code/Magento/Customer/Controller/Adminhtml/Index/Validate.php b/app/code/Magento/Customer/Controller/Adminhtml/Index/Validate.php
@@ -28,7 +28,11 @@ protected function _validateCustomer($response)
             $customerForm = $this->_formFactory->create(
                 'customer',
                 'adminhtml_customer',
-                $this->_extensibleDataObjectConverter->toFlatArray($customer),
+                $this->_extensibleDataObjectConverter->toFlatArray(
+                    $customer,
+                    [],
+                    '\Magento\Customer\Api\Data\CustomerInterface'
+                ),
                 true
             );
             $customerForm->setInvisibleIgnored(true);
diff --git a/app/code/Magento/Customer/Model/AccountManagement.php b/app/code/Magento/Customer/Model/AccountManagement.php
@@ -682,7 +682,7 @@ protected function createPasswordHash($password)
     public function validate(\Magento\Customer\Api\Data\CustomerInterface $customer)
     {
         $customerErrors = $this->validator->validateData(
-            $this->extensibleDataObjectConverter->toFlatArray($customer),
+            $this->extensibleDataObjectConverter->toFlatArray($customer, [], '\Magento\Customer\Api\Data\CustomerInterface'),
             [],
             'customer'
         );
diff --git a/app/code/Magento/Customer/Model/Address/Mapper.php b/app/code/Magento/Customer/Model/Address/Mapper.php
@@ -36,7 +36,7 @@ public function __construct(ExtensibleDataObjectConverter $extensibleDataObjectC
      */
     public function toFlatArray($addressDataObject)
     {
-        $flatAddressArray = $this->extensibleDataObjectConverter->toFlatArray($addressDataObject);
+        $flatAddressArray = $this->extensibleDataObjectConverter->toFlatArray($addressDataObject, [], '\Magento\Customer\Api\Data\AddressInterface');
         //preserve street
         $street = $addressDataObject->getStreet();
         if (!empty($street) && is_array($street)) {
diff --git a/app/code/Magento/Customer/Model/Customer/Mapper.php b/app/code/Magento/Customer/Model/Customer/Mapper.php
@@ -35,7 +35,7 @@ public function __construct(ExtensibleDataObjectConverter $extensibleDataObjectC
      */
     public function toFlatArray(CustomerInterface $customer)
     {
-        $flatArray = $this->extensibleDataObjectConverter->toNestedArray($customer);
+        $flatArray = $this->extensibleDataObjectConverter->toNestedArray($customer, [], '\Magento\Customer\Api\Data\CustomerInterface');
         unset($flatArray["addresses"]);
         return ConvertArray::toFlatArray($flatArray);
     }
diff --git a/app/code/Magento/Customer/Model/Resource/CustomerRepository.php b/app/code/Magento/Customer/Model/Resource/CustomerRepository.php
@@ -124,7 +124,9 @@ public function save(\Magento\Customer\Api\Data\CustomerInterface $customer, $pa
     {
         $this->validate($customer);
         $customerData = $this->extensibleDataObjectConverter->toFlatArray(
-            $this->customerBuilder->populate($customer)->setAddresses([])->create()
+            $this->customerBuilder->populate($customer)->setAddresses([])->create(),
+            [],
+            '\Magento\Customer\Api\Data\CustomerInterface'
         );
         $customerModel = $this->customerFactory->create(['data' => $customerData]);
         $storeId = $customerModel->getStoreId();
diff --git a/app/code/Magento/Customer/Model/Resource/Group/Grid/ServiceCollection.php b/app/code/Magento/Customer/Model/Resource/Group/Grid/ServiceCollection.php
@@ -66,7 +66,7 @@ public function loadData($printQuery = false, $logQuery = false)
             $groups = $searchResults->getItems();
             foreach ($groups as $group) {
                 $groupItem = new \Magento\Framework\Object();
-                $groupItem->addData($this->simpleDataObjectConverter->toFlatArray($group));
+                $groupItem->addData($this->simpleDataObjectConverter->toFlatArray($group, '\Magento\Customer\Api\Data\GroupInterface'));
                 $this->_addItem($groupItem);
             }
             $this->_setIsLoaded();
diff --git a/app/code/Magento/Sales/Block/Adminhtml/Order/Create/Form/Account.php b/app/code/Magento/Sales/Block/Adminhtml/Order/Create/Form/Account.php
@@ -160,7 +160,7 @@ public function getFormValues()
         } catch (\Exception $e) {
             /** If customer does not exist do nothing. */
         }
-        $data = isset($customer) ? $this->_extensibleDataObjectConverter->toFlatArray($customer) : [];
+        $data = isset($customer) ? $this->_extensibleDataObjectConverter->toFlatArray($customer, [], '\Magento\Customer\Api\Data\CustomerInterface') : [];
         foreach ($this->getQuote()->getData() as $key => $value) {
             if (strpos($key, 'customer_') === 0) {
                 $data[substr($key, 9)] = $value;
diff --git a/app/code/Magento/Sales/Model/Quote.php b/app/code/Magento/Sales/Model/Quote.php
@@ -683,7 +683,9 @@ public function setCustomer(\Magento\Customer\Api\Data\CustomerInterface $custom
         $this->setCustomerId($customer->getId());
         $customerData = $this->objectFactory->create(
             $this->extensibleDataObjectConverter->toFlatArray(
-                $this->customerBuilder->populate($customer)->setAddresses([])->create()
+                $this->customerBuilder->populate($customer)->setAddresses([])->create(),
+                [],
+                '\Magento\Customer\Api\Data\CustomerInterface'
             )
         );
         $this->_objectCopyService->copyFieldsetToTarget('customer_account', 'to_quote', $customerData, $this);
diff --git a/dev/tests/integration/testsuite/Magento/Customer/Controller/Adminhtml/GroupTest.php b/dev/tests/integration/testsuite/Magento/Customer/Controller/Adminhtml/GroupTest.php
@@ -145,7 +145,8 @@ public function testSaveActionExistingGroup()
         $simpleDataObjectConverter = Bootstrap::getObjectManager()
             ->get('Magento\Framework\Api\SimpleDataObjectConverter');
         $customerGroupData = $simpleDataObjectConverter->toFlatArray(
-            $this->groupRepository->getById($groupId)
+            $this->groupRepository->getById($groupId),
+            'Magento\Customer\Api\Data\GroupInterface'
         );
         ksort($customerGroupData);
 
diff --git a/dev/tests/integration/testsuite/Magento/Customer/Model/AccountManagementTest.php b/dev/tests/integration/testsuite/Magento/Customer/Model/AccountManagementTest.php
@@ -598,8 +598,16 @@ public function testCreateNonexistingCustomer()
             'aPassword',
             true
         );
-        $attributesBefore = $this->extensibleDataObjectConverter->toFlatArray($existingCustomer);
-        $attributesAfter = $this->extensibleDataObjectConverter->toFlatArray($customerAfter);
+        $attributesBefore = $this->extensibleDataObjectConverter->toFlatArray(
+            $existingCustomer,
+            [],
+            '\Magento\Customer\Api\Data\CustomerInterface'
+        );
+        $attributesAfter = $this->extensibleDataObjectConverter->toFlatArray(
+            $customerAfter,
+            [],
+            '\Magento\Customer\Api\Data\CustomerInterface'
+        );
         // ignore 'updated_at'
         unset($attributesBefore['updated_at']);
         unset($attributesAfter['updated_at']);
@@ -669,7 +677,10 @@ public function testCreateCustomerInServiceVsInModel()
         $simpleDataObjectConverter = Bootstrap::getObjectManager()
             ->get('Magento\Framework\Api\SimpleDataObjectConverter');
 
-        $dataInService = $simpleDataObjectConverter->toFlatArray($savedCustomer);
+        $dataInService = $simpleDataObjectConverter->toFlatArray(
+            $savedCustomer,
+            'Magento\Customer\Api\Data\CustomerInterface'
+        );
         $expectedDifferences = [
             'created_at',
             'updated_at',
diff --git a/dev/tests/integration/testsuite/Magento/Customer/Model/CustomerMetadataTest.php b/dev/tests/integration/testsuite/Magento/Customer/Model/CustomerMetadataTest.php
@@ -119,7 +119,7 @@ public function testGetCustomerAttributeMetadata()
             'id' => 1,
             'website_id' => 1,
             'store_id' => 1,
-            'group_id' => '1',
+            'group_id' => 1,
             'firstname' => 'John',
             'lastname' => 'Smith',
             'email' => 'customer@example.com',
@@ -131,7 +131,11 @@ public function testGetCustomerAttributeMetadata()
         $customer = $this->customerRepository->getById(1);
         $this->assertNotNull($customer);
 
-        $attributes = $this->_extensibleDataObjectConverter->toFlatArray($customer);
+        $attributes = $this->_extensibleDataObjectConverter->toFlatArray(
+            $customer,
+            [],
+            '\Magento\Customer\Api\Data\CustomerInterface'
+        );
         $this->assertNotEmpty($attributes);
 
         foreach ($attributes as $attributeCode => $attributeValue) {
diff --git a/dev/tests/integration/testsuite/Magento/Customer/Model/Resource/CustomerRepositoryTest.php b/dev/tests/integration/testsuite/Magento/Customer/Model/Resource/CustomerRepositoryTest.php
@@ -140,8 +140,16 @@ public function testUpdateCustomer()
         $this->assertEquals('Admin', $customerAfter->getCreatedIn());
         $passwordFromFixture = 'password';
         $this->accountManagement->authenticate($customerAfter->getEmail(), $passwordFromFixture);
-        $attributesBefore = $this->converter->toFlatArray($customerBefore);
-        $attributesAfter = $this->converter->toFlatArray($customerAfter);
+        $attributesBefore = $this->converter->toFlatArray(
+            $customerBefore,
+            [],
+            '\Magento\Customer\Api\Data\CustomerInterface'
+        );
+        $attributesAfter = $this->converter->toFlatArray(
+            $customerAfter,
+            [],
+            '\Magento\Customer\Api\Data\CustomerInterface'
+        );
         // ignore 'updated_at'
         unset($attributesBefore['updated_at']);
         unset($attributesAfter['updated_at']);
diff --git a/dev/tests/integration/testsuite/Magento/Weee/Model/TaxTest.php b/dev/tests/integration/testsuite/Magento/Weee/Model/TaxTest.php
@@ -57,7 +57,7 @@ public function testGetProductWeeeAttributes()
             ['metadataService' => $customerMetadataService]
         );
         $expected = $this->_extensibleDataObjectConverter->toFlatArray(
-            $customerRepository->getById(1)
+            $customerRepository->getById(1), [], '\Magento\Customer\Api\Data\CustomerInterface'
         );
         $customerBuilder->populateWithArray($expected);
         $customerDataSet = $customerBuilder->create();
diff --git a/dev/tests/unit/testsuite/Magento/Customer/Block/Adminhtml/Edit/Tab/AccountTest.php b/dev/tests/unit/testsuite/Magento/Customer/Block/Adminhtml/Edit/Tab/AccountTest.php
@@ -186,6 +186,7 @@ private function _setupStoreMode($customerData, $isSingleStoreMode, $canModifyCu
                 'adminhtml_customer',
                 $this->extensibleDataObjectConverterMock->toFlatArray(
                     $customerObject,
+                    [],
                     '\Magento\Customer\Api\Data\CustomerInterface'
                 )
             )
diff --git a/lib/internal/Magento/Framework/Api/ExtensibleDataObjectConverter.php b/lib/internal/Magento/Framework/Api/ExtensibleDataObjectConverter.php
@@ -31,11 +31,17 @@ public function __construct(DataObjectProcessor $dataObjectProcessor)
      *
      * @param ExtensibleDataInterface $dataObject
      * @param string[] $skipCustomAttributes
+     * @param string $dataObjectType
      * @return array
      */
-    public function toNestedArray(ExtensibleDataInterface $dataObject, $skipCustomAttributes = [])
-    {
-        $dataObjectType = get_class($dataObject);
+    public function toNestedArray(
+        ExtensibleDataInterface $dataObject,
+        $skipCustomAttributes = [],
+        $dataObjectType = null
+    ) {
+        if ($dataObjectType == null) {
+            $dataObjectType = get_class($dataObject);
+        }
         $dataObjectArray = $this->dataObjectProcessor->buildOutputDataArray($dataObject, $dataObjectType);
         //process custom attributes if present
         if (!empty($dataObjectArray[AbstractExtensibleObject::CUSTOM_ATTRIBUTES_KEY])) {
@@ -57,11 +63,15 @@ public function toNestedArray(ExtensibleDataInterface $dataObject, $skipCustomAt
      *
      * @param ExtensibleDataInterface $dataObject
      * @param string[] $skipCustomAttributes
+     * @param string $dataObjectType
      * @return array
      */
-    public function toFlatArray(ExtensibleDataInterface $dataObject, $skipCustomAttributes = [])
-    {
-        $dataObjectArray = $this->toNestedArray($dataObject, $skipCustomAttributes);
+    public function toFlatArray(
+        ExtensibleDataInterface $dataObject,
+        $skipCustomAttributes = [],
+        $dataObjectType = null
+    ) {
+        $dataObjectArray = $this->toNestedArray($dataObject, $skipCustomAttributes, $dataObjectType);
         return ConvertArray::toFlatArray($dataObjectArray);
     }
 
diff --git a/lib/internal/Magento/Framework/Api/SimpleDataObjectConverter.php b/lib/internal/Magento/Framework/Api/SimpleDataObjectConverter.php
@@ -26,11 +26,14 @@ public function __construct(DataObjectProcessor $dataObjectProcessor)
      * Convert nested array into flat array.
      *
      * @param ExtensibleDataInterface $dataObject
+     * @param string $dataObjectType
      * @return array
      */
-    public function toFlatArray(ExtensibleDataInterface $dataObject)
+    public function toFlatArray(ExtensibleDataInterface $dataObject, $dataObjectType = null)
     {
-        $dataObjectType = get_class($dataObject);
+        if ($dataObjectType === null) {
+            $dataObjectType = get_class($dataObject);
+        }
         $data = $this->dataObjectProcessor->buildOutputDataArray($dataObject, $dataObjectType);
         return ConvertArray::toFlatArray($data);
     }

Original file line number	Diff line number	Diff line change
`@@ -682,7 +682,7 @@ protected function createPasswordHash($password)`
`682`	`682`	`public function validate(\Magento\Customer\Api\Data\CustomerInterface $customer)`
`683`	`683`	`{`
`684`	`684`	`$customerErrors = $this->validator->validateData(`
`685`		`- $this->extensibleDataObjectConverter->toFlatArray($customer),`
	`685`	`+ $this->extensibleDataObjectConverter->toFlatArray($customer, [], '\Magento\Customer\Api\Data\CustomerInterface'),`
`686`	`686`	`[],`
`687`	`687`	`'customer'`
`688`	`688`	`);`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ public function __construct(ExtensibleDataObjectConverter $extensibleDataObjectC`
`36`	`36`	`*/`
`37`	`37`	`public function toFlatArray($addressDataObject)`
`38`	`38`	`{`
`39`		`- $flatAddressArray = $this->extensibleDataObjectConverter->toFlatArray($addressDataObject);`
	`39`	`+ $flatAddressArray = $this->extensibleDataObjectConverter->toFlatArray($addressDataObject, [], '\Magento\Customer\Api\Data\AddressInterface');`
`40`	`40`	`//preserve street`
`41`	`41`	`$street = $addressDataObject->getStreet();`
`42`	`42`	`if (!empty($street) && is_array($street)) {`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ public function __construct(ExtensibleDataObjectConverter $extensibleDataObjectC`
`35`	`35`	`*/`
`36`	`36`	`public function toFlatArray(CustomerInterface $customer)`
`37`	`37`	`{`
`38`		`- $flatArray = $this->extensibleDataObjectConverter->toNestedArray($customer);`
	`38`	`+ $flatArray = $this->extensibleDataObjectConverter->toNestedArray($customer, [], '\Magento\Customer\Api\Data\CustomerInterface');`
`39`	`39`	`unset($flatArray["addresses"]);`
`40`	`40`	`return ConvertArray::toFlatArray($flatArray);`
`41`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ public function loadData($printQuery = false, $logQuery = false)`
`66`	`66`	`$groups = $searchResults->getItems();`
`67`	`67`	`foreach ($groups as $group) {`
`68`	`68`	`$groupItem = new \Magento\Framework\Object();`
`69`		`- $groupItem->addData($this->simpleDataObjectConverter->toFlatArray($group));`
	`69`	`+ $groupItem->addData($this->simpleDataObjectConverter->toFlatArray($group, '\Magento\Customer\Api\Data\GroupInterface'));`
`70`	`70`	`$this->_addItem($groupItem);`
`71`	`71`	`}`
`72`	`72`	`$this->_setIsLoaded();`
Original file line number	Diff line number	Diff line change
`@@ -160,7 +160,7 @@ public function getFormValues()`
`160`	`160`	`} catch (\Exception $e) {`
`161`	`161`	`/** If customer does not exist do nothing. */`
`162`	`162`	`}`
`163`		`- $data = isset($customer) ? $this->_extensibleDataObjectConverter->toFlatArray($customer) : [];`
	`163`	`+ $data = isset($customer) ? $this->_extensibleDataObjectConverter->toFlatArray($customer, [], '\Magento\Customer\Api\Data\CustomerInterface') : [];`
`164`	`164`	`foreach ($this->getQuote()->getData() as $key => $value) {`
`165`	`165`	`if (strpos($key, 'customer_') === 0) {`
`166`	`166`	`$data[substr($key, 9)] = $value;`