Merge pull request #4 from nWidart/patch-2

Refactor signature of listsFlattened method

Author: sdebacker

README.md

@@ -41,4 +41,16 @@ Of course you will probably want a position column as well. So you will have to
     '17' => '    Child 2 Title',
     '14' => 'Item 2 Title',
 ]
-```
+```
+
+To use it, first call the `nest()` method, followed by the `listsFlattened()` method:
+
+``` php
+Model::orderBy('parent_id')->get()->nest()->listsFlattened();
+```
+
+By default it will look for a `title` column. You send as first parameter a custom column name:
+
+``` php
+Model::orderBy('parent_id')->get()->nest()->listsFlattened('name');
+```

src/NestableCollection.php

@@ -66,21 +66,21 @@ public function nest()
     /**
      * Recursive function that flatten a nested Collection
      * with characters (default is four spaces)
-     * 
+     *
      * @param  BaseCollection|null $collection
+     * @param  string              $column
      * @param  integer             $level
      * @param  array               &$flattened
-     * @param  string              $column
      * @param  string              $indentChars
      * @return array
      */
-    public function listsFlattened(BaseCollection $collection = null, $level = 0, array &$flattened = [], $column = 'title', $indentChars = '    ')
+    public function listsFlattened($column = 'title', BaseCollection $collection = null, $level = 0, array &$flattened = [], $indentChars = '    ')
     {
         $collection = $collection ? : $this ;
         foreach ($collection as $item) {
             $flattened[$item->id] = str_repeat($indentChars, $level) . $item->$column;
             if ($item->items) {
-                $this->listsFlattened($item->items, $level + 1, $flattened);
+                $this->listsFlattened($column, $item->items, $level + 1, $flattened);
             }
         }