X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FCore%2FRenderer.php;h=0a86cc6f86ffe890c4173e0b33dba508e66a8837;hb=87bb4d44a2eccec4180b9cd0a70f9011b3b759bc;hp=8844f26881c35183e84874ccfd5431881415a00e;hpb=fb371e10486f535ffcb52569a55e185b5a78c015;p=friendica.git diff --git a/src/Core/Renderer.php b/src/Core/Renderer.php index 8844f26881..0a86cc6f86 100644 --- a/src/Core/Renderer.php +++ b/src/Core/Renderer.php @@ -1,163 +1,193 @@ . + * */ namespace Friendica\Core; use Exception; -use Friendica\BaseObject; -use Friendica\Render\FriendicaSmarty; -use Friendica\Render\ITemplateEngine; +use Friendica\DI; +use Friendica\Network\HTTPException\ServiceUnavailableException; +use Friendica\Render\TemplateEngine; /** - * @brief This class handles Renderer related functions. + * This class handles Renderer related functions. */ -class Renderer extends BaseObject +class Renderer { - /** - * @brief An array of registered template engines ('name'=>'class name') + /** + * An array of registered template engines ('name'=>'class name') */ - public static $template_engines = []; + public static $template_engines = []; - /** - * @brief An array of instanced template engines ('name'=>'instance') + /** + * An array of instanced template engines ('name'=>'instance') */ public static $template_engine_instance = []; - /** - * @brief An array for all theme-controllable parameters + /** + * An array for all theme-controllable parameters * * Mostly unimplemented yet. Only options 'template_engine' and * beyond are used. */ public static $theme = [ - 'sourcename' => '', - 'videowidth' => 425, - 'videoheight' => 350, - 'force_max_items' => 0, - 'stylesheet' => '', + 'videowidth' => 425, + 'videoheight' => 350, + 'stylesheet' => '', 'template_engine' => 'smarty3', ]; - - private static $ldelim = [ + + private static $ldelim = [ 'internal' => '', - 'smarty3' => '{{' + 'smarty3' => '{{' ]; private static $rdelim = [ 'internal' => '', - 'smarty3' => '}}' - ]; + 'smarty3' => '}}' + ]; /** - * @brief This is our template processor - * - * @param string|FriendicaSmarty $s The string requiring macro substitution or an instance of FriendicaSmarty - * @param array $vars key value pairs (search => replace) + * Returns the rendered template output from the template string and variables * - * @return string substituted string - * @throws \Friendica\Network\HTTPException\InternalServerErrorException + * @param string $template + * @param array $vars + * @return string + * @throws ServiceUnavailableException */ - public static function replaceMacros($s, $vars) - { - $stamp1 = microtime(true); - $a = self::getApp(); + public static function replaceMacros(string $template, array $vars = []): string + { + DI::profiler()->startRecording('rendering'); - // pass $baseurl to all templates - $vars['$baseurl'] = System::baseUrl(); - $t = self::getTemplateEngine(); + // pass $baseurl to all templates if it isn't set + $vars = array_merge(['$baseurl' => DI::baseUrl()->get(), '$APP' => DI::app()], $vars); - try { - $output = $t->replaceMacros($s, $vars); - } catch (Exception $e) { - echo "
" . __FUNCTION__ . ": " . $e->getMessage() . ""; - exit(); - } + $t = self::getTemplateEngine(); - $a->getProfiler()->saveTimestamp($stamp1, "rendering", System::callstack()); + try { + $output = $t->replaceMacros($template, $vars); + } catch (Exception $e) { + DI::logger()->critical($e->getMessage(), ['template' => $template, 'vars' => $vars]); + $message = DI::app()->isSiteAdmin() ? + $e->getMessage() : + DI::l10n()->t('Friendica can\'t display this page at the moment, please contact the administrator.'); + throw new ServiceUnavailableException($message); + } - return $output; - } + DI::profiler()->stopRecording(); + + return $output; + } /** - * @brief Load a given template $s + * Load a given template $s * - * @param string $s Template to load. - * @param string $root Optional. + * @param string $file Template to load. + * @param string $subDir Subdirectory (Optional) * - * @return string template. - * @throws Exception + * @return string Template + * @throws ServiceUnavailableException */ - public static function getMarkupTemplate($s, $root = '') - { - $stamp1 = microtime(true); - $a = self::getApp(); - $t = self::getTemplateEngine(); - - try { - $template = $t->getTemplateFile($s, $root); - } catch (Exception $e) { - echo "
" . __FUNCTION__ . ": " . $e->getMessage() . ""; - exit(); - } + public static function getMarkupTemplate(string $file, string $subDir = ''): string + { + DI::profiler()->startRecording('file'); + $t = self::getTemplateEngine(); + + try { + $template = $t->getTemplateFile($file, $subDir); + } catch (Exception $e) { + DI::logger()->critical($e->getMessage(), ['file' => $file, 'subDir' => $subDir]); + $message = DI::app()->isSiteAdmin() ? + $e->getMessage() : + DI::l10n()->t('Friendica can\'t display this page at the moment, please contact the administrator.'); + throw new ServiceUnavailableException($message); + } - $a->getProfiler()->saveTimestamp($stamp1, "file", System::callstack()); + DI::profiler()->stopRecording(); - return $template; - } + return $template; + } - /** - * @brief Register template engine class + /** + * Register template engine class * * @param string $class + * + * @return void + * @throws ServiceUnavailableException */ - public static function registerTemplateEngine($class) + public static function registerTemplateEngine(string $class) { - $v = get_class_vars($class); - - if (!empty($v['name'])) - { + $v = get_class_vars($class); + + if (!empty($v['name'])) { $name = $v['name']; self::$template_engines[$name] = $class; } else { - echo "template engine $class cannot be registered without a name.\n"; - die(); + $admin_message = DI::l10n()->t('template engine cannot be registered without a name.'); + DI::logger()->critical($admin_message, ['class' => $class]); + $message = DI::app()->isSiteAdmin() ? + $admin_message : + DI::l10n()->t('Friendica can\'t display this page at the moment, please contact the administrator.'); + throw new ServiceUnavailableException($message); } } /** - * @brief Return template engine instance. + * Return template engine instance. * * If $name is not defined, return engine defined by theme, * or default * - * @return ITemplateEngine Template Engine instance + * @return TemplateEngine Template Engine instance + * @throws ServiceUnavailableException */ - public static function getTemplateEngine() + public static function getTemplateEngine(): TemplateEngine { - $template_engine = defaults(self::$theme, 'template_engine', 'smarty3'); + $template_engine = (self::$theme['template_engine'] ?? '') ?: 'smarty3'; if (isset(self::$template_engines[$template_engine])) { if (isset(self::$template_engine_instance[$template_engine])) { return self::$template_engine_instance[$template_engine]; } else { + $a = DI::app(); $class = self::$template_engines[$template_engine]; - $obj = new $class; + $obj = new $class($a->getCurrentTheme(), $a->getThemeInfo()); self::$template_engine_instance[$template_engine] = $obj; return $obj; } } - echo "template engine $template_engine is not registered!\n"; - exit(); - } - - /** - * @brief Returns the active template engine. + $admin_message = DI::l10n()->t('template engine is not registered!'); + DI::logger()->critical($admin_message, ['template_engine' => $template_engine]); + $message = DI::app()->isSiteAdmin() ? + $admin_message : + DI::l10n()->t('Friendica can\'t display this page at the moment, please contact the administrator.'); + throw new ServiceUnavailableException($message); + } + + /** + * Returns the active template engine. * * @return string the active template engine */ - public static function getActiveTemplateEngine() + public static function getActiveTemplateEngine(): string { return self::$theme['template_engine']; } @@ -166,13 +196,15 @@ class Renderer extends BaseObject * sets the active template engine * * @param string $engine the template engine (default is Smarty3) + * + * @return void */ - public static function setActiveTemplateEngine($engine = 'smarty3') + public static function setActiveTemplateEngine(string $engine = 'smarty3') { self::$theme['template_engine'] = $engine; } - /** + /** * Gets the right delimiter for a template engine * * Currently: @@ -183,7 +215,7 @@ class Renderer extends BaseObject * * @return string the right delimiter */ - public static function getTemplateLeftDelimiter($engine = 'smarty3') + public static function getTemplateLeftDelimiter(string $engine = 'smarty3'): string { return self::$ldelim[$engine]; } @@ -199,7 +231,7 @@ class Renderer extends BaseObject * * @return string the left delimiter */ - public static function getTemplateRightDelimiter($engine = 'smarty3') + public static function getTemplateRightDelimiter(string $engine = 'smarty3'): string { return self::$rdelim[$engine]; }