ManifestFileFinder
class ManifestFileFinder extends FileFinder (View source)
An extension to the default file finder with some extra filters to facilitate 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 either of these conditions is meant:
- the
ignore_testsoption is not set to false. - the module PHP CI configuration matches one of the
ignored_ci_configs
- the
Constants
| CONFIG_FILE |
|
| CONFIG_DIR |
|
| EXCLUDE_FILE |
|
| LANG_DIR |
|
| TESTS_DIR |
|
| VENDOR_DIR |
|
| deprecated RESOURCES_DIR |
|
Properties
| protected static | array | $vcs_dirs | from FileFinder | |
| protected static | $default_options | |||
| protected | array | $options | from FileFinder |
Methods
Set an option on this finder instance. See SS_FileFinder for the list of options available.
Finds all files matching the options within a directory. The search is performed depth first.
Returns TRUE if the directory should be traversed. This can be overloaded to customise functionality, or extended with callbacks.
Returns TRUE if the file should be included in the results. This can be overloaded to customise functionality, or extended via callbacks.
Check if the given dir is, or is inside the vendor folder
Check if the given dir is, or is inside the themes folder
Check if this folder or any parent is ignored
Check if this folder is inside any module
Check if any parents match the given callback
Check if the given dir is a module root (not a subdir)
Check if the given directory is ignored
Details
__construct()
No description
mixed
getOption(string $name)
Returns an option value set on this instance.
setOption(string $name, mixed $value)
Set an option on this finder instance. See SS_FileFinder for the list of options available.
setOptions(array $options)
Sets several options at once.
array
find(string $base)
Finds all files matching the options within a directory. The search is performed depth first.
bool
acceptDir(string $basename, string $pathname, int $depth)
Returns TRUE if the directory should be traversed. This can be overloaded to customise functionality, or extended with callbacks.
protected bool
acceptFile(string $basename, string $pathname, int $depth)
Returns TRUE if the file should be included in the results. This can be overloaded to customise functionality, or extended via callbacks.
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
protected bool
anyParents(string $basename, string $pathname, int $depth, callable $callback)
Check if any parents match the given callback
bool
isDirectoryModule(string $basename, string $pathname, string $depth)
Check if the given dir is a module root (not a subdir)
protected string
upLevels(string $pathname, int $depth)
Get a parent path the given levels above
protected array
getIgnoredDirs()
Get all ignored directories
bool
isDirectoryIgnored(string $basename, string $pathname, string $depth)
Check if the given directory is ignored