odannyc/treeize

The ultimate tree library. For all your tree recursion needs.

Treeize

The ultimate tree library. For all your tree recursion needs., _(*1)

Treeize::create($tree)->parse()->get();

Installation

You can install this library using composer, _(*2)

composer require odannyc/treeize, _(*3)

Usage

Given a simple array:, _(*4)

$tree = [
  [
    "id" => 1,
    "parent_id" => 0
  ],
  [
    "id" => 2,
    "parent_id" => 1
  ],
  [
    "id" => 3,
    "parent_id" => 1
  ],
  [
    "id" => 4,
    "parent_id" => 2
  ],
  [
    "id" => 5,
    "parent_id" => 2
  ],[
    "id" => 6,
    "parent_id" => 0
  ],
  [
    "id" => 7,
    "parent_id" => 6
  ],
  [
    "id" => 8,
    "parent_id" => 6
  ]
]

You will be able to parse this tree and set it correctly recursively doing this:, _(*5)

Treeize::create($tree)->parse()->get();

The output will be:, _(*6)

[
  [
    "id" => 1,
    "parent_id" => 0,
    "children" => [
      [
        "id" => 2,
        "parent_id" => 1,
        "children" => [
          [
            "id" => 4,
            "parent_id" => 2
          ],
          [
            "id" => 5,
            "parent_id" => 2
          ]
        ]
      ],
      [
        "id" => 3,
        "parent_id" => 1
      ],
    ]
  ],
  [
    "id" => 6,
    "parent_id" => 0,
    "children" => [
      [
        "id" => 7,
        "parent_id" => 6
      ],
      [
        "id" => 8,
        "parent_id" => 6
      ]
    ]
  ]
]

If you'd like to change the "children" key to any other string you can do so by chaining off the create method before parsing. So:, _(*7)

Treeize::create($tree)->childrenKey('nodes')->parse()->get();

There's other options to chain on that method, here's the whole list:, _(*8)

Treeize::create($tree)
  ->parentKey('pid')
  ->indexKey('id')
  ->parentId(0)
  ->childrenKey('nodes')
  ->parse(function($item) {//do stuff to item})
  ->get();

parentKey - Sets the parent key name: Default is "parent_key", _(*9)

indexKey - Sets the index key name: Default is "id", _(*10)

parentId - Sets the initial parent ID to search for: This is figured out if non is provided, _(*11)

childrenKey - Sets the children key name as described above., _(*12)

parse - Accepts a callback function that you can apply to each item in the tree, an item is an array in this instance., _(*13)