Document
class Document implements Renderable
A view which renders a HTML skeleton for Flarum's frontend app.
Properties
| $title | <p>The title of the document, displayed in the <title> tag.</p> |
|
||
| $language | <p>The language of the document, displayed as the value of the attribute <code>lang</code> in the <html> tag.</p> |
|
||
| $direction | <p>The text direction of the document, displayed as the value of the attribute <code>dir</code> in the <html> tag.</p> |
|
||
| $appView | <p>The name of the frontend app view to display.</p> |
|
||
| $layoutView | <p>The name of the frontend layout view to display.</p> |
|
||
| $contentView | <p>The name of the frontend content view to display.</p> |
|
||
| $content | <p>The SEO content of the page, displayed within the layout in <noscript> tags.</p> |
|
||
| $payload | <p>Other variables to preload into the Flarum JS.</p> |
|
||
| $meta | <p>An array of meta tags to append to the page's <head>.</p> |
|
||
| $canonicalUrl | <p>The canonical URL for this page.</p> |
|
||
| $page | <p>Which page of content are we on?</p> |
|
||
| $hasNextPage | <p>Is there a next page?</p> |
|
||
| $head | <p>An array of strings to append to the page's <head>.</p> |
|
||
| $foot | <p>An array of strings to prepend before the page's </body>.</p> |
|
||
| $js | <p>An array of JavaScript URLs to load.</p> |
|
||
| $css | <p>An array of CSS URLs to load.</p> |
|
||
| array | $preloads | <p>An array of preloaded assets.</p> |
|
|
| protected | $versioner | <p>We need the versioner to get the revisions of split chunks.</p> |
|
Methods
__construct(Factory $view, array $forumApiDocument, ServerRequestInterface $request, TitleDriverInterface $titleDriver, Config $config, Factory $filesystem)
No description
static string
setQueryParam(string $url, string $key, string|null $value)
<p>Set or override a query param on a string URL to a particular value.</p>
Details
at
line 143
__construct(Factory $view, array $forumApiDocument, ServerRequestInterface $request, TitleDriverInterface $titleDriver, Config $config, Factory $filesystem)
at
line 156
string
render()
at
line 163
protected View
makeView()
at
line 179
protected string
makeTitle()
at
line 184
protected View|null
makeLayout()
at
line 193
protected View
makeContent()
at
line 198
protected array
makePreloads()
at
line 211
protected string
makeHead()
at
line 239
protected string
makeJs()
at
line 246
protected string
makeFoot()
at
line 251
array
getForumApiDocument()
at
line 256
void
setForumApiDocument(array $forumApiDocument)
at
line 261
static string
setPageParam(string $url, int|null $page)
at
line 273
static protected string
setQueryParam(string $url, string $key, string|null $value)
<p>Set or override a query param on a string URL to a particular value.</p>