• Home
  • Gdn_ThemeManager

PHP Class Gdn_ThemeManager, vanilla

Show file Open project: vanilla/vanilla Class Usage Examples

Public Methods

Method Description
__construct ( AddonManager $addonManager = null, $hasRequest = null )
availableThemes ( boolean $force = false ) : array Looks through the themes directory for valid themes.
clearThemeCache ( ) Deprecated.
currentTheme ( ) : mixed
desktopTheme ( ) : mixed
disableTheme ( )
enableTheme ( $ThemeName, boolean $IsMobile = false ) : boolean
enabledTheme ( ) : Gdn_Config | mixed
enabledThemeInfo ( boolean $ReturnInSourceFormat = false ) : array | mixed
findThemeFiles ( ) : array Deprecated.
getMobilePreview ( ) : string Returns the folder name (aka slug) of the previewed mobile theme, or an empty string if there is no previewed mobile theme.
getPreview ( ) : string Returns the folder name (aka slug) of the previewed theme, or an empty string if there is no previewed theme.
getThemeInfo ( $ThemeName ) : mixed
hasMobilePreview ( ) : boolean Returns whether there's a mobile theme being previewed.
hasPreview ( ) : boolean Returns whether there's a theme being previewed.
indexSearchPath ( $SearchPath, &$ThemeInfo, null $PathListing = null ) : boolean | string
mobileTheme ( ) : mixed
searchPaths ( ) Deprecated.
start ( $Force = false ) Sets up the theme framework
testTheme ( string $themeName ) : boolean Test a theme for dependencies and parse errors.
themeFromType ( $Type ) : mixed

Private Methods

Method Description
asset ( string $path, string $withDomain ) : string Clear the dependencies on {@link asset()} for unit testing.
findThemeFilesOld ( string $themePath ) : array | false Find the files associated with the theme.
scanThemeFileOld ( string $ThemeFile, string $VariableName = '' ) : null | array Deprecated.
themeHook ( string $themeName, string $forAction, boolean $callback = false ) : void Hooks to the various actions, i.e. enable, disable and load.

Method Details

__construct() public method

public __construct ( AddonManager $addonManager = null, $hasRequest = null )
$addonManager Vanilla\AddonManager

availableThemes() public method

The themes are returned as an associative array of "Theme Name" => "Theme Info Array".
public availableThemes ( boolean $force = false ) : array
$force boolean Deprecated.
return array Returns the available themes in an array.

clearThemeCache() public method

Deprecated.
Deprecation:
public clearThemeCache ( )

currentTheme() public method

public currentTheme ( ) : mixed
return mixed

desktopTheme() public method

public desktopTheme ( ) : mixed
return mixed

disableTheme() public method

public disableTheme ( )

enableTheme() public method

public enableTheme ( $ThemeName, boolean $IsMobile = false ) : boolean
$ThemeName
$IsMobile boolean
return boolean

enabledTheme() public method

public enabledTheme ( ) : Gdn_Config | mixed
return Gdn_Config | mixed

enabledThemeInfo() public method

public enabledThemeInfo ( boolean $ReturnInSourceFormat = false ) : array | mixed
$ReturnInSourceFormat boolean
return array | mixed

findThemeFiles() public method

Deprecated.
public findThemeFiles ( ) : array
return array Deprecated.

getMobilePreview() public method

Returns the folder name (aka slug) of the previewed mobile theme, or an empty string if there is no previewed mobile theme.
public getMobilePreview ( ) : string
return string The folder name of the previewed mobile theme or an empty string.

getPreview() public method

Returns the folder name (aka slug) of the previewed theme, or an empty string if there is no previewed theme.
public getPreview ( ) : string
return string The folder name of the previewed mobile theme or an empty string.

getThemeInfo() public method

public getThemeInfo ( $ThemeName ) : mixed
$ThemeName
return mixed

hasMobilePreview() public method

Returns whether there's a mobile theme being previewed.
public hasMobilePreview ( ) : boolean
return boolean Whether there's a mobile theme being previewed.

hasPreview() public method

Returns whether there's a theme being previewed.
public hasPreview ( ) : boolean
return boolean Whether there's a theme being previewed.

indexSearchPath() public method

public indexSearchPath ( $SearchPath, &$ThemeInfo, null $PathListing = null ) : boolean | string
$SearchPath
$ThemeInfo
$PathListing null
return boolean | string

mobileTheme() public method

public mobileTheme ( ) : mixed
return mixed

searchPaths() public method

Deprecated.
Deprecation:
public searchPaths ( )

start() public method

This method indexes all available themes and extracts their information. It then determines which plugins have been enabled, and includes them. Finally, it parses all plugin files and extracts their events and plugged methods.
public start ( $Force = false )

testTheme() public method

Test a theme for dependencies and parse errors.
public testTheme ( string $themeName ) : boolean
$themeName string The case-sensitive theme name.
return boolean Returns

themeFromType() public method

public themeFromType ( $Type ) : mixed
$Type
return mixed