Add nestedToArray to treecollection

[damsfx]

Added a new method to the TreeCollection class to obtain the collection in a nested array.

In order to add a tree view mode to the checkboxlist formwidget, I need to be able to get the collection items as a nested tree.

$tree = new Winter\Test\Models\Channel;
$tree->all();  // Winter\Storm\Database\TreeCollection

$tree->nestedArray(title', 'id'); 
// or 
$tree->all()->toNestedArray('title', 'id');
// return an nested array
[
    1 => [
      "title" => "Channel Orange",
      "children" => [
        2 => [
          "title" => "Autumn Leaves",
          "children" => [
            3 => [
              "title" => "September",
            ],
            4 => [
              "title" => "Winter",
            ],
            5 => [
              "title" => "November",
            ],
          ],
        ],
        6 => [
          "title" => "Summer Breeze",
        ],
      ],
    ],
    7 => [
      "title" => "Channel Green",
      "children" => [
        8 => [
          "title" => "Winter Snow",
        ],
        9 => [
          "title" => "Spring Trees",
        ],
      ],
    ],
  ]

Can be used with multiple column names to be returned in the array:

$tree->nestedArray(['title', 'description'], 'id'),
// or 
$tree->all()->toNestedArray(['title', 'description'], 'id');

Can also be used without key :

$tree->nestedArray(title'); 
// or 
$tree->all()->nestedToArray('title');

$tree->nestedArray(['title', 'description']),
// or 
$tree->all()->nestedToArray(['title', 'description']);

[LukeTowers]

Looks great @damsfx! Could you PR the docs as well?

[damsfx]

Looks great @damsfx! Could you PR the docs as well?

wintercms/docs#221 for the trait.
I don't really know how to describe the possible parameters.

For the api/Winter/Storm/Database/TreeCollection collection ... is documentation generated automatically?

[LukeTowers]

@damsfx yes: https://wintercms.com/docs/develop/api/Winter/Storm/Database/TreeCollection

[damsfx]

@LukeTowers I don't see the new toNestedArray() method on my side.

[LukeTowers]

@damsfx I think I need to look into what triggers it to regenerate the API docs