fenom/src/Fenom/ProviderInterface.php

<?php
/*
 * This file is part of Fenom.
 *
 * (c) 2013 Ivan Shalganov
 *
 * For the full copyright and license information, please view the license.md
 * file that was distributed with this source code.
 */
namespace Fenom;

/**
 * Interface of templates provider
 * @package Fenom
 * @author     Ivan Shalganov <a.cobest@gmail.com>
 */
interface ProviderInterface
{
    /**
     * @param string $tpl
     * @return bool
     */
    public function templateExists(string $tpl): bool;

    /**
     * @param string $tpl
     * @param float $time seconds with micro
     * @return string
     */
    public function getSource(string $tpl, float &$time): string;

    /**
     * @param string $tpl
     * @return float seconds with micro
     */
    public function getLastModified(string $tpl): float;

    /**
     * Verify templates (check mtime)
     *
     * @param array $templates [template_name => modified, ...] By conversation, you may trust the template's name
     * @return bool if true - all templates are valid else some templates are invalid
     */
    public function verify(array $templates): bool;

    /**
     * Get all names of template from provider
     * @return iterable
     */
    public function getList(): iterable;
}