.\" 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::Container::Parameterized 3pm"
.TH Bread::Board::Container::Parameterized 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::Container::Parameterized \- A parameterized container
.SH "VERSION"
.IX Header "VERSION"
version 0.37
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class implements a sort of container factory for Bread::Board:
a parameterized container is a, in practice, a function from a set of
parameters (which must be containers) to an actual container. See
Bread::Board::Manual::Example::FormSensible for an example.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.ie n .SS """name"""
.el .SS "\f(CWname\fP"
.IX Subsection "name"
Read/write string, required. Every container needs a name, by which it
can be referenced when fetching it.
.ie n .SS """allowed_parameter_names"""
.el .SS "\f(CWallowed_parameter_names\fP"
.IX Subsection "allowed_parameter_names"
Read-only arrayref of strings, required. These are the names of the
containers that must be passed to \f(CW\*(C`create\*(C'\fR
to get an actual container out of this parameterized object.
.ie n .SS """container"""
.el .SS "\f(CWcontainer\fP"
.IX Subsection "container"
This attribute holds the \*(L"prototype\*(R" container. Services inside it can
depend on service paths that include the container names given in
\&\*(L"allowed_parameter_names\*(R".
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """add_service"""
.el .SS "\f(CWadd_service\fP"
.IX Subsection "add_service"
.ie n .SS """get_service"""
.el .SS "\f(CWget_service\fP"
.IX Subsection "get_service"
.ie n .SS """has_service"""
.el .SS "\f(CWhas_service\fP"
.IX Subsection "has_service"
.ie n .SS """get_service_list"""
.el .SS "\f(CWget_service_list\fP"
.IX Subsection "get_service_list"
.ie n .SS """has_services"""
.el .SS "\f(CWhas_services\fP"
.IX Subsection "has_services"
.ie n .SS """add_sub_container"""
.el .SS "\f(CWadd_sub_container\fP"
.IX Subsection "add_sub_container"
.ie n .SS """get_sub_container"""
.el .SS "\f(CWget_sub_container\fP"
.IX Subsection "get_sub_container"
.ie n .SS """has_sub_container"""
.el .SS "\f(CWhas_sub_container\fP"
.IX Subsection "has_sub_container"
.ie n .SS """get_sub_container_list"""
.el .SS "\f(CWget_sub_container_list\fP"
.IX Subsection "get_sub_container_list"
.ie n .SS """has_sub_containers"""
.el .SS "\f(CWhas_sub_containers\fP"
.IX Subsection "has_sub_containers"
All these methods are delegated to the \*(L"prototype\*(R" \*(L"container\*(R", so
that this object can be defined as if it were a normal container.
.ie n .SS """create"""
.el .SS "\f(CWcreate\fP"
.IX Subsection "create"
.Vb 1
\&  my $container = $parameterized_container\->create(%params);
.Ve
.PP
After checking that the keys of \f(CW%params\fR are exactly the same
strings that are present in \*(L"allowed_parameter_names\*(R", this method
clones the prototype \*(L"container\*(R", adds the \f(CW%params\fR to the clone
as sub-containers, and returns the clone.
.PP
If this was not a top-level container, the parent is also cloned, and
the container clone is added to the parent clone.
.PP
Please note that the container returned by this method does \fInot\fR
have the same name as the parameterized container, and that calling
this method with different parameter values will return different
containers, but all with the same name. It's probably a bad idea to
instantiate a non-top-level parameterized container more than once.
.ie n .SS """fetch"""
.el .SS "\f(CWfetch\fP"
.IX Subsection "fetch"
.ie n .SS """resolve"""
.el .SS "\f(CWresolve\fP"
.IX Subsection "resolve"
These two methods die, since services in a parameterized container
won't usually resolve, and attempting to do so is almost always a
mistake.
.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.