--- name: "Moose::Meta::Role" section: "3pm" platform: "linux" package: "perl-moose" version: "2.4001-2" release: "Arch Linux 2026-11-01" platforms: ["linux"] url: "https://new.carta.tech/Moose::Meta::Role" --- # Moose::Meta::Role(3pm) The Moose Role metaclass ## NAME Moose::Meta::Role - The Moose Role metaclass ## VERSION version 2.4001 ## DESCRIPTION This class is a subclass of Class::MOP::Module that provides additional Moose-specific functionality. Its API looks a lot like Moose::Meta::Class, but internally it implements many things differently. This may change in the future. ## INHERITANCE `"Moose::Meta::Role"` is a subclass of Class::MOP::Module. ## METHODS ### Construction *Moose::Meta::Role-\>initialize($role\_name)* This method creates a new role object with the provided name. *Moose::Meta::Role-\>combine( \[ $role =\> { ... } \], \[ $role \], ... )* This method accepts a list of array references. Each array reference should contain a role name or Moose::Meta::Role object as its first element. The second element is an optional hash reference. The hash reference can contain `"-excludes"` and `"-alias"` keys to control how methods are composed from the role. The return value is a new Moose::Meta::Role::Composite that represents the combined roles. *$metarole-\>composition\_class\_roles* When combining multiple roles using `"combine"`, this method is used to obtain a list of role names to be applied to the Moose::Meta::Role::Composite instance returned by `"combine"`. The default implementation returns an empty list. Extensions that need to hook into role combination may wrap this method to return additional role names. *Moose::Meta::Role-\>create($name, %options)* This method is identical to the Moose::Meta::Class `"create"` method. *Moose::Meta::Role-\>create\_anon\_role* This method is identical to the Moose::Meta::Class `"create_anon_class"` method. *$metarole-\>is\_anon\_role* Returns true if the role is an anonymous role. *$metarole-\>consumers* Returns a list of names of classes and roles which consume this role. ### Role application *$metarole-\>apply( $thing, @options )* This method applies a role to the given `$thing`. That can be another Moose::Meta::Role, object, a Moose::Meta::Class object, or a (non-meta) object instance. The options are passed directly to the constructor for the appropriate Moose::Meta::Role::Application subclass. Note that this will apply the role even if the `$thing` in question already `"does"` this role. "does\_role" in Moose::Util is a convenient wrapper for finding out if role application is necessary. ### Roles and other roles *$metarole-\>get\_roles* This returns an array reference of roles which this role does. This list may include duplicates. *$metarole-\>calculate\_all\_roles* This returns a *unique* list of all roles that this role does, and all the roles that its roles do. *$metarole-\>does\_role($role)* Given a role *name* or Moose::Meta::Role object, returns true if this role does the given role. *$metarole-\>add\_role($role)* Given a Moose::Meta::Role object, this adds the role to the list of roles that the role does. *$metarole-\>get\_excluded\_roles\_list* Returns a list of role names which this role excludes. *$metarole-\>excludes\_role($role\_name)* Given a role *name*, returns true if this role excludes the named role. *$metarole-\>add\_excluded\_roles(@role\_names)* Given one or more role names, adds those roles to the list of excluded roles. ### Methods The methods for dealing with a role's methods are all identical in API and behavior to the same methods in Class::MOP::Class. *$metarole-\>method\_metaclass* Returns the method metaclass name for the role. This defaults to Moose::Meta::Role::Method. *$metarole-\>get\_method($name)* *$metarole-\>has\_method($name)* *$metarole-\>add\_method( $name, $body )* *$metarole-\>get\_method\_list* *$metarole-\>find\_method\_by\_name($name)* These methods are all identical to the methods of the same name in Class::MOP::Class ### Attributes As with methods, the methods for dealing with a role's attribute are all identical in API and behavior to the same methods in Class::MOP::Class. However, attributes stored in this class are *not* stored as objects. Rather, the attribute definition is stored as a hash reference. When a role is composed into a class, this hash reference is passed directly to the metaclass's `"add_attribute"` method. This is quite likely to change in the future. *$metarole-\>get\_attribute($attribute\_name)* *$metarole-\>has\_attribute($attribute\_name)* *$metarole-\>get\_attribute\_list* *$metarole-\>add\_attribute($name, %options)* *$metarole-\>remove\_attribute($attribute\_name)* ### Overload introspection and creation The methods for dealing with a role's overloads are all identical in API and behavior to the same methods in Class::MOP::Class. *$metarole-\>is\_overloaded* *$metarole-\>get\_overloaded\_operator($op)* *$metarole-\>has\_overloaded\_operator($op)* *$metarole-\>get\_overload\_list* *$metarole-\>get\_all\_overloaded\_operators* *$metarole-\>add\_overloaded\_operator($op, $impl)* *$metarole-\>remove\_overloaded\_operator($op)* ### Required methods *$metarole-\>get\_required\_method\_list* Returns the list of methods required by the role. *$metarole-\>requires\_method($name)* Returns true if the role requires the named method. *$metarole-\>add\_required\_methods(@names)* Adds the named methods to the role's list of required methods. *$metarole-\>remove\_required\_methods(@names)* Removes the named methods from the role's list of required methods. *$metarole-\>add\_conflicting\_method(%params)* Instantiate the parameters as a Moose::Meta::Role::Method::Conflicting object, then add it to the required method list. ### Method modifiers These methods act like their counterparts in Class::MOP::Class and Moose::Meta::Class. However, method modifiers are simply stored internally, and are not applied until the role itself is applied to a class or object. *$metarole-\>add\_after\_method\_modifier($method\_name, $method)* *$metarole-\>add\_around\_method\_modifier($method\_name, $method)* *$metarole-\>add\_before\_method\_modifier($method\_name, $method)* *$metarole-\>add\_override\_method\_modifier($method\_name, $method)* These methods all add an appropriate modifier to the internal list of modifiers. *$metarole-\>has\_after\_method\_modifiers* *$metarole-\>has\_around\_method\_modifiers* *$metarole-\>has\_before\_method\_modifiers* *$metarole-\>has\_override\_method\_modifier* Return true if the role has any modifiers of the given type. *$metarole-\>get\_after\_method\_modifiers($method\_name)* *$metarole-\>get\_around\_method\_modifiers($method\_name)* *$metarole-\>get\_before\_method\_modifiers($method\_name)* Given a method name, returns a list of the appropriate modifiers for that method. *$metarole-\>get\_override\_method\_modifier($method\_name)* Given a method name, returns the override method modifier for that method, if it has one. ### Introspection *Moose::Meta::Role-\>meta* This will return a Class::MOP::Class instance for this class. ## BUGS See "BUGS" in Moose for details on reporting bugs. ## AUTHORS - • Stevan Little \ - • Dave Rolsky \ - • Jesse Luehrs \ - • Shawn M Moore \ - • יובל קוג'מן (Yuval Kogman) \ - • Karen Etheridge \ - • Florian Ragwitz \ - • Hans Dieter Pearcey \ - • Chris Prather \ - • Matt S Trout \ ## COPYRIGHT AND LICENSE This software is copyright (c) 2006 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.