ThemesHandler
in package
Themes Handler class
This class is specifically designed to require as few as possible composer infrastructure. It should also be useful for offline / register-only scenarios.
Table of Contents
- $themesCatalog : ThemesCatalog
- $filesystem : Filesystem
- Filesystem API
- $rootDir : string
- The root package's dir
- $themesDir : string
- $vendorDir : string
- $mode : string
- __construct() : mixed
- setupDefaultTheme() : void
- Setup themes shipped with an app
- setupPackagedThemes() : void
- setupThemes() : void
- Rebuild the link structure from index
- ensureThemesFolderExists() : void
- Create the basic themes folder if missing
Properties
$themesCatalog
public
ThemesCatalog
$themesCatalog
$filesystem
Filesystem API
protected
Filesystem
$filesystem
$rootDir
The root package's dir
protected
string
$rootDir
$themesDir
protected
string
$themesDir
$vendorDir
protected
string
$vendorDir
$mode
private
string
$mode
= 'symlink'
Methods
__construct()
public
__construct(Filesystem $filesystem, string $rootDir, string $vendorDir[, string $mode = 'symlink' ]) : mixed
Parameters
- $filesystem : Filesystem
- $rootDir : string
- $vendorDir : string
- $mode : string = 'symlink'
Return values
mixed —setupDefaultTheme()
Setup themes shipped with an app
public
setupDefaultTheme() : void
These may be named "default" or other
Return values
void —setupPackagedThemes()
public
setupPackagedThemes() : void
Return values
void —setupThemes()
Rebuild the link structure from index
public
setupThemes() : void
TODO: Unregister themes which are not really installed but indexed
Return values
void —ensureThemesFolderExists()
Create the basic themes folder if missing
protected
ensureThemesFolderExists() : void