/ 
Role-TinyCommons-Tree-0.128
River stage one • 1 direct dependent • 1 total dependent
/ Role::TinyCommons::Tree::FromObjArray

NAME

Role::TinyCommons::Tree::FromObjArray - Role that provides methods to build a tree of objects from a nested array of objects

VERSION

This document describes version 0.128 of Role::TinyCommons::Tree::FromObjArray (from Perl distribution Role-TinyCommons-Tree), released on 2021-10-07.

MIXED IN ROLES

Role::TinyCommons::Tree::NodeMethods

PROVIDED METHODS

new_from_obj_array($obj_array) => obj

Construct a tree of objects from a nested array of objects $obj_array. The array must contain the root node object followed by zero or more children node objects. Each child can be directly followed by an arrayref to specify its children. Example:

[$root_node_obj]                                     # if there are no children nodes

[$root_node_obj, [$child1_obj, $child2_obj]]         # if root node has two children

The above tree can be visualized as follow:

$root_node_obj
  ├─$child1_obj
  └─$child2_obj

Another example:

[$root_node_obj, [
  $child1_obj, [$grandchild1_obj, $grandchild2_obj],
  $child2_obj]]                                      # if first child has two children of its own

The above tree can be visualized as follow:

$root_node_obj
  ├─$child1_obj
  │   ├─$grandchild1_obj
  │   └─$grandchild2_obj
  └─$child2_obj

A more complex example ($ABC, $DEF, and so on are all objects):

[$ABC, [
  $DEF, [$GHI, $JKL],
  $MNO, [$PQR, [$STU]],
  $VWX
 ]]

The above tree can be visualized as follow:

$ABC
  ├─$DEF
  │   ├─$GHI
  │   └─$JKL
  ├─$MNO
  │   └─$PQR
  │       └─$STU
  └─$VWX

The objects will be connected to each other by calling their parent() and children() methods. See Role::TinyCommons::Tree::Node for more details.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Role-TinyCommons-Tree.

SOURCE

Source repository is at https://github.com/perlancar/perl-Role-TinyCommons-Tree.

SEE ALSO

Code::Includable::Tree::FromStruct if you want to use the routines in this module without consuming a role.

Role::TinyCommons::Tree::FromObjArray if you want to build a tree of objects from a nested array of objects.

Role::TinyCommons::Tree::Node

Role::TinyCommons

The nested array format is inspired by Text::Tree::Indented.

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

% prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2021, 2020, 2016 by perlancar <perlancar@cpan.org>.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Role-TinyCommons-Tree

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.