.\" 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::Service::WithParameters 3pm"
.TH Bread::Board::Service::WithParameters 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::Service::WithParameters \- Services with parameters
.SH "VERSION"
.IX Header "VERSION"
version 0.37
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a sub-role of Bread::Board::Service, for parameterized
services. These are services that will instantiate different values
depending on parameters that are passed to the \f(CW\*(C`get\*(C'\fR method. You can
pass those parameters via the \f(CW\*(C`service_params\*(C'\fR attribute of
\&\f(CW\*(C`Bread::Board::Dependency\*(C'\fR, or via the \f(CW\*(C`inflate\*(C'\fR method of
\&\f(CW\*(C`Bread::Board::Service::Deferred::Thunk\*(C'\fR.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.ie n .SS """parameters"""
.el .SS "\f(CWparameters\fP"
.IX Subsection "parameters"
Read-only hashref, will be passed as-is to \f(CW\*(C`MooseX::Params::Validate\*(C'\fR's
\&\f(CW\*(C`validated_hash\*(C'\fR, so you
can use things like \f(CW\*(C`optional\*(C'\fR and \f(CW\*(C`default\*(C'\fR in addition to type
constraints:
.PP
.Vb 6
\&  service something => (
\&    class => \*(AqThing\*(Aq,
\&    parameters => {
\&       type => { isa => \*(AqStr\*(Aq, default => \*(Aqtext\*(Aq },
\&    },
\&  );
.Ve
.PP
This attribute uses coercions on \f(CW\*(C`Bread::Board::Service::Parameters\*(C'\fR so that you can also say:
.PP
.Vb 4
\&  service something => (
\&    class => \*(AqThing\*(Aq,
\&    parameters => [\*(Aqtype\*(Aq],
\&  );
.Ve
.PP
and it will be equivalent to:
.PP
.Vb 6
\&  service something => (
\&    class => \*(AqThing\*(Aq,
\&    parameters => {
\&       type => { optional => 0 },
\&    },
\&  );
.Ve
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """has_parameters"""
.el .SS "\f(CWhas_parameters\fP"
.IX Subsection "has_parameters"
Predicate for the \*(L"parameters\*(R" attribute.
.ie n .SS """has_parameter_defaults"""
.el .SS "\f(CWhas_parameter_defaults\fP"
.IX Subsection "has_parameter_defaults"
Returns true if any of the \*(L"parameters\*(R" have a \f(CW\*(C`default\*(C'\fR value.
.ie n .SS """has_required_parameters"""
.el .SS "\f(CWhas_required_parameters\fP"
.IX Subsection "has_required_parameters"
Returns true if any of the \*(L"parameters\*(R" does \fInot\fR have \f(CW\*(C`optional\*(C'\fR
set to true.
.ie n .SS """check_parameters"""
.el .SS "\f(CWcheck_parameters\fP"
.IX Subsection "check_parameters"
.Vb 2
\&  my %parameters = $service\->check_parameters(name1=>$value1,name2=>$value2);
\&  my %parameters = $service\->check_parameters({name1=>$value1,name2=>$value2});
.Ve
.PP
If any \*(L"parameters\*(R" are defined, this function validates its
arguments against the parameters' definitions (using
MooseX::Params::Validate). It will die if the validation fails, or
return the validated parameters (including default value) if it
succeeds.
.ie n .SS """get"""
.el .SS "\f(CWget\fP"
.IX Subsection "get"
\&\fIBefore\fR the \f(CW\*(C`get\*(C'\fR method, arguments to \f(CW\*(C`get\*(C'\fR are passed through
\&\*(L"check_parameters\*(R" and added to the \f(CW\*(C`params\*(C'\fR hashref. \fIAfter\fR the \f(CW\*(C`get\*(C'\fR
method, those keys/values will be removed. In practice, this makes all
parameters available to the actual \f(CW\*(C`get\*(C'\fR method body.
.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.