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

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

NAME

       Object::Role - base class for non-Moose roles

SYNOPSIS

	{
	  package Object::Dumpable;
	  use base qw/Object::Role/;
	  use Data::Dumper;
	  sub import
	  {
	    my ($class, @args) = @_;
	    my ($caller, %args) = __PACKAGE__->parse_arguments(undef, @args);
	    my $coderef = sub
	      {
		my ($self) = @_;
		return Dumper($self);
	      };
	    __PACKAGE__->install_method(dump => $coderef, $caller);
	  }
	}

	{
	  package Foo;
	  use Object::Dumpable;
	  sub new { ... }
	}

	{
	  package main;
	  my $foo = Foo->new;
	  warn $foo->dump;
	}

DESCRIPTION

       This will be better documented once I fully understand it myself!

       The idea of this is to be a base class for roles like Object::DOES, Object::Stash and Object::ID. It handles parsing of import arguments,
       installing methods into the caller's namespace (like Exporter, but using a technique that is immune to namespace::autoclean) and tracking
       which packages have consumed your role.

       While "Object::Role" is a base class for roles, it is not itself a role, so does not export anything. Instead, your role must inherit from
       it.

   Methods
       "parse_arguments($default_arg_name, @arguments)"
	   Will parse:

	     package My::Class;
	     use My::Role -foo => 1, -bar => [2,3], 4, 5;

	   as:

	     (
	       'My::Class',   # caller,
	       (
		 '-foo' 	    => [1],
		 '-bar' 	    => [2, 3],
		 $default_arg_name  => [4, 5],
	       )
	     )

       "install_method($subname => $coderef, $package)"
	   Installs $coderef as "$package::$subname".

	   Automatically calls register_consumer($package).

       "register_consumer($package)"
	   Records that $package has consumed (used) your role.

       "has_consumer($package)"
	   Check if $package has consumed (used) your role.

BUGS

       Please report any bugs to http://rt.cpan.org/Dist/Display.html?Queue=Object-Role <http://rt.cpan.org/Dist/Display.html?Queue=Object-Role>.

SEE ALSO

       Object::DOES, Object::AUTHORITY.

AUTHOR

       Toby Inkster <tobyink@cpan.org>.

COPYRIGHT AND LICENCE

       This software is copyright (c) 2011 by Toby Inkster.

       This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

DISCLAIMER OF WARRANTIES

       THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
       MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.

perl v5.14.2							    2011-12-15							 Object::Role(3pm)

Moose::Util::MetaRole(3pm)				User Contributed Perl Documentation				Moose::Util::MetaRole(3pm)

NAME

       Moose::Util::MetaRole - Apply roles to any metaclass, as well as the object base class

VERSION

       version 2.0603

SYNOPSIS

	 package MyApp::Moose;

	 use Moose ();
	 use Moose::Exporter;
	 use Moose::Util::MetaRole;

	 use MyApp::Role::Meta::Class;
	 use MyApp::Role::Meta::Method::Constructor;
	 use MyApp::Role::Object;

	 Moose::Exporter->setup_import_methods( also => 'Moose' );

	 sub init_meta {
	     shift;
	     my %args = @_;

	     Moose->init_meta(%args);

	     Moose::Util::MetaRole::apply_metaroles(
		 for		 => $args{for_class},
		 class_metaroles => {
		     class => => ['MyApp::Role::Meta::Class'],
		     constructor => ['MyApp::Role::Meta::Method::Constructor'],
		 },
	     );

	     Moose::Util::MetaRole::apply_base_class_roles(
		 for   => $args{for_class},
		 roles => ['MyApp::Role::Object'],
	     );

	     return $args{for_class}->meta();
	 }

DESCRIPTION

       This utility module is designed to help authors of Moose extensions write extensions that are able to cooperate with other Moose
       extensions. To do this, you must write your extensions as roles, which can then be dynamically applied to the caller's metaclasses.

       This module makes sure to preserve any existing superclasses and roles already set for the meta objects, which means that any number of
       extensions can apply roles in any order.

USAGE

       The easiest way to use this module is through Moose::Exporter, which can generate the appropriate "init_meta" method for you, and make sure
       it is called when imported.

FUNCTIONS

       This module provides two functions.

   apply_metaroles( ... )
       This function will apply roles to one or more metaclasses for the specified class. It will return a new metaclass object for the class or
       role passed in the "for" parameter.

       It accepts the following parameters:

       o   for => $name

	   This specifies the class or for which to alter the meta classes. This can be a package name, or an appropriate meta-object (a
	   Moose::Meta::Class or Moose::Meta::Role).

       o   class_metaroles => \%roles

	   This is a hash reference specifying which metaroles will be applied to the class metaclass and its contained metaclasses and helper
	   classes.

	   Each key should in turn point to an array reference of role names.

	   It accepts the following keys:

	   class
	   attribute
	   method
	   wrapped_method
	   instance
	   constructor
	   destructor
	   error
       o   role_metaroles => \%roles

	   This is a hash reference specifying which metaroles will be applied to the role metaclass and its contained metaclasses and helper
	   classes.

	   It accepts the following keys:

	   role
	   attribute
	   method
	   required_method
	   conflicting_method
	   application_to_class
	   application_to_role
	   application_to_instance
	   application_role_summation
	   applied_attribute

   apply_base_class_roles( for => $class, roles => @roles )
       This function will apply the specified roles to the object's base class.

BUGS

       See "BUGS" in Moose for details on reporting bugs.

AUTHOR

       Moose is maintained by the Moose Cabal, along with the help of many contributors. See "CABAL" in Moose and "CONTRIBUTORS" in Moose for
       details.

COPYRIGHT AND LICENSE

       This software is copyright (c) 2012 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.14.2							    2012-06-28						Moose::Util::MetaRole(3pm)