ILIAS\Filesystem\Finder\Finder Class Reference

Inheritance diagram for ILIAS\Filesystem\Finder\Finder:

Collaboration diagram for ILIAS\Filesystem\Finder\Finder:

Public Member Functions
	__construct (Filesystem $filesystem)
	Finder constructor. More...
	files ()
	directories ()
	allTypes ()
	exclude (array $directories)
	in (array $directories)
	depth ($level)
	Adds tests for the directory depth. More...
	date (string $date)
	Adds tests for file dates. More...
	size ($sizes)
	Adds tests for file sizes. More...
	reverseSorting ()
	ignoreVCS (bool $ignoreVCS)
	addVCSPattern (array $pattern)
	sort (\Closure $closure)
	Sorts files and directories by an anonymous function. More...
	sortByName (bool $useNaturalSort=false)
	sortByType ()
	sortByTime ()
	append (iterable $iterator)
	Appends an existing set of files/directories to the finder. More...
	getIterator ()
	count ()

Data Fields
const	IGNORE_VCS_FILES = 1
const	IGNORE_DOT_FILES = 2

Protected Attributes
	$dirs = []

Private Member Functions
	searchInDirectory (string $dir)

Private Attributes
	$filesystem
	$vcsPatterns = ['.svn', '_svn', 'CVS', '_darcs', '.arch-params', '.monotone', '.bzr', '.git', '.hg']
	$iterators = []
	$exclude = []
	$ignore = 0
	$mode = Iterator\FileTypeFilterIterator::ALL
	$reverseSorting = false
	$dates = []
	$sizes = []
	$depths = []
	$sort = false

Detailed Description

Definition at line 17 of file Finder.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Filesystem\Finder\Finder::__construct

(

Filesystem

$filesystem

)

Finder constructor.

Parameters

Filesystem

$filesystem

Definition at line 62 of file Finder.php.

References ILIAS\Filesystem\Finder\Finder\$filesystem.

    {
        $this->filesystem = $filesystem;
        $this->ignore = static::IGNORE_VCS_FILES|static::IGNORE_DOT_FILES;
    }

Member Function Documentation

addVCSPattern()

ILIAS\Filesystem\Finder\Finder::addVCSPattern

(

array

$pattern

)

Parameters

string[]

$pattern

Returns

Finder

Definition at line 243 of file Finder.php.

                                                  : self
    {
        array_walk($pattern, function ($p) {
            if (!is_string($p)) {
                if (is_object($p)) {
                    throw new \InvalidArgumentException(sprintf('Invalid pattern given: %s', get_class($p)));
                }

                throw new \InvalidArgumentException(sprintf('Invalid pattern given: %s', gettype($p)));
            }
        });

        $clone = clone $this;
        foreach ($pattern as $p) {
            $clone->vcsPatterns[] = $p;
        }

        $clone->vcsPatterns = array_unique($clone->vcsPatterns);

        return $clone;
    }

allTypes()

ILIAS\Filesystem\Finder\Finder::allTypes

(

)

Returns

Finder

Definition at line 93 of file Finder.php.

References ILIAS\Filesystem\Finder\Iterator\FileTypeFilterIterator\ALL.

                               : self
    {
        $clone = clone $this;
        $clone->mode = Iterator\FileTypeFilterIterator::ALL;

        return $clone;
    }

append()

ILIAS\Filesystem\Finder\Finder::append

(

iterable

$iterator

)

Appends an existing set of files/directories to the finder.

The set can be another Finder, an Iterator, an IteratorAggregate, or even a plain array.

Parameters

iterable

$iterator

Returns

Finder

Exceptions

Definition at line 324 of file Finder.php.

                                               : self
    {
        $clone = clone $this;

        if ($iterator instanceof \IteratorAggregate) {
            $clone->iterators[] = $iterator->getIterator();
        } elseif ($iterator instanceof \Iterator) {
            $clone->iterators[] = $iterator;
        } elseif ($iterator instanceof \Traversable || is_array($iterator)) {
            $it = new \ArrayIterator();
            foreach ($iterator as $file) {
                if ($file instanceof MetadataType) {
                    $it->append($file);
                } else {
                    throw new \InvalidArgumentException('Finder::append() method wrong argument type in passed iterator.');
                }
            }
            $clone->iterators[] = $it;
        } else {
            throw new \InvalidArgumentException('Finder::append() method wrong argument type.');
        }

        return $clone;
    }

count()

ILIAS\Filesystem\Finder\Finder::count

(

)

Definition at line 425 of file Finder.php.

References ILIAS\Filesystem\Finder\Finder\getIterator().

Referenced by ILIAS\Filesystem\Finder\Finder\getIterator().

    {
        return iterator_count($this->getIterator());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

date()

ILIAS\Filesystem\Finder\Finder::date

(

string

$date

)

Adds tests for file dates.

The date must be something that strtotime() is able to parse: $finder->date('since yesterday'); $finder->date('until 2 days ago'); $finder->date('> now - 2 hours'); $finder->date('>= 2005-10-15');

Parameters

string

$date

A date range string

Returns

Finder

See also

strtotime

DateRangeFilterIterator

DateComparator

::getTimestamp()

Definition at line 177 of file Finder.php.

                                       : self
    {
        $clone = clone $this;
        $clone->dates[] = new Comparator\DateComparator($date);

        return $clone;
    }

depth()

ILIAS\Filesystem\Finder\Finder::depth

(

$level

)

Adds tests for the directory depth.

Usage: $finder->depth('> 1') // the Finder will start matching at level 1. $finder->depth('< 3') // the Finder will descend at most 3 levels of directories below the starting point.

Parameters

string | int

$level

The depth level expression

Returns

Finder

See also

DepthRangeFilterIterator

NumberComparator

Definition at line 155 of file Finder.php.

                                  : self
    {
        $clone = clone $this;
        $clone->depths[] = new Comparator\NumberComparator((string) $level);

        return $clone;
    }

directories()

ILIAS\Filesystem\Finder\Finder::directories

(

)

Returns

Finder

Definition at line 82 of file Finder.php.

References ILIAS\Filesystem\Finder\Iterator\FileTypeFilterIterator\ONLY_DIRECTORIES.

                                  : self
    {
        $clone = clone $this;
        $clone->mode = Iterator\FileTypeFilterIterator::ONLY_DIRECTORIES;

        return $clone;
    }

exclude()

ILIAS\Filesystem\Finder\Finder::exclude

(

array

$directories

)

Parameters

string[]

$directories

Returns

Finder

Definition at line 105 of file Finder.php.

Referenced by ILIAS\Filesystem\Finder\Finder\searchInDirectory().

                                                : self
    {
        array_walk($directories, function ($directory) {
            if (!is_string($directory)) {
                if (is_object($directory)) {
                    throw new \InvalidArgumentException(sprintf('Invalid directory given: %s', get_class($directory)));
                }

                throw new \InvalidArgumentException(sprintf('Invalid directory given: %s', gettype($directory)));
            }
        });

        $clone = clone $this;
        $clone->exclude = array_merge($clone->exclude, $directories);

        return $clone;
    }

Here is the caller graph for this function:

files()

ILIAS\Filesystem\Finder\Finder::files

(

)

Returns

Finder

Definition at line 71 of file Finder.php.

References ILIAS\Filesystem\Finder\Iterator\FileTypeFilterIterator\ONLY_FILES.

Referenced by ILIAS\Filesystem\Finder\Iterator\RecursiveDirectoryIterator\current(), ILIAS\Filesystem\Finder\Iterator\RecursiveDirectoryIterator\key(), ILIAS\Filesystem\Finder\Iterator\RecursiveDirectoryIterator\next(), and ILIAS\Filesystem\Finder\Iterator\RecursiveDirectoryIterator\rewind().

                            : self
    {
        $clone = clone $this;
        $clone->mode = Iterator\FileTypeFilterIterator::ONLY_FILES;

        return $clone;
    }

Here is the caller graph for this function:

getIterator()

ILIAS\Filesystem\Finder\Finder::getIterator

(

)

Returns

|Metadata[]

Definition at line 400 of file Finder.php.

References ILIAS\Filesystem\Finder\Finder\count(), and ILIAS\Filesystem\Finder\Finder\searchInDirectory().

Referenced by ILIAS\Filesystem\Finder\Finder\count().

    {
        if (0 === count($this->dirs) && 0 === count($this->iterators)) {
            throw new \LogicException('You must call one of in() or append() methods before iterating over a Finder.');
        }

        if (1 === count($this->dirs) && 0 === count($this->iterators)) {
            return $this->searchInDirectory($this->dirs[0]);
        }

        $iterator = new \AppendIterator();
        foreach ($this->dirs as $dir) {
            $iterator->append($this->searchInDirectory($dir));
        }

        foreach ($this->iterators as $it) {
            $iterator->append($it);
        }

        return $iterator;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

ignoreVCS()

ILIAS\Filesystem\Finder\Finder::ignoreVCS

(

bool

$ignoreVCS

)

Parameters

bool

$ignoreVCS

Returns

Finder

Definition at line 227 of file Finder.php.

References ILIAS\Filesystem\Finder\Finder\IGNORE_VCS_FILES.

                                               : self
    {
        $clone = clone $this;
        if ($ignoreVCS) {
            $clone->ignore |= static::IGNORE_VCS_FILES;
        } else {
            $clone->ignore &= ~static::IGNORE_VCS_FILES;
        }

        return $clone;
    }

in()

ILIAS\Filesystem\Finder\Finder::in

(

array

$directories

)

Parameters

string[]

$directories

Returns

Finder

Definition at line 127 of file Finder.php.

                                           : self
    {
        array_walk($directories, function ($directory) {
            if (!is_string($directory)) {
                if (is_object($directory)) {
                    throw new \InvalidArgumentException(sprintf('Invalid directory given: %s', get_class($directory)));
                }

                throw new \InvalidArgumentException(sprintf('Invalid directory given: %s', gettype($directory)));
            }
        });

        $clone = clone $this;
        $clone->dirs = array_unique(array_merge($clone->dirs, $directories));

        return $clone;
    }

reverseSorting()

ILIAS\Filesystem\Finder\Finder::reverseSorting

(

)

Returns

Finder

Definition at line 215 of file Finder.php.

Referenced by ILIAS\Filesystem\Finder\Finder\searchInDirectory().

                                     : self
    {
        $clone = clone $this;
        $clone->reverseSorting = true;

        return $clone;
    }

Here is the caller graph for this function:

searchInDirectory()

ILIAS\Filesystem\Finder\Finder::searchInDirectory ( string  $dir )

private

Parameters

string

$dir

Returns

Definition at line 353 of file Finder.php.

References ILIAS\Filesystem\Finder\Finder\exclude(), ILIAS\Filesystem\Finder\Finder\reverseSorting(), and ILIAS\Filesystem\Finder\Finder\sort().

Referenced by ILIAS\Filesystem\Finder\Finder\getIterator().

                                                    : \Iterator
    {
        if (static::IGNORE_VCS_FILES === (static::IGNORE_VCS_FILES&$this->ignore)) {
            $this->exclude = array_merge($this->exclude, $this->vcsPatterns);
        }

        $iterator = new Iterator\RecursiveDirectoryIterator($this->filesystem, $dir);

        if ($this->exclude) {
            $iterator = new Iterator\ExcludeDirectoryFilterIterator($iterator, $this->exclude);
        }

        $iterator = new \RecursiveIteratorIterator($iterator, \RecursiveIteratorIterator::SELF_FIRST);

        if ($this->depths) {
            $iterator = new Iterator\DepthRangeFilterIterator($iterator, $this->depths);
        }

        if ($this->mode) {
            $iterator = new Iterator\FileTypeFilterIterator($iterator, $this->mode);
        }

        if ($this->dates) {
            $iterator = new Iterator\DateRangeFilterIterator($this->filesystem, $iterator, $this->dates);
        }

        if ($this->sizes) {
            $iterator = new Iterator\SizeRangeFilterIterator($this->filesystem, $iterator, $this->sizes);
        }

        if ($this->sort || $this->reverseSorting) {
            $iteratorAggregate = new Iterator\SortableIterator(
                $this->filesystem,
                $iterator,
                $this->sort,
                $this->reverseSorting
            );
            $iterator = $iteratorAggregate->getIterator();
        }

        return $iterator;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

size()

ILIAS\Filesystem\Finder\Finder::size

(

$sizes

)

Adds tests for file sizes.

$finder->size('> 10K'); $finder->size('<= 1Ki'); $finder->size(4); $finder->size(['> 10K', '< 20K'])

Parameters

string|int|string[]|int[]

$sizes A size range string or an integer or an array of size ranges

Returns

Finder

See also

SizeRangeFilterIterator

NumberComparator

::getSize()

Definition at line 197 of file Finder.php.

References $size, and ILIAS\Filesystem\Finder\Finder\$sizes.

                                 : self
    {
        if (!is_array($sizes)) {
            $sizes = [$sizes];
        }

        $clone = clone $this;

        foreach ($sizes as $size) {
            $clone->sizes[] = new Comparator\NumberComparator((string) $size);
        }

        return $clone;
    }

sort()

ILIAS\Filesystem\Finder\Finder::sort

(

\Closure

$closure

)

Sorts files and directories by an anonymous function.

The anonymous function receives two Metadata instances to compare. This can be slow as all the matching files and directories must be retrieved for comparison.

Parameters

\Closure

$closure

Returns

Finder

Definition at line 272 of file Finder.php.

Referenced by ILIAS\Filesystem\Finder\Iterator\SortableIterator\__construct(), ILIAS\Filesystem\Finder\Iterator\SortableIterator\getIterator(), and ILIAS\Filesystem\Finder\Finder\searchInDirectory().

                                            : self
    {
        $clone = clone $this;
        $clone->sort = $closure;

        return $clone;
    }

Here is the caller graph for this function:

sortByName()

ILIAS\Filesystem\Finder\Finder::sortByName

(

bool

$useNaturalSort = false

)

Parameters

bool

$useNaturalSort

Returns

Finder

Definition at line 284 of file Finder.php.

References ILIAS\Filesystem\Finder\Iterator\SortableIterator\SORT_BY_NAME, and ILIAS\Filesystem\Finder\Iterator\SortableIterator\SORT_BY_NAME_NATURAL.

                                                             : self
    {
        $clone = clone $this;
        $clone->sort = Iterator\SortableIterator::SORT_BY_NAME;
        if ($useNaturalSort) {
            $clone->sort = Iterator\SortableIterator::SORT_BY_NAME_NATURAL;
        }

        return $clone;
    }

sortByTime()

ILIAS\Filesystem\Finder\Finder::sortByTime

(

)

Returns

Finder

Definition at line 309 of file Finder.php.

References ILIAS\Filesystem\Finder\Iterator\SortableIterator\SORT_BY_TIME.

                                 : self
    {
        $clone = clone $this;
        $clone->sort = Iterator\SortableIterator::SORT_BY_TIME;

        return $clone;
    }

sortByType()

ILIAS\Filesystem\Finder\Finder::sortByType

(

)

Returns

Finder

Definition at line 298 of file Finder.php.

References ILIAS\Filesystem\Finder\Iterator\SortableIterator\SORT_BY_TYPE.

                                 : self
    {
        $clone = clone $this;
        $clone->sort = Iterator\SortableIterator::SORT_BY_TYPE;

        return $clone;
    }

Field Documentation

$dates

ILIAS\Filesystem\Finder\Finder::$dates = []

private

Definition at line 47 of file Finder.php.

$depths

ILIAS\Filesystem\Finder\Finder::$depths = []

private

Definition at line 53 of file Finder.php.

$dirs

ILIAS\Filesystem\Finder\Finder::$dirs = []

protected

Definition at line 32 of file Finder.php.

$exclude

ILIAS\Filesystem\Finder\Finder::$exclude = []

private

Definition at line 35 of file Finder.php.

$filesystem

ILIAS\Filesystem\Finder\Finder::$filesystem

private

Definition at line 23 of file Finder.php.

Referenced by ILIAS\Filesystem\Finder\Finder\__construct().

$ignore

ILIAS\Filesystem\Finder\Finder::$ignore = 0

private

Definition at line 38 of file Finder.php.

$iterators

ILIAS\Filesystem\Finder\Finder::$iterators = []

private

Definition at line 29 of file Finder.php.

$mode

ILIAS\Filesystem\Finder\Finder::$mode = Iterator\FileTypeFilterIterator::ALL

private

Definition at line 41 of file Finder.php.

$reverseSorting

ILIAS\Filesystem\Finder\Finder::$reverseSorting = false

private

Definition at line 44 of file Finder.php.

$sizes

ILIAS\Filesystem\Finder\Finder::$sizes = []

private

Definition at line 50 of file Finder.php.

Referenced by ILIAS\Filesystem\Finder\Finder\size().

$sort

ILIAS\Filesystem\Finder\Finder::$sort = false

private

Definition at line 56 of file Finder.php.

$vcsPatterns

ILIAS\Filesystem\Finder\Finder::$vcsPatterns = ['.svn', '_svn', 'CVS', '_darcs', '.arch-params', '.monotone', '.bzr', '.git', '.hg']

private

Definition at line 26 of file Finder.php.

IGNORE_DOT_FILES

const ILIAS\Filesystem\Finder\Finder::IGNORE_DOT_FILES = 2

Definition at line 20 of file Finder.php.

IGNORE_VCS_FILES

const ILIAS\Filesystem\Finder\Finder::IGNORE_VCS_FILES = 1

Definition at line 19 of file Finder.php.

Referenced by ILIAS\Filesystem\Finder\Finder\ignoreVCS().

---

The documentation for this class was generated from the following file:

• src/Filesystem/Finder/Finder.php