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)

PP(3pm) 						User Contributed Perl Documentation						   PP(3pm)

NAME

       Clone::PP - Recursively copy Perl datatypes

SYNOPSIS

	 use Clone::PP qw(clone);

	 $item = { 'foo' => 'bar', 'move' => [ 'zig', 'zag' ]  };
	 $copy = clone( $item );

	 $item = [ 'alpha', 'beta', { 'gamma' => 'vlissides' } ];
	 $copy = clone( $item );

	 $item = Foo->new();
	 $copy = clone( $item );

       Or as an object method:

	 require Clone::PP;
	 push @Foo::ISA, 'Clone::PP';

	 $item = Foo->new();
	 $copy = $item->clone();

DESCRIPTION

       This module provides a general-purpose clone function to make deep copies of Perl data structures. It calls itself recursively to copy
       nested hash, array, scalar and reference types, including tied variables and objects.

       The clone() function takes a scalar argument to copy. To duplicate arrays or hashes, pass them in by reference:

	 my $copy = clone(@array);    my @copy = @{ clone(@array) };
	 my $copy = clone(\%hash);     my %copy = %{ clone(\%hash) };

       The clone() function also accepts an optional second parameter that can be used to limit the depth of the copy. If you pass a limit of 0,
       clone will return the same value you supplied; for a limit of 1, a shallow copy is constructed; for a limit of 2, two layers of copying are
       done, and so on.

	 my $shallow_copy = clone( $item, 1 );

       To allow objects to intervene in the way they are copied, the clone() function checks for a couple of optional methods. If an object pro-
       vides a method named "clone_self", it is called and the result returned without further processing. Alternately, if an object provides a
       method named "clone_init", it is called on the copied object before it is returned.

BUGS

       Some data types, such as globs, regexes, and code refs, are always copied shallowly.

       References to hash elements are not properly duplicated. (This is why two tests in t/dclone.t that are marked "todo".) For example, the
       following test should succeed but does not:

	 my $hash = { foo => 1 };
	 $hash->{bar} = { $hash->{foo} };
	 my $copy = clone( \%hash );
	 $hash->{foo} = 2;
	 $copy->{foo} = 2;
	 ok( $hash->{bar} == $copy->{bar} );

       To report bugs via the CPAN web tracking system, go to "http://rt.cpan.org/NoAuth/Bugs.html?Dist=Clone-PP" or send mail to
       "Dist=Clone-PP#rt.cpan.org", replacing "#" with "@".

SEE ALSO

       For a faster implementation in XS, see "clone" in Clone, "clone" in Util, or <Storable/dclone>.

CREDITS AND COPYRIGHT

       Developed by Matthew Simon Cavalletto at Evolution Softworks.  More free Perl software is available at "www.evoscript.org".

       Copyright 2003 Matthew Simon Cavalletto. You may contact the author directly at "evo@cpan.org" or "simonm@cavalletto.org".

       Code initially derived from Ref.pm. Portions Copyright 1994 David Muir Sharnoff.

       Interface based by Clone by Ray Finch with contributions from chocolateboy.  Portions Copyright 2001 Ray Finch. Portions Copyright 2001
       chocolateboy.

       You may use, modify, and distribute this software under the same terms as Perl.

perl v5.8.8							    2008-03-27								   PP(3pm)