ThemeDirectory
in package
implements
ThemeDirectoryInterface
Class ThemeDirectory
Interfaces, Classes and Traits
- ThemeDirectoryInterface
- Interface ThemeDirectoryInterface
Table of Contents
- $children : ThemeDirectoryCollection|null
- $files : array<string|int, string>
- $root : ThemeDirectoryRootInterface
- __construct() : mixed
- ThemeDirectory constructor.
- create() : ThemeDirectory
- Named constructor of ThemeDirectory.
- getChildren() : ThemeDirectoryCollection|null
- Returns a list of all directories in the current theme (non-recursively).
- getFiles() : array<string|int, string>
- Returns a list of all files in the current theme (non-recursively).
- getRoot() : ThemeDirectoryRootInterface
- Returns the theme directories root path.
Properties
$children
protected
ThemeDirectoryCollection|null
$children
$files
protected
array<string|int, string>
$files
= []
$root
protected
ThemeDirectoryRootInterface
$root
Methods
__construct()
ThemeDirectory constructor.
public
__construct(ThemeDirectoryRootInterface $directoryRoot) : mixed
Parameters
- $directoryRoot : ThemeDirectoryRootInterface
-
Absolute path to root of theme directory.
Return values
mixed —create()
Named constructor of ThemeDirectory.
public
static create(ThemeDirectoryRootInterface $directoryRoot) : ThemeDirectory
Parameters
- $directoryRoot : ThemeDirectoryRootInterface
-
Absolute path to root of theme directory.
Return values
ThemeDirectory —New instance.
getChildren()
Returns a list of all directories in the current theme (non-recursively).
public
getChildren() : ThemeDirectoryCollection|null
Return values
ThemeDirectoryCollection|null —getFiles()
Returns a list of all files in the current theme (non-recursively).
public
getFiles() : array<string|int, string>
Return values
array<string|int, string> —getRoot()
Returns the theme directories root path.
public
getRoot() : ThemeDirectoryRootInterface