1 package MooseX::ClassAttribute;
9 use MooseX::ClassAttribute::Trait::Class;
10 use MooseX::ClassAttribute::Trait::Role;
11 use MooseX::ClassAttribute::Trait::Application::ToClass;
12 use MooseX::ClassAttribute::Trait::Application::ToRole;
14 Moose::Exporter->setup_import_methods(
15 with_meta => ['class_has'],
17 class => ['MooseX::ClassAttribute::Trait::Class'],
20 role => ['MooseX::ClassAttribute::Trait::Role'],
21 application_to_class =>
22 ['MooseX::ClassAttribute::Trait::Application::ToClass'],
23 application_to_role =>
24 ['MooseX::ClassAttribute::Trait::Application::ToRole'],
32 my $attrs = ref $name eq 'ARRAY' ? $name : [$name];
34 my %options = ( definition_context => Moose::Util::_caller_info(), @_ );
36 $meta->add_class_attribute( $_, %options ) for @{$attrs};
41 # ABSTRACT: Declare class attributes Moose-style
52 use MooseX::ClassAttribute;
57 default => sub { {} },
60 __PACKAGE__->meta()->make_immutable();
63 no MooseX::ClassAttribute;
67 My::Class->Cache()->{thing} = ...;
71 This module allows you to declare class attributes in exactly the same
72 way as object attributes, using C<class_has()> instead of C<has()>.
74 You can use any feature of Moose's attribute declarations, including
75 overriding a parent's attributes, delegation (C<handles>), attribute traits,
76 etc. All features should just work. The one exception is the "required" flag,
77 which is not allowed for class attributes.
79 The accessor methods for class attribute may be called on the class
80 directly, or on objects of that class. Passing a class attribute to
81 the constructor will not set that attribute.
85 This class exports one function when you use it, C<class_has()>. This
86 works exactly like Moose's C<has()>, but it declares class attributes.
88 One little nit is that if you include C<no Moose> in your class, you won't
89 remove the C<class_has()> function. To do that you must include C<no
90 MooseX::ClassAttribute> as well. Or you can just use L<namespace::autoclean>
93 =head2 Implementation and Immutability
95 This module will add a role to your class's metaclass, See
96 L<MooseX::ClassAttribute::Trait::Class> for details. This role
97 provides introspection methods for class attributes.
99 Class attributes themselves do the
100 L<MooseX::ClassAttribute::Trait::Attribute> role.
102 =head2 Cooperation with Metaclasses and Traits
104 This module should work with most attribute metaclasses and traits,
105 but it's possible that conflicts could occur. This module has been
106 tested to work with Moose's native traits.
108 =head2 Class Attributes in Roles
110 You can add a class attribute to a role. When that role is applied to a class,
111 the class will have the relevant class attributes added. Note that attribute
112 defaults will be calculated when the class attribute is composed into the
117 If you'd like to thank me for the work I've done on this module,
118 please consider making a "donation" to me via PayPal. I spend a lot of
119 free time creating free software, and would appreciate any support
122 Please note that B<I am not suggesting that you must do this> in order
123 for me to continue working on this particular software. I will
124 continue to do so, inasmuch as I have in the past, for as long as it
127 Similarly, a donation made in this way will probably not make me work
128 on this software much more, unless I get so many donations that I can
129 consider working on free software full time, which seems unlikely at
132 To donate, log into PayPal and send money to autarch@urth.org or use
133 the button on this page:
134 L<http://www.urth.org/~autarch/fs-donation.html>
138 Please report any bugs or feature requests to
139 C<bug-moosex-classattribute@rt.cpan.org>, or through the web interface
140 at L<http://rt.cpan.org>. I will be notified, and then you'll
141 automatically be notified of progress on your bug as I make changes.