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)
Check Out this Related Man Page
Moose::Cookbook::Meta::Recipe1(3) User Contributed Perl Documentation Moose::Cookbook::Meta::Recipe1(3)NAME
Moose::Cookbook::Meta::Recipe1 - Welcome to the meta world (Why Go Meta?)
VERSION
version 2.0205
SUMMARY
You might want to read Moose::Manual::MOP if you haven't done so yet.
If you've ever thought "Moose is great, but I wish it did X differently", then you've gone meta. The meta recipes demonstrate how to change
and extend the way Moose works by extending and overriding how the meta classes (Moose::Meta::Class, Moose::Meta::Attribute, etc) work.
The metaclass API is a set of classes that describe classes, roles, attributes, etc. The metaclass API lets you ask questions about a
class, like "what attributes does it have?", or "what roles does the class do?"
The metaclass system also lets you make changes to a class, for example by adding new methods or attributes.
The interface presented by Moose.pm ("has", "with", "extends") is just a thin layer of syntactic sugar over the underlying metaclass
system.
By extending and changing how this metaclass system works, you can create your own Moose variant.
Examples
Let's say that you want to add additional properties to attributes. Specifically, we want to add a "label" property to each attribute, so
we can write "My::Class->meta()->get_attribute('size')->label()". The first two recipes show two different ways to do this, one with a full
meta-attribute subclass, and the other with an attribute trait.
You might also want to add additional properties to your metaclass. For example, if you were writing an ORM based on Moose, you could
associate a table name with each class via the class's metaclass object, letting you write "My::Class->meta()->table_name()".
SEE ALSO
Many of the MooseX modules on CPAN implement metaclass extensions. A couple good examples include MooseX::Singleton and
MooseX::AttributeHelpers. For a more complex example see Fey::ORM or Reaction.
AUTHOR
Stevan Little <stevan@iinteractive.com>
COPYRIGHT AND LICENSE
This software is copyright (c) 2011 by Infinity Interactive, Inc..
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
perl v5.12.5 2011-09-06 Moose::Cookbook::Meta::Recipe1(3)