Lots of doc improvements for native delegations.
[gitmo/Moose.git] / lib / Moose / Meta / Attribute / Native / Trait / Code.pm
1 package Moose::Meta::Attribute::Native::Trait::Code;
2 use Moose::Role;
3
4 our $VERSION   = '1.15';
5 $VERSION = eval $VERSION;
6 our $AUTHORITY = 'cpan:STEVAN';
7
8 use Moose::Meta::Method::Accessor::Native::Code::execute;
9 use Moose::Meta::Method::Accessor::Native::Code::execute_method;
10
11 with 'Moose::Meta::Attribute::Native::Trait';
12
13 sub _helper_type { 'CodeRef' }
14
15 no Moose::Role;
16
17 1;
18
19 =pod
20
21 =head1 NAME
22
23 Moose::Meta::Attribute::Native::Trait::Code - Helper trait for Code attributes
24
25 =head1 SYNOPSIS
26
27   package Foo;
28   use Moose;
29
30   has 'callback' => (
31       traits  => ['Code'],
32       is      => 'ro',
33       isa     => 'CodeRef',
34       default => sub {
35           sub { print "called" }
36       },
37       handles => {
38           call => 'execute',
39       },
40   );
41
42   my $foo = Foo->new;
43   $foo->call;    # prints "called"
44
45 =head1 DESCRIPTION
46
47 This provides operations on coderef attributes.
48
49 =head1 PROVIDED METHODS
50
51 =over 4
52
53 =item * B<execute(@args)>
54
55 Calls the coderef with the given args.
56
57 =item * B<execute_method(@args)>
58
59 Calls the coderef with the the instance as invocant and given args.
60
61 =back
62
63 =head1 BUGS
64
65 See L<Moose/BUGS> for details on reporting bugs.
66
67 =head1 AUTHOR
68
69   Florian Ragwitz <rafl@debian.org>
70
71 =head1 COPYRIGHT AND LICENSE
72
73 Copyright 2007-2009 by Infinity Interactive, Inc.
74
75 L<http://www.iinteractive.com>
76
77 This library is free software; you can redistribute it and/or modify
78 it under the same terms as Perl itself.
79
80 =cut