Frontend  

class Frontend implements ExtenderInterface

Methods

__construct(string $frontend)

No description

Frontend
css(string $path)

<p>Add a CSS file to load in the frontend.</p>

Frontend
js(string $path)

<p>Add a JavaScript file to load in the frontend.</p>

Frontend
route(string $path, string $name, callable|string|null $content = null)

<p>Add a route to the frontend.</p>

Frontend
removeRoute(string $name)

<p>Remove a route from the frontend.</p>

Frontend
content(callable|string|null $callback)

<p>Modify the content of the frontend.</p>

Frontend
preloads(callable|array $preloads)

<p>Adds multiple asset preloads.</p>

Frontend
title(string $driverClass)

<p>Register a new title driver to change the title of frontend documents.</p>

extend(Container $container, Extension $extension = null)

No description

Details

at line 43
__construct(string $frontend)

Parameters

string $frontend

at line 54
Frontend css(string $path)

<p>Add a CSS file to load in the frontend.</p>

Parameters

string $path

Return Value

Frontend

at line 67
Frontend js(string $path)

<p>Add a JavaScript file to load in the frontend.</p>

Parameters

string $path

Return Value

Frontend

at line 89
Frontend route(string $path, string $name, callable|string|null $content = null)

<p>Add a route to the frontend.</p>

Parameters

string $path
string $name
callable|string|null $content <p>The content can be a closure or an invokable class, and should accept:</p> <ul> <li>\Flarum\Frontend\Document $document</li> <li>\Psr\Http\Message\ServerRequestInterface $request</li> </ul> <p>The callable should return void.</p>

Return Value

Frontend

at line 103
Frontend removeRoute(string $name)

<p>Remove a route from the frontend.</p>

<p>This is necessary before overriding a route.</p>

Parameters

string $name

Return Value

Frontend

at line 123
Frontend content(callable|string|null $callback)

<p>Modify the content of the frontend.</p>

Parameters

callable|string|null $callback <p>The content can be a closure or an invokable class, and should accept:</p> <ul> <li>\Flarum\Frontend\Document $document</li> <li>\Psr\Http\Message\ServerRequestInterface $request</li> </ul> <p>The callable should return void.</p>

Return Value

Frontend

at line 156
Frontend preloads(callable|array $preloads)

<p>Adds multiple asset preloads.</p>

<p>The parameter should be an array of preload arrays, or a callable that returns this.</p> <p>A preload array must contain keys that pertain to the <code>&lt;link rel="preload"&gt;</code> tag.</p> <p>For example, the following will add preload tags for a script and font file:</p> <pre><code>$frontend-&gt;preloads([ [ 'href' =&gt; '/assets/my-script.js', 'as' =&gt; 'script', ], [ 'href' =&gt; '/assets/fonts/my-font.woff2', 'as' =&gt; 'font', 'type' =&gt; 'font/woff2', 'crossorigin' =&gt; '' ] ]);</code></pre>

Parameters

callable|array $preloads

Return Value

Frontend

at line 166
Frontend title(string $driverClass)

<p>Register a new title driver to change the title of frontend documents.</p>

Parameters

string $driverClass

Return Value

Frontend

at line 173
extend(Container $container, Extension $extension = null)

Parameters

Container $container
Extension $extension