Add validation rule "exist"

Author: natanfelles

.phpstorm.meta.php

@@ -32,6 +32,7 @@
 );
 registerArgumentsSet(
     'rules',
+    'exist',
     'notUnique',
     'unique',
 );

src/Languages/en/validation.php

@@ -8,6 +8,7 @@
  * file that was distributed with this source code.
  */
 return [
+    'exist' => 'The {field} field does not exist.',
     'notUnique' => 'The {field} field is not registered.',
     'unique' => 'The {field} field has already been registered.',
 ];

src/Languages/es/validation.php

@@ -8,6 +8,7 @@
  * file that was distributed with this source code.
  */
 return [
+    'exist' => 'El campo {field} no existe.',
     'notUnique' => 'El campo {field} no está registrado.',
     'unique' => 'El campo {field} ya se ha registrado. ',
 ];

src/Languages/pt-br/validation.php

@@ -8,6 +8,7 @@
  * file that was distributed with this source code.
  */
 return [
+    'exist' => 'O campo {field} não existe.',
     'notUnique' => 'O campo {field} não está registrado.',
     'unique' => 'O campo {field} já foi registrado.',
 ];

src/Validator.php

@@ -95,4 +95,45 @@ public static function unique(
         }
         return $statement->limit(1)->run()->fetch()->count < 1; // @phpstan-ignore-line
     }
+
+    /**
+     * Validates value exists in database table.
+     *
+     * @since 3.3
+     *
+     * @param string $field
+     * @param array<string,mixed> $data
+     * @param string $tableColumn
+     * @param string $connection
+     *
+     * @return bool
+     */
+    public static function exist(
+        string $field,
+        array $data,
+        string $tableColumn,
+        string $connection = 'default'
+    ) : bool {
+        $value = static::getData($field, $data);
+        if ($value === null) {
+            return false;
+        }
+        [$table, $column] = \array_pad(\explode('.', $tableColumn, 2), 2, '');
+        if ($column === '') {
+            $column = $field;
+        }
+        if ($connection === '') {
+            throw new LogicException(
+                'The connection parameter must be set to be able to connect the database'
+            );
+        }
+        return App::database($connection) // @phpstan-ignore-line
+            ->select()
+            ->expressions(['count' => static fn () => 'COUNT(*)'])
+            ->from($table)
+            ->whereEqual($column, $value)
+            ->limit(1)
+            ->run()
+            ->fetch()->count > 0;
+    }
 }

tests/ValidatorTest.php

@@ -33,6 +33,14 @@ protected function setUp() : void
         App::database()->insert()->into('Users')->values(2, 'bar')->run();
     }
 
+    public function testExistNoDataValue() : void
+    {
+        $validation = App::validation();
+        $validation->setRule('username', 'exist:Users');
+        self::assertFalse($validation->validate([]));
+        self::assertArrayHasKey('username', $validation->getErrors());
+    }
+
     public function testUniqueNoDataValue() : void
     {
         $validation = App::validation();
@@ -49,6 +57,22 @@ public function testNotUniqueNoDataValue() : void
         self::assertArrayNotHasKey('username', $validation->getErrors());
     }
 
+    public function testExist() : void
+    {
+        $validation = App::validation();
+        $validation->setRule('username', 'exist:Users');
+        $data = [
+            'username' => 'foo',
+        ];
+        self::assertTrue($validation->validate($data));
+        self::assertEmpty($validation->getErrors());
+        $data = [
+            'username' => 'bazz',
+        ];
+        self::assertFalse($validation->validate($data));
+        self::assertArrayHasKey('username', $validation->getErrors());
+    }
+
     public function testUnique() : void
     {
         $validation = App::validation();
@@ -71,6 +95,22 @@ public function testNotUnique() : void
         self::assertArrayNotHasKey('username', $validation->getErrors());
     }
 
+    public function testExistWithTableColumn() : void
+    {
+        $validation = App::validation();
+        $validation->setRule('user', 'exist:Users.username');
+        $data = [
+            'user' => 'foo',
+        ];
+        self::assertTrue($validation->validate($data));
+        self::assertEmpty($validation->getErrors());
+        $data = [
+            'user' => 'bazz',
+        ];
+        self::assertFalse($validation->validate($data));
+        self::assertArrayHasKey('user', $validation->getErrors());
+    }
+
     public function testUniqueWithTableColumn() : void
     {
         $validation = App::validation();
@@ -114,6 +154,20 @@ public function testNotUniqueIgnoring() : void
         self::assertArrayHasKey('username', $validation->getErrors());
     }
 
+    public function testExistWithoutConnection() : void
+    {
+        $validation = App::validation();
+        $validation->setRule('username', 'exist:Users,');
+        $this->expectException(\LogicException::class);
+        $this->expectExceptionMessage(
+            'The connection parameter must be set to be able to connect the database'
+        );
+        $data = [
+            'username' => 'foo',
+        ];
+        $validation->validate($data);
+    }
+
     public function testUniqueWithoutConnection() : void
     {
         $validation = App::validation();