3 * @copyright Copyright (C) 2020, Friendica
5 * @license GNU AGPL version 3 or any later version
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.
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.
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/>.
22 namespace Friendica\Core;
26 use Friendica\Render\FriendicaSmarty;
27 use Friendica\Render\ITemplateEngine;
30 * This class handles Renderer related functions.
35 * An array of registered template engines ('name'=>'class name')
37 public static $template_engines = [];
40 * An array of instanced template engines ('name'=>'instance')
42 public static $template_engine_instance = [];
45 * An array for all theme-controllable parameters
47 * Mostly unimplemented yet. Only options 'template_engine' and
50 public static $theme = [
54 'force_max_items' => 0,
56 'template_engine' => 'smarty3',
59 private static $ldelim = [
63 private static $rdelim = [
69 * This is our template processor
71 * @param string|FriendicaSmarty $s The string requiring macro substitution or an instance of FriendicaSmarty
72 * @param array $vars Key value pairs (search => replace)
74 * @return string substituted string
77 public static function replaceMacros($s, array $vars = [])
79 $stamp1 = microtime(true);
81 // pass $baseurl to all templates if it isn't set
82 $vars = array_merge(['$baseurl' => DI::baseUrl()->get()], $vars);
84 $t = self::getTemplateEngine();
87 $output = $t->replaceMacros($s, $vars);
88 } catch (Exception $e) {
89 echo "<pre><b>" . __FUNCTION__ . "</b>: " . $e->getMessage() . "</pre>";
93 DI::profiler()->saveTimestamp($stamp1, "rendering", System::callstack());
99 * Load a given template $s
101 * @param string $s Template to load.
102 * @param string $subDir Subdirectory (Optional)
104 * @return string template.
107 public static function getMarkupTemplate($s, $subDir = '')
109 $stamp1 = microtime(true);
110 $t = self::getTemplateEngine();
113 $template = $t->getTemplateFile($s, $subDir);
114 } catch (Exception $e) {
115 echo "<pre><b>" . __FUNCTION__ . "</b>: " . $e->getMessage() . "</pre>";
119 DI::profiler()->saveTimestamp($stamp1, "file", System::callstack());
125 * Register template engine class
127 * @param string $class
129 public static function registerTemplateEngine($class)
131 $v = get_class_vars($class);
133 if (!empty($v['name']))
136 self::$template_engines[$name] = $class;
138 echo "template engine <tt>$class</tt> cannot be registered without a name.\n";
144 * Return template engine instance.
146 * If $name is not defined, return engine defined by theme,
149 * @return ITemplateEngine Template Engine instance
151 public static function getTemplateEngine()
153 $template_engine = (self::$theme['template_engine'] ?? '') ?: 'smarty3';
155 if (isset(self::$template_engines[$template_engine])) {
156 if (isset(self::$template_engine_instance[$template_engine])) {
157 return self::$template_engine_instance[$template_engine];
159 $class = self::$template_engines[$template_engine];
161 self::$template_engine_instance[$template_engine] = $obj;
166 echo "template engine <tt>$template_engine</tt> is not registered!\n";
171 * Returns the active template engine.
173 * @return string the active template engine
175 public static function getActiveTemplateEngine()
177 return self::$theme['template_engine'];
181 * sets the active template engine
183 * @param string $engine the template engine (default is Smarty3)
185 public static function setActiveTemplateEngine($engine = 'smarty3')
187 self::$theme['template_engine'] = $engine;
191 * Gets the right delimiter for a template engine
197 * @param string $engine The template engine (default is Smarty3)
199 * @return string the right delimiter
201 public static function getTemplateLeftDelimiter($engine = 'smarty3')
203 return self::$ldelim[$engine];
207 * Gets the left delimiter for a template engine
213 * @param string $engine The template engine (default is Smarty3)
215 * @return string the left delimiter
217 public static function getTemplateRightDelimiter($engine = 'smarty3')
219 return self::$rdelim[$engine];