MooseX::Role::Parameterized::Meta::Trait::Parameterizable
Section: User Contributed Perl Documentation (3)
Updated: 2017-04-20
Page Index
NAME
MooseX::Role::Parameterized::Meta::Trait::Parameterizable - trait for parameterizable roles
VERSION
version 1.10
DESCRIPTION
This is the trait that is applied to the metaclass for parameterizable roles,
roles that have their parameters currently unbound. These are the roles that
you use ``with'' in Moose, but instead of composing the parameterizable role, we
construct a new parameterized role
(MooseX::Role::Parameterized::Meta::Role::Parameterized) and use that new
parameterized role instead.
ATTRIBUTES
parameterized_role_metaclass
The name of the class that will be used to construct the parameterized role.
parameters_class
The name of the class that will be used to construct the parameters object.
parameters_metaclass
A metaclass representing this role's parameters. It will be an anonymous
subclass of ``parameters_class''. Each call to
``parameter'' in MooseX::Role::Parameters adds an attribute to this metaclass.
When this role is consumed, the parameters object will be instantiated using
this metaclass.
role_generator
A code reference that is used to generate a role based on the parameters
provided by the consumer. The user usually specifies it using the
``role'' in MooseX::Role::Parameterized keyword.
METHODS
add_parameter $name, %options
Delegates to ``add_attribute'' in Moose::Meta::Class on the
``parameters_metaclass'' object.
construct_parameters %arguments
Creates a new MooseX::Role::Parameterized::Parameters object using metaclass
``parameters_metaclass''.
The arguments are those specified by the consumer as parameter values.
generate_role %arguments
This method generates and returns a new instance of
``parameterized_role_metaclass''. It can take any combination of
three named arguments:
- parameters
-
A hashref of parameters for the role, same as would be passed in at a ``with''
statement.
- package
-
A package name that, if present, we will use for the generated role; if not,
we generate an anonymous role.
- consumer
-
A consumer metaobject, if available.
apply
Overrides ``apply'' in Moose::Meta::Role to automatically generate the
parameterized role.
SUPPORT
Bugs may be submitted through the
RT bug tracker <
https://rt.cpan.org/Public/Dist/Display.html?Name=MooseX-Role-Parameterized>
(or
bug-MooseX-Role-Parameterized@rt.cpan.org <mailto:
bug-MooseX-Role-Parameterized@rt.cpan.org>).
There is also a mailing list available for users of this distribution, at
<http://lists.perl.org/list/moose.html>.
There is also an irc channel available for users of this distribution, at
"#moose" on "irc.perl.org" <irc://irc.perl.org/#moose>.
AUTHOR
Shawn M Moore <
code@sartak.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2008 by Shawn M Moore.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.