expTheme
in package
This is the class expTheme
Tags
Table of Contents
- advertiseRSS() : mixed
- exdoc Output <link /> elements for each RSS feed on the site
- buttonColor() : mixed|string
- Return the color style for the current framework
- buttonIcon() : stdClass|string
- Return the icon associated for the current frameowrk
- buttonSize() : mixed|string
- Return the button size for the current framework
- buttonStyle() : mixed|string
- Return the button color and size style for the current framework
- clearSmartyCache() : mixed
- deprecated() : mixed
- Warn admin of obsolete theme methods
- foot() : mixed
- footerInfo() : mixed
- getPrinterFriendlyTheme() : mixed
- getSubthemes() : array<string|int, mixed>
- exdoc
- getTheme() : mixed
- getThemeDetails() : mixed
- goDefaultSection() : mixed
- exdoc Redirect User to Default Section
- grabView() : mixed
- grabViews() : mixed
- head() : mixed
- headerInfo() : mixed
- iconSize() : mixed|string
- Return the icon size for the current framework
- iconStyle() : string
- Return the full icon style string for the current framework
- inAction() : bool
- Checks to see if we are in an action or calling a page
- initialize() : mixed
- inPreview() : bool
- exdoc Checks to see if the page is currently in an action. Useful only if the theme does not use the self::main() function Returns whether or not an action should be run.
- is_mobile() : mixed
- loadActionMaps() : mixed
- main() : mixed
- exdoc Takes care of all the specifics of either showing a sectional container or running an action.
- module() : bool
- Entry point for displaying modules Packages $params for calling showModule method
- pageMetaInfo() : mixed
- processCSSandJS() : mixed
- removeCss() : mixed
- removeSmartyCache() : mixed
- reRoutActionTo() : mixed
- runAction() : bool
- exdoc Runs the appropriate action, by looking at the $_REQUEST variable.
- satisfyThemeRequirements() : mixed
- showAction() : mixed
- showController() : mixed
- showModule() : void
- exdoc Calls the necessary methods to show a specific module - NOT intended to be called directly from theme
- showSectionalModule() : void
- exdoc Calls the necessary methods to show a specific module, in a section-sensitive way.
- showTopSectionalModule() : mixed
- exdoc Calls the necessary methods to show a specific module in such a way that the current section displays the same content as its top-level parent and all of the top-level parent's children, grand-children, grand-grand-children, etc.
Methods
advertiseRSS()
exdoc Output <link /> elements for each RSS feed on the site
public
static advertiseRSS() : mixed
Tags
Return values
mixed —buttonColor()
Return the color style for the current framework
public
static buttonColor([ $color = null ]) : mixed|string
Parameters
Return values
mixed|string —buttonIcon()
Return the icon associated for the current frameowrk
public
static buttonIcon( $class[, null $size = null ]) : stdClass|string
Parameters
Return values
stdClass|string —buttonSize()
Return the button size for the current framework
public
static buttonSize([ $size = null ]) : mixed|string
Parameters
Return values
mixed|string —buttonStyle()
Return the button color and size style for the current framework
public
static buttonStyle([null $color = null ][, $size = null ]) : mixed|string
Parameters
Return values
mixed|string —clearSmartyCache()
public
static clearSmartyCache() : mixed
Return values
mixed —deprecated()
Warn admin of obsolete theme methods
public
static deprecated([string $newcall = "expTheme::module()" ][, null $controller = null ][, null $actionview = null ]) : mixed
Parameters
- $newcall : string = "expTheme::module()"
- $controller : null = null
- $actionview : null = null
Return values
mixed —foot()
public
static foot([mixed $params = array() ]) : mixed
Parameters
- $params : mixed = array()
Return values
mixed —footerInfo()
public
static footerInfo([mixed $params = array() ]) : mixed
Parameters
- $params : mixed = array()
Return values
mixed —getPrinterFriendlyTheme()
public
static getPrinterFriendlyTheme() : mixed
Return values
mixed —getSubthemes()
exdoc
public
static getSubthemes([bool $include_default = true ][, string $theme = DISPLAY_THEME ]) : array<string|int, mixed>
Parameters
- $include_default : bool = true
- $theme : string = DISPLAY_THEME
Tags
Return values
array<string|int, mixed> —getTheme()
public
static getTheme() : mixed
Return values
mixed —getThemeDetails()
public
static getThemeDetails() : mixed
Return values
mixed —goDefaultSection()
exdoc Redirect User to Default Section
public
static goDefaultSection() : mixed
Tags
Return values
mixed —grabView()
public
static grabView(mixed $path, mixed $filename) : mixed
Parameters
- $path : mixed
- $filename : mixed
Return values
mixed —grabViews()
public
static grabViews(mixed $path[, mixed $filter = '' ]) : mixed
Parameters
- $path : mixed
- $filter : mixed = ''
Return values
mixed —head()
public
static head([mixed $config = array() ]) : mixed
Parameters
- $config : mixed = array()
Return values
mixed —headerInfo()
public
static headerInfo(mixed $config) : mixed
Parameters
- $config : mixed
Return values
mixed —iconSize()
Return the icon size for the current framework
public
static iconSize([ $size = null ]) : mixed|string
Parameters
Return values
mixed|string —iconStyle()
Return the full icon style string for the current framework
public
static iconStyle( $class[, null $text = null ]) : string
Parameters
Return values
string —inAction()
Checks to see if we are in an action or calling a page
public
static inAction([null $action = null ]) : bool
Parameters
- $action : null = null
Return values
bool —initialize()
public
static initialize() : mixed
Return values
mixed —inPreview()
exdoc Checks to see if the page is currently in an action. Useful only if the theme does not use the self::main() function Returns whether or not an action should be run.
public
static inPreview() : bool
Tags
Return values
bool —is_mobile()
public
static is_mobile() : mixed
Return values
mixed —loadActionMaps()
public
static loadActionMaps() : mixed
Return values
mixed —main()
exdoc Takes care of all the specifics of either showing a sectional container or running an action.
public
static main() : mixed
Tags
Return values
mixed —module()
Entry point for displaying modules Packages $params for calling showModule method
public
static module(array<string|int, mixed> $params[, mixed $main = false ]) : bool
Parameters
- $params : array<string|int, mixed>
-
list of module parameters
- $main : mixed = false
Return values
bool —pageMetaInfo()
public
static pageMetaInfo() : mixed
Return values
mixed —processCSSandJS()
public
static processCSSandJS() : mixed
Return values
mixed —removeCss()
public
static removeCss() : mixed
Return values
mixed —removeSmartyCache()
public
static removeSmartyCache() : mixed
Return values
mixed —reRoutActionTo()
public
static reRoutActionTo([mixed $theme = "" ]) : mixed
Parameters
- $theme : mixed = ""
Return values
mixed —runAction()
exdoc Runs the appropriate action, by looking at the $_REQUEST variable.
public
static runAction() : bool
Tags
Return values
bool —satisfyThemeRequirements()
public
static satisfyThemeRequirements() : mixed
Return values
mixed —showAction()
public
static showAction(mixed $module, mixed $action[, mixed $src = "" ][, mixed $params = array() ]) : mixed
Parameters
- $module : mixed
- $action : mixed
- $src : mixed = ""
- $params : mixed = array()
Return values
mixed —showController()
public
static showController([array<string|int, mixed> $params = array() ]) : mixed
Parameters
- $params : array<string|int, mixed> = array()
Tags
Return values
mixed —showModule()
exdoc Calls the necessary methods to show a specific module - NOT intended to be called directly from theme
public
static showModule(string $module[, string $view = "Default" ][, string $title = "" ][, string $source = null ][, bool $pickable = false ][, null $section = null ][, bool $hide_menu = false ][, array<string|int, mixed> $params = array() ]) : void
Parameters
- $module : string
-
The classname of the module to display
- $view : string = "Default"
-
The name of the view to display the module with
- $title : string = ""
-
The title of the module (support is view-dependent)
- $source : string = null
-
The source of the module.
- $pickable : bool = false
-
Whether or not the module is pickable in the Source Picker.
- $section : null = null
- $hide_menu : bool = false
- $params : array<string|int, mixed> = array()
Tags
Return values
void —showSectionalModule()
exdoc Calls the necessary methods to show a specific module, in a section-sensitive way.
public
static showSectionalModule(string $module, string $view, string $title[, string $prefix = null ][, bool $pickable = false ][, bool $hide_menu = false ]) : void
Parameters
- $module : string
-
The classname of the module to display
- $view : string
-
The name of the view to display the module with
- $title : string
-
The title of the module (support is view-dependent)
- $prefix : string = null
-
The prefix of the module's source. The current section id will be appended to this
- $pickable : bool = false
-
Whether or not the module is pickable in the Source Picker.
- $hide_menu : bool = false
Tags
Return values
void —showTopSectionalModule()
exdoc Calls the necessary methods to show a specific module in such a way that the current section displays the same content as its top-level parent and all of the top-level parent's children, grand-children, grand-grand-children, etc.
public
static showTopSectionalModule(string $module, string $view, string $title[, string $prefix = null ][, bool $pickable = false ][, bool $hide_menu = false ]) : mixed
Parameters
- $module : string
-
The classname of the module to display
- $view : string
-
The name of the view to display the module with
- $title : string
-
The title of the module (support is view-dependent)
- $prefix : string = null
-
The prefix of the module's source. The current section id will be appended to this
- $pickable : bool = false
-
Whether or not the module is pickable in the Source Picker.
- $hide_menu : bool = false