Refactor and rename InvalidAttributeException to `UndefinedProperty…

…Exception` (#270)
yiisoft · Nov 17, 2023 · dad3a5a · dad3a5a
1 parent bdfe924
commit dad3a5a
Show file tree

Hide file tree

Showing 6 changed files with 52 additions and 49 deletions.
diff --git a/src/FormModel.php b/src/FormModel.php
@@ -166,7 +166,7 @@ public function hasAttribute(string $attribute): bool
     {
         try {
             $this->readAttributeValue($attribute);
-        } catch (InvalidAttributeException) {
+        } catch (UndefinedPropertyException) {
             return false;
         }
         return true;
@@ -178,7 +178,7 @@ public function isValid(): bool
     }
 
     /**
-     * @throws InvalidAttributeException
+     * @throws UndefinedPropertyException If the property is not in the set.
      */
     private function readAttributeValue(string $attribute): mixed
     {
@@ -191,35 +191,31 @@ private function readAttributeValue(string $attribute): mixed
 
             if (is_array($value)) {
                 if (array_key_exists($key, $value)) {
-                    /** @var mixed $value */
                     $value = $value[$key];
                     continue;
                 }
-                throw $this->createNotFoundException($keys);
+                throw UndefinedPropertyException::forUndefinedProperty($this->makePropertyPathString($keys));
             }
 
             if (is_object($value)) {
                 $class = new ReflectionClass($value);
                 try {
                     $property = $class->getProperty($key);
                 } catch (ReflectionException) {
-                    throw $this->createNotFoundException($keys);
+                    throw UndefinedPropertyException::forUndefinedProperty($this->makePropertyPathString($keys));
                 }
                 if ($property->isStatic()) {
-                    throw $this->createNotFoundException($keys);
+                    throw UndefinedPropertyException::forUndefinedProperty($this->makePropertyPathString($keys));
                 }
                 if (PHP_VERSION_ID < 80100) {
                     $property->setAccessible(true);
                 }
-                /** @var mixed $value */
                 $value = $property->getValue($value);
                 continue;
             }
 
             array_pop($keys);
-            throw new InvalidAttributeException(
-                sprintf('Attribute "%s" is not a nested attribute.', $this->makePathString($keys))
-            );
+            throw UndefinedPropertyException::forNotNestedProperty($this->makePropertyPathString($keys));
         }
 
         return $value;
@@ -305,15 +301,7 @@ private function normalizePath(string $attribute): array
     /**
      * @psalm-param array<array-key, array{0:int|string, 1:mixed}> $keys
      */
-    private function createNotFoundException(array $keys): InvalidArgumentException
-    {
-        return new InvalidAttributeException('Undefined property: "' . $this->makePathString($keys) . '".');
-    }
-
-    /**
-     * @psalm-param array<array-key, array{0:int|string, 1:mixed}> $keys
-     */
-    private function makePathString(array $keys): string
+    private function makePropertyPathString(array $keys): string
     {
         $path = '';
         foreach ($keys as $key) {

diff --git a/src/InvalidAttributeException.php b/src/InvalidAttributeException.php
diff --git a/src/UndefinedPropertyException.php b/src/UndefinedPropertyException.php
@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Form;
+
+use InvalidArgumentException;
+
+final class UndefinedPropertyException extends InvalidArgumentException
+{
+    private function __construct(string $message)
+    {
+        parent::__construct($message);
+    }
+
+    public static function forUndefinedProperty(string $property): self
+    {
+        return new self('Undefined property: "' . $property . '".');
+    }
+
+    public static function forNotNestedProperty(string $property): self
+    {
+        return new self('Property "' . $property . '" is not a nested attribute.');
+    }
+}
diff --git a/tests/FormModelTest.php b/tests/FormModelTest.php
@@ -13,9 +13,10 @@
 use Yiisoft\Form\Tests\Support\TestHelper;
 use Yiisoft\Form\Tests\TestSupport\Form\CustomFormNameForm;
 use Yiisoft\Form\Tests\TestSupport\Form\DefaultFormNameForm;
-use Yiisoft\Form\Tests\TestSupport\Form\FormWithNestedAttribute;
+use Yiisoft\Form\Tests\TestSupport\Form\FormWithNestedProperty;
 use Yiisoft\Form\Tests\TestSupport\Form\LoginForm;
 use Yiisoft\Form\Tests\TestSupport\TestTrait;
+use Yiisoft\Form\UndefinedPropertyException;
 
 require __DIR__ . '/TestSupport/Form/NonNamespacedForm.php';
 
@@ -113,34 +114,34 @@ public function testGetAttributesLabels(): void
         $this->assertSame($expected, $form->getAttributeLabels());
     }
 
-    public function testGetNestedAttributeException(): void
+    public function testGetNestedPropertyException(): void
     {
-        $form = new FormWithNestedAttribute();
+        $form = new FormWithNestedProperty();
 
-        $this->expectException(InvalidArgumentException::class);
+        $this->expectException(UndefinedPropertyException::class);
         $this->expectExceptionMessage(
-            'Attribute "' . FormWithNestedAttribute::class . '::id" is not a nested attribute.'
+            'Property "' . FormWithNestedProperty::class . '::id" is not a nested attribute.'
         );
         $form->getAttributeValue('id.profile');
     }
 
     public function testGetNestedAttributeHint(): void
     {
-        $form = new FormWithNestedAttribute();
+        $form = new FormWithNestedProperty();
 
         $this->assertSame('Write your id or email.', $form->getAttributeHint('user.login'));
     }
 
     public function testGetNestedAttributeLabel(): void
     {
-        $form = new FormWithNestedAttribute();
+        $form = new FormWithNestedProperty();
 
         $this->assertSame('Login:', $form->getAttributeLabel('user.login'));
     }
 
     public function testGetNestedAttributePlaceHolder(): void
     {
-        $form = new FormWithNestedAttribute();
+        $form = new FormWithNestedProperty();
 
         $this->assertSame('Type Username or Email.', $form->getAttributePlaceHolder('user.login'));
     }
@@ -181,7 +182,7 @@ public function testGetAttributeValueException(): void
 
     public function testGetAttributeValueWithNestedAttribute(): void
     {
-        $form = new FormWithNestedAttribute();
+        $form = new FormWithNestedProperty();
 
         $form->setUserLogin('admin');
         $this->assertSame('admin', $form->getAttributeValue('user.login'));
@@ -200,7 +201,7 @@ public function testHasAttribute(): void
 
     public function testHasNestedAttribute(): void
     {
-        $form = new FormWithNestedAttribute();
+        $form = new FormWithNestedProperty();
 
         $this->assertTrue($form->hasAttribute('user.login'));
         $this->assertTrue($form->hasAttribute('user.password'));
@@ -210,7 +211,7 @@ public function testHasNestedAttribute(): void
 
     public function testHasNestedAttributeException(): void
     {
-        $form = new FormWithNestedAttribute();
+        $form = new FormWithNestedProperty();
 
         $this->assertFalse($form->hasAttribute('user.noexist'));
     }
@@ -289,12 +290,12 @@ public function testLoadWithEmptyScope(): void
         $this->assertSame('555', $form->getAttributeValue('string'));
     }
 
-    public function testLoadWithNestedAttribute(): void
+    public function testLoadWithNestedProperty(): void
     {
-        $form = new FormWithNestedAttribute();
+        $form = new FormWithNestedProperty();
 
         $data = [
-            'FormWithNestedAttribute' => [
+            'FormWithNestedProperty' => [
                 'user.login' => 'admin',
             ],
         ];

diff --git a/tests/Helper/HtmlFormErrorsTest.php b/tests/Helper/HtmlFormErrorsTest.php
@@ -8,7 +8,7 @@
 use Yiisoft\Form\Helper\HtmlFormErrors;
 use Yiisoft\Form\Tests\Support\TestHelper;
 use Yiisoft\Form\Tests\TestSupport\Form\LoginForm;
-use Yiisoft\Form\Tests\TestSupport\Form\FormWithNestedAttribute;
+use Yiisoft\Form\Tests\TestSupport\Form\FormWithNestedProperty;
 use Yiisoft\Form\Tests\TestSupport\TestTrait;
 use Yiisoft\Validator\Validator;
 
@@ -131,13 +131,13 @@ public function testGetErrorSummaryOnlyAttributes(): void
         );
     }
 
-    public function testGetErrorNestedAttribute(): void
+    public function testGetErrorNestedProperty(): void
     {
-        $formModel = new FormWithNestedAttribute();
+        $formModel = new FormWithNestedProperty();
         $validator = new Validator();
         $populateResult = TestHelper::createFormHydrator()->populate(
             $formModel,
-            ['FormWithNestedAttribute' => ['user.login' => 'ad']]
+            ['FormWithNestedProperty' => ['user.login' => 'ad']]
         );
 
         $this->assertTrue($populateResult);

diff --git a/...tSupport/Form/FormWithNestedAttribute.php → ...stSupport/Form/FormWithNestedProperty.php b/...tSupport/Form/FormWithNestedAttribute.php → ...stSupport/Form/FormWithNestedProperty.php
@@ -9,7 +9,7 @@
 use Yiisoft\Validator\Rule\Required;
 use Yiisoft\Validator\RulesProviderInterface;
 
-final class FormWithNestedAttribute extends FormModel implements RulesProviderInterface
+final class FormWithNestedProperty extends FormModel implements RulesProviderInterface
 {
     private ?int $id = null;
     private LoginForm $user;