Diviner

libphutil » FileFinder (Class)

Class FileFinder

Defined	src/filesystem/FileFinder.php:19
Group	Filesystem

Find files on disk matching criteria, like the 'find' system utility. Use of this class is straightforward:

// Find PHP files in /tmp
$files = id(new FileFinder('/tmp'))
  ->withType('f')
  ->withSuffix('php')
  ->find();

Tasks

Creating a File Query

public __construct()

Configuring File Queries

public excludePath()
public setForceMode()
public setGenerateChecksums()
public withFollowSymlinks()
public withPath()
public withSuffix()
public withType()

Executing the File Query

public find()

Internal

private generateList()
private getFiles()
public validateFile()

Methods

public this __construct($root)

parameters	string	$root	Root directory to find files beneath.
return	this

Create a new FileFinder.

public excludePath($path)

parameters	wild	$path
return	wild

This method is not documented.

public find()

return

wild

This method is not documented.

private generateList($flag, array $items)

parameters	wild	$flag
	array	$items
return	wild

This method is not documented.

private getFiles($dir)

parameters	wild	$dir
return	wild

This method is not documented.

public setForceMode($mode)

parameters	string	$mode	Either "php", "shell", or the empty string.
return	wild

This method is not documented.

public setGenerateChecksums($generate)

parameters	wild	$generate
return	wild

This method is not documented.

public validateFile($file)

parameters	wild	$file
return	wild

This method is not documented.

public withFollowSymlinks($follow)

parameters	wild	$follow
return	wild

This method is not documented.

public withPath($path)

parameters	wild	$path
return	wild

This method is not documented.

public withSuffix($suffix)

parameters	wild	$suffix
return	wild

This method is not documented.

public withType($type)

parameters	wild	$type
return	wild

This method is not documented.