tests/PHPUnit/File/Iterator/Facade.php

   1 <?php
   2 /**
   3  * php-file-iterator
   4  *
   5  * Copyright (c) 2009-2011, Sebastian Bergmann <sb@sebastian-bergmann.de>.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  *   * Redistributions of source code must retain the above copyright
  13  *     notice, this list of conditions and the following disclaimer.
  14  *
  15  *   * Redistributions in binary form must reproduce the above copyright
  16  *     notice, this list of conditions and the following disclaimer in
  17  *     the documentation and/or other materials provided with the
  18  *     distribution.
  19  *
  20  *   * Neither the name of Sebastian Bergmann nor the names of his
  21  *     contributors may be used to endorse or promote products derived
  22  *     from this software without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  27  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  28  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  29  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  30  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  34  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  *
  37  * @package   File
  38  * @author    Sebastian Bergmann <sb@sebastian-bergmann.de>
  39  * @copyright 2009-2011 Sebastian Bergmann <sb@sebastian-bergmann.de>
  40  * @license   http://www.opensource.org/licenses/bsd-license.php  BSD License
  41  * @since     File available since Release 1.3.0
  42  */
  43
  44 /**
  45  * Façade implementation that uses File_Iterator_Factory to create a
  46  * File_Iterator that operates on an AppendIterator that contains an
  47  * RecursiveDirectoryIterator for each given path. The list of unique
  48  * files is returned as an array.
  49  *
  50  * @author    Sebastian Bergmann <sb@sebastian-bergmann.de>
  51  * @copyright 2009-2011 Sebastian Bergmann <sb@sebastian-bergmann.de>
  52  * @license   http://www.opensource.org/licenses/bsd-license.php  BSD License
  53  * @version   Release: 1.3.0
  54  * @link      http://github.com/sebastianbergmann/php-file-iterator/tree
  55  * @since     Class available since Release 1.3.0
  56  */
  57 class File_Iterator_Facade
  58 {
  59     /**
  60      * @param  array|string $paths
  61      * @param  array|string $suffixes
  62      * @param  array|string $prefixes
  63      * @param  array        $exclude
  64      * @param  boolean      $commonPath
  65      * @return array
  66      */
  67     public function getFilesAsArray($paths, $suffixes = '', $prefixes = '', array $exclude = array(), $commonPath = FALSE)
  68     {
  69         if (is_string($paths)) {
  70             $paths = array($paths);
  71         }
  72
  73         $factory  = new File_Iterator_Factory;
  74         $iterator = $factory->getFileIterator(
  75           $paths, $suffixes, $prefixes, $exclude
  76         );
  77
  78         $files = array();
  79
  80         foreach ($iterator as $file) {
  81             $file = $file->getRealPath();
  82
  83             if ($file) {
  84                 $files[] = $file;
  85             }
  86         }
  87
  88         foreach ($paths as $path) {
  89             if (is_file($path)) {
  90                 $files[] = realpath($path);
  91             }
  92         }
  93
  94         $files = array_unique($files);
  95         sort($files);
  96
  97         if ($commonPath) {
  98             return array(
  99               'commonPath' => $this->getCommonPath($files),
 100               'files'      => $files
 101             );
 102         } else {
 103             return $files;
 104         }
 105     }
 106
 107     /**
 108      * Returns the common path of a set of files.
 109      *
 110      * @param  array $files
 111      * @return string
 112      */
 113     protected function getCommonPath(array $files)
 114     {
 115         $count = count($files);
 116
 117         if ($count == 1) {
 118             return dirname($files[0]) . DIRECTORY_SEPARATOR;
 119         }
 120
 121         $_files = array();
 122
 123         foreach ($files as $file) {
 124             $_files[] = $_fileParts = explode(DIRECTORY_SEPARATOR, $file);
 125
 126             if (empty($_fileParts[0])) {
 127                 $_fileParts[0] = DIRECTORY_SEPARATOR;
 128             }
 129         }
 130
 131         $common = '';
 132         $done   = FALSE;
 133         $j      = 0;
 134         $count--;
 135
 136         while (!$done) {
 137             for ($i = 0; $i < $count; $i++) {
 138                 if ($_files[$i][$j] != $_files[$i+1][$j]) {
 139                     $done = TRUE;
 140                     break;
 141                 }
 142             }
 143
 144             if (!$done) {
 145                 $common .= $_files[0][$j];
 146
 147                 if ($j > 0) {
 148                     $common .= DIRECTORY_SEPARATOR;
 149                 }
 150             }
 151
 152             $j++;
 153         }
 154
 155         return $common;
 156     }
 157 }