From: Dave Rolsky Date: Tue, 17 Mar 2009 14:41:58 +0000 (-0500) Subject: docs for CMOP::Metohd X-Git-Tag: 0.78_02~30 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=c40e7f373b8a3b32c8e73f73c975347e83d655a7;p=gitmo%2FClass-MOP.git docs for CMOP::Metohd --- diff --git a/lib/Class/MOP/Method.pm b/lib/Class/MOP/Method.pm index 3cae994..4710a03 100644 --- a/lib/Class/MOP/Method.pm +++ b/lib/Class/MOP/Method.pm @@ -139,118 +139,121 @@ Class::MOP::Method - Method Meta Object =head1 DESCRIPTION The Method Protocol is very small, since methods in Perl 5 are just -subroutines within the particular package. We provide a very basic +subroutines in a specific package. We provide a very basic introspection interface. =head1 METHODS -=head2 Introspection - =over 4 -=item B +=item B<< Class::MOP::Method->wrap($code, %options) >> -This will return a B instance which is related -to this class. +This is the constructor. It accepts a subroutine reference and a hash +of options. -=back +The options are: -=head2 Construction +=over 8 -=over 4 +=item * name + +The method name (without a package name). This is required. -=item B +=item * package_name -This is the basic constructor, it returns a B -instance which wraps the given C<$code> reference. You must also set -the C and C attributes in C<%params>. +The package name for the method. This is required. -=item B +=item * associated_metaclass -This will make a copy of the object, allowing you to override -any values by stuffing them in C<%params>. +An optional L object. This is the metaclass for the +method's class. =back -=head2 Informational +=item B<< $metamethod->clone(%params) >> -=over 4 +This makes a shallow clone of the method object. In particular, +subroutine reference itself is shared between all clones of a given +method. + +When a method is cloned, the original method object will be available +by calling C on the clone. -=item B +=item B<< $metamethod->body >> -This returns the actual CODE reference of the particular instance. +This returns a reference to the method's subroutine. -=item B +=item B<< $metamethod->name >> -This returns the name of the CODE reference. +This returns the method's name -=item B +=item B<< $metamethod->package_name >> -The metaclass of the method +This returns the method's package name. -=item B +=item B<< $metamethod->fully_qualified_name >> -This returns the package name that the CODE reference is attached to. +This returns the method's fully qualified name (package name and +method name). -=item B +=item B<< $metamethod->associated_metaclass >> -This returns the fully qualified name of the CODE reference. +This returns the L object for the method, if one +exists. -=item B +=item B<< $metamethod->original_method >> If this method object was created as a clone of some other method object, this returns the object that was cloned. -=item B +=item B<< $metamethod->original_name >> -This returns the original name of the CODE reference, wherever it was -first defined. +This returns the method's original name, wherever it was first +defined. If this method is a clone of a clone (of a clone, etc.), this method returns the name from the I method in the chain of clones. -=item B +=item B<< $metamethod->original_package_name >> -This returns the original package name that the CODE reference is -attached to, wherever it was first defined. +This returns the method's original package name, wherever it was first +defined. If this method is a clone of a clone (of a clone, etc.), this method returns the package name from the I method in the chain of clones. -=item B +=item B<< $metamethod->original_fully_qualified_name >> -This returns the original fully qualified name of the CODE reference, -wherever it was first defined. +This returns the method's original fully qualified name, wherever it +was first defined. If this method is a clone of a clone (of a clone, etc.), this method returns the fully qualified name from the I method in the chain of clones. -=back +=item B<< $metamethod->attach_to_class($metaclass) >> -=head2 Metaclass +Given a L object, this method sets the associated +metaclass for the method. This will overwrite any existing associated +metaclass. -=over 4 - -=item B - -Sets the associated metaclass +=item B<< $metamethod->detach_from_class >> -=item B +Removes any associated metaclass object for the method. -Disassociates the method from the metaclass +=item B<< $metamethod->execute(...) >> -=back - -=head2 Miscellaneous +This executes the method. Any arguments provided will be passed on to +the method itself. -=over 4 +=item B<< Class::MOP::Method->meta >> -=item B +This will return a L instance for this class. -Executes the method. Be sure to pass in the instance, since the -method expects it. +It should also be noted that L will actually bootstrap +this module by installing a number of attribute meta-objects into its +metaclass. =back