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