n2n Page Rocket 1 API

n2n\impl\web\ui\view\html

­Html­Builder­Meta

HtmlBuilderMeta
Accessible through $html->meta() in every html view

Constant summary

Methods summary

Modifier and Type Method
public __construct ( HtmlView view )
public HtmlView getView ( )
public HtmlProperties getHtmlProperties ( )
public HeadBuilderMeta head ( )
public HeadBuilderMeta bodyStart ( )
public HeadBuilderMeta bodyEnd ( )
public setTitle ( string title , bool includePageName = false )
public string getPageName ( )
public addCss ( Url|string relativeUrl , string media = null , string moduleNamespace = null , boolean prepend = false , array attrs = null , string target = self )
public addCssUrl ( string href , string|null media = null , boolean prepend = false , array attrs = null , string target = self )
public addAsyncJs ( Url|string relativeUrl , string moduleNamespace = null , boolean prepend = false )
public addAsyncJsUrl ( string src , bool prepend = false )
public addJs ( Url|string relativeUrl , string moduleNamespace = null , bool defer = false , bool prepend = false , array attrs = null , string target = self )
public addJsUrl ( string src , bool defer = false , bool prepend = false , array attrs = null , string target = self )
public addMeta ( array attrs , string uniqueAttrName = null , bool prepend = false )
public addLink ( array attrs , string uniqueAttrName = null , bool prepend = false )
public static string [] getHeadKeys ( )
public static string [] getTargets ( )
public static string [] getKeys ( )
public addJsCode ( string code , bool defer = false , boolean prepend = false , array attrs = null , string target = self )
public addCssCode ( string code , boolean prepend = false , array attrs = null , string target = self )
public addContents ( string|UiComponent contents , bool prepend = false , string target = self )
public addLibrary ( Library library )
public serverPush ( unknown url , string as )
public getMessages ( unknown groupName = null , unknown severity = null , unknown translate = true )
public getContextUrl ( unknown pathExt , unknown query = null , unknown fragment = null , unknown ssl = null , unknown subsystem = null )
public getControllerUrl ( unknown pathExt , unknown query = null , unknown fragment = null , unknown controllerContext = null , unknown ssl = null , unknown subsystem = null )
public getAssetUrl ( unknown urlExt , string moduleNamespace = null , bool absolute = false )
public getPath ( unknown pathExt = null , unknown query = null , unknown fragment = null , unknown ssl = null , unknown subsystem = null )
public Url getUrl ( string pathExt = null , array query = null , string fragment = null , string ssl = null , string subsystem = null )
public buildLinkLabel ( unknown url , string label = null )
public static string replace ( string textHtml , array replacements = null , HtmlView view = null )

Constants in detail

  • HEAD_TITLE_KEY

    ­ const HEAD_TITLE_KEY ­
  • HEAD_SCRIPT_KEY

    ­ const HEAD_SCRIPT_KEY ­
  • HEAD_META_KEY

    ­ const HEAD_META_KEY ­
  • HEAD_CONTENTS_KEY

    ­ const HEAD_CONTENTS_KEY ­
  • TARGET_HEAD

    ­ const TARGET_HEAD ­
  • TARGET_BODY_START

    ­ const TARGET_BODY_START ­
  • TARGET_BODY_END

    ­ const TARGET_BODY_END ­

Methods in detail

  • __construct

    public __construct ( HtmlView view )
    param
  • getView

    HtmlView public getView ( )
    return
  • getHtmlProperties

    HtmlProperties public getHtmlProperties ( )
  • head

    HeadBuilderMeta public head ( )
  • bodyStart

    HeadBuilderMeta public bodyStart ( )
  • bodyEnd

    HeadBuilderMeta public bodyEnd ( )
  • setTitle

    public setTitle ( string title , bool includePageName = false )
  • getPageName

    string public getPageName ( )
    return
    string
  • addCss

    public addCss ( Url|string relativeUrl , string media = null , string moduleNamespace = null , boolean prepend = false , array attrs = null , string target = self )
    param
    Url|string relativeUrl
    string media
    string moduleNamespace
    boolean prepend
    array attrs
    string target Any of {@self::getTargets()
  • addCssUrl

    public addCssUrl ( string href , string|null media = null , boolean prepend = false , array attrs = null , string target = self )
    param
    string href
    string|null media
    boolean prepend
    array attrs
    string target Any of {@self::getTargets()
  • addAsyncJs

    public addAsyncJs ( Url|string relativeUrl , string moduleNamespace = null , boolean prepend = false )
    param
    Url|string relativeUrl
    string moduleNamespace
    boolean prepend
  • addAsyncJsUrl

    public addAsyncJsUrl ( string src , bool prepend = false )
    param
    string src
    bool prepend
  • addJs

    public addJs ( Url|string relativeUrl , string moduleNamespace = null , bool defer = false , bool prepend = false , array attrs = null , string target = self )
    param
    Url|string relativeUrl
    string moduleNamespace
    bool defer
    bool prepend
    array attrs
    string target Any of {@self::getTargets()
  • addJsUrl

    public addJsUrl ( string src , bool defer = false , bool prepend = false , array attrs = null , string target = self )
    param
    string src
    bool defer
    bool prepend
    array attrs
    string target Any of {@self::getTargets()
  • addMeta

    public addMeta ( array attrs , string uniqueAttrName = null , bool prepend = false )
    param
    array attrs
    string uniqueAttrName
    bool prepend
  • getHeadKeys

    string public static getHeadKeys ( )
    return
    string
  • getTargets

    string public static getTargets ( )
    return
    string
  • getKeys

    string public static getKeys ( )
    return
    string
  • addJsCode

    public addJsCode ( string code , bool defer = false , boolean prepend = false , array attrs = null , string target = self )
    param
    string code
    bool defer
    boolean prepend
    array attrs
    string target Any of {@self::getTargets()
  • addCssCode

    public addCssCode ( string code , boolean prepend = false , array attrs = null , string target = self )
    param
    string code
    boolean prepend
    array attrs
    string target Any of {@self::getTargets()
  • addContents

    public addContents ( string|UiComponent contents , bool prepend = false , string target = self )
    param
    string|UiComponent contents
    bool prepend
    string target
  • addLibrary

    public addLibrary ( Library library )
    param
  • serverPush

    public serverPush ( unknown url , string as )
    Will create a ServerPushDirective pass it automatically to n2n\impl\web\ui\view\html\Response when this view will be send.
    param
    Url|string url;
  • getMessages

    public getMessages ( unknown groupName = null , unknown severity = null , unknown translate = true )
  • getContextUrl

    public getContextUrl ( unknown pathExt , unknown query = null , unknown fragment = null , unknown ssl = null , unknown subsystem = null )
  • getControllerUrl

    public getControllerUrl ( unknown pathExt , unknown query = null , unknown fragment = null , unknown controllerContext = null , unknown ssl = null , unknown subsystem = null )
  • getAssetUrl

    public getAssetUrl ( unknown urlExt , string moduleNamespace = null , bool absolute = false )
  • getPath

    public getPath ( unknown pathExt = null , unknown query = null , unknown fragment = null , unknown ssl = null , unknown subsystem = null )
  • getUrl

    Url public getUrl ( string pathExt = null , array query = null , string fragment = null , string ssl = null , string subsystem = null )
    param
    string pathExt
    array query
    string fragment
    string ssl
    string subsystem
    return
  • buildLinkLabel

    public buildLinkLabel ( unknown url , string label = null )
  • replace

    string public static replace ( string textHtml , array replacements = null , HtmlView view = null )
    param
    string textHtml
    array replacements
    return
    string