Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

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

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

NAME

       Mouse::Util - Utilities for working with Mouse classes

VERSION

       This document describes Mouse version 0.99

SYNOPSIS

	   use Mouse::Util; # turns on strict and warnings

DESCRIPTION

       This module provides a set of utility functions. Many of these functions are intended for use in Mouse itself or MouseX modules, but some
       of them may be useful for use in your own code.

IMPLEMENTATIONS FOR

   Moose::Util functions
       The following functions are exportable.

       "find_meta($class_or_obj)"

       The same as "Mouse::Util::class_of()".

       "does_role($class_or_obj, $role_or_obj)"

       "resolve_metaclass_alias($category, $name, %options)"

       "apply_all_roles($applicant, @roles)"

       "english_listi(@items)"

   Class::MOP functions
       The following functions are not exportable.

       "Mouse::Util::is_class_loaded($classname) -> Bool"

       Returns whether $classname is actually loaded or not.  It uses a heuristic which involves checking for the existence of $VERSION, @ISA, and
       any locally-defined method.

       "Mouse::Util::load_class($classname) -> ClassName"

       This will load a given $classname (or die if it is not loadable).  This function can be used in place of tricks like "eval "use $module
       ()"" or using "require".

       "Mouse::Util::class_of($classname_or_object) -> MetaClass"

       "Mouse::Util::get_metaclass_by_name($classname) -> MetaClass"

       "Mouse::Util::get_all_metaclass_instances() -> (MetaClasses)"

       "Mouse::Util::get_all_metaclass_names() -> (ClassNames)"

   mro (or MRO::Compat)
       "get_linear_isa"

   Sub::Identify
       "get_code_info"

Mouse specific utilities
       "not_supported"

       "get_code_package"

       "get_code_ref"

SEE ALSO

       Moose::Util

       Class::MOP

       Sub::Identify

       mro

       MRO::Compat

perl v5.14.2							    2012-06-30							  Mouse::Util(3pm)

Check Out this Related Man Page

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

NAME

       Mouse::Object - The base object for Mouse classes

VERSION

       This document describes Mouse version 0.99

METHODS

   "$class->new(%args | \%args) -> Object"
       Instantiates a new "Mouse::Object". This is obviously intended for subclasses.

   "$class->BUILDARGS(@args) -> HashRef"
       Lets you override the arguments that "new" takes.  It must return a HashRef of parameters.

   "$object->BUILDALL(\%args)"
       Calls "BUILD" on each class in the class hierarchy. This is called at the end of "new".

   "$object->BUILD(\%args)"
       You may put any business logic initialization in BUILD methods. You don't need to redispatch or return any specific value.

   "$object->DEMOLISHALL"
       Calls "DEMOLISH" on each class in the class hierarchy. This is called at "DESTROY" time.

   "$object->DEMOLISH"
       You may put any business logic deinitialization in DEMOLISH methods. You don't need to redispatch or return any specific value.

   "$object->does($role_name) -> Bool"
       This will check if the invocant's class does a given $role_name.  This is similar to "isa" for object, but it checks the roles instead.

   "$object->dump($maxdepth) -> Str"
       This is a handy utility for dumping an object with Data::Dumper.  By default, the maximum depth is 3, to avoid making a mess.

   "$object->meta() -> MetaClass"
       This is a method which provides access to the object's metaclass.

SEE ALSO

       Moose::Object

perl v5.14.2							    2012-06-30							Mouse::Object(3pm)
Man Page