NAME

Tree::Object::Hash - A hash-based tree object

VERSION

This document describes version 0.080 of Tree::Object::Hash (from Perl distribution Tree-Object), released on 2021-10-07.

SYNOPSIS

 use Tree::Object::Hash;
 my $tree = Tree::Object::Hash->new(attr1 => ..., attr2 => ...);

DESCRIPTION

This is a pretty generic hash-based tree object you can use directly or as a base class.

It gets its methods from Role::TinyCommons::Tree::Node and Role::TinyCommons::Tree::NodeMethods roles.

Parent node is stored internally in the _parent key. Children nodes in the _children key (arrayref). You can store attributes in other keys.

METHODS

See Role::TinyCommons::Tree::Node, Role::TinyCommons::Tree::NodeMethods for the complete list of methods.

CLASS->new(%attrs) => obj

Constructor.

$obj->parent( [ $obj ] ) => obj

Get or set parent.

$obj->children( [ \@children ] ) => arrayref

Get or set children.

HOMEPAGE

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

SOURCE

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

SEE ALSO

Role::TinyCommons::Tree::Node

Role::TinyCommons::Tree::NodeMethods

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, 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=Tree-Object

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.