3 * @copyright Copyright (C) 2010-2023, the Friendica project
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\Render;
25 use Friendica\Core\Renderer;
28 * Friendica extension of the Smarty3 template engine
30 class FriendicaSmarty extends Smarty
32 const SMARTY3_TEMPLATE_FOLDER = 'templates';
36 public function __construct(string $theme, array $theme_info, string $work_dir, bool $use_sub_dirs)
38 parent::__construct();
40 // setTemplateDir can be set to an array, which Smarty will parse in order.
41 // The order is thus very important here
42 $template_dirs = ['theme' => "view/theme/$theme/" . self::SMARTY3_TEMPLATE_FOLDER . '/'];
43 if (!empty($theme_info['extends'])) {
44 $template_dirs = $template_dirs + ['extends' => 'view/theme/' . $theme_info['extends'] . '/' . self::SMARTY3_TEMPLATE_FOLDER . '/'];
47 $template_dirs = $template_dirs + ['base' => 'view/' . self::SMARTY3_TEMPLATE_FOLDER . '/'];
48 $this->setTemplateDir($template_dirs);
50 $work_dir = rtrim($work_dir, '/');
52 $this->setCompileDir($work_dir . '/compiled');
53 $this->setConfigDir($work_dir . '/');
54 $this->setCacheDir($work_dir . '/');
56 $this->registerPlugin('modifier', 'is_string', function ($value) {
57 return is_string($value);
61 * Enable sub-directory splitting for reducing directory descriptor
62 * size. The default behavior is to put all compiled/cached files into
63 * one single directory. Under Linux and EXT4 (and maybe other FS) this
64 * will increase the descriptor's size (which contains information
65 * about entries inside the described directory. If the descriptor is
66 * getting to big, the system will slow down as it has to read the
67 * whole directory descriptor all over again (unless you have tons of
68 * RAM available + have enabled caching inode tables (aka.
69 * "descriptors"). Still it won't hurt you.
71 $this->setUseSubDirs($use_sub_dirs);
73 $this->left_delimiter = Renderer::getTemplateLeftDelimiter();
74 $this->right_delimiter = Renderer::getTemplateRightDelimiter();
76 $this->escape_html = true;
78 // Don't report errors so verbosely
79 $this->error_reporting = E_ALL & ~E_NOTICE;
81 $this->muteUndefinedOrNullWarnings();