File Coverage

blib/lib/MooseX/Declare/Syntax/Keyword/Method.pm

Criterion	Covered	Total	%
statement	8	8	100.0
branch			n/a
condition			n/a
subroutine	3	3	100.0
pod	1	1	100.0
total	12	12	100.0

package MooseX::Declare::Syntax::Keyword::Method;
# ABSTRACT: Handle method declarations
$MooseX::Declare::Syntax::Keyword::Method::VERSION = '0.40';
use Moose;

use namespace::clean -except => 'meta';

#pod =head1 DESCRIPTION
#pod
#pod This role is an extension of L<MooseX::Declare::Syntax::MethodDeclaration>
#pod that allows you to install keywords that declare methods.
#pod
#pod =head1 CONSUMES
#pod
#pod =for :list
#pod * L<MooseX::Declare::Syntax::MethodDeclaration>
#pod
#pod =cut

with 'MooseX::Declare::Syntax::MethodDeclaration';

#pod =method register_method_declaration
#pod
#pod   Object->register_method_declaration (Object $metaclass, Str $name, Object $method)
#pod
#pod This method required by the method declaration role will register the finished
#pod method object via the C<< $metaclass->add_method >> method.
#pod
#pod   MethodModifier->new(
#pod       identifier           => 'around',
#pod       modifier_type        => 'around',
#pod       prototype_injections => {
#pod           declarator => 'around',
#pod           injections => [ 'CodeRef $orig' ],
#pod       },
#pod   );
#pod
#pod This will mean that the signature C<(Str $foo)> will become
#pod C<CodeRef $orig: Object $self, Str $foo> and C<()> will become
#pod C<CodeRef $orig: Object $self>.
#pod
#pod =cut

sub register_method_declaration {
    my ($self, $meta, $name, $method) = @_;
    return $meta->add_method($name, $method);
}

#pod =head1 SEE ALSO
#pod
#pod =for :list
#pod * L<MooseX::Declare>
#pod * L<MooseX::Declare::Syntax::MooseSetup>
#pod * L<MooseX::Declare::Syntax::MethodDeclaration>
#pod * L<MooseX::Method::Signatures>
#pod
#pod =cut

1;

__END__

=pod

=encoding UTF-8

=head1 NAME

MooseX::Declare::Syntax::Keyword::Method - Handle method declarations

=head1 VERSION

version 0.40

=head1 DESCRIPTION

This role is an extension of L<MooseX::Declare::Syntax::MethodDeclaration>
that allows you to install keywords that declare methods.

=head1 METHODS

=head2 register_method_declaration

  Object->register_method_declaration (Object $metaclass, Str $name, Object $method)

This method required by the method declaration role will register the finished
method object via the C<< $metaclass->add_method >> method.

  MethodModifier->new(
      identifier           => 'around',
      modifier_type        => 'around',
      prototype_injections => {
          declarator => 'around',
          injections => [ 'CodeRef $orig' ],
      },
  );

This will mean that the signature C<(Str $foo)> will become
C<CodeRef $orig: Object $self, Str $foo> and C<()> will become
C<CodeRef $orig: Object $self>.

=head1 CONSUMES

=over 4

=item *

L<MooseX::Declare::Syntax::MethodDeclaration>

=back

=head1 SEE ALSO

=over 4

=item *

L<MooseX::Declare>

=item *

L<MooseX::Declare::Syntax::MooseSetup>

=item *

L<MooseX::Declare::Syntax::MethodDeclaration>

=item *

L<MooseX::Method::Signatures>

=back

=head1 AUTHOR

Florian Ragwitz <[e-mail]>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2008 by Florian Ragwitz.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut