1 package MooseX::ClassAttribute;
7 our $AUTHORITY = 'cpan:DROLSKY';
11 use MooseX::ClassAttribute::Trait::Class;
12 use MooseX::ClassAttribute::Trait::Role;
13 use MooseX::ClassAttribute::Trait::Application::ToClass;
14 use MooseX::ClassAttribute::Trait::Application::ToRole;
16 Moose::Exporter->setup_import_methods(
17 with_meta => ['class_has'],
19 class => ['MooseX::ClassAttribute::Trait::Class'],
22 role => ['MooseX::ClassAttribute::Trait::Role'],
23 application_to_class =>
24 ['MooseX::ClassAttribute::Trait::Application::ToClass'],
25 application_to_role =>
26 ['MooseX::ClassAttribute::Trait::Application::ToRole'],
35 my $attrs = ref $name eq 'ARRAY' ? $name : [$name];
37 $meta->add_class_attribute( $_, %options ) for @{$attrs};
42 # ABSTRACT: Declare class attributes Moose-style
53 use MooseX::ClassAttribute;
58 default => sub { {} },
61 __PACKAGE__->meta()->make_immutable();
64 no MooseX::ClassAttribute;
68 My::Class->Cache()->{thing} = ...;
72 This module allows you to declare class attributes in exactly the same
73 way as object attributes, using C<class_has()> instead of C<has()>.
75 You can use any feature of Moose's attribute declarations, including
76 overriding a parent's attributes, delegation (C<handles>), attribute traits,
77 etc. All features should just work. The one exception is the "required" flag,
78 which is not allowed for class attributes.
80 The accessor methods for class attribute may be called on the class
81 directly, or on objects of that class. Passing a class attribute to
82 the constructor will not set that attribute.
86 This class exports one function when you use it, C<class_has()>. This
87 works exactly like Moose's C<has()>, but it declares class attributes.
89 One little nit is that if you include C<no Moose> in your class, you won't
90 remove the C<class_has()> function. To do that you must include C<no
91 MooseX::ClassAttribute> as well. Or you can just use L<namespace::autoclean>
94 =head2 Implementation and Immutability
96 This module will add a role to your class's metaclass, See
97 L<MooseX::ClassAttribute::Trait::Class> for details. This role
98 provides introspection methods for class attributes.
100 Class attributes themselves do the
101 L<MooseX::ClassAttribute::Trait::Attribute> role.
103 There is also a L<MooseX::ClassAttribute::Meta::Method::Accessor>
104 which provides part of the inlining implementation for class
107 =head2 Cooperation with Metaclasses and Traits
109 This module should work with most attribute metaclasses and traits,
110 but it's possible that conflicts could occur. This module has been
111 tested to work with Moose's native traits.
113 =head2 Class Attributes in Roles
115 You can add a class attribute to a role. When that role is applied to a class,
116 the class will have the relevant class attributes added. Note that attribute
117 defaults will be calculated when the class attribute is composed into the
122 If you'd like to thank me for the work I've done on this module,
123 please consider making a "donation" to me via PayPal. I spend a lot of
124 free time creating free software, and would appreciate any support
127 Please note that B<I am not suggesting that you must do this> in order
128 for me to continue working on this particular software. I will
129 continue to do so, inasmuch as I have in the past, for as long as it
132 Similarly, a donation made in this way will probably not make me work
133 on this software much more, unless I get so many donations that I can
134 consider working on free software full time, which seems unlikely at
137 To donate, log into PayPal and send money to autarch@urth.org or use
138 the button on this page:
139 L<http://www.urth.org/~autarch/fs-donation.html>
143 Please report any bugs or feature requests to
144 C<bug-moosex-classattribute@rt.cpan.org>, or through the web interface
145 at L<http://rt.cpan.org>. I will be notified, and then you'll
146 automatically be notified of progress on your bug as I make changes.