Twig::addFunction() - Code Metrics - Inspection of "204 rfc nette latte templates compatibility" - phpMv/ubiquity - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Pull Request — master (#313)

by Jean-Christophe

created 2023-02-03 11:27 UTC

Twig::addFunction() A

↳ Parent: Twig

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	1
dl	0
loc	2
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	3

<?php

namespace Ubiquity\views\engine\twig;

use Twig\Environment;
use Twig\Loader\FilesystemLoader;
use Twig\TwigFilter;
use Twig\TwigFunction;
use Twig\TwigTest;
use Ubiquity\cache\CacheManager;
use Ubiquity\controllers\Startup;
use Ubiquity\events\EventsManager;
use Ubiquity\events\ViewEvents;
use Ubiquity\exceptions\ThemesException;
use Ubiquity\themes\ThemesManager;
use Ubiquity\translation\TranslatorManager;
use Ubiquity\utils\base\UFileSystem;
use Ubiquity\views\engine\TemplateEngine;
use Ubiquity\views\engine\TemplateGenerator;

/**
 * Ubiquity Twig template engine.
 *
 * Ubiquity\views\engine$Twig
 * This class is part of Ubiquity
 *
 * @author jcheron <[email protected]>
 * @version 1.0.13
 *
 */
class Twig extends TemplateEngine {
	private $twig;
	private $loader;

	public function __construct($options = []) {
		$loader = new FilesystemLoader (\ROOT . \DS . 'views' . \DS);
		$loader->addPath(Startup::getFrameworkDir() . '/../core/views/engines/twig', 'framework');
		$this->loader = $loader;

		if (($options ['cache'] ?? false) === true) {
			$options ['cache'] = CacheManager::getCacheSubDirectory('views');
		}

		$this->twig = new Environment ($loader, $options);

		if (isset($options['extensions'])) {
			foreach ($options['extensions'] as $ext) {
				$this->twig->addExtension(new $ext());
			}
		}

		if (isset ($options ['activeTheme'])) {
			ThemesManager::setActiveThemeFromTwig($options ['activeTheme']);
			$this->setTheme($options ['activeTheme'], ThemesManager::THEMES_FOLDER);
			unset ($options ['activeTheme']);
		} else {
			$this->loader->setPaths([\ROOT . \DS . 'views'], 'activeTheme');
		}

		$this->addFunctions();
	}

	protected function addFunctions(): void {
		parent::addFunctions();
		$t = new TwigFunction ('t', function ($context, $id, array $parameters = array(), $domain = null, $locale = null) {
			$trans = TranslatorManager::trans($id, $parameters, $domain, $locale);
			return $this->twig->createTemplate($trans)->render($context);
		}, ['needs_context' => true]);

		$tc = new TwigFunction ('tc', function ($context, $id, array $choice, array $parameters = array(), $domain = null, $locale = null) {
			$trans = TranslatorManager::transChoice($id, $choice, $parameters, $domain, $locale);
			return $this->twig->createTemplate($trans)->render($context);
		}, ['needs_context' => true]);
		$this->twig->addFunction($t);
		$this->twig->addFunction($tc);

		$test = new TwigTest ('instanceOf', function ($var, $class) {
			return $var instanceof $class;
		});
		$this->twig->addTest($test);
		$this->twig->addGlobal('app', $this->fw);
	}

	public function addFunction(string $name, $callback, array $options = []): void {
		$this->twig->addFunction(new TwigFunction ($name, $callback, $options));
	}

	protected function addFilter(string $name, $callback, array $options = []): void {
		$this->twig->addFilter(new TwigFilter($name, $callback, $options));
	}

	protected function addExtension($extension): void {
		$this->twig->addExtension($extension);
	}

	/*
	 * (non-PHPdoc)
	 * @see TemplateEngine::render()
	 */
	public function render(string $viewName, ?array $pData = [], bool $asString = false) {
		$pData ['config'] = Startup::getConfig();
		EventsManager::trigger(ViewEvents::BEFORE_RENDER, $viewName, $pData);
		$render = $this->twig->render($viewName, $pData);
		EventsManager::trigger(ViewEvents::AFTER_RENDER, $render, $viewName, $pData);
		if ($asString) {
			return $render;
		} else {
			echo $render;
		}
	}

	/**
	 *
	 * {@inheritdoc}
	 * @see \Ubiquity\views\engine\TemplateEngine::getBlockNames()
	 */
	public function getBlockNames(string $templateName): array {
		try {
			$result = $this->twig->load($templateName)->getBlockNames();
		} catch (\Error $e) {
			$result = [];
		}
		return $result;
	}

	/**
	 *
	 * {@inheritdoc}
	 * @see \Ubiquity\views\engine\TemplateEngine::getCode()
	 */
	public function getCode(string $templateName): string {
		return UFileSystem::load($this->twig->load($templateName)->getSourceContext()->getPath());

	}

	/**
	 * Adds a new path in a namespace
	 *
	 * @param string $path The path to add
	 * @param string $namespace The namespace to use
	 */
	public function addPath(string $path, string $namespace) {
		$this->loader->addPath($path, $namespace);
	}

	/**
	 * Sets a path in a namespace
	 *
	 * @param array $paths The paths to add
	 * @param string $namespace The namespace to use
	 */
	public function setPaths(array $paths, string $namespace) {
		$this->loader->setPaths($paths, $namespace);
	}

	/**
	 * @param string $theme
	 * @param string $themeFolder
	 * @return string|void
	 * @throws ThemesException
	 */
	public function setTheme(string $theme, string $themeFolder = ThemesManager::THEMES_FOLDER): string {
		$path = parent::setTheme($theme, $themeFolder);
		$this->loader->setPaths([$path], 'activeTheme');
		return $path;
	}

	/**
	 * Checks if we have the source code of a template, given its name.
	 *
	 * @param string $name
	 * @return boolean
	 */
	public function exists(string $name): bool {
		return $this->twig->getLoader()->exists($name);
	}

	public function getGenerator(): ?TemplateGenerator {
		return null;
	}

}


1			<?php
2
3			namespace Ubiquity\views\engine\twig;
4
5			use Twig\Environment;
6			use Twig\Loader\FilesystemLoader;
7			use Twig\TwigFilter;
8			use Twig\TwigFunction;
9			use Twig\TwigTest;
10			use Ubiquity\cache\CacheManager;
11			use Ubiquity\controllers\Startup;
12			use Ubiquity\events\EventsManager;
13			use Ubiquity\events\ViewEvents;
14			use Ubiquity\exceptions\ThemesException;
15			use Ubiquity\themes\ThemesManager;
16			use Ubiquity\translation\TranslatorManager;
17			use Ubiquity\utils\base\UFileSystem;
18			use Ubiquity\views\engine\TemplateEngine;
19			use Ubiquity\views\engine\TemplateGenerator;
20
21			/**
22			* Ubiquity Twig template engine.
23			*
24			* Ubiquity\views\engine$Twig
25			* This class is part of Ubiquity
26			*
27			* @author jcheron <[email protected]>
28			* @version 1.0.13
29			*
30			*/
31			class Twig extends TemplateEngine {
32			private $twig;
33			private $loader;
34
35			public function __construct($options = []) {
36			$loader = new FilesystemLoader (\ROOT . \DS . 'views' . \DS);
37			$loader->addPath(Startup::getFrameworkDir() . '/../core/views/engines/twig', 'framework');
38			$this->loader = $loader;
39
40			if (($options ['cache'] ?? false) === true) {
41			$options ['cache'] = CacheManager::getCacheSubDirectory('views');
42			}
43
44			$this->twig = new Environment ($loader, $options);
45
46			if (isset($options['extensions'])) {
47			foreach ($options['extensions'] as $ext) {
48			$this->twig->addExtension(new $ext());
49			}
50			}
51
52			if (isset ($options ['activeTheme'])) {
53			ThemesManager::setActiveThemeFromTwig($options ['activeTheme']);
54			$this->setTheme($options ['activeTheme'], ThemesManager::THEMES_FOLDER);
55			unset ($options ['activeTheme']);
56			} else {
57			$this->loader->setPaths([\ROOT . \DS . 'views'], 'activeTheme');
58			}
59
60			$this->addFunctions();
61			}
62
63			protected function addFunctions(): void {
64			parent::addFunctions();
65			$t = new TwigFunction ('t', function ($context, $id, array $parameters = array(), $domain = null, $locale = null) {
66			$trans = TranslatorManager::trans($id, $parameters, $domain, $locale);
67			return $this->twig->createTemplate($trans)->render($context);
68			}, ['needs_context' => true]);
69
70			$tc = new TwigFunction ('tc', function ($context, $id, array $choice, array $parameters = array(), $domain = null, $locale = null) {
71			$trans = TranslatorManager::transChoice($id, $choice, $parameters, $domain, $locale);
72			return $this->twig->createTemplate($trans)->render($context);
73			}, ['needs_context' => true]);
74			$this->twig->addFunction($t);
75			$this->twig->addFunction($tc);
76
77			$test = new TwigTest ('instanceOf', function ($var, $class) {
78			return $var instanceof $class;
79			});
80			$this->twig->addTest($test);
81			$this->twig->addGlobal('app', $this->fw);
82			}
83
84			public function addFunction(string $name, $callback, array $options = []): void {
85			$this->twig->addFunction(new TwigFunction ($name, $callback, $options));
86			}
87
88			protected function addFilter(string $name, $callback, array $options = []): void {
89			$this->twig->addFilter(new TwigFilter($name, $callback, $options));
90			}
91
92			protected function addExtension($extension): void {
93			$this->twig->addExtension($extension);
94			}
95
96			/*
97			* (non-PHPdoc)
98			* @see TemplateEngine::render()
99			*/
100			public function render(string $viewName, ?array $pData = [], bool $asString = false) {
101			$pData ['config'] = Startup::getConfig();
102			EventsManager::trigger(ViewEvents::BEFORE_RENDER, $viewName, $pData);
103			$render = $this->twig->render($viewName, $pData);
104			EventsManager::trigger(ViewEvents::AFTER_RENDER, $render, $viewName, $pData);
105			if ($asString) {
106			return $render;
107			} else {
108			echo $render;
109			}
110			}
111
112			/**
113			*
114			* {@inheritdoc}
115			* @see \Ubiquity\views\engine\TemplateEngine::getBlockNames()
116			*/
117			public function getBlockNames(string $templateName): array {
118			try {
119			$result = $this->twig->load($templateName)->getBlockNames();
120			} catch (\Error $e) {
121			$result = [];
122			}
123			return $result;
124			}
125
126			/**
127			*
128			* {@inheritdoc}
129			* @see \Ubiquity\views\engine\TemplateEngine::getCode()
130			*/
131			public function getCode(string $templateName): string {
132			return UFileSystem::load($this->twig->load($templateName)->getSourceContext()->getPath());
			0 ignored issues – show Bug Best Practice introduced 2023-02-03 11:56 UTC by Report Bug Copy Issue Report The expression `return Ubiquity\utils\ba...ceContext()->getPath())` could return the type `false` which is incompatible with the type-hinted return `string`. Consider adding an additional type-check to rule them out. Loading history...
133			}
134
135			/**
136			* Adds a new path in a namespace
137			*
138			* @param string $path The path to add
139			* @param string $namespace The namespace to use
140			*/
141			public function addPath(string $path, string $namespace) {
142			$this->loader->addPath($path, $namespace);
143			}
144
145			/**
146			* Sets a path in a namespace
147			*
148			* @param array $paths The paths to add
149			* @param string $namespace The namespace to use
150			*/
151			public function setPaths(array $paths, string $namespace) {
152			$this->loader->setPaths($paths, $namespace);
153			}
154
155			/**
156			* @param string $theme
157			* @param string $themeFolder
158			* @return string\|void
159			* @throws ThemesException
160			*/
161			public function setTheme(string $theme, string $themeFolder = ThemesManager::THEMES_FOLDER): string {
162			$path = parent::setTheme($theme, $themeFolder);
163			$this->loader->setPaths([$path], 'activeTheme');
164			return $path;
165			}
166
167			/**
168			* Checks if we have the source code of a template, given its name.
169			*
170			* @param string $name
171			* @return boolean
172			*/
173			public function exists(string $name): bool {
174			return $this->twig->getLoader()->exists($name);
175			}
176
177			public function getGenerator(): ?TemplateGenerator {
178			return null;
179			}
180
181			}
182

phpMv / ubiquity

Pull Request — master (#313)

Twig::addFunction() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like