MooseX::ClassAttribute::Trait::Class

Section: User Contributed Perl Documentation (3)
Updated: 2016-05-29
Page Index

NAME

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

VERSION

version 0.29

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.

Bugs may be submitted through the RT bug tracker <http://rt.cpan.org/Public/Dist/Display.html?Name=MooseX-ClassAttribute> (or bug-moosex-classattribute@rt.cpan.org <mailto:bug-moosex-classattribute@rt.cpan.org>).

I am also usually active on IRC as 'drolsky' on "irc://irc.perl.org".

AUTHOR

Dave Rolsky <autarch@urth.org>

COPYRIGHT AND LICENCE

This is free software, licensed under:

  The Artistic License 2.0 (GPL Compatible)