Merge pull request #234 from phpDocumentor/fix/233-in_function_define…

…d_const Fix #233 inline defined const
phpDocumentor · Jan 4, 2022 · d0fcff5 · d0fcff5
2 parents 7666c4b + 88e6692
commit d0fcff5
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 1 deletion.
diff --git a/src/phpDocumentor/Reflection/Php/Factory/ContextStack.php b/src/phpDocumentor/Reflection/Php/Factory/ContextStack.php
@@ -10,6 +10,7 @@
 use phpDocumentor\Reflection\Php\Project;
 use phpDocumentor\Reflection\Types\Context as TypeContext;
 
+use function array_reverse;
 use function end;
 
 final class ContextStack
@@ -73,4 +74,26 @@ public function peek()
 
         return $element;
     }
+
+    /**
+     * Returns the first element of type.
+     *
+     * Will reverse search the stack for an element matching $type. Will return null when the element type is not
+     * in the current stack.
+     *
+     * @param class-string $type
+     *
+     * @return Element|FileElement|null
+     */
+    public function search(string $type)
+    {
+        $reverseElements = array_reverse($this->elements);
+        foreach ($reverseElements as $element) {
+            if ($element instanceof $type) {
+                return $element;
+            }
+        }
+
+        return null;
+    }
 }
diff --git a/src/phpDocumentor/Reflection/Php/Factory/Define.php b/src/phpDocumentor/Reflection/Php/Factory/Define.php
@@ -99,7 +99,7 @@ protected function doCreate(
             return;
         }
 
-        $file = $context->peek();
+        $file = $context->search(FileElement::class);
         assert($file instanceof FileElement);
 
         $constant = new ConstantElement(

diff --git a/tests/integration/data/Luigi/constants.php b/tests/integration/data/Luigi/constants.php
@@ -5,3 +5,7 @@
 const OVEN_TEMPERATURE = 9001;
 define('\\Luigi\\MAX_OVEN_TEMPERATURE', 9002);
 define('OUTSIDE_OVEN_TEMPERATURE', 9002);
+
+function in_function_define(){
+    define('IN_FUNCTION_OVEN_TEMPERATURE', 9003);
+}
diff --git a/tests/unit/phpDocumentor/Reflection/Php/Factory/ContextStackTest.php b/tests/unit/phpDocumentor/Reflection/Php/Factory/ContextStackTest.php
@@ -7,6 +7,7 @@
 use OutOfBoundsException;
 use phpDocumentor\Reflection\Fqsen;
 use phpDocumentor\Reflection\Php\Class_ as ClassElement;
+use phpDocumentor\Reflection\Php\Method;
 use phpDocumentor\Reflection\Php\Project;
 use phpDocumentor\Reflection\Types\Context;
 use PHPUnit\Framework\TestCase as PHPUnitTestCase;
@@ -89,4 +90,33 @@ public function testCreateWithTypeContext(): void
         self::assertSame($project, $context->getProject());
         self::assertSame($typeContext, $context->getTypeContext());
     }
+
+    /**
+     * @covers ::__construct
+     * @covers ::search
+     */
+    public function testSearchEmptyStackResultsInNull(): void
+    {
+        $project = new Project('myProject');
+        $context = new ContextStack($project);
+
+        self::assertNull($context->search(ClassElement::class));
+    }
+
+    /**
+     * @covers ::__construct
+     * @covers ::search
+     */
+    public function testSearchStackForExistingElementTypeWillReturnTheFirstHit(): void
+    {
+        $class = new ClassElement(new Fqsen('\MyClass'));
+        $project = new Project('myProject');
+        $context = new ContextStack($project);
+        $context = $context
+            ->push(new ClassElement(new Fqsen('\OtherClass')))
+            ->push($class)
+            ->push(new Method(new Fqsen('\MyClass::method()')));
+
+        self::assertSame($class, $context->search(ClassElement::class));
+    }
 }