1 package MooseX::ClassAttribute;
7 our $AUTHORITY = 'cpan:DROLSKY';
11 use MooseX::ClassAttribute::Role::Meta::Class;
13 Moose::Exporter->setup_import_methods
14 ( with_caller => [ 'class_has' ] );
25 Moose::Util::MetaRole::apply_metaclass_roles
26 ( for_class => $p{for_class},
27 metaclass_roles => [ 'MooseX::ClassAttribute::Role::Meta::Class' ],
37 my $attrs = ref $name eq 'ARRAY' ? $name : [$name];
39 Class::MOP::class_of($caller)
40 ->add_class_attribute( $_, %options )
52 MooseX::ClassAttribute - Declare class attributes Moose-style
59 use MooseX::ClassAttribute;
64 default => sub { {} },
67 __PACKAGE__->meta()->make_immutable();
70 no MooseX::ClassAttribute;
74 My::Class->Cache()->{thing} = ...;
79 This module allows you to declare class attributes in exactly the same
80 way as object attributes, using C<class_has()> instead of C<has()>.
82 You can use any feature of Moose's attribute declarations, including
83 overriding a parent's attributes, delegation (C<handles>), and
84 attribute metaclasses, and it should just work. The one exception is
85 the "required" flag, which is not allowed for class attributes.
87 The accessor methods for class attribute may be called on the class
88 directly, or on objects of that class. Passing a class attribute to
89 the constructor will not set it.
93 This class exports one function when you use it, C<class_has()>. This
94 works exactly like Moose's C<has()>, but it declares class attributes.
96 One little nit is that if you include C<no Moose> in your class, you
97 won't remove the C<class_has()> function. To do that you must include
98 C<no MooseX::ClassAttribute> as well.
100 =head2 Implementation and Immutability
102 This module will add a role to your class's metaclass, See
103 L<MooseX::ClassAttribute::Role::Meta::Class> for details. This role
104 provides introspection methods for class attributes.
106 Class attributes themselves do the
107 L<MooseX::ClassAttribute::Role::Meta::Attribute> role.
109 There is also a L<MooseX::ClassAttribute::Meta::Method::Accessor>
110 which provides part of the inlining implementation for class
113 =head2 Cooperation with Metaclasses and Traits
115 This module should work with most attribute metaclasses and traits,
116 but it's possible that conflicts could occur. This module has been
117 tested to work with C<MooseX::AttributeHelpers>.
121 If you'd like to thank me for the work I've done on this module,
122 please consider making a "donation" to me via PayPal. I spend a lot of
123 free time creating free software, and would appreciate any support
126 Please note that B<I am not suggesting that you must do this> in order
127 for me to continue working on this particular software. I will
128 continue to do so, inasmuch as I have in the past, for as long as it
131 Similarly, a donation made in this way will probably not make me work
132 on this software much more, unless I get so many donations that I can
133 consider working on free software full time, which seems unlikely at
136 To donate, log into PayPal and send money to autarch@urth.org or use
137 the button on this page:
138 L<http://www.urth.org/~autarch/fs-donation.html>
142 Dave Rolsky, C<< <autarch@urth.org> >>
146 Please report any bugs or feature requests to
147 C<bug-moosex-classattribute@rt.cpan.org>, or through the web interface
148 at L<http://rt.cpan.org>. I will be notified, and then you'll
149 automatically be notified of progress on your bug as I make changes.
151 =head1 COPYRIGHT & LICENSE
153 Copyright 2007-2008 Dave Rolsky, All Rights Reserved.
155 This program is free software; you can redistribute it and/or modify
156 it under the same terms as Perl itself.