Inheritance diagram for ILIAS\Filesystem\Finder\Finder:

Collaboration diagram for ILIAS\Filesystem\Finder\Finder:

Public Member Functions
	__construct (private Filesystem $filesystem)

	files ()

	directories ()

	allTypes ()

	exclude (array $directories)

	in (array $directories)

	depth (string\|int $level)
	Adds tests for the directory depth. More...

	date (string $date)
	Adds tests for file dates. More...

	size (string\|int\|array $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 ()

Protected Attributes
array	$dirs = []

Private Member Functions
	searchInDirectory (string $dir)

Private Attributes
const	IGNORE_VCS_FILES = 1

const	IGNORE_DOT_FILES = 2

array	$vcsPatterns = ['.svn', '_svn', 'CVS', '_darcs', '.arch-params', '.monotone', '.bzr', '.git', '.hg']

array	$iterators = []

array	$exclude = []

int	$ignore = 0

int	$mode = FileTypeFilterIterator::ALL

bool	$reverseSorting = false

array	$dates = []

array	$sizes = []

array	$depths = []

	$sort = SortableIterator::SORT_BY_NONE

Detailed Description

Definition at line 52 of file Finder.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Filesystem\Finder\Finder::__construct ( private Filesystem $filesystem )

Definition at line 82 of file Finder.php.

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

References ILIAS\Filesystem\Finder\Finder\IGNORE_DOT_FILES.

Member Function Documentation

◆ addVCSPattern()

ILIAS\Filesystem\Finder\Finder::addVCSPattern ( array $pattern )

Parameters

string[] $pattern

Exceptions

InvalidArgumentException

Definition at line 239 of file Finder.php.

                                                 : self
    {
        array_walk($pattern, static function ($p): void {
            if (!is_string($p)) {
                throw new InvalidArgumentException(sprintf('Invalid pattern given: %s', $p::class));
            }
        });
 
        $clone = clone $this;
        foreach ($pattern as $p) {
            $clone->vcsPatterns[] = $p;
        }
 
        $clone->vcsPatterns = array_unique($clone->vcsPatterns);
 
        return $clone;
    }

◆ allTypes()

ILIAS\Filesystem\Finder\Finder::allTypes ( )

Definition at line 103 of file Finder.php.

                              : self
    {
        $clone = clone $this;
        $clone->mode = FileTypeFilterIterator::ALL;
 
        return $clone;
    }

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

◆ 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.

Exceptions

InvalidArgumentException when the given argument is not iterable

Definition at line 302 of file Finder.php.

                                              : self
    {
        $clone = clone $this;
 
        if ($iterator instanceof IteratorAggregate) {
            $clone->iterators[] = $iterator->getIterator();
        } elseif ($iterator instanceof PhpIterator) {
            $clone->iterators[] = $iterator;
        } elseif (is_iterable($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 403 of file Finder.php.

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

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

Referenced by ILIAS\Filesystem\Finder\Finder\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

See also: strtotime; DateRangeFilterIterator; DateComparator; \ILIAS\FileSystem\Filesystem::getTimestamp()

Definition at line 181 of file Finder.php.

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

◆ depth()

ILIAS\Filesystem\Finder\Finder::depth ( string|int $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

See also: DepthRangeFilterIterator; NumberComparator

Definition at line 158 of file Finder.php.

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

◆ directories()

ILIAS\Filesystem\Finder\Finder::directories ( )

Definition at line 95 of file Finder.php.

                                 : self
    {
        $clone = clone $this;
        $clone->mode = FileTypeFilterIterator::ONLY_DIRECTORIES;
 
        return $clone;
    }

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

◆ exclude()

ILIAS\Filesystem\Finder\Finder::exclude ( array $directories )

Parameters

string[] $directories

Exceptions

InvalidArgumentException

Definition at line 115 of file Finder.php.

                                               : self
    {
        array_walk($directories, static function ($directory): void {
            if (!is_string($directory)) {
                throw new InvalidArgumentException(sprintf('Invalid directory given: %s', $directory::class));
            }
        });
 
        $clone = clone $this;
        $clone->exclude = array_merge($clone->exclude, $directories);
 
        return $clone;
    }

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

Here is the caller graph for this function:

◆ files()

ILIAS\Filesystem\Finder\Finder::files ( )

Definition at line 87 of file Finder.php.

                           : self
    {
        $clone = clone $this;
        $clone->mode = FileTypeFilterIterator::ONLY_FILES;
 
        return $clone;
    }

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(), ILIAS\Filesystem\Finder\Iterator\RecursiveDirectoryIterator\rewind(), and ILIAS\Filesystem\Finder\Iterator\RecursiveDirectoryIterator\valid().

Here is the caller graph for this function:

◆ getIterator()

ILIAS\Filesystem\Finder\Finder::getIterator ( )

Returns: PhpIterator|Metadata[]

Exceptions

LogicException

Definition at line 378 of file Finder.php.

                                 : \Iterator
    {
        if ([] === $this->dirs && [] === $this->iterators) {
            throw new LogicException('You must call one of in() or append() methods before iterating over a Finder.');
        }
 
        if (1 === count($this->dirs) && [] === $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;
    }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ignoreVCS()

ILIAS\Filesystem\Finder\Finder::ignoreVCS ( bool $ignoreVCS )

Definition at line 223 of file Finder.php.

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

References ILIAS\Filesystem\Finder\Finder\IGNORE_VCS_FILES.

◆ in()

ILIAS\Filesystem\Finder\Finder::in ( array $directories )

Parameters

string[] $directories

Exceptions

InvalidArgumentException

Definition at line 133 of file Finder.php.

                                          : self
    {
        array_walk($directories, static function ($directory): void {
            if (!is_string($directory)) {
                throw new InvalidArgumentException(sprintf('Invalid directory given: %s', $directory::class));
            }
        });
 
        $clone = clone $this;
        $clone->dirs = array_unique(array_merge($clone->dirs, $directories));
 
        return $clone;
    }

◆ reverseSorting()

ILIAS\Filesystem\Finder\Finder::reverseSorting ( )

Definition at line 215 of file Finder.php.

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

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

Here is the caller graph for this function:

◆ searchInDirectory()

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

private

Definition at line 329 of file Finder.php.

                                                   : \Traversable
    {
        if (self::IGNORE_VCS_FILES === (self::IGNORE_VCS_FILES & $this->ignore)) {
            $this->exclude = array_merge($this->exclude, $this->vcsPatterns);
        }
 
        $iterator = new RecursiveDirectoryIterator($this->filesystem, $dir);
 
        if ($this->exclude) {
            $iterator = new ExcludeDirectoryFilterIterator($iterator, $this->exclude);
        }
 
        $iterator = new RecursiveIteratorIterator($iterator, \RecursiveIteratorIterator::SELF_FIRST);
 
        if ($this->depths) {
            $iterator = new DepthRangeFilterIterator($iterator, $this->depths);
        }
 
        if ($this->mode !== 0) {
            $iterator = new FileTypeFilterIterator($iterator, $this->mode);
        }
 
        if ($this->dates) {
            $iterator = new DateRangeFilterIterator($this->filesystem, $iterator, $this->dates);
        }
 
        if ($this->sizes) {
            $iterator = new SizeRangeFilterIterator($this->filesystem, $iterator, $this->sizes);
        }
 
        if ($this->sort || $this->reverseSorting) {
            $iteratorAggregate = new SortableIterator(
                $this->filesystem,
                $iterator,
                $this->sort,
                $this->reverseSorting
            );
            $iterator = $iteratorAggregate->getIterator();
        }
 
        return $iterator;
    }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ size()

ILIAS\Filesystem\Finder\Finder::size ( string|int|array $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

See also: SizeRangeFilterIterator; NumberComparator; \ILIAS\FileSystem\Filesystem::getSize()

Definition at line 202 of file Finder.php.

                                                 : self
    {
        $sizes = is_array($sizes) ? $sizes : [$sizes];
 
        $clone = clone $this;
 
        foreach ($sizes as $size) {
            $clone->sizes[] = new NumberComparator((string) $size);
        }
 
        return $clone;
    }

References ILIAS\Filesystem\Finder\Finder\$sizes.

◆ 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.

Definition at line 262 of file Finder.php.

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

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

Here is the caller graph for this function:

◆ sortByName()

ILIAS\Filesystem\Finder\Finder::sortByName ( bool $useNaturalSort = false )

Definition at line 270 of file Finder.php.

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

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

◆ sortByTime()

ILIAS\Filesystem\Finder\Finder::sortByTime ( )

Definition at line 289 of file Finder.php.

                                : self
    {
        $clone = clone $this;
        $clone->sort = SortableIterator::SORT_BY_TIME;
 
        return $clone;
    }

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

◆ sortByType()

ILIAS\Filesystem\Finder\Finder::sortByType ( )

Definition at line 281 of file Finder.php.

                                : self
    {
        $clone = clone $this;
        $clone->sort = SortableIterator::SORT_BY_TYPE;
 
        return $clone;
    }

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

Field Documentation

◆ $dates

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

private

Definition at line 74 of file Finder.php.

◆ $depths

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

private

Definition at line 78 of file Finder.php.

◆ $dirs

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

protected

Definition at line 67 of file Finder.php.

◆ $exclude

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

private

Definition at line 69 of file Finder.php.

◆ $ignore

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

private

Definition at line 70 of file Finder.php.

◆ $iterators

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

private

Definition at line 65 of file Finder.php.

◆ $mode

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

private

Definition at line 71 of file Finder.php.

◆ $reverseSorting

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

private

Definition at line 72 of file Finder.php.

◆ $sizes

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

private

Definition at line 76 of file Finder.php.

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

◆ $sort

ILIAS\Filesystem\Finder\Finder::$sort = SortableIterator::SORT_BY_NONE

private

Definition at line 80 of file Finder.php.

◆ $vcsPatterns

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

private

Definition at line 63 of file Finder.php.

◆ IGNORE_DOT_FILES

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

private

Definition at line 61 of file Finder.php.

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

◆ IGNORE_VCS_FILES

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

private

Definition at line 57 of file Finder.php.

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

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

components/ILIAS/Filesystem/src/Finder/Finder.php

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addVCSPattern()

◆ allTypes()

◆ append()

◆ count()

◆ date()

◆ depth()

◆ directories()

◆ exclude()

◆ files()

◆ getIterator()

◆ ignoreVCS()

◆ in()

◆ reverseSorting()

◆ searchInDirectory()

◆ size()

◆ sort()

◆ sortByName()

◆ sortByTime()

◆ sortByType()

Field Documentation

◆ $dates

◆ $depths

◆ $dirs

◆ $exclude

◆ $ignore

◆ $iterators

◆ $mode

◆ $reverseSorting

◆ $sizes

◆ $sort

◆ $vcsPatterns

◆ IGNORE_DOT_FILES

◆ IGNORE_VCS_FILES