Chris@0: <?php
Chris@0: /*
Chris@0:  * This file is part of the File_Iterator package.
Chris@0:  *
Chris@0:  * (c) Sebastian Bergmann <sebastian@phpunit.de>
Chris@0:  *
Chris@0:  * For the full copyright and license information, please view the LICENSE
Chris@0:  * file that was distributed with this source code.
Chris@0:  */
Chris@0: 
Chris@0: /**
Chris@0:  * FilterIterator implementation that filters files based on prefix(es) and/or
Chris@0:  * suffix(es). Hidden files and files from hidden directories are also filtered.
Chris@0:  *
Chris@0:  * @since     Class available since Release 1.0.0
Chris@0:  */
Chris@0: class File_Iterator extends FilterIterator
Chris@0: {
Chris@0:     const PREFIX = 0;
Chris@0:     const SUFFIX = 1;
Chris@0: 
Chris@0:     /**
Chris@0:      * @var array
Chris@0:      */
Chris@0:     protected $suffixes = array();
Chris@0: 
Chris@0:     /**
Chris@0:      * @var array
Chris@0:      */
Chris@0:     protected $prefixes = array();
Chris@0: 
Chris@0:     /**
Chris@0:      * @var array
Chris@0:      */
Chris@0:     protected $exclude = array();
Chris@0: 
Chris@0:     /**
Chris@0:      * @var string
Chris@0:      */
Chris@0:     protected $basepath;
Chris@0: 
Chris@0:     /**
Chris@0:      * @param Iterator $iterator
Chris@0:      * @param array    $suffixes
Chris@0:      * @param array    $prefixes
Chris@0:      * @param array    $exclude
Chris@0:      * @param string   $basepath
Chris@0:      */
Chris@0:     public function __construct(Iterator $iterator, array $suffixes = array(), array $prefixes = array(), array $exclude = array(), $basepath = NULL)
Chris@0:     {
Chris@0:         $exclude = array_filter(array_map('realpath', $exclude));
Chris@0: 
Chris@0:         if ($basepath !== NULL) {
Chris@0:             $basepath = realpath($basepath);
Chris@0:         }
Chris@0: 
Chris@0:         if ($basepath === FALSE) {
Chris@0:             $basepath = NULL;
Chris@0:         } else {
Chris@0:             foreach ($exclude as &$_exclude) {
Chris@0:                 $_exclude = str_replace($basepath, '', $_exclude);
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         $this->prefixes = $prefixes;
Chris@0:         $this->suffixes = $suffixes;
Chris@0:         $this->exclude  = $exclude;
Chris@0:         $this->basepath = $basepath;
Chris@0: 
Chris@0:         parent::__construct($iterator);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @return bool
Chris@0:      */
Chris@0:     public function accept()
Chris@0:     {
Chris@0:         $current  = $this->getInnerIterator()->current();
Chris@0:         $filename = $current->getFilename();
Chris@0:         $realpath = $current->getRealPath();
Chris@0: 
Chris@0:         if ($this->basepath !== NULL) {
Chris@0:             $realpath = str_replace($this->basepath, '', $realpath);
Chris@0:         }
Chris@0: 
Chris@0:         // Filter files in hidden directories.
Chris@0:         if (preg_match('=/\.[^/]*/=', $realpath)) {
Chris@0:             return FALSE;
Chris@0:         }
Chris@0: 
Chris@0:         return $this->acceptPath($realpath) &&
Chris@0:                $this->acceptPrefix($filename) &&
Chris@0:                $this->acceptSuffix($filename);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param  string $path
Chris@0:      * @return bool
Chris@0:      * @since  Method available since Release 1.1.0
Chris@0:      */
Chris@0:     protected function acceptPath($path)
Chris@0:     {
Chris@0:         foreach ($this->exclude as $exclude) {
Chris@0:             if (strpos($path, $exclude) === 0) {
Chris@0:                 return FALSE;
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         return TRUE;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param  string $filename
Chris@0:      * @return bool
Chris@0:      * @since  Method available since Release 1.1.0
Chris@0:      */
Chris@0:     protected function acceptPrefix($filename)
Chris@0:     {
Chris@0:         return $this->acceptSubString($filename, $this->prefixes, self::PREFIX);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param  string $filename
Chris@0:      * @return bool
Chris@0:      * @since  Method available since Release 1.1.0
Chris@0:      */
Chris@0:     protected function acceptSuffix($filename)
Chris@0:     {
Chris@0:         return $this->acceptSubString($filename, $this->suffixes, self::SUFFIX);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param  string $filename
Chris@12:      * @param  array  $subStrings
Chris@0:      * @param  int    $type
Chris@0:      * @return bool
Chris@0:      * @since  Method available since Release 1.1.0
Chris@0:      */
Chris@0:     protected function acceptSubString($filename, array $subStrings, $type)
Chris@0:     {
Chris@0:         if (empty($subStrings)) {
Chris@0:             return TRUE;
Chris@0:         }
Chris@0: 
Chris@0:         $matched = FALSE;
Chris@0: 
Chris@0:         foreach ($subStrings as $string) {
Chris@0:             if (($type == self::PREFIX && strpos($filename, $string) === 0) ||
Chris@0:                 ($type == self::SUFFIX &&
Chris@0:                  substr($filename, -1 * strlen($string)) == $string)) {
Chris@0:                 $matched = TRUE;
Chris@0:                 break;
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         return $matched;
Chris@0:     }
Chris@0: }