Documentation

Finder
in package

Class helping to find files and directories.

Table of Contents

Methods

__construct()  : mixed
Constructor
Children()  : ArrayList
Return children folders in a directory.
Directories()  : ArrayList
Find directories.
DirectoriesRecursive()  : ArrayList
Find directories recursively.
Files()  : ArrayList
Find files.
FilesRecursive()  : ArrayList
Find files recursively.

Methods

__construct()

Constructor

public __construct() : mixed

Children()

Return children folders in a directory.

public Children(string $path) : ArrayList
Parameters
$path : string

Path to the directory

Return values
ArrayList

Directories()

Find directories.

public Directories(string $path[, string $sortField = '' ][, int $sortType = SORT_ASC ]) : ArrayList
Parameters
$path : string

Path to the folder

$sortField : string = ''

Field for sorting

$sortType : int = SORT_ASC

Sorting type

Return values
ArrayList

DirectoriesRecursive()

Find directories recursively.

public DirectoriesRecursive(string $path[, string $match = '/.*/' ][, string $sortField = '' ][, int $sortType = SORT_ASC ]) : ArrayList
Parameters
$path : string

Path to the folder

$match : string = '/.*/'

Regular expression

$sortField : string = ''

Field for sorting

$sortType : int = SORT_ASC

Sorting type

Return values
ArrayList

Files()

Find files.

public Files(string $path[, string $match = '/.*/' ][, string $sortField = '' ][, int $sortType = SORT_ASC ]) : ArrayList
Parameters
$path : string

Path to the folder

$match : string = '/.*/'

Regular expression

$sortField : string = ''

Field for sorting

$sortType : int = SORT_ASC

Sorting type

Return values
ArrayList

FilesRecursive()

Find files recursively.

public FilesRecursive(string $path[, string $match = '/.*/' ][, string $sortField = '' ][, int $sortType = SORT_ASC ]) : ArrayList
Parameters
$path : string

Path to the folder

$match : string = '/.*/'

Regular expression

$sortField : string = ''

Field for sorting

$sortType : int = SORT_ASC

Sorting type

Return values
ArrayList

        
On this page

Search results