Merge pull request #45 from nonamephp/feature/validator-type-resource

Add validator for resource, stream, dir, and file

Author: cdtweb

README.md

@@ -231,6 +231,10 @@ if ($valid) {
 * `ipv4` Validate that value is IPv4
 * `ipv6` Validate that value is IPv6
 * `date`, `datetime` Validate that value is date/datetime
+* `resource` Validate that value is a resource
+* `stream` Validate that value is a stream
+* `dir`, `directory` Validate that value is a directory
+* `file` Validate that value is a file
 
 **Hint:** Adding `[]` to any type (e.g. `int[]`) will validate an array of values.
 

src/Validator.php

@@ -34,6 +34,11 @@
  * @method static bool isIPv6(mixed $value, array $rule = []) Checks if value is valid IPv6
  * @method static bool isDate(mixed $value, array $rule = []) Checks if value is date/datetime
  * @method static bool isDateTime(mixed $value, array $rule = []) Checks if value is date/datetime
+ * @method static bool isResource(mixed $value, array $rule = []) Checks if value is resource
+ * @method static bool isStream(mixed $value, array $rule = []) Checks if value is resource
+ * @method static bool isDir(mixed $value, array $rule = []) Checks if value is directory
+ * @method static bool isDirectory(mixed $value, array $rule = []) Checks if value is directory
+ * @method static bool isFile(mixed $value, array $rule = []) Checks if value is file
  */
 class Validator
 {
@@ -235,6 +240,24 @@ protected function registerBuiltInTypes()
             'alias' => 'datetime',
             'validator' => [$this, 'validateDateTime']
         ]);
+
+        $this->addType('resource', [
+            'validator' => [$this, 'validateResource']
+        ]);
+
+        $this->addType('stream', [
+            'extends' => 'resource',
+            'validator' => [$this, 'validateStream']
+        ]);
+
+        $this->addType('dir', [
+            'alias' => 'directory',
+            'validator' => [$this, 'validateDir']
+        ]);
+
+        $this->addType('file', [
+            'validator' => [$this, 'validateFile']
+        ]);
     }
 
     /**
@@ -864,4 +887,90 @@ protected function validateDateTime($value, array $rule = []): bool
 
         return true;
     }
+
+    /**
+     * Validate that $value is a valid resource.
+     *
+     * @param mixed $value
+     * @param array $rule
+     * @return bool
+     */
+    protected function validateResource($value, array $rule = []): bool
+    {
+        $valid = is_resource($value);
+
+        if ($valid && isset($rule['resource_type']) && is_string($rule['resource_type'])) {
+            $valid = Str::equals(get_resource_type($value), $rule['resource_type'], false);
+            if (!$valid) {
+                $this->setError($rule['name'], "Value ($value) failed to validate as resource type of '{$rule['resource_type']}'");
+                return true;
+            }
+        }
+
+        return $valid;
+    }
+
+    /**
+     * Validate that $value is a valid stream.
+     *
+     * @param mixed $value
+     * @param array $rule
+     * @return bool
+     */
+    protected function validateStream($value, array $rule = []): bool
+    {
+        return is_resource($value) && get_resource_type($value) == 'stream';
+    }
+
+    /**
+     * Validate the $value is a valid directory.
+     *
+     * @param $value
+     * @param array $rule
+     * @return bool
+     */
+    protected function validateDir($value, array $rule = []): bool
+    {
+        $valid = is_dir($value);
+
+        if ($valid && isset($rule['is_writable']) && $rule['is_writable'] == true) {
+            if (!is_writeable($value)) {
+                $this->setError($rule['name'], "Directory ($value) must be writable.");
+                return true;
+            }
+        } elseif ($valid && isset($rule['is_writable']) && $rule['is_writable'] == false) {
+            if (is_writeable($value)) {
+                $this->setError($rule['name'], "Directory ($value) must not be writable.");
+                return true;
+            }
+        }
+
+        return $valid;
+    }
+
+    /**
+     * Validate the $value is a valid file.
+     *
+     * @param $value
+     * @param array $rule
+     * @return bool
+     */
+    protected function validateFile($value, array $rule = []): bool
+    {
+        $valid = is_file($value);
+
+        if ($valid && isset($rule['is_writable']) && $rule['is_writable'] == true) {
+            if (!is_writeable($value)) {
+                $this->setError($rule['name'], "File ($value) must be writable.");
+                return true;
+            }
+        } elseif ($valid && isset($rule['is_writable']) && $rule['is_writable'] == false) {
+            if (is_writeable($value)) {
+                $this->setError($rule['name'], "File ($value) must not be writable.");
+                return true;
+            }
+        }
+
+        return $valid;
+    }
 }

tests/ValidatorTest.php

@@ -3,6 +3,8 @@
 
 class ValidatorTest extends \PHPUnit_Framework_TestCase
 {
+    protected $dir;
+    protected $file;
     protected $resource;
     protected $nullValues;
     protected $booleanValues;
@@ -30,6 +32,8 @@ class ValidatorTest extends \PHPUnit_Framework_TestCase
     protected function setUp()
     {
         // Create resource/stream
+        $this->dir = __DIR__ . '/fixtures';
+        $this->file = $this->dir . '/resource.txt';
         $this->resource = fopen(__DIR__ . '/fixtures/resource.txt', 'r');
 
         // Set values for each data type
@@ -741,6 +745,43 @@ public function testValidateDateTime()
         }
     }
 
+    /**
+     * @covers Validator::validateResource
+     */
+    public function testValidateResource()
+    {
+        $this->assertTrue(Validator::isResource($this->resource));
+        $this->assertTrue(Validator::isResource($this->resource, ['resource_type' => 'stream']));
+    }
+
+    /**
+     * @covers Validator::validateStream
+     */
+    public function testValidateStream()
+    {
+        $this->assertTrue(Validator::isStream($this->resource));
+    }
+
+    /**
+     * @covers Validator::validateDir
+     */
+    public function testValidateDir()
+    {
+        $this->assertTrue(Validator::isDir($this->dir));
+        $this->assertTrue(Validator::isDir($this->dir, ['is_writable' => true]));
+        $this->assertFalse(Validator::isDir($this->dir, ['is_writable' => false]));
+    }
+
+    /**
+     * @covers Validator::validateFile
+     */
+    public function testValidateFile()
+    {
+        $this->assertTrue(Validator::isFile($this->file));
+        $this->assertTrue(Validator::isFile($this->file, ['is_writable' => true]));
+        $this->assertFalse(Validator::isFile($this->file, ['is_writable' => false]));
+    }
+
     /**
      * Test 'required' setting for rules.
      */