| Commit | Line | Data |
|---|
| 6e2766f2 |
1 | package DBIx::Class::Tree; |
| bb17efa0 |
2 | # vim: ts=8:sw=4:sts=4:et |
| 6e2766f2 |
3 | |
| 4 | use strict; |
| 5 | use warnings; |
| 6 | |
| 6e2766f2 |
7 | use base qw( DBIx::Class ); |
| 8 | |
| 806b784d |
9 | our $VERSION = '0.03002'; |
| 6e2766f2 |
10 | |
| 11 | 1; |
| 82958127 |
12 | __END__ |
| 13 | |
| 14 | =head1 NAME |
| 15 | |
| af9120b0 |
16 | DBIx::Class::Tree - Manipulate and anaylze tree structured data. |
| 82958127 |
17 | |
| 2bd95b57 |
18 | =head1 GETTING HELP/SUPPORT |
| 19 | |
| 20 | The community can be found via: |
| 21 | |
| 22 | =over |
| 23 | |
| 24 | =item * IRC: irc.perl.org#dbix-class |
| 25 | |
| 26 | =for html |
| 27 | <a href="http://chat.mibbit.com/#dbix-class@irc.perl.org">(click for instant chatroom login)</a> |
| 28 | |
| 29 | =item * Mailing list: L<http://lists.scsys.co.uk/mailman/listinfo/dbix-class> |
| 30 | |
| 31 | =item * RT Bug Tracker: L<https://rt.cpan.org/Dist/Display.html?Queue=DBIx-Class-Tree> |
| 32 | |
| 33 | =item * gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/DBIx-Class-Tree.git> |
| 34 | |
| 35 | =item * git: L<git://git.shadowcat.co.uk/dbsrgits/DBIx-Class-Tree.git> |
| 36 | |
| 37 | =back |
| 38 | |
| 82958127 |
39 | =head1 DESCRIPTION |
| 40 | |
| 5e44a0c6 |
41 | The tree modules provide the tools to represent, modify, and analyze |
| 9d3d72a3 |
42 | trees of data with DBIx::Class. |
| 43 | |
| 44 | =head1 COMPONENTS |
| 45 | |
| 5e44a0c6 |
46 | L<DBIx::Class::Tree::AdjacencyList> - Manage a tree of data using the |
| af9120b0 |
47 | common adjacency list model. |
| 74d97bdc |
48 | |
| 5e44a0c6 |
49 | L<DBIx::Class::Tree::AdjacencyList::Ordered> - Glue DBIx::Class::Ordered |
| af9120b0 |
50 | and DBIx::Class::Tree::AdjacencyList together. |
| 74d97bdc |
51 | |
| 52 | =head1 DAG |
| 53 | |
| 5e44a0c6 |
54 | All tree related modules must conform to have and use the basic traversal |
| 55 | methods of a DAG. For the most part this just means that Tree modules |
| 56 | must provide the appearance of having multiple parents per node (via a |
| 57 | parents() method) but may very well never return more than one parent. |
| 58 | All utility modules, such as a Visitor module, should do its best to |
| 59 | never assume that a node only has one parent. There are situations |
| 60 | where this is not possible - in those cases the module's documentation |
| 74d97bdc |
61 | should clearly state that it is not compatible with DAGs. |
| 62 | |
| 5e44a0c6 |
63 | So far there is no Tree::DAG module, but there will be. These requirements |
| 64 | are vague, and the requirements of Tree modules to be DAG compatible will |
| 74d97bdc |
65 | become more defined in due course. |
| 9d3d72a3 |
66 | |
| 82958127 |
67 | =head1 AUTHOR |
| 68 | |
| 69 | Aran Clary Deltac <bluefeet@cpan.org> |
| 70 | |
| 71 | =head1 LICENSE |
| 72 | |
| 73 | You may distribute this code under the same terms as Perl itself. |
| 74 | |
projects / dbsrgits/DBIx-Class-Tree.git / blame