Skip to content

Latest commit

 

History

History
320 lines (208 loc) · 8.93 KB

finder.rst

File metadata and controls

320 lines (208 loc) · 8.93 KB
.. index::
   single: Finder
   single: Components; Finder

The Finder Component

The Finder component finds files and directories via an intuitive fluent interface.

Installation

You can install the component in 2 different ways:

Usage

The :class:`Symfony\\Component\\Finder\\Finder` class finds files and/or directories:

use Symfony\Component\Finder\Finder;

$finder = new Finder();
$finder->files()->in(__DIR__);

foreach ($finder as $file) {
    // Dump the absolute path
    var_dump($file->getRealPath());

    // Dump the relative path to the file, omitting the filename
    var_dump($file->getRelativePath());

    // Dump the relative path to the file
    var_dump($file->getRelativePathname());
}

The $file is an instance of :class:`Symfony\\Component\\Finder\\SplFileInfo` which extends PHP's own :phpclass:`SplFileInfo` to provide methods to work with relative paths.

The above code prints the names of all the files in the current directory recursively. The Finder class uses a fluent interface, so all methods return the Finder instance.

Tip

A Finder instance is a PHP :phpclass:`Iterator`. So, instead of iterating over the Finder with foreach, you can also convert it to an array with the :phpfunction:`iterator_to_array` method, or get the number of items with :phpfunction:`iterator_count`.

Caution!

When searching through multiple locations passed to the :method:`Symfony\\Component\\Finder\\Finder::in` method, a separate iterator is created internally for every location. This means we have multiple result sets aggregated into one. Since :phpfunction:`iterator_to_array` uses keys of result sets by default, when converting to an array, some keys might be duplicated and their values overwritten. This can be avoided by passing false as a second parameter to :phpfunction:`iterator_to_array`.

Criteria

There are lots of ways to filter and sort your results.

Location

The location is the only mandatory criteria. It tells the finder which directory to use for the search:

$finder->in(__DIR__);

Search in several locations by chaining calls to :method:`Symfony\\Component\\Finder\\Finder::in`:

// search inside *both* directories
$finder->files()->in(array(__DIR__, '/elsewhere'));

// same as above
$finder->in(__DIR__)->in('/elsewhere');

Use wildcard characters to search in the directories matching a pattern:

$finder->in('src/Symfony/*/*/Resources');

Each pattern has to resolve to at least one directory path.

Exclude directories from matching with the :method:`Symfony\\Component\\Finder\\Finder::exclude` method:

$finder->in(__DIR__)->exclude('ruby');

.. versionadded:: 2.3
   The :method:`Symfony\\Component\\Finder\\Finder::ignoreUnreadableDirs`
   method was introduced in Symfony 2.3.

It's also possible to ignore directories that you don't have permission to read:

$finder->ignoreUnreadableDirs()->in(__DIR__);

As the Finder uses PHP iterators, you can pass any URL with a supported protocol:

$finder->in('ftp://example.com/pub/');

And it also works with user-defined streams:

use Symfony\Component\Finder\Finder;

$s3 = new \Zend_Service_Amazon_S3($key, $secret);
$s3->registerStreamWrapper('s3');

$finder = new Finder();
$finder->name('photos*')->size('< 100K')->date('since 1 hour ago');
foreach ($finder->in('s3://bucket-name') as $file) {
    // ... do something with the file
}

Note

Read the Streams documentation to learn how to create your own streams.

Files or Directories

By default, the Finder returns files and directories; but the :method:`Symfony\\Component\\Finder\\Finder::files` and :method:`Symfony\\Component\\Finder\\Finder::directories` methods control that:

$finder->files();

$finder->directories();

If you want to follow links, use the followLinks() method:

$finder->files()->followLinks();

By default, the iterator ignores popular VCS files. This can be changed with the ignoreVCS() method:

$finder->ignoreVCS(false);

Sorting

Sort the result by name or by type (directories first, then files):

$finder->sortByName();

$finder->sortByType();

Note

Notice that the sort* methods need to get all matching elements to do their jobs. For large iterators, it is slow.

You can also define your own sorting algorithm with sort() method:

$sort = function (\SplFileInfo $a, \SplFileInfo $b)
{
    return strcmp($a->getRealPath(), $b->getRealPath());
};

$finder->sort($sort);

File Name

Restrict files by name with the :method:`Symfony\\Component\\Finder\\Finder::name` method:

$finder->files()->name('*.php');

The name() method accepts globs, strings, or regexes:

$finder->files()->name('/\.php$/');

The notName() method excludes files matching a pattern:

$finder->files()->notName('*.rb');

File Contents

Restrict files by contents with the :method:`Symfony\\Component\\Finder\\Finder::contains` method:

$finder->files()->contains('lorem ipsum');

The contains() method accepts strings or regexes:

$finder->files()->contains('/lorem\s+ipsum$/i');

The notContains() method excludes files containing given pattern:

$finder->files()->notContains('dolor sit amet');

Path

Restrict files and directories by path with the :method:`Symfony\\Component\\Finder\\Finder::path` method:

// matches files that contain "data" anywhere in their paths (files or directories)
$finder->path('data');
// for example this will match data/*.xml and data.xml if they exist
$finder->path('data')->name('*.xml');

On all platforms slash (i.e. /) should be used as the directory separator.

The path() method accepts a string or a regular expression:

$finder->path('foo/bar');
$finder->path('/^foo\/bar/');

Internally, strings are converted into regular expressions by escaping slashes and adding delimiters:

dirname    ===>    /dirname/
a/b/c      ===>    /a\/b\/c/

The :method:`Symfony\\Component\\Finder\\Finder::notPath` method excludes files by path:

$finder->notPath('other/dir');

File Size

Restrict files by size with the :method:`Symfony\\Component\\Finder\\Finder::size` method:

$finder->files()->size('< 1.5K');

Restrict by a size range by chaining calls:

$finder->files()->size('>= 1K')->size('<= 2K');

The comparison operator can be any of the following: >, >=, <, <=, ==, !=.

The target value may use magnitudes of kilobytes (k, ki), megabytes (m, mi), or gigabytes (g, gi). Those suffixed with an i use the appropriate 2**n version in accordance with the IEC standard.

File Date

Restrict files by last modified dates with the :method:`Symfony\\Component\\Finder\\Finder::date` method:

$finder->date('since yesterday');

The comparison operator can be any of the following: >, >=, <, <=, ==. You can also use since or after as an alias for >, and until or before as an alias for <.

The target value can be any date supported by the strtotime function.

Directory Depth

By default, the Finder recursively traverse directories. Restrict the depth of traversing with :method:`Symfony\\Component\\Finder\\Finder::depth`:

$finder->depth('== 0');
$finder->depth('< 3');

Custom Filtering

To restrict the matching file with your own strategy, use :method:`Symfony\\Component\\Finder\\Finder::filter`:

$filter = function (\SplFileInfo $file)
{
    if (strlen($file) > 10) {
        return false;
    }
};

$finder->files()->filter($filter);

The filter() method takes a Closure as an argument. For each matching file, it is called with the file as a :class:`Symfony\\Component\\Finder\\SplFileInfo` instance. The file is excluded from the result set if the Closure returns false.

Reading Contents of Returned Files

The contents of returned files can be read with :method:`Symfony\\Component\\Finder\\SplFileInfo::getContents`:

use Symfony\Component\Finder\Finder;

$finder = new Finder();
$finder->files()->in(__DIR__);

foreach ($finder as $file) {
    $contents = $file->getContents();

    // ...
}