Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

mouse::role(3pm) [debian man page]

Mouse::Role(3pm)					User Contributed Perl Documentation					  Mouse::Role(3pm)

Mouse::Role - The Mouse Role VERSION
This document describes Mouse version 0.99 SYNOPSIS
package Comparable; use Mouse::Role; # the package is now a Mouse role # Declare methods that are required by this role requires qw(compare); # Define methods this role provides sub equals { my($self, $other) = @_; return $self->compare($other) == 0; } # and later package MyObject; use Mouse; with qw(Comparable); # Now MyObject can equals() sub compare { # ... } my $foo = MyObject->new(); my $bar = MyObject->new(); $obj->equals($bar); # yes, it is comparable DESCRIPTION
This module declares the caller class to be a Mouse role. The concept of roles is documented in Moose::Manual::Roles. This document serves as API documentation. EXPORTED FUNCTIONS
Mouse::Role supports all of the functions that Mouse exports, but differs slightly in how some items are handled (see "CAVEATS" below for details). Mouse::Role also offers two role-specific keywords: "requires(@method_names)" Roles can require that certain methods are implemented by any class which "does" the role. Note that attribute accessors also count as methods for the purposes of satisfying the requirements of a role. "excludes(@role_names)" This is exported but not implemented in Mouse. IMPORT AND UNIMPORT
import Importing Mouse::Role will give you sugar. "-traits" are also supported. unimport Please unimport ("no Mouse::Role") so that if someone calls one of the keywords (such as "has") it will break loudly instead breaking subtly. CAVEATS
Role support has only a few caveats: o Roles cannot use the "extends" keyword; it will throw an exception for now. The same is true of the "augment" and "inner" keywords (not sure those really make sense for roles). All other Mouse keywords will be deferred so that they can be applied to the consuming class. o Role composition does its best to not be order-sensitive when it comes to conflict resolution and requirements detection. However, it is order-sensitive when it comes to method modifiers. All before/around/after modifiers are included whenever a role is composed into a class, and then applied in the order in which the roles are used. This also means that there is no conflict for before/around/after modifiers. In most cases, this will be a non-issue; however, it is something to keep in mind when using method modifiers in a role. You should never assume any ordering. SEE ALSO
Mouse Moose::Role Moose::Manual::Roles Moose::Spec::Role perl v5.14.2 2012-06-30 Mouse::Role(3pm)

Check Out this Related Man Page

MooseX::Role::Parameterized::Extending(3)		User Contributed Perl Documentation		 MooseX::Role::Parameterized::Extending(3)

MooseX::Role::Parameterized::Extending - extending MooseX::Role::Parameterized roles DESCRIPTION
There are heaps of useful modules in the "MooseX" namespace that you can use to make your roles more powerful. However, they do not always work out of the box with MooseX::Role::Parameterized, but it's fairly straight-forward to achieve the functionality you desire. MooseX::Role::Parameterized was designed to be as extensible as the rest of Moose, and as such it is possible to apply custom traits to both the parameterizable role or the ordinary roles they generate. In this example, we will look at applying the fake trait "MooseX::MagicRole" to a parameterizable role. First we need to define a new metaclass for our parameterizable role. package MyApp::Meta::Role::Parameterizable; use Moose; extends 'MooseX::Role::Parameterized::Meta::Role::Parameterizable'; with 'MooseX::MagicRole'; This is a class (observe that it uses Moose, not Moose::Role) which extends the class which governs parameterizable roles. MooseX::Role::Parameterized::Meta::Role::Parameterizable is the metaclass that packages using MooseX::Role::Parameterized receive by default. Note that the class we are extending, MooseX::Role::Parameterized::Meta::Role::Parameterizable, is entirely distinct from the similarly- named class which governs the ordinary roles that parameterized roles generate. An instance of MooseX::Role::Parameterized::Meta::Role::Parameterized represents a role with its parameters already bound. Now we can take advantage of our new subclass by specifying that we want to use "MyApp::Meta::Role::Parameterizable" as our metaclass when importing MooseX::Role::Parameterized: package MyApp::Role; use MooseX::Role::Parameterized -metaclass => 'MyApp::Meta::Role::Parameterizable'; role { ... } And there you go! "MyApp::Role" now has the "MooseX::MagicRole" trait applied. perl v5.18.2 2012-08-14 MooseX::Role::Parameterized::Extending(3)
Man Page

Featured Tech Videos