Frontend  

class Frontend implements ExtenderInterface

Methods

__construct(string $frontend)

No description

Frontend
css(string $path)

Add a CSS file to load in the frontend.

Frontend
js(string $path)

Add a JavaScript file to load in the frontend.

Frontend
jsDirectory(string $path)

Add a directory of JavaScript files to include in the JS assets public directory.

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

Add a route to the frontend.

Frontend
removeRoute(string $name)

Remove a route from the frontend.

Frontend
content(callable|string|null $callback, int $priority = 0)

Modify the content of the frontend.

Frontend
preloads(callable|array $preloads)

Adds multiple asset preloads.

Frontend
title(string $driverClass)

Register a new title driver to change the title of frontend documents.

Frontend
extraDocumentAttributes(array $attributes)

Adds document root attributes.

Frontend
extraDocumentClasses(string|array| Closure $classes)

Adds document root classes.

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

No description

Details

at line 46
__construct(string $frontend)

Parameters

string $frontend : The name of the frontend.

at line 56
Frontend css(string $path)

Add a CSS file to load in the frontend.

Parameters

string $path : The path to the CSS file.

Return Value

Frontend

at line 68
Frontend js(string $path)

Add a JavaScript file to load in the frontend.

Parameters

string $path : The path to the JavaScript file.

Return Value

Frontend

at line 82
Frontend jsDirectory(string $path)

Add a directory of JavaScript files to include in the JS assets public directory.

Primarily used to copy JS chunks.

Parameters

string $path The path to the specific frontend chunks directory.

Return Value

Frontend

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

Add a route to the frontend.

Parameters

string $path : The path of the route.
string $name : The name of the route, must be unique.
callable|string|null $content The content can be a closure or an invokable class, and should accept: - \Flarum\Frontend\Document $document - \Psr\Http\Message\ServerRequestInterface $request The callable should return void.

Return Value

Frontend

at line 115
Frontend removeRoute(string $name)

Remove a route from the frontend.

This is necessary before overriding a route.

Parameters

string $name : The name of the route.

Return Value

Frontend

at line 134
Frontend content(callable|string|null $callback, int $priority = 0)

Modify the content of the frontend.

Parameters

callable|string|null $callback The content can be a closure or an invokable class, and should accept: - \Flarum\Frontend\Document $document - \Psr\Http\Message\ServerRequestInterface $request The callable should return void.
int $priority : The priority of the content. Higher priorities are executed first.

Return Value

Frontend

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

Adds multiple asset preloads.

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

Parameters

callable|array $preloads

Return Value

Frontend

at line 176
Frontend title(string $driverClass)

Register a new title driver to change the title of frontend documents.

Parameters

string $driverClass

Return Value

Frontend

at line 194
Frontend extraDocumentAttributes(array $attributes)

Adds document root attributes.

Parameters

array $attributes

Return Value

Frontend

at line 211
Frontend extraDocumentClasses(string|array| Closure $classes)

Adds document root classes.

Can be a string, an array, or a Closure that returns either. An array can be of a format acceptable by the @class blade directive.

Parameters

string|array| Closure $classes

Return Value

Frontend

at line 216
void extend( Container $container, Extension|null $extension = null)

Parameters

Container $container
Extension|null $extension

Return Value

void