#1272 DDC-2704 - implementation for a property getter utility

2025-03-21 07:23:55 +03:00 · 2015-01-24 14:29:09 +01:00 · 2015-01-24 14:29:09 +01:00 · 5ec300452a
commit 5ec300452a
parent 1b0a5e38d9
1 changed files with 161 additions and 0 deletions
--- a/lib/Doctrine/ORM/Mapping/Reflection/ReflectionPropertiesGetter.php
+++ b/lib/Doctrine/ORM/Mapping/Reflection/ReflectionPropertiesGetter.php
@ -0,0 +1,161 @@
+<?php
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the MIT license. For more information, see
+ * <http://www.doctrine-project.org>.
+ */
+
+namespace Doctrine\ORM\Mapping\Reflection;
+
+use Doctrine\Common\Persistence\Mapping\ReflectionService;
+use ReflectionClass;
+use ReflectionProperty;
+
+/**
+ * Utility class to retrieve all reflection instance properties of a given class, including
+ * private inherited properties and transient properties.
+ *
+ * @author Marco Pivetta <ocramius@gmail.com>
+ */
+final class ReflectionPropertiesGetter
+{
+    /**
+     * @var ReflectionProperty[][] indexed by class name and property internal name
+     */
+    private $properties = [];
+
+    /**
+     * @var ReflectionService
+     */
+    private $reflectionService;
+
+    /**
+     * @param ReflectionService $reflectionService
+     */
+    public function __construct(ReflectionService $reflectionService)
+    {
+        $this->reflectionService = $reflectionService;
+    }
+
+    /**
+     * @param $className
+     *
+     * @return ReflectionProperty[] indexed by property internal name
+     */
+    public function getProperties($className)
+    {
+        if (isset($this->properties[$className])) {
+            return $this->properties[$className];
+        }
+
+        return $this->properties[$className] = call_user_func_array(
+            'array_merge',
+            // first merge because `array_merge` expects >= 1 params
+            array_merge(
+                [[]],
+                array_map(
+                    [$this, 'getClassProperties'],
+                    $this->getHierarchyClasses($className)
+                )
+            )
+        );
+    }
+
+    /**
+     * @param string $className
+     *
+     * @return ReflectionClass[]
+     */
+    private function getHierarchyClasses($className)
+    {
+        $classes         = [];
+        $parentClassName = $className;
+
+        while ($parentClassName && $currentClass = $this->reflectionService->getClass($parentClassName)) {
+            $classes[]       = $currentClass;
+            $parentClassName = null;
+
+            if ($parentClass = $currentClass->getParentClass()) {
+                $parentClassName = $parentClass->getName();
+            }
+        }
+
+        return $classes;
+    }
+
+    /**
+     * @param ReflectionClass $reflectionClass
+     *
+     * @return ReflectionProperty[]
+     */
+    private function getClassProperties(ReflectionClass $reflectionClass)
+    {
+        $properties = $reflectionClass->getProperties();
+
+        return array_filter(
+            array_filter(array_map(
+                [$this, 'getAccessibleProperty'],
+                array_combine(
+                    array_map([$this, 'getLogicalName'], $properties),
+                    $properties
+                )
+            )),
+            [$this, 'isInstanceProperty']
+        );
+    }
+
+    /**
+     * @param ReflectionProperty $reflectionProperty
+     *
+     * @return bool
+     */
+    private function isInstanceProperty(ReflectionProperty $reflectionProperty)
+    {
+        return ! $reflectionProperty->isStatic();
+    }
+
+    /**
+     * @param ReflectionProperty $property
+     *
+     * @return null|ReflectionProperty
+     */
+    private function getAccessibleProperty(ReflectionProperty $property)
+    {
+        return $this->reflectionService->getAccessibleProperty(
+            $property->getDeclaringClass()->getName(),
+            $property->getName()
+        );
+    }
+
+    /**
+     * @param ReflectionProperty $property
+     *
+     * @return string
+     */
+    private function getLogicalName(ReflectionProperty $property)
+    {
+        $propertyName = $property->getName();
+
+        if ($property->isPublic()) {
+            return $propertyName;
+        }
+
+        if ($property->isProtected()) {
+            return "\0*\0" . $propertyName;
+        }
+
+        return "\0" . $property->getDeclaringClass()->getName() . "\0" . $propertyName;
+    }
+}