Tweaks & cosmetic changes (#83)

Author: theofidry

composer.json

@@ -23,7 +23,7 @@
         "php": ">=5.4.0"
     },
     "require-dev": {
-        "doctrine/collections": "1.*",
+        "doctrine/collections": "^1.0",
         "phpunit/phpunit": "~4.1"
     },
 

src/DeepCopy/DeepCopy.php

@@ -2,39 +2,44 @@
 
 namespace DeepCopy;
 
+use DateTimeInterface;
 use DeepCopy\Exception\CloneException;
 use DeepCopy\Filter\Filter;
 use DeepCopy\Matcher\Matcher;
 use DeepCopy\TypeFilter\Spl\SplDoublyLinkedList;
 use DeepCopy\TypeFilter\TypeFilter;
 use DeepCopy\TypeMatcher\TypeMatcher;
+use ReflectionObject;
 use ReflectionProperty;
 use DeepCopy\Reflection\ReflectionHelper;
 
 /**
- * DeepCopy
- *
  * @final
  */
 class DeepCopy
 {
     /**
-     * @var array
+     * @var object[] List of objects copied.
      */
     private $hashMap = [];
 
     /**
      * Filters to apply.
-     * @var array
+     *
+     * @var array Array of ['filter' => Filter, 'matcher' => Matcher] pairs.
      */
     private $filters = [];
 
     /**
      * Type Filters to apply.
-     * @var array
+     *
+     * @var array Array of ['filter' => Filter, 'matcher' => Matcher] pairs.
      */
     private $typeFilters = [];
 
+    /**
+     * @var bool
+     */
     private $skipUncloneable = false;
 
     /**
@@ -50,23 +55,28 @@ public function __construct($useCloneMethod = false)
     {
         $this->useCloneMethod = $useCloneMethod;
 
-        $this->addTypeFilter(new SplDoublyLinkedList($this), new TypeMatcher('\SplDoublyLinkedList'));
+        $this->addTypeFilter(new SplDoublyLinkedList($this), new TypeMatcher('SplDoublyLinkedList'));
     }
 
     /**
-     * Cloning uncloneable properties won't throw exception.
+     * If enabled, will not throw an exception when coming across an uncloneable property.
+     *
      * @param $skipUncloneable
+     *
      * @return $this
      */
     public function skipUncloneable($skipUncloneable = true)
     {
         $this->skipUncloneable = $skipUncloneable;
+
         return $this;
     }
 
     /**
-     * Perform a deep copy of the object.
+     * Deep copies the given object.
+     *
      * @param mixed $object
+     *
      * @return mixed
      */
     public function copy($object)
@@ -92,7 +102,6 @@ public function addTypeFilter(TypeFilter $filter, TypeMatcher $matcher)
         ];
     }
 
-
     private function recursiveCopy($var)
     {
         // Matches Type Filter
@@ -104,14 +113,17 @@ private function recursiveCopy($var)
         if (is_resource($var)) {
             return $var;
         }
+
         // Array
         if (is_array($var)) {
             return $this->copyArray($var);
         }
+
         // Scalar
         if (! is_object($var)) {
             return $var;
         }
+
         // Object
         return $this->copyObject($var);
     }
@@ -131,8 +143,12 @@ private function copyArray(array $array)
     }
 
     /**
-     * Copy an object
+     * Copies an object.
+     *
      * @param object $object
+     *
+     * @throws CloneException
+     *
      * @return object
      */
     private function copyObject($object)
@@ -143,29 +159,35 @@ private function copyObject($object)
             return $this->hashMap[$objectHash];
         }
 
-        $reflectedObject = new \ReflectionObject($object);
-
-        if (false === $isCloneable = $reflectedObject->isCloneable() and $this->skipUncloneable) {
-            $this->hashMap[$objectHash] = $object;
-            return $object;
-        }
+        $reflectedObject = new ReflectionObject($object);
+        $isCloneable = $reflectedObject->isCloneable();
 
         if (false === $isCloneable) {
-            throw new CloneException(sprintf(
-                'Class "%s" is not cloneable.',
-                $reflectedObject->getName()
-            ));
+            if ($this->skipUncloneable) {
+                $this->hashMap[$objectHash] = $object;
+
+                return $object;
+            }
+
+            throw new CloneException(
+                sprintf(
+                    'Class "%s" is not cloneable.',
+                    $reflectedObject->getName()
+                )
+            );
         }
 
         $newObject = clone $object;
         $this->hashMap[$objectHash] = $newObject;
+
         if ($this->useCloneMethod && $reflectedObject->hasMethod('__clone')) {
             return $object;
         }
 
-        if ($newObject instanceof \DateTimeInterface) {
+        if ($newObject instanceof DateTimeInterface) {
             return $newObject;
         }
+
         foreach (ReflectionHelper::getProperties($reflectedObject) as $property) {
             $this->copyObjectProperty($newObject, $property);
         }
@@ -195,11 +217,13 @@ function ($object) {
                         return $this->recursiveCopy($object);
                     }
                 );
+
                 // If a filter matches, we stop processing this property
                 return;
             }
         }
 
+        // No filter has been applied: simply copy the value
         $property->setAccessible(true);
         $propertyValue = $property->getValue($object);
 
@@ -208,10 +232,12 @@ function ($object) {
     }
 
     /**
-     * Returns first filter that matches variable, NULL if no such filter found.
+     * Returns first filter that matches variable, `null` if no such filter found.
+     *
      * @param array $filterRecords Associative array with 2 members: 'filter' with value of type {@see TypeFilter} and
      *                             'matcher' with value of type {@see TypeMatcher}
      * @param mixed $var
+     *
      * @return TypeFilter|null
      */
     private function getFirstMatchedTypeFilter(array $filterRecords, $var)
@@ -230,10 +256,13 @@ function (array $record) use ($var) {
     }
 
     /**
-     * Returns first element that matches predicate, NULL if no such element found.
-     * @param array    $elements
+     * Returns first element that matches predicate, `null` if no such element found.
+     *
+     * @param array    $elements Array of ['filter' => Filter, 'matcher' => Matcher] pairs.
      * @param callable $predicate Predicate arguments are: element.
-     * @return mixed|null
+     *
+     * @return array|null Associative array with 2 members: 'filter' with value of type {@see TypeFilter} and 'matcher'
+     *                    with value of type {@see TypeMatcher} or `null`.
      */
     private function first(array $elements, callable $predicate)
     {

src/DeepCopy/Exception/CloneException.php

@@ -1,6 +1,9 @@
 <?php
+
 namespace DeepCopy\Exception;
 
-class CloneException extends \UnexpectedValueException
+use UnexpectedValueException;
+
+class CloneException extends UnexpectedValueException
 {
 } 

src/DeepCopy/Filter/Doctrine/DoctrineCollectionFilter.php

@@ -6,7 +6,7 @@
 use ReflectionProperty;
 
 /**
- * Set a null value for a property
+ * Sets a null value for a property.
  *
  * @final
  */

src/DeepCopy/Filter/Doctrine/DoctrineEmptyCollectionFilter.php

@@ -4,22 +4,23 @@
 
 use DeepCopy\Filter\Filter;
 use Doctrine\Common\Collections\ArrayCollection;
+use ReflectionProperty;
 
 /**
  * @final
  */
 class DoctrineEmptyCollectionFilter implements Filter
 {
     /**
-     * Apply the filter to the object.
+     * Applies the filter to the object.
      *
      * @param object   $object
      * @param string   $property
      * @param callable $objectCopier
      */
     public function apply($object, $property, $objectCopier)
     {
-        $reflectionProperty = new \ReflectionProperty($object, $property);
+        $reflectionProperty = new ReflectionProperty($object, $property);
         $reflectionProperty->setAccessible(true);
 
         $reflectionProperty->setValue($object, new ArrayCollection());

src/DeepCopy/Filter/Filter.php

@@ -8,7 +8,8 @@
 interface Filter
 {
     /**
-     * Apply the filter to the object.
+     * Applies the filter to the object.
+     *
      * @param object   $object
      * @param string   $property
      * @param callable $objectCopier

src/DeepCopy/Filter/ReplaceFilter.php

@@ -2,8 +2,10 @@
 
 namespace DeepCopy\Filter;
 
+use ReflectionProperty;
+
 /**
- * Replace the value of a property
+ * Replaces the value of a property
  *
  * @final
  */
@@ -27,7 +29,7 @@ public function __construct(callable $callable)
      */
     public function apply($object, $property, $objectCopier)
     {
-        $reflectionProperty = new \ReflectionProperty($object, $property);
+        $reflectionProperty = new ReflectionProperty($object, $property);
         $reflectionProperty->setAccessible(true);
 
         $value = call_user_func($this->callback, $reflectionProperty->getValue($object));

src/DeepCopy/Filter/SetNullFilter.php

@@ -5,7 +5,7 @@
 use ReflectionProperty;
 
 /**
- * Set a null value for a property
+ * Sets a null value for a property.
  *
  * @final
  */

src/DeepCopy/Matcher/Matcher.php

@@ -2,14 +2,12 @@
 
 namespace DeepCopy\Matcher;
 
-/**
- * Matcher interface
- */
 interface Matcher
 {
     /**
      * @param object $object
      * @param string $property
+     *
      * @return boolean
      */
     public function matches($object, $property);

src/DeepCopy/Matcher/PropertyMatcher.php

@@ -3,7 +3,7 @@
 namespace DeepCopy\Matcher;
 
 /**
- * Match a specific property of a specific class
+ * Match a specific property of a specific class.
  *
  * @final
  */
@@ -34,6 +34,6 @@ public function __construct($class, $property)
      */
     public function matches($object, $property)
     {
-        return ($object instanceof $this->class) && ($property == $this->property);
+        return ($object instanceof $this->class) && $property == $this->property;
     }
 }

src/DeepCopy/Matcher/PropertyNameMatcher.php

@@ -3,7 +3,7 @@
 namespace DeepCopy\Matcher;
 
 /**
- * Match a property by its name
+ * Matches a property by its name.
  *
  * @final
  */

src/DeepCopy/Matcher/PropertyTypeMatcher.php

@@ -2,10 +2,11 @@
 
 namespace DeepCopy\Matcher;
 
+use ReflectionException;
 use ReflectionProperty;
 
 /**
- * Match a property by its type
+ * Matches a property by its type.
  *
  * It is recommended to use {@see DeepCopy\TypeFilter\TypeFilter} instead, as it applies on all occurrences
  * of given type in copied context (eg. array elements), not just on object properties.
@@ -32,7 +33,12 @@ public function __construct($propertyType)
      */
     public function matches($object, $property)
     {
-        $reflectionProperty = new ReflectionProperty($object, $property);
+        try {
+            $reflectionProperty = new ReflectionProperty($object, $property);
+        } catch (ReflectionException $exception) {
+            return false;
+        }
+
         $reflectionProperty->setAccessible(true);
 
         return $reflectionProperty->getValue($object) instanceof $this->propertyType;