class FileViewFinder implements ViewFinderInterface

Properties

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 string[] $extensions

Register a view extension with the finder.

Methods

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

Create a new file view loader instance.

string
find(string $view)

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.

getFilesystem()

Get the filesystem instance.

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

at line 38
__construct(Filesystem $files, array $paths, array|null $extensions = null)

Create a new file view loader instance.

Parameters

Filesystem $files
array $paths
array|null $extensions

at line 53
string find(string $view)

Get the fully-qualified location of the view.

Parameters

string $view

Return Value

string

at line 69
protected string findNamespacedView(string $name)

Get the path to a template with a named path.

Parameters

string $name

Return Value

string

at line 81
protected array parseNamespaceSegments(string $name)

Get the segments of a template with a named path.

Parameters

string $name

Return Value

array

Exceptions

InvalidArgumentException

at line 101
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

at line 119
protected array getPossibleViewFiles(string $name)

Get an array of possible view files.

Parameters

string $name

Return Value

array

at line 130
void addLocation(string $location)

Add a location to the finder.

On the shared factory's finder, request-time use changes view paths while concurrent coroutines may still be resolving views.

Parameters

string $location

Return Value

void

at line 142
void prependLocation(string $location)

Prepend a location to the finder.

On the shared factory's finder, request-time use changes view paths while concurrent coroutines may still be resolving views.

Parameters

string $location

Return Value

void

at line 151
protected string resolvePath(string $path)

Resolve the path.

Parameters

string $path

Return Value

string

at line 162
void addNamespace(string $namespace, string|array $hints)

Add a namespace hint to the finder.

On the shared factory's finder, request-time use changes view hints while concurrent coroutines may still be resolving views.

Parameters

string $namespace
string|array $hints

Return Value

void

at line 180
void prependNamespace(string $namespace, string|array $hints)

Prepend a namespace hint to the finder.

On the shared factory's finder, request-time use changes view hints while concurrent coroutines may still be resolving views.

Parameters

string $namespace
string|array $hints

Return Value

void

at line 198
void replaceNamespace(string $namespace, string|array $hints)

Replace the namespace hints for the given namespace.

On the shared factory's finder, request-time use changes view hints while concurrent coroutines may still be resolving views.

Parameters

string $namespace
string|array $hints

Return Value

void

at line 210
void addExtension(string $extension)

Register an extension with the view finder.

On the shared factory's finder, request-time use changes view extensions while concurrent coroutines may still be resolving views.

Parameters

string $extension

Return Value

void

at line 223
bool hasHintInformation(string $name)

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

Parameters

string $name

Return Value

bool

at line 231
void flush()

Flush the cache of located views.

Return Value

void

at line 239
Filesystem getFilesystem()

Get the filesystem instance.

Return Value

Filesystem

at line 252
FileViewFinder setPaths(array $paths)

Set the active view paths.

On the shared factory's finder, request-time use changes view paths while concurrent coroutines may still be resolving views.

Parameters

array $paths

Return Value

FileViewFinder

at line 263
array getPaths()

Get the active view paths.

Return Value

array

at line 271
array getViews()

Get the views that have been located.

Return Value

array

at line 279
array getHints()

Get the namespace to file path hints.

Return Value

array

at line 287
array getExtensions()

Get registered extensions.

Return Value

array