TemplateLocator
TemplateLocator
class TemplateLocator implements FileLocatorInterface
TemplateLocator locates templates in bundles.
Methods
| __construct(FileLocatorInterface $locator, string $cacheDir = null) Constructor. | ||
| string|array | locate(TemplateReferenceInterface $template, string|null $currentPath = null, bool $first = true) Returns a full path for a given file. |
Details
__construct(FileLocatorInterface $locator, string $cacheDir = null)
Constructor.
Parameters
| FileLocatorInterface | $locator | A FileLocatorInterface instance |
| string | $cacheDir | The cache path |
string|array locate(TemplateReferenceInterface $template, string|null $currentPath = null, bool $first = true)
Returns a full path for a given file.
Parameters
| TemplateReferenceInterface | $template | A template |
| string|null | $currentPath | The current path |
| bool | $first | Whether to return the first occurrence or an array of filenames |
Return Value
| string|array | The full path to the file or an array of file paths |
Exceptions
| InvalidArgumentException | When the template is not an instance of TemplateReferenceInterface |
| InvalidArgumentException | When the template file can not be found |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.3/Symfony/Bundle/FrameworkBundle/Templating/Loader/TemplateLocator.html
