class RecursiveDirectoryIterator in Database Sanitize 7

Extends the \RecursiveDirectoryIterator to support relative paths.

@author Victor Berchet <[e-mail]>

Hierarchy

• class \Symfony\Component\Finder\Iterator\RecursiveDirectoryIterator
  • class \Symfony\Component\Finder\Iterator\RecursiveDirectoryIterator

2 files declare their use of RecursiveDirectoryIterator

ExcludeDirectoryFilterIteratorTest.php in vendor/symfony/finder/Tests/Iterator/ExcludeDirectoryFilterIteratorTest.php

RecursiveDirectoryIteratorTest.php in vendor/symfony/finder/Tests/Iterator/RecursiveDirectoryIteratorTest.php

File

vendor/symfony/finder/Iterator/RecursiveDirectoryIterator.php, line 22

Namespace

Symfony\Component\Finder\Iterator

class RecursiveDirectoryIterator extends \RecursiveDirectoryIterator {

  /**
   * @var bool
   */
  private $ignoreUnreadableDirs;

  /**
   * @var bool
   */
  private $rewindable;

  // these 3 properties take part of the performance optimization to avoid redoing the same work in all iterations
  private $rootPath;
  private $subPath;
  private $directorySeparator = '/';

  /**
   * @param string $path
   * @param int    $flags
   * @param bool   $ignoreUnreadableDirs
   *
   * @throws \RuntimeException
   */
  public function __construct($path, $flags, $ignoreUnreadableDirs = false) {
    if ($flags & (self::CURRENT_AS_PATHNAME | self::CURRENT_AS_SELF)) {
      throw new \RuntimeException('This iterator only support returning current as fileinfo.');
    }
    parent::__construct($path, $flags);
    $this->ignoreUnreadableDirs = $ignoreUnreadableDirs;
    $this->rootPath = $path;
    if ('/' !== \DIRECTORY_SEPARATOR && !($flags & self::UNIX_PATHS)) {
      $this->directorySeparator = \DIRECTORY_SEPARATOR;
    }
  }

  /**
   * Return an instance of SplFileInfo with support for relative paths.
   *
   * @return SplFileInfo File information
   */
  public function current() {

    // the logic here avoids redoing the same work in all iterations
    if (null === ($subPathname = $this->subPath)) {
      $subPathname = $this->subPath = (string) $this
        ->getSubPath();
    }
    if ('' !== $subPathname) {
      $subPathname .= $this->directorySeparator;
    }
    $subPathname .= $this
      ->getFilename();
    return new SplFileInfo($this->rootPath . $this->directorySeparator . $subPathname, $this->subPath, $subPathname);
  }

  /**
   * @return \RecursiveIterator
   *
   * @throws AccessDeniedException
   */
  public function getChildren() {
    try {
      $children = parent::getChildren();
      if ($children instanceof self) {

        // parent method will call the constructor with default arguments, so unreadable dirs won't be ignored anymore
        $children->ignoreUnreadableDirs = $this->ignoreUnreadableDirs;

        // performance optimization to avoid redoing the same work in all children
        $children->rewindable =& $this->rewindable;
        $children->rootPath = $this->rootPath;
      }
      return $children;
    } catch (\UnexpectedValueException $e) {
      if ($this->ignoreUnreadableDirs) {

        // If directory is unreadable and finder is set to ignore it, a fake empty content is returned.
        return new \RecursiveArrayIterator(array());
      }
      else {
        throw new AccessDeniedException($e
          ->getMessage(), $e
          ->getCode(), $e);
      }
    }
  }

  /**
   * Do nothing for non rewindable stream.
   */
  public function rewind() {
    if (false === $this
      ->isRewindable()) {
      return;
    }

    // @see https://bugs.php.net/68557
    if (\PHP_VERSION_ID < 50523 || \PHP_VERSION_ID >= 50600 && \PHP_VERSION_ID < 50607) {
      parent::next();
    }
    parent::rewind();
  }

  /**
   * Checks if the stream is rewindable.
   *
   * @return bool true when the stream is rewindable, false otherwise
   */
  public function isRewindable() {
    if (null !== $this->rewindable) {
      return $this->rewindable;
    }

    // workaround for an HHVM bug, should be removed when https://github.com/facebook/hhvm/issues/7281 is fixed
    if ('' === $this
      ->getPath()) {
      return $this->rewindable = false;
    }
    if (false !== ($stream = @opendir($this
      ->getPath()))) {
      $infos = stream_get_meta_data($stream);
      closedir($stream);
      if ($infos['seekable']) {
        return $this->rewindable = true;
      }
    }
    return $this->rewindable = false;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
RecursiveDirectoryIterator::$directorySeparator	private	property	Overrides RecursiveDirectoryIterator::$directorySeparator	1
RecursiveDirectoryIterator::$ignoreUnreadableDirs	private	property	Overrides RecursiveDirectoryIterator::$ignoreUnreadableDirs	1
RecursiveDirectoryIterator::$rewindable	private	property	Overrides RecursiveDirectoryIterator::$rewindable	1
RecursiveDirectoryIterator::$rootPath	private	property	Overrides RecursiveDirectoryIterator::$rootPath	1
RecursiveDirectoryIterator::$subPath	private	property	Overrides RecursiveDirectoryIterator::$subPath	1
RecursiveDirectoryIterator::current	public	function	Return an instance of SplFileInfo with support for relative paths. Overrides RecursiveDirectoryIterator::current	1
RecursiveDirectoryIterator::getChildren	public	function	Overrides RecursiveDirectoryIterator::getChildren	1
RecursiveDirectoryIterator::isRewindable	public	function	Checks if the stream is rewindable. Overrides RecursiveDirectoryIterator::isRewindable	1
RecursiveDirectoryIterator::rewind	public	function	Do nothing for non rewindable stream. Overrides RecursiveDirectoryIterator::rewind	1
RecursiveDirectoryIterator::__construct	public	function	Overrides RecursiveDirectoryIterator::__construct	1