.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Bread::Board::Traversable 3pm"
.TH Bread::Board::Traversable 3pm "2022-12-12" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Bread::Board::Traversable \- role for traversing a container service tree
.SH "VERSION"
.IX Header "VERSION"
version 0.37
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  my $service = $container\->fetch(\*(Aq/some/service/path\*(Aq);
\&
\&  my $root = $service\->get_root_container;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This role provides the basic functionality to traverse a container /
service tree. Instances of classes consuming this role will get a
parent-child relationship between them.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.ie n .SS """parent"""
.el .SS "\f(CWparent\fP"
.IX Subsection "parent"
Weak ref to another Bread::Board::Traversable object, read/write
accessor (although you should probably not change this value directly
in normal code).
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """has_parent"""
.el .SS "\f(CWhas_parent\fP"
.IX Subsection "has_parent"
Predicate for the \*(L"parent\*(R" attribute, true if a parent has been set.
.ie n .SS """detach_from_parent"""
.el .SS "\f(CWdetach_from_parent\fP"
.IX Subsection "detach_from_parent"
Clearer for the \*(L"parent\*(R" attribute, you should probably not call
this method in normal code.
.ie n .SS """get_root_container"""
.el .SS "\f(CWget_root_container\fP"
.IX Subsection "get_root_container"
Returns the farthest ancestor of the invocant, i.e. the top-most
container this object is a part of.
.ie n .SS """fetch"""
.el .SS "\f(CWfetch\fP"
.IX Subsection "fetch"
.Vb 3
\&  my $service = $this\->fetch(\*(Aq/absolute/path\*(Aq);
\&  my $service = $this\->fetch(\*(Aqrelative/path\*(Aq);
\&  my $service = $this\->fetch(\*(Aq../relative/path\*(Aq);
.Ve
.PP
Given a (relative or absolute) path to a service or container, this
method walks the tree and returns the Bread::Board::Service or
Bread::Board::Container instance for that path. Dies if no object
can be found for the given
path.
.PP
Aliases are resolved in this call, by
calling \f(CW\*(C`aliased_from\*(C'\fR until we get an actual service.
.SH "AUTHOR"
.IX Header "AUTHOR"
Stevan Little <stevan@iinteractive.com>
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests on the bugtracker website
https://github.com/stevan/BreadBoard/issues
.PP
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.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2019, 2017, 2016, 2015, 2014, 2013, 2011, 2009 by Infinity Interactive.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.