add docs for choice_tree

Author: Charlie

README.md

@@ -60,8 +60,16 @@ for use when rendering templates.
 
 For more information see the [Twig Helper][].
 
+Choice Tree
+--------------
+
+The choice Tree form Type allows have a tree for choices.
+
+For more information see the [Choice Tree Documentation][].
+
 [PolyCollection Documentation]: https://github.com/infinite-networks/InfiniteFormBundle/blob/master/Resources/doc/polycollection.md
 [Collection Helper Documentation]: https://github.com/infinite-networks/InfiniteFormBundle/blob/master/Resources/doc/collection-helper.md
 [CheckboxGrid Documentation]: https://github.com/infinite-networks/InfiniteFormBundle/blob/master/Resources/doc/checkboxgrid.md
 [Twig Helper]: https://github.com/infinite-networks/InfiniteFormBundle/blob/master/Resources/doc/twig-helper.md
+[Choice Tree Documentation]: https://github.com/Charlie-Lucas/InfiniteFormBundle/blob/feature/add-choice-tree-form-type/Resources/doc/choice_tree.md
 [can be found here]: https://github.com/infinite-networks/InfiniteFormBundle/blob/master/Resources/doc/installation.md

Resources/doc/choice_tree.md

@@ -0,0 +1,93 @@
+InfiniteFormBundle's Choice Tree Form Type
+=============================================
+
+Introduction
+------------
+
+The choice tree form type allow you to display a tree of choice, a simple
+choice list give you the possibility to generate group but just for one level.
+
+Installation
+------------
+
+[Installation of InfiniteFormBundle](installation.md) is covered in a separate
+document. The Choice Tree type is automatically enabled when the bundle is
+installed.
+
+Object Structure
+----------------
+
+The Choice Tree type work as a choice but choices must implement a specific pattern:
+```php
+        $tree = {
+            0 => [
+                "value" => 1,
+                "label" => Object/string,
+                "choice_list" =>{
+                    0 => [
+                        "value" => 3,
+                        "label" => Object/string,
+                        "choice_list" => []
+                    ]
+                }
+            ],
+            1 => [
+                "value" => 2,
+                "label" => Object/string,
+                "choice_list" =>{
+                    0 => [
+                        "value" => 1,
+                        "label" => Object/string,
+                        "choice_list" => []
+                    ]
+                }
+            ]
+        }
+        $builder
+            ->add(
+                'category', 'infinite_form_choice_tree', [
+                    'choices'     => $tree,
+                ]
+            );
+
+```
+For example when you use the Nested Tree Repository from Gedmo :
+
+```php
+    class MyFormType extends AbstractType
+    {
+        public function buildForm(FormBuilderInterface $builder, array $options)
+        {
+            $tree = $myRepo->buildTree($myRepo->getNodesHierarchy());
+            // then we need recursively parse this tree for the form with a recursive function
+            $builder
+                ->add(
+                    'category', 'infinite_form_choice_tree', [
+                        'choices'     => $this->rebuildTree($tree),
+                    ]
+                );
+
+        }
+
+
+        public function rebuildTree($tree)
+        {
+            $hierarchy = [];
+            foreach ($tree as $children) {
+                $node = [];
+                $node['label'] = $category['title'];
+                $node['value'] = $category['id'];
+                $node['choice_list'] = $this->rebuildTree($children);
+                $hierarchy[] = $node;
+
+            }
+            return $hierarchy;
+        }
+    }
+```
+
+#TODO
+----------------
+
+L'utilisation de paramètres dans le form type devraient permettre de parser ce qui est passer par "choices",
+pour éviter ainsi d'avoir à implémenter une méthode de parsing