src/Render/TemplateEngine.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2023, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Render;
  23
  24 /**
  25  * Interface for template engines
  26  */
  27 abstract class TemplateEngine
  28 {
  29         /** @var string */
  30         static $name;
  31
  32         /** @var string */
  33         protected $theme;
  34         /** @var array */
  35         protected $theme_info;
  36
  37         /**
  38          * @param string $theme      The current theme name
  39          * @param array  $theme_info The current theme info array
  40          */
  41         abstract public function __construct(string $theme, array $theme_info);
  42
  43         /**
  44          * Checks the template engine is correctly installed and configured and reports error messages in the provided
  45          * parameter or displays them directly if it's null.
  46          *
  47          * @param array|null $errors
  48          * @return void
  49          */
  50         abstract public function testInstall(array &$errors = null);
  51
  52         /**
  53          * Returns the rendered template output from the template string and variables
  54          *
  55          * @param string $template
  56          * @param array  $vars
  57          * @return string Template output with replaced macros
  58          */
  59         abstract public function replaceMacros(string $template, array $vars): string;
  60
  61         /**
  62          * Returns the template string from a file path and an optional sub-directory from the project root
  63          *
  64          * @param string $file
  65          * @param string $subDir
  66          * @return mixed
  67          */
  68         abstract public function getTemplateFile(string $file, string $subDir = '');
  69 }