FileViewFinder
class FileViewFinder implements ViewFinderInterface (View source)
Properties
| protected Filesystem | $files | The filesystem instance. |
|
| protected string[] | $paths | The array of active view paths. |
|
| protected array<string,string> | $views | The array of views that have been located. |
|
| protected array<string,array> | $hints | The namespace to file path hints. |
|
| protected string[] | $extensions | Register a view extension with the finder. |
Methods
Create a new file view loader instance.
Get the fully qualified location of the view.
Get the path to a template with a named path.
Get the segments of a template with a named path.
Find the given view in the list of paths.
Get an array of possible view files.
Add a location to the finder.
Prepend a location to the finder.
Resolve the path.
Add a namespace hint to the finder.
Prepend a namespace hint to the finder.
Replace the namespace hints for the given namespace.
Register an extension with the view finder.
Returns whether or not the view name has any hint information.
Flush the cache of located views.
Get the filesystem instance.
Set the active view paths.
Get the active view paths.
Get the views that have been located.
Get the namespace to file path hints.
Get registered extensions.
Details
__construct(Filesystem $files, array $paths, array|null $extensions = null)
Create a new file view loader instance.
string
find(string $name)
Get the fully qualified location of the view.
protected string
findNamespacedView(string $name)
Get the path to a template with a named path.
protected string[]
parseNamespaceSegments(string $name)
Get the segments of a template with a named path.
protected string
findInPaths(string $name, string|string[] $paths)
Find the given view in the list of paths.
protected string[]
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.
protected 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(string[] $paths)
Set the active view paths.
string[]
getPaths()
Get the active view paths.
array<string,string>
getViews()
Get the views that have been located.
array<string,array>
getHints()
Get the namespace to file path hints.
string[]
getExtensions()
Get registered extensions.