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;
15 use MooseX::ClassAttribute::Trait::Application::ToInstance;
17 Moose::Exporter->setup_import_methods( with_meta => ['class_has'] );
23 return Moose::Util::MetaRole::apply_metaclass_roles(
26 class => ['MooseX::ClassAttribute::Trait::Class'],
29 role => ['MooseX::ClassAttribute::Trait::Role'],
30 application_to_class =>
31 ['MooseX::ClassAttribute::Trait::Application::ToClass'],
32 application_to_role =>
33 ['MooseX::ClassAttribute::Trait::Application::ToRole'],
34 application_to_instance => [
35 'MooseX::ClassAttribute::Trait::Application::ToInstance'
46 my $attrs = ref $name eq 'ARRAY' ? $name : [$name];
48 $meta->add_class_attribute( $_, %options ) for @{$attrs};
59 MooseX::ClassAttribute - Declare class attributes Moose-style
66 use MooseX::ClassAttribute;
71 default => sub { {} },
74 __PACKAGE__->meta()->make_immutable();
77 no MooseX::ClassAttribute;
81 My::Class->Cache()->{thing} = ...;
85 This module allows you to declare class attributes in exactly the same
86 way as object attributes, using C<class_has()> instead of C<has()>.
88 You can use any feature of Moose's attribute declarations, including
89 overriding a parent's attributes, delegation (C<handles>), and
90 attribute metaclasses, and it should just work. The one exception is
91 the "required" flag, which is not allowed for class attributes.
93 The accessor methods for class attribute may be called on the class
94 directly, or on objects of that class. Passing a class attribute to
95 the constructor will not set it.
99 This class exports one function when you use it, C<class_has()>. This
100 works exactly like Moose's C<has()>, but it declares class attributes.
102 One little nit is that if you include C<no Moose> in your class, you
103 won't remove the C<class_has()> function. To do that you must include
104 C<no MooseX::ClassAttribute> as well.
106 =head2 Implementation and Immutability
108 This module will add a role to your class's metaclass, See
109 L<MooseX::ClassAttribute::Trait::Class> for details. This role
110 provides introspection methods for class attributes.
112 Class attributes themselves do the
113 L<MooseX::ClassAttribute::Trait::Attribute> role.
115 There is also a L<MooseX::ClassAttribute::Meta::Method::Accessor>
116 which provides part of the inlining implementation for class
119 =head2 Cooperation with Metaclasses and Traits
121 This module should work with most attribute metaclasses and traits,
122 but it's possible that conflicts could occur. This module has been
123 tested to work with C<MooseX::AttributeHelpers>.
127 If you'd like to thank me for the work I've done on this module,
128 please consider making a "donation" to me via PayPal. I spend a lot of
129 free time creating free software, and would appreciate any support
132 Please note that B<I am not suggesting that you must do this> in order
133 for me to continue working on this particular software. I will
134 continue to do so, inasmuch as I have in the past, for as long as it
137 Similarly, a donation made in this way will probably not make me work
138 on this software much more, unless I get so many donations that I can
139 consider working on free software full time, which seems unlikely at
142 To donate, log into PayPal and send money to autarch@urth.org or use
143 the button on this page:
144 L<http://www.urth.org/~autarch/fs-donation.html>
148 Dave Rolsky, C<< <autarch@urth.org> >>
152 Please report any bugs or feature requests to
153 C<bug-moosex-classattribute@rt.cpan.org>, or through the web interface
154 at L<http://rt.cpan.org>. I will be notified, and then you'll
155 automatically be notified of progress on your bug as I make changes.
157 =head1 COPYRIGHT & LICENSE
159 Copyright 2007-2008 Dave Rolsky, All Rights Reserved.
161 This program is free software; you can redistribute it and/or modify
162 it under the same terms as Perl itself.