Collections - string as item key

src/Element/Collection.php

@@ -39,6 +39,13 @@ class Collection extends Fieldset
      */
     protected $count = 1;
 
+    /**
+     * Initial key names array (optional parameter)
+     *
+     * @var array
+     */
+    protected $keyNames = [];
+
     /**
      * Are new elements allowed to be added dynamically ?
      *
@@ -139,6 +146,14 @@ public function setOptions($options)
             $this->setCreateNewObjects($options['create_new_objects']);
         }
 
+        if (isset($options['key_names']) && is_array($options['key_names'])) {
+            $this->setKeyNames(array_values($options['key_names']));
+        }
+
+        if (isset($options['labels']) && is_array($options['labels'])) {
+            $this->setLabels(array_values($options['labels']));
+        }
+
         return $this;
     }
 
@@ -195,6 +210,11 @@ public function populateValues($data)
             ));
         }
 
+        // Can't do anything with empty data
+        if (empty($data)) {
+            return;
+        }
+
         if (!$this->allowRemove && count($data) < $this->count) {
             throw new Exception\DomainException(sprintf(
                 'There are fewer elements than specified in the collection (%s). Either set the allow_remove option '
@@ -301,6 +321,51 @@ public function getCount()
         return $this->count;
     }
 
+    /**
+     * Set the labels for each item
+     *
+     * @param $labels
+     * @return Collection
+     */
+    public function setLabels($labels)
+    {
+        $this->labels = $labels;
+        return $this;
+    }
+
+    /**
+     * Get the labels
+     *
+     * @return int
+     */
+    public function getLabels()
+    {
+        return $this->labels;
+    }
+
+    /**
+     * Set the array key names
+     *
+     * @param $names
+     * @return Collection
+     */
+    public function setKeyNames($names)
+    {
+        $this->keyNames = $names;
+        $this->setCount(count($this->keyNames));
+        return $this;
+    }
+
+    /**
+     * Get the array key names
+     *
+     * @return int
+     */
+    public function getKeyNames()
+    {
+        return $this->keyNames;
+    }
+
     /**
      * Set the target element
      *
@@ -472,8 +537,10 @@ public function prepareElement(FormInterface $form)
     {
         if (true === $this->shouldCreateChildrenOnPrepareElement) {
             if ($this->targetElement !== null && $this->count > 0) {
+                $applyNames = count($this->keyNames) > 0 && count($this->keyNames) === $this->count ? 1 : 0;
                 while ($this->count > $this->lastChildIndex + 1) {
-                    $this->addNewTargetElementInstance(++$this->lastChildIndex);
+                    $label = isSet($this->labels[$this->lastChildIndex + 1]) ? $this->labels[$this->lastChildIndex + 1] : null;
+                    $this->addNewTargetElementInstance($applyNames ? $this->keyNames[++$this->lastChildIndex] : ++$this->lastChildIndex, $label);
                 }
             }
         }
@@ -564,12 +631,13 @@ protected function createNewTargetElementInstance()
      * @return ElementInterface
      * @throws Exception\DomainException
      */
-    protected function addNewTargetElementInstance($name)
+    protected function addNewTargetElementInstance($name, $label = null)
     {
         $this->shouldCreateChildrenOnPrepareElement = false;
 
         $elementOrFieldset = $this->createNewTargetElementInstance();
         $elementOrFieldset->setName($name);
+        if($label) $elementOrFieldset->setLabel($label);
 
         $this->add($elementOrFieldset);