Orpheus

HtmlRendering extends Rendering

in package

• orpheus

The HTML rendering class

Table of Contents

Constants

LINK_TYPE_CUSTOM  = 2

LINK_TYPE_PLUGIN  = 1

Properties

$cssPath  : string

Path to css folder

$cssURLs  : array<string|int, mixed>

List of CSS Urls to load

$defaultTheme  : string|null

The default theme to use for $theme

$jsPath  : string

Path to js folder

$jsURLs  : array<string|int, mixed>

List of JS Urls to load

$layoutsPath  : string

Path to layouts folder

$metaprop  : array<string|int, mixed>

List of meta-properties to send

$remote  : bool

$renderingId  : int

$resourcePath  : string

$themeFolderUri  : string

$current  : Rendering

The current global rendering

$layoutStack  : array<string|int, mixed>

The rendering layout stack

$menusConfig  : Config

The configuration of the menu

$renderingStack  : array<string|int, mixed>

The current rendering stack

$theme  : string

The theme to use to render HTML layouts

Methods

__construct()  : mixed

addCssFile()  : mixed

Add a global css file to the list

addCssUrl()  : mixed

Add a css url to the list

addJsFile()  : HtmlRendering

Add a global js file to the list

addJsUrl()  : HtmlRendering

Add a js url to the list

addMetaProperty()  : void

Add a html meta property to the list

addThemeCssFile()  : mixed

Add a theme css file to the list

addThemeJsFile()  : HtmlRendering

Add a theme js file to the list

captureOutput()  : void

Start capture of buffer

display()  : void

Display the model, allow an absolute path to the template file.

endCapture()  : bool|string

End capture of buffer

endCurrentLayout()  : bool

End the current layout

existsLayoutPath()  : bool

Test if the layout exists

getAbsThemePath()  : string

Get the absolute theme path.

getCssPath()  : string

Get the css theme path

getCssUrl()  : string

Get the CSS files url

getCurrent()  : static

getDefaultTheme()  : string

Get the default theme used to render layouts

getJsPath()  : string

Get the js theme path

getJsUrl()  : string

Get the JS files url

getLayoutPath()  : string

Get the path to the $layout

getLayoutsPath()  : string

Get the layout theme path

getMenuItems()  : array<string|int, string>

Get menu items

getRenderingId()  : int

getResourcePath()  : string

getThemeFolderUri()  : string

Get Theme folder Url. Mainly, a http URL for a website.

getThemePath()  : string

Get the theme path.

getThemeUrl()  : string

Get the theme url

isRemote()  : bool

listCssUrls()  : array<string|int, mixed>

List all registered css URLs

listJsUrls()  : array<string|int, mixed>

List all registered js URLs

listMetaProperties()  : array<string|int, mixed>

List all registered html meta properties

render()  : string|null

Render the model This function does not display the result, see display().

setDefaultTheme()  : mixed

Set the default theme used to render layouts

setRemote()  : self

setResourcePath()  : HtmlRendering

setTheme()  : mixed

Set the theme used to render layouts

setThemeFolderUri()  : self

showMenu()  : void

Show the $menu

startNewBlock()  : void

Start new block capture

useLayout()  : void

Use layout until the next endCurrentLayout()

addTypedUrl()  : mixed

Add an $url by $type in $array

getCurrentRendering()  : array<string|int, mixed>|null

Get current rendering

listTypedUrl()  : array<string|int, mixed>

List urls by $type in $array

pullFromStack()  : void

Remove current rendering and get to previous one

pushToStack()  : void

Push rendering to stack