Finder
in package
implements
PluginInterface
Flysystem plugin to add file finding capabilities to the filesystem entity.
Note that found directories are not returned... only found files.
Interfaces, Classes and Traits
Table of Contents
- $filesystem : FilesystemInterface
- getMethod() : string
- Get the method name.
- handle() : Generator<string|int, mixed>
- Find the specified files
- setFilesystem() : void
- Set the Filesystem object.
- yieldFilesInPath() : Generator<string|int, mixed>
- Recursively yield files that meet the specification
Properties
$filesystem
private
FilesystemInterface
$filesystem
Tags
Methods
getMethod()
Get the method name.
public
getMethod() : string
Return values
string —handle()
Find the specified files
public
handle(SpecificationInterface $specification) : Generator<string|int, mixed>
Note that only found files are yielded at this level, which go back to the caller.
Parameters
- $specification : SpecificationInterface
Tags
Return values
Generator<string|int, mixed> —setFilesystem()
Set the Filesystem object.
public
setFilesystem(FilesystemInterface $filesystem) : void
Parameters
- $filesystem : FilesystemInterface
Return values
void —yieldFilesInPath()
Recursively yield files that meet the specification
private
yieldFilesInPath(SpecificationInterface $specification, string $path) : Generator<string|int, mixed>
Note that directories are also yielded at this level, since they have to be recursed into. Yielded directories will not make their way back to the caller, as they are filtered out by .
Parameters
- $specification : SpecificationInterface
- $path : string