MC-36640: Validation Update

- Fixed static test failure.

Author: Hwashiang Yu

lib/internal/Magento/Framework/Filesystem/Directory/Read.php

@@ -5,10 +5,14 @@
  */
 namespace Magento\Framework\Filesystem\Directory;
 
+use FilesystemIterator;
 use Magento\Framework\Exception\FileSystemException;
 use Magento\Framework\Exception\ValidatorException;
+use Magento\Framework\Filesystem\DriverInterface;
 
 /**
+ * Directory Read Class
+ *
  * @api
  * @since 100.0.2
  */
@@ -31,11 +35,13 @@ class Read implements ReadInterface
     /**
      * Filesystem driver
      *
-     * @var \Magento\Framework\Filesystem\DriverInterface
+     * @var DriverInterface
      */
     protected $driver;
 
     /**
+     * Validator for path strings
+     *
      * @var PathValidatorInterface|null
      */
     private $pathValidator;
@@ -44,13 +50,13 @@ class Read implements ReadInterface
      * Constructor. Set properties.
      *
      * @param \Magento\Framework\Filesystem\File\ReadFactory $fileFactory
-     * @param \Magento\Framework\Filesystem\DriverInterface $driver
+     * @param DriverInterface $driver
      * @param string $path
      * @param PathValidatorInterface|null $pathValidator
      */
     public function __construct(
         \Magento\Framework\Filesystem\File\ReadFactory $fileFactory,
-        \Magento\Framework\Filesystem\DriverInterface $driver,
+        DriverInterface $driver,
         $path,
         ?PathValidatorInterface $pathValidator = null
     ) {
@@ -61,6 +67,8 @@ public function __construct(
     }
 
     /**
+     * Validate provided path with scheme.
+     *
      * @param null|string $path
      * @param null|string $scheme
      * @param bool $absolutePath
@@ -88,6 +96,7 @@ protected function validatePath(
      * Sets base path
      *
      * @param string $path
+     *
      * @return void
      */
     protected function setPath($path)
@@ -98,12 +107,12 @@ protected function setPath($path)
     }
 
     /**
-     * Retrieves absolute path
-     * E.g.: /var/www/application/file.txt
+     * Retrieves absolute path E.g.: /var/www/application/file.txt
      *
      * @param string $path
      * @param string $scheme
      * @throws ValidatorException
+     *
      * @return string
      */
     public function getAbsolutePath($path = null, $scheme = null)
@@ -135,6 +144,7 @@ public function getRelativePath($path = null)
      * Retrieve list of all entities in given path
      *
      * @param string|null $path
+     * @throws FileSystemException
      * @throws ValidatorException
      * @return string[]
      */
@@ -153,7 +163,8 @@ public function read($path = null)
     /**
      * Read recursively
      *
-     * @param null $path
+     * @param string|null $path
+     * @throws FileSystemException
      * @throws ValidatorException
      * @return string[]
      */
@@ -163,7 +174,7 @@ public function readRecursively($path = null)
 
         $result = [];
         $paths = $this->driver->readDirectoryRecursively($this->driver->getAbsolutePath($this->path, $path));
-        /** @var \FilesystemIterator $file */
+        /** @var FilesystemIterator $file */
         foreach ($paths as $file) {
             $result[] = $this->getRelativePath($file);
         }
@@ -176,6 +187,7 @@ public function readRecursively($path = null)
      *
      * @param string $pattern
      * @param string $path [optional]
+     * @throws FileSystemException
      * @throws ValidatorException
      * @return string[]
      */
@@ -202,24 +214,22 @@ public function search($pattern, $path = null)
      *
      * @param string $path [optional]
      * @return bool
-     * @throws \Magento\Framework\Exception\FileSystemException
+     * @throws FileSystemException
      * @throws ValidatorException
      */
     public function isExist($path = null)
     {
         $this->validatePath($path);
 
-        return $this->driver->isExists(
-            $this->driver->getRealPathSafety($this->driver->getAbsolutePath($this->path, $path))
-        );
+        return $this->driver->isExists($this->driver->getAbsolutePath($this->path, $path));
     }
 
     /**
      * Gathers the statistics of the given path
      *
      * @param string $path
-     * @return arrays
-     * @throws \Magento\Framework\Exception\FileSystemException
+     * @return array
+     * @throws FileSystemException
      * @throws ValidatorException
      */
     public function stat($path)
@@ -234,7 +244,7 @@ public function stat($path)
      *
      * @param string $path [optional]
      * @return bool
-     * @throws \Magento\Framework\Exception\FileSystemException
+     * @throws FileSystemException
      * @throws ValidatorException
      */
     public function isReadable($path = null)
@@ -284,6 +294,7 @@ public function readFile($path, $flag = null, $context = null)
      * Check whether given path is file
      *
      * @param string $path
+     * @throws FileSystemException
      * @throws ValidatorException
      * @return bool
      */
@@ -298,6 +309,7 @@ public function isFile($path)
      * Check whether given path is directory
      *
      * @param string $path [optional]
+     * @throws FileSystemException
      * @throws ValidatorException
      * @return bool
      */