3.4. Template Locator

Qiq will search through any number of directory paths for named templates. You can pass an array of paths to Template::new() ...

$tpl = Template::new(
    paths: [

... or you can tell the TemplateLocator directly:


The TemplateLocator will search for the named template from the first directory path to the last.

searches first for:  /path/to/custom/templates/foo.php,
and then second for: /path/to/default/templates/foo.php
$output = $tpl('foo');

If you like, you can modify the paths after the Template instantiation to append or prepend a directory path to the TemplateLocator:


3.4. Subdirectories

To render a template from any location, use the absolute path to the template name:

// renders the "foo/bar/baz.php" template
$output = $tpl('foo/bar/baz');

Alternatively, while inside a template, you may refer to template names by relative path. Use ./ to indicate a template in the same directory, or ../ to indicate the directory above the current one.

Given a template file structure like the following ...


... while inside the foo/bar/baz.php template file:

// refers to "foo/bar/dib.php"
echo $this->render('./dib');

// refers to "foo/bar.php"
echo $this->render('../bar');

// refers to "foo.php"
echo $this->render('../../foo');

3.4. File Name Extension

By default, the TemplateLocator will auto-append .php to template file names. If the template files end with a different extension, change it using the setExtension() method:

$templateLocator = $tpl->getTempLatelocator();

Or, you can set it at Template creation time:

$tpl = Template::new(
    extension: '.phtml'

3.4. Collections

Sometimes it may be useful to identify collections of templates, say for emails or for admin pages. (Other systems may refer to these as "groups", "folders", or "namespaces".)

To associate a directory path with a collection, prefix the path with the collection name and a colon:

$tpl = new Template(
    paths: [

To render a template from a collection, prefix the template name with the collection name.

$output = $tpl('email:notify/subscribed');

You can set, append, and prepend collection paths, the same as you would with the "main" or "default" collection of unprefixed template paths.