final class FileFinder
Arcanist Technical Documentation ()

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 function __construct($root) — Create a new FileFinder.

Configuring File Queries

public function excludePath($path)
public function withName($name)
public function withSuffix($suffix)
public function withPath($path)
public function withType($type)
public function withFollowSymlinks($follow)
public function setGenerateChecksums($generate)
public function setForceMode($mode)

Executing the File Query

public function find()

Internal

public function validateFile($file)
private function getFiles($dir)
private function generateList($flag, $items, $mode)

Other Methods

public function getGenerateChecksums()
public function withNameGlob($pattern)

Methods

public function __construct($root)

Create a new FileFinder.

Parameters

string

$root

Root directory to find files beneath.

Return

this	//Implicit.//

public function excludePath($path)

This method is not documented.

Parameters

$path

Return

wild

public function withName($name)

This method is not documented.

Parameters

$name

Return

wild

public function withSuffix($suffix)

This method is not documented.

Parameters

$suffix

Return

wild

public function withPath($path)

This method is not documented.

Parameters

$path

Return

wild

public function withType($type)

This method is not documented.

Parameters

$type

Return

wild

public function withFollowSymlinks($follow)

This method is not documented.

Parameters

$follow

Return

wild

public function setGenerateChecksums($generate)

This method is not documented.

Parameters

$generate

Return

wild

public function getGenerateChecksums()

This method is not documented.

Return

wild

public function withNameGlob($pattern)

This method is not documented.

Parameters

$pattern

Return

wild

public function setForceMode($mode)

This method is not documented.

Parameters

string

$mode

Either "php", "shell", or the empty string.

Return

wild

public function validateFile($file)

This method is not documented.

Parameters

$file

Return

wild

private function getFiles($dir)

This method is not documented.

Parameters

$dir

Return

wild

public function find()

This method is not documented.

Return

wild

private function generateList($flag, $items, $mode)

This method is not documented.

Parameters

	$flag
array	$items
	$mode

Return

wild

Defined: src/filesystem/FileFinder.php:18

final class FileFinderArcanist Technical Documentation ()

Tasks

Creating a File Query

Configuring File Queries

Executing the File Query

Internal

Other Methods

Methods

public function __construct($root)

public function excludePath($path)

public function withName($name)

public function withSuffix($suffix)

public function withPath($path)

public function withType($type)

public function withFollowSymlinks($follow)

public function setGenerateChecksums($generate)

public function getGenerateChecksums()

public function withNameGlob($pattern)

public function setForceMode($mode)

public function validateFile($file)

private function getFiles($dir)

public function find()

private function generateList($flag, $items, $mode)

final class FileFinder
Arcanist Technical Documentation ()