]> git.mxchange.org Git - friendica.git/blobdiff - src/Render/TemplateEngine.php
Friendica copyright changed from 2023 to 2034
[friendica.git] / src / Render / TemplateEngine.php
index 40fbfea6cac98f65102c97dac6e32714055abdfc..c619c65f4b6f7c5310a78ac45660cc101b7e2764 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * @copyright Copyright (C) 2020, Friendica
+ * @copyright Copyright (C) 2010-2024, the Friendica project
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -40,14 +40,23 @@ abstract class TemplateEngine
         */
        abstract public function __construct(string $theme, array $theme_info);
 
+       /**
+        * Checks the template engine is correctly installed and configured and reports error messages in the provided
+        * parameter or displays them directly if it's null.
+        *
+        * @param array|null $errors
+        * @return void
+        */
+       abstract public function testInstall(array &$errors = null);
+
        /**
         * Returns the rendered template output from the template string and variables
         *
         * @param string $template
         * @param array  $vars
-        * @return string
+        * @return string Template output with replaced macros
         */
-       abstract public function replaceMacros(string $template, array $vars);
+       abstract public function replaceMacros(string $template, array $vars): string;
 
        /**
         * Returns the template string from a file path and an optional sub-directory from the project root