moosex::classattribute::trait::class(3) [osx man page]

MooseX::ClassAttribute::Trait::Class(3) 		User Contributed Perl Documentation		   MooseX::ClassAttribute::Trait::Class(3)

NAME

       MooseX::ClassAttribute::Trait::Class - A trait for classes with class attributes

VERSION

       version 0.26

SYNOPSIS

	 for my $attr ( HasClassAttributes->meta()->get_all_class_attributes() )
	 {
	     print $attr->name();
	 }

DESCRIPTION

       This role adds awareness of class attributes to a metaclass object. It provides a set of introspection methods that largely parallel the
       existing attribute methods, except they operate on class attributes.

METHODS

       Every method provided by this role has an analogous method in "Class::MOP::Class" or "Moose::Meta::Class" for regular attributes.

   $meta->has_class_attribute($name)
   $meta->get_class_attribute($name)
   $meta->get_class_attribute_list()
       These methods operate on the current metaclass only.

   $meta->add_class_attribute(...)
       This accepts the same options as the Moose::Meta::Attribute "add_attribute()" method. However, if an attribute is specified as "required"
       an error will be thrown.

   $meta->remove_class_attribute($name)
       If the named class attribute exists, it is removed from the class, along with its accessor methods.

   $meta->get_all_class_attributes()
       This method returns a list of attribute objects for the class and all its parent classes.

   $meta->find_class_attribute_by_name($name)
       This method looks at the class and all its parent classes for the named class attribute.

   $meta->get_class_attribute_value($name)
   $meta->set_class_attribute_value($name, $value)
   $meta->set_class_attribute_value($name)
   $meta->clear_class_attribute_value($name)
       These methods operate on the storage for class attribute values, which is attached to the metaclass object.

       There's really no good reason for you to call these methods unless you're doing some deep hacking. They are named as public methods solely
       because they are used by other meta roles and classes in this distribution.

BUGS

       See MooseX::ClassAttribute for details.

AUTHOR

       Dave Rolsky <autarch@urth.org>

COPYRIGHT AND LICENSE

       This software is Copyright (c) 2011 by Dave Rolsky.

       This is free software, licensed under:

	 The Artistic License 2.0 (GPL Compatible)

perl v5.16.2							    2011-06-05				   MooseX::ClassAttribute::Trait::Class(3)

MooseX::ClassAttribute(3)				User Contributed Perl Documentation				 MooseX::ClassAttribute(3)

NAME

       MooseX::ClassAttribute - Declare class attributes Moose-style

VERSION

       version 0.27

SYNOPSIS

	   package My::Class;

	   use Moose;
	   use MooseX::ClassAttribute;

	   class_has 'Cache' =>
	       ( is	 => 'rw',
		 isa	 => 'HashRef',
		 default => sub { {} },
	       );

	   __PACKAGE__->meta()->make_immutable();

	   no Moose;
	   no MooseX::ClassAttribute;

	   # then later ...

	   My::Class->Cache()->{thing} = ...;

DESCRIPTION

       This module allows you to declare class attributes in exactly the same way as object attributes, using "class_has()" instead of "has()".

       You can use any feature of Moose's attribute declarations, including overriding a parent's attributes, delegation ("handles"), attribute
       traits, etc. All features should just work. The one exception is the "required" flag, which is not allowed for class attributes.

       The accessor methods for class attribute may be called on the class directly, or on objects of that class. Passing a class attribute to the
       constructor will not set that attribute.

FUNCTIONS

       This class exports one function when you use it, "class_has()". This works exactly like Moose's "has()", but it declares class attributes.

       One little nit is that if you include "no Moose" in your class, you won't remove the "class_has()" function. To do that you must include
       "no MooseX::ClassAttribute" as well. Or you can just use namespace::autoclean instead.

   Implementation and Immutability
       This module will add a role to your class's metaclass, See MooseX::ClassAttribute::Trait::Class for details. This role provides
       introspection methods for class attributes.

       Class attributes themselves do the MooseX::ClassAttribute::Trait::Attribute role.

   Cooperation with Metaclasses and Traits
       This module should work with most attribute metaclasses and traits, but it's possible that conflicts could occur. This module has been
       tested to work with Moose's native traits.

   Class Attributes in Roles
       You can add a class attribute to a role. When that role is applied to a class, the class will have the relevant class attributes added.
       Note that attribute defaults will be calculated when the class attribute is composed into the class.

DONATIONS

       If you'd like to thank me for the work I've done on this module, please consider making a "donation" to me via PayPal. I spend a lot of
       free time creating free software, and would appreciate any support you'd care to offer.

       Please note that I am not suggesting that you must do this in order for me to continue working on this particular software. I will continue
       to do so, inasmuch as I have in the past, for as long as it interests me.

       Similarly, a donation made in this way will probably not make me work on this software much more, unless I get so many donations that I can
       consider working on free software full time, which seems unlikely at best.

       To donate, log into PayPal and send money to autarch@urth.org or use the button on this page:
       <http://www.urth.org/~autarch/fs-donation.html>

BUGS

       Please report any bugs or feature requests to "bug-moosex-classattribute@rt.cpan.org", or through the web interface at
       <http://rt.cpan.org>.  I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

AUTHOR

       Dave Rolsky <autarch@urth.org>

COPYRIGHT AND LICENSE

       This software is Copyright (c) 2013 by Dave Rolsky.

       This is free software, licensed under:

	 The Artistic License 2.0 (GPL Compatible)

perl v5.18.2							    2013-03-28						 MooseX::ClassAttribute(3)