MAGETWO-56154: Sorted Object List in di.xml

- added support of sortOrder attribute to array object items

Author: Oleksii Korshenko

lib/internal/Magento/Framework/Data/Argument/Interpreter/ArrayType.php

@@ -39,9 +39,40 @@ public function evaluate(array $data)
             throw new \InvalidArgumentException('Array items are expected.');
         }
         $result = [];
+        $items = $this->sortItems($items);
         foreach ($items as $itemKey => $itemData) {
             $result[$itemKey] = $this->itemInterpreter->evaluate($itemData);
         }
         return $result;
     }
+
+    /**
+     * Sort items by sort order attribute.
+     *
+     * @param array $items
+     * @return array
+     */
+    private function sortItems($items)
+    {
+        uasort(
+            $items,
+            function ($firstItem, $secondItem) {
+                $firstValue = 0;
+                $secondValue = 0;
+                if (isset($firstItem['sortOrder'])) {
+                    $firstValue = intval($firstItem['sortOrder']);
+                }
+
+                if (isset($secondItem['sortOrder'])) {
+                    $secondValue = intval($secondItem['sortOrder']);
+                }
+
+                if ($firstValue == $secondValue) {
+                    return 0;
+                }
+                return $firstValue < $secondValue ? -1 : 1;
+            }
+        );
+        return $items;
+    }
 }

lib/internal/Magento/Framework/Data/Test/Unit/Argument/Interpreter/ArrayTypeTest.php

@@ -87,6 +87,22 @@ public function evaluateDataProvider()
                     'key3' => '-value 3-',
                 ],
             ],
+            'sorted array items' => [
+                [
+                    'item' => [
+                        'key1' => ['value' => 'value 1', 'sortOrder' => 50],
+                        'key2' => ['value' => 'value 2'],
+                        'key3' => ['value' => 'value 3', 'sortOrder' => 10],
+                        'key4' => ['value' => 'value 4'],
+                    ],
+                ],
+                [
+                    'key2' => '-value 2-',
+                    'key4' => '-value 4-',
+                    'key3' => '-value 3-',
+                    'key1' => '-value 1-',
+                ],
+            ],
         ];
     }
 }

lib/internal/Magento/Framework/ObjectManager/Test/Unit/Config/_files/invalidConfigXmlArray.php

@@ -155,5 +155,21 @@
             "Element 'argument': Duplicate key-sequence ['same_param_name'] in key identity-constraint"
                 . " 'argumentName'.\nLine: 6\n"
         ],
-    ]
+    ],
+    'sorted_object_list_with_invalid_sortOrder_attribute_value' => [
+        '<?xml version="1.0"?>
+        <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+            <type name="Some_Name">
+                <arguments>
+                    <argument name="sorted_object_list" xsi:type="array">
+                        <item name="someObject" xsi:type="object" sortOrder="false">Some_Class_Name</item>
+                    </argument>
+                </arguments>
+            </type>
+        </config>',
+        [
+            "Element 'item', attribute 'sortOrder': 'false' is not a valid value of the atomic type 'xs:integer'." .
+            "\nLine: 6\n"
+        ],
+    ],
 ];

lib/internal/Magento/Framework/ObjectManager/Test/Unit/Config/_files/valid_config.xml

@@ -57,6 +57,11 @@
                 </item>
             </argument>
             <argument name="baseController" xsi:type="string">some_value</argument>
+            <argument name="sortedList" xsi:type="array">
+                <item name="itemTwo" xsi:type="object" sortOrder="20">Instance_test_name_two</item>
+                <item name="itemOne" xsi:type="object">Instance_test_name_one</item>
+                <item name="itemThree" xsi:type="object" sortOrder="30">Instance_test_name_three</item>
+            </argument>
         </arguments>
     </type>
 </config>

lib/internal/Magento/Framework/ObjectManager/etc/config.xsd

@@ -20,6 +20,7 @@
             <xs:complexContent>
                 <xs:extension base="object">
                     <xs:attribute name="shared" use="optional" type="xs:boolean"/>
+                    <xs:attribute name="sortOrder" use="optional" type="xs:integer"/>
                 </xs:extension>
             </xs:complexContent>
         </xs:complexType>