moosex::clone(3pm) [debian man page]

MooseX::Clone(3pm)					User Contributed Perl Documentation					MooseX::Clone(3pm)

NAME

       MooseX::Clone - Fine grained cloning support for Moose objects.

SYNOPSIS

	   package Bar;
	   use Moose;

	   with qw(MooseX::Clone);

	   has foo => (
	       isa => "Foo",
	       traits => [qw(Clone)], # this attribute will be recursively cloned
	   );

	   package Foo;
	   use Moose;

	   # this API is used/provided by MooseX::Clone
	   sub clone {
	       my ( $self, %params ) = @_;

	       # ...
	   }

	   # used like this:

	   my $bar = Bar->new( foo => Foo->new );

	   my $copy = $bar->clone( foo => [ qw(Args for Foo::clone) ] );

DESCRIPTION

       Out of the box Moose only provides very barebones cloning support in order to maximize flexibility.

       This role provides a "clone" method that makes use of the low level cloning support already in Moose and adds selective deep cloning based
       on introspection on top of that. Attributes with the "Clone" trait will handle cloning of data within the object, typically delegating to
       the attribute value's own "clone" method.

TRAITS

       Clone
	   By default Moose objects are cloned like this:

	       bless { %$old }, ref $old;

	   By specifying the Clone trait for certain attributes custom behavior the value's own "clone" method will be invoked.

	   By extending this trait you can create custom cloning for certain attributes.

	   By creating "clone" methods for your objects (e.g. by composing MooseX::Compile) you can make them interact with this trait.

       NoClone
	   Specifies attributes that should be skipped entirely while cloning.

METHODS

       clone %params
	   Returns a clone of the object.

	   All attributes which do the MooseX::Clone::Meta::Attribute::Trait::Clone role will handle cloning of that attribute. All other fields
	   are plainly copied over, just like in "clone_object" in Class::MOP::Class.

	   Attributes whose "init_arg" is in %params and who do the "Clone" trait will get that argument passed to the "clone" method
	   (dereferenced). If the attribute does not self-clone then the param is used normally by "clone_object" in Class::MOP::Class, that is it
	   will simply shadow the previous value, and does not have to be an array or hash reference.

TODO

       Refactor to work in term of a metaclass trait so that "meta->clone_object" will still do the right thing.

THANKS

       clkao made the food required to write this module

VERSION CONTROL

       <http://code2.0beta.co.uk/moose/svn/>. Ask on #moose for commit bits.

AUTHOR

       Yuval Kogman <nothingmuch@woobling.org>

COPYRIGHT

	   Copyright (c) 2008 Yuval Kogman. All rights reserved
	   This program is free software; you can redistribute
	   it and/or modify it under the same terms as Perl itself.

perl v5.10.1							    2010-01-14							MooseX::Clone(3pm)

Check Out this Related Man Page

MooseX::Clone::Meta::Attribute::Trait::Clone(3pm)	User Contributed Perl Documentation	 MooseX::Clone::Meta::Attribute::Trait::Clone(3pm)

NAME

       MooseX::Clone::Meta::Attribute::Trait::Clone - The Moose::Meta::Attribute trait for deeply cloning attributes.

SYNOPSIS

	   # see MooseX::Clone

	   has foo => (
	       traits => [qw(Clone)],
	       isa => "Something",
	   );

	   $object->clone; # will recursively call $object->foo->clone and set the value properly

DESCRIPTION

       This meta attribute trait provides a "clone_value" method, in the spirit of "get_value" and "set_value". This allows clone methods such as
       the one in MooseX::Clone to make use of this per-attribute cloning behavior.

DERIVATION

       Deriving this role for your own cloning purposes is encouraged.

       This will allow your fine grained cloning semantics to interact with MooseX::Clone in the RightX way.

ATTRIBUTES

       clone_only_objects
	   Whether or not Data::Visitor should be used to clone arbitrary structures.  Objects found in these structures will be cloned using
	   clone_object_value.

	   If true then non object values will be copied over in shallow cloning semantics (shared reference).

	   Defaults to false (all reference will be cloned).

       clone_visitor_config
	   A hash ref used to construct "clone_visitor". Defaults to the empty ref.

	   This can be used to alter the cloning behavior for non object values.

       clone_visitor
	   The Data::Visitor::Callback object that will be used to clone.

	   It has an "object" handler that delegates to "clone_object_value" and sets "tied_as_objects" to true in order to deeply clone tied
	   structures while retaining magic.

	   Only used if "clone_only_objects" is false and the value of the attribute is not an object.

METHODS

       clone_value $target, $proto, %args
	   Clones the value the attribute encapsulates from $proto into $target.

       clone_value_data $value, %args
	   Does the actual cloning of the value data by delegating to a "clone" method on the object if any.

	   If the object does not support a "clone" method an error is thrown.

	   If the value is not an object then it will not be cloned.

	   In the future support for deep cloning of simple refs will be added too.

       clone_object_value $object, %args
	   This is the actual workhorse of "clone_value_data".

       clone_any_value $value, %args
	   Uses "clone_visitor" to clone all non object values.

	   Called from "clone_value_data" if the value is not an object and "clone_only_objects" is false.

perl v5.10.1							    2010-01-01			 MooseX::Clone::Meta::Attribute::Trait::Clone(3pm)

Linux and UNIX Man Pages

moosex::clone(3pm) [debian man page]

Check Out this Related Man Page