FileViewFinder

class FileViewFinder implements ViewFinderInterface (View source)

Properties

protected Filesystem $files The filesystem instance.
protected array $paths The array of active view paths.
protected array $views The array of views that have been located.
protected array $hints The namespace to file path hints.
protected array $extensions Register a view extension with the finder.

Methods

void __construct(Filesystem $files, array $paths, array $extensions = null)

Create a new file view loader instance.
string find(string $name)

Get the fully qualified location of the view.
string findNamespacedView(string $name)

Get the path to a template with a named path.
array parseNamespaceSegments(string $name)

Get the segments of a template with a named path.
string findInPaths(string $name, array $paths)

Find the given view in the list of paths.
array getPossibleViewFiles(string $name)

Get an array of possible view files.
void addLocation(string $location)

Add a location to the finder.
void prependLocation(string $location)

Prepend a location to the finder.
string resolvePath(string $path)

Resolve the path.
void addNamespace(string $namespace, string|array $hints)

Add a namespace hint to the finder.
void prependNamespace(string $namespace, string|array $hints)

Prepend a namespace hint to the finder.
void replaceNamespace(string $namespace, string|array $hints)

Replace the namespace hints for the given namespace.
void addExtension(string $extension)

Register an extension with the view finder.
bool hasHintInformation(string $name)

Returns whether or not the view name has any hint information.
void flush()

Flush the cache of located views.
Filesystem getFilesystem()

Get the filesystem instance.
$this setPaths(array $paths)

Set the active view paths.
array getPaths()

Get the active view paths.
array getViews()

Get the views that have been located.
array getHints()

Get the namespace to file path hints.
array getExtensions()

Get registered extensions.

Details

void __construct(Filesystem $files, array $paths, array $extensions = null)

Create a new file view loader instance.

Parameters

Filesystem $files
array $paths
array $extensions

Return Value

void

string find(string $name)

Get the fully qualified location of the view.

Parameters

string $name

Return Value

string

protected string findNamespacedView(string $name)

Get the path to a template with a named path.

Parameters

string $name

Return Value

string

protected array parseNamespaceSegments(string $name)

Get the segments of a template with a named path.

Parameters

string $name

Return Value

array

Exceptions

InvalidArgumentException

protected string findInPaths(string $name, array $paths)

Find the given view in the list of paths.

Parameters

string $name
array $paths

Return Value

string

Exceptions

InvalidArgumentException

protected array getPossibleViewFiles(string $name)

Get an array of possible view files.

Parameters

string $name

Return Value

array

void addLocation(string $location)

Add a location to the finder.

Parameters

string $location

Return Value

void

void prependLocation(string $location)

Prepend a location to the finder.

Parameters

string $location

Return Value

void

protected string resolvePath(string $path)

Resolve the path.

Parameters

string $path

Return Value

string

void addNamespace(string $namespace, string|array $hints)

Add a namespace hint to the finder.

Parameters

string $namespace
string|array $hints

Return Value

void

void prependNamespace(string $namespace, string|array $hints)

Prepend a namespace hint to the finder.

Parameters

string $namespace
string|array $hints

Return Value

void

void replaceNamespace(string $namespace, string|array $hints)

Replace the namespace hints for the given namespace.

Parameters

string $namespace
string|array $hints

Return Value

void

void addExtension(string $extension)

Register an extension with the view finder.

Parameters

string $extension

Return Value

void

bool hasHintInformation(string $name)

Returns whether or not the view name has any hint information.

Parameters

string $name

Return Value

bool

void flush()

Flush the cache of located views.

Return Value

void

Filesystem getFilesystem()

Get the filesystem instance.

Return Value

Filesystem

$this setPaths(array $paths)

Set the active view paths.

Parameters

array $paths

Return Value

$this

array getPaths()

Get the active view paths.

Return Value

array

array getViews()

Get the views that have been located.

Return Value

array

array getHints()

Get the namespace to file path hints.

Return Value

array

array getExtensions()

Get registered extensions.

Return Value

array

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/6.x/Illuminate/View/FileViewFinder.html