Клонирование объектов в PHP
Иногда может потребоваться создать копию уже заполненного объекта, чтобы не устанавливать свойства заново. Для этого в PHP используется ключевое слово clone. Например, предположим ситуацию, что мы создали объект класса и заполнили часть его свойств:
name = $name; > public function setCity($value) < $this->city = $value; > > $user = new User("Иван"); $user->setCity("Москва"); Рассмотрим следующие примеры клонирования объектов.
Удачный пример клонирования объекта
Предположим, что у Ивана есть сестра Маша, которая живет в том же городе. Чтобы не создавать объект заново, мы можем сделать копию уже существующего объекта и поменять только имя:
setCity("Москва"); $user2 = clone $user; $user2->name = "Маша"; print_r($user); print_r($user2); В данном случае мы описали пример удачного клонирования объектов, поскольку в переменной $user2 у нас будет копия объекта $user, а не ссылка на него.
Неудачный пример клонирования объекта
Если в указанном выше примере убрать ключевое слово clone, то мы получим ссылку на объект $user, а не его копию:
setCity("Москва"); $user2 = $user; $user2->name = "Маша"; print_r($user); print_r($user2); Тем самым, при изменении свойства name у объекта $user2 мы поменяем данное свойство и у объекта $user.
Изменения при клонировании объекта
С помощью магического метода __clone мы можем указать дополнительные действия, которые требуется выполнить при клонировании объекта. Например, мы можем сделать, чтобы при клонировании объекта User, его свойство name было пустой строкой:
name = $name; > public function setCity($value) < $this->city = $value; > public function __clone() < $this->name = ""; > > $user = new User("Иван"); $user->setCity("Москва"); $user2 = clone $user; print_r($user); print_r($user2); Таким образом в переменной $user2 свойство name будет пустым.
Запрещаем клонирование
Чтобы запретить клонирование объектов класса, нам требуется сделать приватным магический метод __clone, таким образом пример ниже выдаст фатальную ошибку:
name = $name; > public function setCity($value) < $this->city = $value; > private function __clone() < >> $user = new User("Иван"); $user->setCity("Москва"); $user2 = clone $user; // здесь будет ошибка Сделать копию объекта php
Создание копии объекта с абсолютно идентичными свойствами не всегда является приемлемым вариантом. Хорошим примером необходимости копирования конструкторов может послужить ситуация, когда у вас есть объект, представляющий собой окно GTK и содержащий ресурс-идентификатор этого окна; когда вы создаёте копию этого объекта, вам может понадобиться, чтобы копия объекта содержала ресурс-идентификатор нового окна. Другим примером может послужить ситуация, когда ваш объект содержит ссылку на какой-либо другой используемый объект и, когда вы создаёте копию родительского объекта, вам нужно также создать новый экземпляр этого другого объекта, так, чтобы копия объекта-контейнера содержала собственный отдельный экземпляр содержащегося объекта.
Копия объекта создаётся с использованием ключевого слова clone (который вызывает метод __clone() объекта, если это возможно).
$copy_of_object = clone $object;
При клонировании объекта, PHP выполняет поверхностную копию всех свойств объекта. Любые свойства, являющиеся ссылками на другие переменные, останутся ссылками.
После завершения клонирования, если метод __clone() определён, то будет вызван метод __clone() вновь созданного объекта для возможного изменения всех необходимых свойств.
Пример #1 Клонирование объекта
class SubObject
static $instances = 0 ;
public $instance ;
public function __construct () $this -> instance = ++ self :: $instances ;
>
public function __clone () $this -> instance = ++ self :: $instances ;
>
>
class MyCloneable
public $object1 ;
public $object2 ;
function __clone ()
// Принудительно клонируем this->object1, иначе
// он будет указывать на один и тот же объект.
$this -> object1 = clone $this -> object1 ;
>
>
$obj -> object1 = new SubObject ();
$obj -> object2 = new SubObject ();
print( «Оригинальный объект:\n» );
print_r ( $obj );
print( «Клонированный объект:\n» );
print_r ( $obj2 );
Результат выполнения данного примера:
Оригинальный объект: MyCloneable Object ( [object1] => SubObject Object ( [instance] => 1 ) [object2] => SubObject Object ( [instance] => 2 ) ) Клонированный объект: MyCloneable Object ( [object1] => SubObject Object ( [instance] => 3 ) [object2] => SubObject Object ( [instance] => 2 ) )
Возможно обращаться к свойствам/методам только что склонированного объекта:
Пример #2 Доступ к только что склонированному объекту
Результатом выполнения данного примера будет что-то подобное:
User Contributed Notes 14 notes
I think it’s relevant to note that __clone is NOT an override. As the example shows, the normal cloning process always occurs, and it’s the responsibility of the __clone method to «mend» any «wrong» action performed by it.
Here is test script i wrote to test the behaviour of clone when i have arrays with primitive values in my class — as an additonal test of the note below by jeffrey at whinger dot nl
private $myArray = array();
function pushSomethingToArray ( $var ) array_push ( $this -> myArray , $var );
>
function getArray () return $this -> myArray ;
>
//push some values to the myArray of Mainclass
$myObj = new MyClass ();
$myObj -> pushSomethingToArray ( ‘blue’ );
$myObj -> pushSomethingToArray ( ‘orange’ );
$myObjClone = clone $myObj ;
$myObj -> pushSomethingToArray ( ‘pink’ );
//testing
print_r ( $myObj -> getArray ()); //Array([0] => blue,[1] => orange,[2] => pink)
print_r ( $myObjClone -> getArray ()); //Array([0] => blue,[1] => orange)
//so array cloned
I ran into the same problem of an array of objects inside of an object that I wanted to clone all pointing to the same objects. However, I agreed that serializing the data was not the answer. It was relatively simple, really:
Note, that I was working with a multi-dimensional array and I was not using the Key=>Value pair system, but basically, the point is that if you use foreach, you need to specify that the copied data is to be accessed by reference.
Another gotcha I encountered: like __construct and __desctruct, you must call parent::__clone() yourself from inside a child’s __clone() function. The manual kind of got me on the wrong foot here: «An object’s __clone() method cannot be called directly.»
Here is a basic example about clone issue. If we use clone in getClassB method. Return value will be same as new B() result. But it we dont use clone we can effect B::$varA.
class A
protected $classB;
public function __construct() $this->classB = new B();
>
public function getClassB()
return clone $this->classB;
>
>
class B
protected $varA = 2;
public function getVarA()
return $this->varA;
>
public function setVarA()
$this->varA = 3;
>
>
echo $a->getClassB()->getVarA() . PHP_EOL;// with clone -> 2, without clone it returns -> 3
echo $classB->getVarA() . PHP_EOL; // returns always 3
Here are some cloning and reference gotchas we came up against at Last.fm.
1. PHP treats variables as either ‘values types’ or ‘reference types’, where the difference is supposed to be transparent. Object cloning is one of the few times when it can make a big difference. I know of no programmatic way to tell if a variable is intrinsically a value or reference type. There IS however a non-programmatic ways to tell if an object property is value or reference type:
$a = new A ;
$a -> p = ‘Hello’ ; // $a->p is a value type
var_dump ( $a );
$ref =& $a -> p ; // note that this CONVERTS $a->p into a reference type!!
var_dump ( $a );
?>
2. unsetting all-but-one of the references will convert the remaining reference back into a value. Continuing from the previous example:
?>
I interpret this as the reference-count jumping from 2 straight to 0. However.
2. It IS possible to create a reference with a reference count of 1 — i.e. to convert an property from value type to reference type, without any extra references. All you have to do is declare that it refers to itself. This is HIGHLY idiosyncratic, but nevertheless it works. This leads to the observation that although the manual states that ‘Any properties that are references to other variables, will remain references,’ this is not strictly true. Any variables that are references, even to *themselves* (not necessarily to other variables), will be copied by reference rather than by value.
Here’s an example to demonstrate:
class ByRef
var $prop ;
function __construct () < $this ->prop =& $this -> prop ; >
>
$a = new ByVal ;
$a -> prop = 1 ;
$b = clone $a ;
$b -> prop = 2 ; // $a->prop remains at 1
$a = new ByRef ;
$a -> prop = 1 ;
$b = clone $a ;
$b -> prop = 2 ; // $a->prop is now 2
It should go without saying that if you have circular references, where a property of object A refers to object B while a property of B refers to A (or more indirect loops than that), then you’ll be glad that clone does NOT automatically make a deep copy!
function __clone ()
$this -> that = clone $this -> that ;
>
$a = new Foo ;
$b = new Foo ;
$a -> that = $b ;
$b -> that = $a ;
$c = clone $a ;
echo ‘What happened?’ ;
var_dump ( $c );
This base class automatically clones attributes of type object or array values of type object recursively. Just inherit your own classes from this base class.
class clone_base
public function __clone ()
$object_vars = get_object_vars ( $this );
foreach ( $object_vars as $attr_name => $attr_value )
if ( is_object ( $this -> $attr_name ))
$this -> $attr_name = clone $this -> $attr_name ;
>
else if ( is_array ( $this -> $attr_name ))
// Note: This copies only one dimension arrays
foreach ( $this -> $attr_name as & $attr_array_value )
if ( is_object ( $attr_array_value ))
$attr_array_value = clone $attr_array_value ;
>
unset( $attr_array_value );
>
>
>
>
>
?>
Example:
class foo extends clone_base
public $attr = «Hello» ;
public $b = null ;
public $attr2 = array();
public function __construct ()
$this -> b = new bar ( «World» );
$this -> attr2 [] = new bar ( «What’s» );
$this -> attr2 [] = new bar ( «up?» );
>
>
class bar extends clone_base
public $attr ;
public function __construct ( $attr_value )
$this -> attr = $attr_value ;
>
>
$f1 = new foo ();
$f2 = clone $f1 ;
$f2 -> attr = «James» ;
$f2 -> b -> attr = «Bond» ;
$f2 -> attr2 [ 0 ]-> attr = «Agent» ;
$f2 -> attr2 [ 1 ]-> attr = «007» ;
echo «f1.attr keyword»>. $f1 -> attr . «\n» ;
echo «f1.b.attr keyword»>. $f1 -> b -> attr . «\n» ;
echo «f1.attr2[0] keyword»>. $f1 -> attr2 [ 0 ]-> attr . «\n» ;
echo «f1.attr2[1] keyword»>. $f1 -> attr2 [ 1 ]-> attr . «\n» ;
echo «\n» ;
echo «f2.attr keyword»>. $f2 -> attr . «\n» ;
echo «f2.b.attr keyword»>. $f2 -> b -> attr . «\n» ;
echo «f2.attr2[0] keyword»>. $f2 -> attr2 [ 0 ]-> attr . «\n» ;
echo «f2.attr2[1] keyword»>. $f2 -> attr2 [ 1 ]-> attr . «\n» ;
?>
Клонирование объектов
Создание копии объекта с абсолютно идентичными свойствами не всегда является приемлемым вариантом. Хорошим примером необходимости копирования конструкторов может послужить ситуация, когда у вас есть объект, представляющий собой окно GTK и содержащий ресурс-идентификатор этого окна; когда вы создаете копию этого объекта, вам может понадобиться, чтобы копия объекта содержала ресурс-идентификатор нового окна. Другим примером может послужить ситуация, когда ваш объект содержит ссылку на какой-либо другой используемый объект и, когда вы создаёте копию родительского объекта, вам нужно также создать новый экземпляр этого другого объекта, так, чтобы копия объекта-контейнера содержала собственный отдельный экземпляр содержащегося объекта.
Копия объекта создается с использованием ключевого слова clone (который вызывает метод __clone() объекта, если это возможно). Вызов метода __clone() не может быть осуществлён непосредственно.
$copy_of_object = clone $object;
При клонировании объекта, PHP 5 выполняет неполную копию всех свойств объекта. Любые свойства, являющиеся ссылками на другие переменные, останутся ссылками.
По завершении клонирования, если у класса был определен метод __clone(), то этот метод __clone() вызывается у свежесозданной копии объекта, для возможного изменения всех необходимых свойств.
Пример #1 Клонирование объекта
class SubObject
static $instances = 0 ;
public $instance ;
public function __construct () $this -> instance = ++ self :: $instances ;
>
public function __clone () $this -> instance = ++ self :: $instances ;
>
>
class MyCloneable
public $object1 ;
public $object2 ;
function __clone ()
// Принудительно копируем this->object, иначе
// он будет указывать на один и тот же объект.
$this -> object1 = clone $this -> object1 ;
>
>
$obj -> object1 = new SubObject ();
$obj -> object2 = new SubObject ();
print( «Оригинальный объект:\n» );
print_r ( $obj );
print( «Клонированный объект:\n» );
print_r ( $obj2 );
Результат выполнения данного примера:
Оригинальный объект: MyCloneable Object ( [object1] => SubObject Object ( [instance] => 1 ) [object2] => SubObject Object ( [instance] => 2 ) ) Клонированный объект: MyCloneable Object ( [object1] => SubObject Object ( [instance] => 3 ) [object2] => SubObject Object ( [instance] => 2 ) )