Property | Type | Description | |
---|---|---|---|
$ajax | boolean | Output code necessary to perform AJAX operations? | |
$css | Horde_Themes_Css | Stylesheet object. | |
$debug | boolean | Activate debugging output. | |
$deferScripts | boolean | Defer loading of scripts until end of page? | |
$growler | boolean | Output code necessary to display growler notifications? | |
$hsl | Horde_Script_List | Script list. | |
$inlineScript | array | List of inline scripts. | |
$linkTags | array | List of LINK tags to output. | |
$metaTags | array | List of META tags to output. | |
$sidebar | boolean | Load the sidebar in this page? | |
$smartmobileInit | array | Smartmobile init code that needs to be output before jquery.mobile.js is loaded. | |
$topbar | boolean | Load the topbar in this page? |
Property | Type | Description | |
---|---|---|---|
$_compress | boolean | Has PHP userspace page compression been started? | |
$_view | integer | View mode. |
Method | Description | |
---|---|---|
__construct ( ) | Constructor. | |
addInlineJsVars ( array $data, mixed $opts = [] ) : array | Add inline javascript variable definitions to the output buffer. | |
addInlineScript ( mixed $script, boolean $onload = false, boolean $top = false ) | Add inline javascript to the output buffer. | |
addLinkTag ( array $opts = [] ) | Adds a LINK tag. | |
addMetaTag ( string $name, string $content, boolean $http_equiv = true ) | Adds a META tag to the page output. | |
addScriptFile ( mixed $file, string $app = null ) : Horde_Script_File | Adds a single javascript script to the output (if output has already started), or to the list of script files to include in the output. | |
addScriptPackage ( mixed $package ) : Horde_Script_Package | Adds a javascript package to the browser output. | |
addStylesheet ( Horde_Themes_Element | string $file, string $url = null ) | Adds an external stylesheet to the output. | |
addThemeStylesheet ( string $file ) | Adds a themed stylesheet to the output. | |
disableCompression ( ) | Disables output compression. If successful, throws out all data currently in the output buffer. Must be called before any data is sent to the browser. | |
footer ( array $opts = [] ) | Output page footer. | |
header ( array $opts = [] ) | Output the page header. | |
includeFavicon ( ) | Generate and output the favicon tag for the current application. | |
includeScriptFiles ( ) | Outputs the necessary script tags, honoring configuration choices as to script caching. | |
includeStylesheetFiles ( array $opts = [], array $full = false ) | Generate the stylesheet tags for the current application. | |
metaRefresh ( integer $time, string $url ) | Adds a META refresh tag. | |
noDnsPrefetch ( ) | Adds a META tag to disable DNS prefetching. | |
outputInlineScript ( boolean $raw = false ) | Print pending inline javascript to the output buffer. | |
outputLinkTags ( ) | Output LINK tags. | |
outputMetaTags ( ) | Output META tags to page. | |
outputSmartmobileFiles ( ) | Output files needed for smartmobile mode. | |
startCompression ( ) | Activates output compression. |
Method | Description | |
---|---|---|
_addBasicScripts ( ) | Add basic framework scripts to the output. |
protected _addBasicScripts ( ) |
public addInlineJsVars ( array $data, mixed $opts = [] ) : array | ||
$data | array | Keys are the variable names, values are the data to JSON encode. If the key begins with a '-', the data will be added to the output as-is. |
$opts | mixed | If boolean true, equivalent to setting the 'onload' option to true. Other options: - onload: (boolean) Wrap the definition in an onload handler? DEFAULT: false - ret_vars: (boolean) If true, will return the list of variable definitions instead of outputting to page. DEFAULT: false - top: (boolean) Add definitions to top of stack? DEFAULT: false |
return | array | Returns the variable list of 'ret_vars' option is true. |
public addLinkTag ( array $opts = [] ) | ||
$opts | array | Non-default tag elements. |
public addScriptFile ( mixed $file, string $app = null ) : Horde_Script_File | ||
$file | mixed | Either a Horde_Script_File object, or the full javascript file name. |
$app | string | If $file is a file name, this is the application where the file is located. Defaults to the current registry application. |
return | Horde_Script_File | Script file object. |
public addScriptPackage ( mixed $package ) : Horde_Script_Package | ||
$package | mixed | Either a classname, basename of a Horde_Core_Script_Package class, or a Horde_Script_Package object. |
return | Horde_Script_Package | Package object. |
public addStylesheet ( Horde_Themes_Element | string $file, string $url = null ) | ||
$file | Horde_Themes_Element | string | Either a Horde_Themes_Element object or the CSS filepath. |
$url | string | If $file is a string, this must be a CSS URL. |
public addThemeStylesheet ( string $file ) | ||
$file | string | The stylesheet name. |
public disableCompression ( ) |
public includeFavicon ( ) |
public includeScriptFiles ( ) |
public includeStylesheetFiles ( array $opts = [], array $full = false ) | ||
$opts | array | Options to pass to Horde_Themes_Css::getStylesheetUrls(). |
$full | array | Return a full URL? |
public metaRefresh ( integer $time, string $url ) | ||
$time | integer | Refresh time. |
$url | string | Refresh URL |
public outputInlineScript ( boolean $raw = false ) | ||
$raw | boolean | Return the raw script (not wrapped in CDATA tags or observe wrappers)? |
public outputSmartmobileFiles ( ) |
protected bool $_compress | ||
return | boolean |
public bool $ajax | ||
return | boolean |
public bool $deferScripts | ||
return | boolean |
public bool $growler | ||
return | boolean |
public array $smartmobileInit | ||
return | array |