Allow extending FileLoader implementation

[daun]

Would it be possible to set the $baseDir property of the FileLoader class to protected instead of private? (see FileLoader.php@L23)

I'm trying to implement a custom file loader that allows prepending an alias to the root directory when including (e.g. {include '~partials/image.latte'} would render /path/to/views/dir/partials/image.latte).

The only change needed is in the getReferredName method, so I'd like to extend the base class and avoid re-implementing the whole thing. However, from my child class, I can't access the base dir property since it's private. See code below.

Let me know if there's a simpler method to accomplish this or any good reason to keep it as private.

Ideally, this would be part of the framework, but I'm okay with creating a custom loader for that and understand it might not make sense for every app.

Thanks.

BTW. If relevant, I'm not using Nette framework, this is on top of a third-party CMS.

This is what the custom loader would look like:

<?php namespace App;

use Latte\Loaders\FileLoader;

/**
 * Custom template file loader.
 *
 * Modified to allow including files from basedir directly by prepending ~ or /
 * Example:
 *   /partials/image.latte >> /path/to/view/dir/partials/image.latte
 *   ~partials/image.latte >> /path/to/view/dir/partials/image.latte
 */
class CustomFileLoader extends FileLoader
{
	/**
	 * Aliases that refer to the base dir when prepended to a filename
	 *
	 * @var array
	 */
	static protected $baseDirAliases = [
		'/',
		'~',
	];

	/**
	 * Returns referred template name.
	 *
	 * Check for prepended alias to baseDir and return path from there if found
	 * Otherwise, refer to default implementation
	 *
	 */
	public function getReferredName($file, $referringFile): string
	{
		if (
			$this->baseDir &&
			in_array(substr($file, 0, 1), static::$baseDirAliases)
		) {
			return $this->normalizePath(substr($file, 1));
		}
		return parent::getReferredName($file, $referringFile);
	}
}

[daun]

This would apply to FileLoader::normalizePath() as well.

[dg]

I changed it from private to protected.

[erickilisboars]

I also don't use the Natte Framework, but I use Latte. I ended up here by chance because I was looking for the same thing. Well, if it's helpful to someone, here it is:

class CustomFileLoader extends FileLoader
{
    private $paths = [];

    function getContent(string $fileName): string
    {
        if ($fileName[0] === '~') {
            $file = explode('\\', $fileName, 2);
            $alias = substr($file[0], 1);
            if (!isset($this->paths[$alias])) {
                throw new \Latte\RuntimeException("Path alias '$alias' is not defined.");
            }
            $file = $this->normalizePath($this->paths[$alias] . '/' . $file[1]);
        } else {
            $file = $this->baseDir . $fileName;
        }

        if (!is_file($file)) {
            throw new Latte\RuntimeException("Missing template file '$file'.");
        } elseif ($this->isExpired($fileName, time())) {
            if (@touch($file) === false) {
                trigger_error("File's modification time is in the future. Cannot update it: " . error_get_last()['message'], E_USER_WARNING);
            }
        }

        return file_get_contents($file);
    }

    public function getReferredName($file, $referringFile): string
    {
        if ($file[0] === '/' || $file[0] === '~') {
            return $this->normalizePath($file);
        }

        return parent::getReferredName($file, $referringFile);
    }

    public function addPath($alias, $path): void
    {
        $this->paths[$alias] = $this->normalizePath($path);
    }

    public function getPaths(): array
    {
        return $this->paths;
    }
}

And then you can use it like this:

{* For example, to access the assets folder *}
{include '~assets/images/1.png'}

{* Or, to access a file in the current folder (without a slash at the beginning) *}
{include 'layout.latte'}

{* Or, to access a file in the baseDir (with a slash at the beginning) *}
{include '/layout.latte'}

I'm not a skilled PHP developer, and I'm not very familiar with Latte, so I'm not sure if this could cause any issues. I haven't tested it extensively, but it works.