Download the PHP package falco442/lumen-treeview without Composer
On this page you can find all versions of the php package falco442/lumen-treeview. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download falco442/lumen-treeview
More information about falco442/lumen-treeview
Files in falco442/lumen-treeview
Package lumen-treeview
Short Description Something to help manage tree data structures
License MIT
Homepage https://falco442.github.io/lumen-treeview/
Informations about the package lumen-treeview
falco442/lumen-treeview
This package is intended for generating a tree structure from flat data (array); it makes use of the class Illuminate\Support\Collection
, so is intended for Lumen/Laravel projects.
Requirements
- PHP >= 8.0
- OpenSSL PHP Extension
- PDO PHP Extension
- Mbstring PHP Extension
- laravel/lumen-framework >= 9.0
Installation
from command line, in the root folder of your Laravel/Lumen project, run the command
Parameters
Static method getTree()
name | type | default value | description |
---|---|---|---|
$array |
array | none. required. | this is the array to pass. |
$parentIdField |
string | 'parent_id' |
the name for the parent field with which is constructed the relation |
$idField |
string | 'id' |
the name for the main field of the array, usually the primary key of the table from which data are taken |
$childrenField |
string | 'children' |
the name for the field which to put the children in, in the returned tree |
Static method getNode()
name | type | default value | description |
---|---|---|---|
$array |
array | none. required. | this is the array to pass. Is taken by reference |
$id |
string || number | none. required. | The id of the node to take for which construct the tree |
$parentIdField |
string | 'parent_id' |
the name for the parent field with which is constructed the relation |
$idField |
string | 'id' |
the name for the main field of the array, usually the primary key of the table from which data are taken |
$childrenField |
string | 'children' |
the name for the field which to put the children in, in the returned tree |
$node |
array | null | The node instance to pass to the method. optional, and not to be used to construct the tree. Internal use only. |
Usage
Get all trees (root nodes as array of nodes)
You can call the function getTree()
to an array of arrays (for example a collection got from Eloquent) like this:
Get single node tree
You can call the static method of the class TreeView to retrieve the tree relative to a node like this, inserting the id as parameter ID: