1. class
  2. SilverStripe
  3. \
  4. Core
  5. \
  6. Manifest
  7. \
  8. ManifestFileFinder

ManifestFileFinder

class ManifestFileFinder extends FileFinder

An extension to the default file finder with some extra filters to faciliate autoload and template manifest generation: - Only modules with _config.php files are scanned.

  • If a _manifest_exclude file is present inside a directory it is ignored.
    • Assets and module language directories are ignored.
    • Module tests directories are skipped if the ignore_tests option is not set to false.

Constants

CONFIG_FILE

CONFIG_DIR

EXCLUDE_FILE

LANG_DIR

TESTS_DIR

VENDOR_DIR

RESOURCES_DIR

Methods

__construct()

No description

from FileFinder
mixed
getOption(string $name)

Returns an option value set on this instance.

from FileFinder
setOption(string $name, mixed $value)

Set an option on this finder instance. See {@link SS_FileFinder} for the list of options available.

from FileFinder
setOptions(array $options)

Sets several options at once.

from FileFinder
array
find(string $base)

Finds all files matching the options within a directory. The search is performed depth first.

from FileFinder
acceptDir($basename, $pathname, $depth)

No description

bool
isInsideVendor(string $basename, string $pathname, int $depth)

Check if the given dir is, or is inside the vendor folder

bool
isInsideThemes(string $basename, string $pathname, int $depth)

Check if the given dir is, or is inside the themes folder

bool
isInsideIgnored(string $basename, string $pathname, int $depth)

Check if this folder or any parent is ignored

bool
isInsideModule(string $basename, string $pathname, int $depth)

Check if this folder is inside any module

bool
isDirectoryModule(string $basename, string $pathname, string $depth)

Check if the given dir is a module root (not a subdir)

bool
isDirectoryIgnored(string $basename, string $pathname, string $depth)

Check if the given directory is ignored

Details

in FileFinder at line 72
__construct()

in FileFinder at line 91
mixed getOption(string $name)

Returns an option value set on this instance.

Parameters

string $name

Return Value

mixed

in FileFinder at line 107
setOption(string $name, mixed $value)

Set an option on this finder instance. See {@link SS_FileFinder} for the list of options available.

Parameters

string $name
mixed $value

in FileFinder at line 121
setOptions(array $options)

Sets several options at once.

Parameters

array $options

in FileFinder at line 135
array find(string $base)

Finds all files matching the options within a directory. The search is performed depth first.

Parameters

string $base

Return Value

array

at line 38
acceptDir($basename, $pathname, $depth)

Parameters

$basename
$pathname
$depth

at line 87
bool isInsideVendor(string $basename, string $pathname, int $depth)

Check if the given dir is, or is inside the vendor folder

Parameters

string $basename
string $pathname
int $depth

Return Value

bool

at line 101
bool isInsideThemes(string $basename, string $pathname, int $depth)

Check if the given dir is, or is inside the themes folder

Parameters

string $basename
string $pathname
int $depth

Return Value

bool

at line 115
bool isInsideIgnored(string $basename, string $pathname, int $depth)

Check if this folder or any parent is ignored

Parameters

string $basename
string $pathname
int $depth

Return Value

bool

at line 130
bool isInsideModule(string $basename, string $pathname, int $depth)

Check if this folder is inside any module

Parameters

string $basename
string $pathname
int $depth

Return Value

bool

at line 169
bool isDirectoryModule(string $basename, string $pathname, string $depth)

Check if the given dir is a module root (not a subdir)

Parameters

string $basename
string $pathname
string $depth

Return Value

bool

at line 229
bool isDirectoryIgnored(string $basename, string $pathname, string $depth)

Check if the given directory is ignored

Parameters

string $basename
string $pathname
string $depth

Return Value

bool