PageTheme
class PageTheme extends Theme (View source)
Constants
| E_THEME_INSTALLED |
|
| THEME_EXTENSION |
|
| THEME_CUSTOMIZABLE_STYLESHEET_EXTENSION |
|
| FILENAME_TYPOGRAPHY_CSS |
|
Properties
| $error | from Object | ||
| protected | $pThemeName | from Theme | |
| protected | $pThemeID | from Theme | |
| protected | $pThemeDescription | from Theme | |
| protected | $pThemeDirectory | from Theme | |
| protected | $pThemeThumbnail | from Theme | |
| protected | $pThemeHandle | from Theme | |
| protected | $pThemeURL | from Theme | |
| protected | $pThemeIsPreview | from Theme | |
| protected | $pkgID | from Theme | |
| protected | $stylesheetCachePath | from Theme | |
| protected | $stylesheetCacheRelativePath | from Theme | |
| protected | $pThemeGridFrameworkHandle |
Methods
scans the directory for available themes. For those who don't want to go through the hassle of uploading.
Checks the theme for a styles.xml file (which is how customizations happen.).
Looks into the current CSS directory and returns a fully compiled stylesheet when passed a LESS stylesheet. Also serves up custom value list values for the stylesheet if they exist.
Returns the value list of the custom style object if one exists.
No description
Returns the display name for this theme (localized and escaped accordingly to $format)
No description
Details
in
Object at line 10
loadError($error)
No description
in
Object at line 15
isError()
No description
in
Object at line 25
getError()
No description
in
Object at line 30
setPropertiesFromArray($arr)
No description
in
Object at line 37
static
camelcase($file)
No description
in
Object at line 42
static
uncamelcase($string)
No description
in
Theme at line 44
__construct()
No description
in
Theme at line 49
static
getGlobalList()
No description
in
Theme at line 54
static
getLocalList()
No description
in
Theme at line 59
static
getListByPackage($pkg)
No description
in
Theme at line 64
static
getList($where = null)
No description
in
Theme at line 81
static
getInstalledHandles()
No description
in
Theme at line 88
providesAsset($assetType, $assetHandle = null)
No description
in
Theme at line 94
requireAsset()
No description
in
Theme at line 108
static Theme[]
getAvailableThemes(bool $filterInstalled = true)
scans the directory for available themes. For those who don't want to go through the hassle of uploading.
in
Theme at line 141
static
getByFileHandle($handle, $dir = DIR_FILES_THEMES, $pkgHandle = '')
No description
in
Theme at line 170
bool
isThemeCustomizable()
Checks the theme for a styles.xml file (which is how customizations happen.).
in
Theme at line 186
StyleList
getThemeCustomizableStyleList()
Gets the style list object for this theme.
in
Theme at line 204
getThemeCustomizablePreset($handle)
Gets a preset for this theme by handle.
in
Theme at line 228
getThemeCustomizableStylePresets()
Gets all presets available to this theme.
in
Theme at line 267
enablePreviewRequest()
No description
in
Theme at line 274
resetThemeCustomStyles()
No description
in
Theme at line 284
isThemePreviewRequest()
No description
in
Theme at line 289
getThemeCustomizableStyleSheets()
No description
in
Theme at line 310
getStylesheetObject($stylesheet)
No description
in
Theme at line 333
string
getStylesheet(string $stylesheet)
Looks into the current CSS directory and returns a fully compiled stylesheet when passed a LESS stylesheet. Also serves up custom value list values for the stylesheet if they exist.
in
Theme at line 358
getThemeCustomStyleObject()
Returns a Custom Style Object for the theme if one exists.
in
Theme at line 378
ValueList
getThemeCustomStyleObjectValues()
Returns the value list of the custom style object if one exists.
in
Theme at line 388
setCustomStyleObject(ValueList $valueList, $selectedPreset = false, CustomCssRecord $customCssRecord = null)
No description
in
Theme at line 430
static PageTheme
getByHandle(string $pThemeHandle)
No description
in
Theme at line 444
static PageTheme
getByID($pThemeID)
No description
in
Theme at line 459
static protected Theme|null
populateThemeQuery(string $where, array $args)
No description
in
Theme at line 496
static
add($pThemeHandle, $pkg = null)
No description
in
Theme at line 521
getFilesInTheme()
No description
in
Theme at line 565
static private
getThemeNameAndDescription($dir, $pThemeHandle, $pkgHandle = '')
No description
in
Theme at line 633
export($node)
No description
in
Theme at line 646
static
exportList($xml)
No description
in
Theme at line 655
static protected
install($dir, $pThemeHandle, $pkgID)
No description
in
Theme at line 698
updateThemeCustomClass()
No description
in
Theme at line 715
getThemeID()
No description
in
Theme at line 720
getThemeName()
No description
in
Theme at line 732
string
getThemeDisplayName(string $format = 'html')
Returns the display name for this theme (localized and escaped accordingly to $format)
in
Theme at line 749
getPackageID()
No description
in
Theme at line 754
getPackageHandle()
No description
in
Theme at line 762
hasCustomClass()
Returns whether a theme has a custom class.
in
Theme at line 767
getThemeHandle()
No description
in
Theme at line 772
getThemeDescription()
No description
in
Theme at line 777
getThemeDisplayDescription($format = 'html')
No description
in
Theme at line 794
getThemeDirectory()
No description
in
Theme at line 799
getThemeURL()
No description
in
Theme at line 804
getThemeEditorCSS()
No description
in
Theme at line 809
setThemeURL($pThemeURL)
No description
in
Theme at line 814
setThemeDirectory($pThemeDirectory)
No description
in
Theme at line 819
setThemeHandle($pThemeHandle)
No description
in
Theme at line 824
setStylesheetCachePath($path)
No description
in
Theme at line 829
setStylesheetCacheRelativePath($path)
No description
in
Theme at line 834
getStylesheetCachePath()
No description
in
Theme at line 839
getStylesheetCacheRelativePath()
No description
in
Theme at line 844
isUninstallable()
No description
in
Theme at line 849
getThemeThumbnail()
No description
in
Theme at line 865
applyToSite(Site $site = null)
No description
in
Theme at line 885
static Theme
getSiteTheme()
No description
in
Theme at line 892
uninstall()
No description
in
Theme at line 906
registerAssets()
No description
in
Theme at line 910
supportsGridFramework()
No description
in
Theme at line 918
GridFramework|null
getThemeGridFrameworkObject()
No description
getThemeBlockClasses()
No description
in
Theme at line 932
getThemeAreaClasses()
No description
in
Theme at line 937
getThemeEditorClasses()
No description
in
Theme at line 942
getThemeDefaultBlockTemplates()
No description
in
Theme at line 947
getThemeResponsiveImageMap()
No description
in
Theme at line 952
getThemeGatheringGridItemMargin()
No description
in
Theme at line 957
getThemeGatheringGridItemWidth()
No description
in
Theme at line 962
getThemeGatheringGridItemHeight()
No description