NAME

Code::Includable::Tree::FromStruct - Routine to build tree object from data structure

VERSION

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

The routines in this module can be imported manually to your tree class/role. The only requirement is that your tree class supports parent and children methods as described in Role::TinyCommons::Tree::Node.

The routines can also be called as a normal function call, with your tree node object as the first argument, e.g.:

 new_from_struct($class, $struct)

The full documentation about the routines is in Role::TinyCommons::Tree::FromStruct.

VARIABLES

$GET_PARENT_METHOD => str (default: parent)

The method name parent to get parent can actually be customized by (locally) setting this variable. See also $SET_PARENT_METHOD.

$SET_PARENT_METHOD => str (default: parent)

The method name parent to set parent can actually be customized by (locally) setting this variable. See also $GET_PARENT_METHOD.

$GET_CHILDREN_METHOD => str (default: children)

The method name children to get children can actually be customized by (locally) setting this variable. See also $SET_CHILDREN_METHOD.

$SET_CHILDREN_METHOD => str (default: children)

The method name children to set children can actually be customized by (locally) setting this variable. See also $GET_CHILDREN_METHOD.

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

Role::TinyCommons::Tree::FromStruct if you want to use the routines in this module via consuming role.

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

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.

cpanm Role::TinyCommons::Tree

perl -MCPAN -e shell
install Role::TinyCommons::Tree