PageTheme
class PageTheme extends Theme (View source)
Constants
| E_THEME_INSTALLED |
|
| THEME_EXTENSION |
|
| THEME_CUSTOMIZABLE_STYLESHEET_EXTENSION |
|
| FILENAME_TYPOGRAPHY_CSS |
|
Properties
| $error | from ConcreteObject | ||
| 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 string|null|false | $pThemeGridFrameworkHandle | The handle of the grid framework supported by this theme. |
from Theme |
Methods
Mark an asset as provided by this theme.
Get the all the themes available in the /application/themes directory.
Get a theme from the file system.
Checks the theme for a styles.xml file (which is how customizations happen).
Get all the customizable LESS stylesheets.
Get a customizable LESS stylesheet given the stylesheed base file name.
Look into the current CSS directory and return a fully compiled stylesheet when passed a LESS stylesheet.
Get a CustomStyle object for the theme if one exists.
Get the value list of the custom style object if one exists.
Create a CustomStyle (and optionally a preset and the custom CSS) for this theme.
Get an installed theme given its handle.
Get the instance representing an installed theme.
Grab all files in theme that are PHP based (or html if we go that route) and then lists them out, by type, allowing people to install them as page type, etc.
Get the theme details by reading a directory containing the theme.
Export this theme by creating the XML nodes under the provided XML node.
Export all the installed themes by creating the XML nodes under the provided XML node.
Install a theme.
(Re)Scan the theme folder to check if it contains the page_theme.php file: if so, marks the theme as having a controller.
Get the localized name for this theme (escaped accordingly to $format).
Get the handle of the package providing this theme (if available).
Get the localized description for this theme (escaped accordingly to $format).
Set the absolute path of a directory where the CSS stylesheet files should be stored.
Set the path of a directory where the CSS stylesheet files should be stored, relative to the website root directory.
Get the absolute path of a directory where the CSS stylesheet files should be stored.
Get the path of a directory where the CSS stylesheet files should be stored, relative to the website root directory.
Register the assets provided by this theme.
Get the grid framework supported by this theme.
Get the theme-specific style names to be used in the rich text editor.
Get the handles of the thumbnail types and related resolution breakpoint.
Details
loadError($error)
No description
isError()
No description
getError()
No description
setPropertiesFromArray($arr)
No description
static
camelcase($file)
No description
static
uncamelcase($string)
No description
in
Theme at line 44
__construct()
No description
in
Theme at line 54
static Theme[]
getGlobalList()
Get the installed themes provided by packages.
in
Theme at line 64
static Theme[]
getLocalList()
Get the installed themes provided by the core.
in
Theme at line 76
static Theme[]
getListByPackage($pkg)
Get the installed themes provided by a package.
in
Theme at line 88
static Theme[]
getList(string|null $where = null)
Get the installed themes.
in
Theme at line 110
static string[]
getInstalledHandles()
Get the handles of all the installed themes.
in
Theme at line 123
providesAsset(string $assetType, string|false $assetHandle = null)
Mark an asset as provided by this theme.
in
Theme at line 135
requireAsset()
Mark an asset as reuired by this theme.
Accepts the same arguments as \Concrete\Core\Http\ResponseAssetGroup::requireAsset().
in
Theme at line 149
static Theme[]
getAvailableThemes(bool $filterInstalled = true)
Get the all the themes available in the /application/themes directory.
in
Theme at line 191
static Theme|null
getByFileHandle(string $handle, string $dir = DIR_FILES_THEMES, string $pkgHandle = '')
Get a theme from the file system.
in
Theme at line 220
bool
isThemeCustomizable()
Checks the theme for a styles.xml file (which is how customizations happen).
in
Theme at line 236
StyleList
getThemeCustomizableStyleList()
Gets the style list object for this theme.
in
Theme at line 256
Preset|null
getThemeCustomizablePreset($handle)
Get a preset for this theme by handle.
in
Theme at line 282
Preset[]
getThemeCustomizableStylePresets()
Get all presets available to this theme.
in
Theme at line 324
enablePreviewRequest()
Set this instance to be a preview for the current request.
in
Theme at line 331
resetThemeCustomStyles()
No description
in
Theme at line 346
bool
isThemePreviewRequest()
Is this instance a preview for the current request?
in
Theme at line 356
Stylesheet[]
getThemeCustomizableStyleSheets()
Get all the customizable LESS stylesheets.
in
Theme at line 384
Stylesheet
getStylesheetObject(string $stylesheet)
Get a customizable LESS stylesheet given the stylesheed base file name.
in
Theme at line 407
string
getStylesheet(string $stylesheet)
Look into the current CSS directory and return 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 434
CustomStyle|null
getThemeCustomStyleObject()
Get a CustomStyle object for the theme if one exists.
in
Theme at line 454
ValueList|null
getThemeCustomStyleObjectValues()
Get the value list of the custom style object if one exists.
in
Theme at line 471
CustomStyle
setCustomStyleObject(ValueList $valueList, Preset|null|false $selectedPreset = false, CustomCssRecord $customCssRecord = null)
Create a CustomStyle (and optionally a preset and the custom CSS) for this theme.
in
Theme at line 515
static Theme|null
getByHandle(string $pThemeHandle)
Get an installed theme given its handle.
in
Theme at line 531
static Theme|null
getByID(int $pThemeID)
Get an installed theme given its ID.
in
Theme at line 548
static protected Theme|null
populateThemeQuery(string $where, array $args)
Get the instance representing an installed theme.
in
Theme at line 595
static Theme|null
add(string $pThemeHandle, Package|Package|null $pkg = null)
Install a theme given its handle.
in
Theme at line 624
File[]
getFilesInTheme()
Grab all files in theme that are PHP based (or html if we go that route) and then lists them out, by type, allowing people to install them as page type, etc.
..
in
Theme at line 677
static private stdClass
getThemeNameAndDescription(string $dir, string $pThemeHandle, string $pkgHandle = '')
Get the theme details by reading a directory containing the theme.
in
Theme at line 750
export(SimpleXMLElement $node)
Export this theme by creating the XML nodes under the provided XML node.
in
Theme at line 768
static
exportList(SimpleXMLElement $xml)
Export all the installed themes by creating the XML nodes under the provided XML node.
in
Theme at line 788
static protected Theme|null
install(string $dir, string $pThemeHandle, int|null $pkgID)
Install a theme.
in
Theme at line 834
updateThemeCustomClass()
(Re)Scan the theme folder to check if it contains the page_theme.php file: if so, marks the theme as having a controller.
in
Theme at line 856
int|null
getThemeID()
Get the ID of the installed theme (if available).
in
Theme at line 866
string
getThemeName()
Get the (English) name of the theme.
in
Theme at line 878
string
getThemeDisplayName(string $format = 'html')
Get the localized name for this theme (escaped accordingly to $format).
in
Theme at line 900
int|null
getPackageID()
Get the ID of the package providing this theme (if available).
in
Theme at line 910
string|false|null
getPackageHandle()
Get the handle of the package providing this theme (if available).
in
Theme at line 918
hasCustomClass()
Returns whether a theme has a custom class.
in
Theme at line 928
string
getThemeHandle()
Get the handle of this theme.
in
Theme at line 938
string
getThemeDescription()
Get the (English) description of this theme.
in
Theme at line 950
string
getThemeDisplayDescription(string $format = 'html')
Get the localized description for this theme (escaped accordingly to $format).
in
Theme at line 972
string
getThemeDirectory()
Get the directory containing this theme.
in
Theme at line 982
string
getThemeURL()
Get the URL prefix of the assets provided by this theme.
in
Theme at line 992
string
getThemeEditorCSS()
Get the URL of the theme typography.css file.
setThemeURL(string $pThemeURL)
Set the URL prefix of the assets provided by this theme.
setThemeDirectory(string $pThemeDirectory)
Set the absolute path of the theme folder.
setThemeHandle(string $pThemeHandle)
Set the handle of this theme.
setStylesheetCachePath(string $path)
Set the absolute path of a directory where the CSS stylesheet files should be stored.
setStylesheetCacheRelativePath(string $path)
Set the path of a directory where the CSS stylesheet files should be stored, relative to the website root directory.
string
getStylesheetCachePath()
Get the absolute path of a directory where the CSS stylesheet files should be stored.
string
getStylesheetCacheRelativePath()
Get the path of a directory where the CSS stylesheet files should be stored, relative to the website root directory.
bool
isUninstallable()
Is this theme uninstallable?
Image
getThemeThumbnail()
Get the theme thumbnail image.
applyToSite(Site $site = null)
Apply this theme to all the pages of a site.
static Theme|null
getSiteTheme()
Get the theme for the current site.
uninstall()
Uninstall this theme.
registerAssets()
Register the assets provided by this theme.
bool
supportsGridFramework()
Does this theme support a grid framework?
GridFramework|null
getThemeGridFrameworkObject()
Get the grid framework supported by this theme.
array
getThemeBlockClasses()
Get the theme-specific CSS classes for every block.
array
getThemeAreaClasses()
Get the theme-specific CSS classes for every area.
array
getThemeEditorClasses()
Get the theme-specific style names to be used in the rich text editor.
array
getThemeDefaultBlockTemplates()
Get the theme-specific templates for every block.
array
getThemeResponsiveImageMap()
Get the handles of the thumbnail types and related resolution breakpoint.
getThemeGatheringGridItemMargin()
deprecated
deprecated
No description
getThemeGatheringGridItemWidth()
deprecated
deprecated
No description
getThemeGatheringGridItemHeight()
deprecated
deprecated
No description