View::layout() - Code Metrics - Inspection of "cs-fix" - blitz-php/framework - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — main ( e1affe...2e6d72 )

by Dimitri

created 2023-12-05 16:58 UTC

View::layout() A

↳ Parent: View

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	5
ccs	0
cts	2
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?php

/**
 * This file is part of Blitz PHP framework.
 *
 * (c) 2022 Dimitri Sitchet Tomkeu <[email protected]>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace BlitzPHP\View;

use BlitzPHP\Container\Services;
use BlitzPHP\Exceptions\ConfigException;
use BlitzPHP\Exceptions\ViewException;
use BlitzPHP\Validation\ErrorBag;
use BlitzPHP\View\Adapters\BladeAdapter;
use BlitzPHP\View\Adapters\LatteAdapter;
use BlitzPHP\View\Adapters\NativeAdapter;
use BlitzPHP\View\Adapters\PlatesAdapter;
use BlitzPHP\View\Adapters\SmartyAdapter;
use BlitzPHP\View\Adapters\TwigAdapter;
use Closure;
use Stringable;

class View implements Stringable
{
    /**
     * Views configuration
     */
    protected array $config = [];

    /**
     * @var RendererInterface
     */
    private $adapter;

    /**
     * Liste des adapters pris en comptes
     */
    public static array $validAdapters = [
        'native' => NativeAdapter::class,
        'blade'  => BladeAdapter::class,
        'latte'  => LatteAdapter::class,
        'plates' => PlatesAdapter::class,
        'smarty' => SmartyAdapter::class,
        'twig'   => TwigAdapter::class,
    ];

    /**
     * Options de la vue
     */
    private array $options = [];

    /**
     * La vue à rendre
     *
     * @var string
     */
    private $view;

    /**
     * Données partagées à toutes les vues
     */
    private static array $shared = [];

    /**
     * Constructeur
     */
    public function __construct()
    {
        $this->config = config('view');
        static::share($this->config['shared']);
        $this->setAdapter($this->config['active_adapter'] ?? 'native');
    }

    /**
     * {@inheritDoc}
     */
    public function __toString(): string
    {
        return $this->get();
    }

    /**
     * Defini les données partagées entre plusieurs vues
     */
    public static function share(array|Closure|string $key, mixed $value = null): void
    {
        if ($key instanceof Closure) {

            $key = Services::container()->call($key);
        }
        if ($value instanceof Closure) {
            $value = Services::container()->call($value);
        }
        if (is_string($key)) {

            $key = [$key => $value];
        }

        self::$shared = array_merge(self::$shared, $key);
    }

    /**
     * Recupere et retourne le code html de la vue créée
     */
    public function get(bool|string $compress = 'auto', ?bool $saveData = null): string
    {
        $output = $this->adapter->render($this->view, $this->options, $saveData);

        return $this->compressView($output, $compress);
    }

    /**
     * Affiche la vue generee au navigateur
     */
    public function render(?bool $saveData = null): void
    {
        $compress = $this->config['compress_output'] ?? 'auto';

        echo $this->get($compress, $saveData);
    }

    /**
     * Construit la sortie en fonction d'une chaîne et de tout données déjà définies.
     */
    public function renderString(string $view, ?array $options = null, bool $saveData = false): string
    {
        return $this->adapter->renderString($view, $options, $saveData);
    }

    /**
     * Verifie qu'un fichier de vue existe
     */
    public function exists(string $view, ?string $ext = null, array $options = []): bool
    {
        return $this->adapter->exists($view, $ext, $options);
    }

    /**
     * Utilise le premier fichier de vue trouvé pour le rendu
     *
     * @param string[] $views
     */
    public function first(array $views, array $data = [], array $options = []): static
    {
        foreach ($views as $view) {
            if ($this->exists($view, null, $options)) {
                return $this->make($view, $data, $options);
            }
        }

        throw ViewException::invalidFile(implode(' OR ', $views));
    }

    /**
     * Crée une instance de vue prêt à être utilisé
     */
    public function make(string $view, array $data = [], array $options = []): static
    {
        return $this->addData($data)->options($options)->display($view);
    }

    /**
     * Modifier les options d'affichage
     *
     * {@deprecated since 1.0 use options() instead}
     */
    public function setOptions(?array $options = []): static
    {
        return $this->options($options ?: []);
    }

    /**
     * Modifier les options d'affichage
     *
     * {@internal}
     */
    public function options(array $options = []): static
    {
        if (isset($options['layout'])) {
            $this->layout($options['layout']);
            unset($options['layout']);
        }

        $this->options = $options;

        return $this;
    }

    /**
     * Définir la vue à afficher
     *
     * {@internal}
     */
    public function display(string $view, ?array $options = null): static
    {
        $this->view = $view;

        if ($options !== null) {
            $this->options($options);
        }

        return $this;
    }

    /**
     * Définit plusieurs éléments de données de vue à la fois.
     *
     * {@internal}
     */
    public function addData(array $data = [], ?string $context = null): static
    {
        unset($data['errors']);

        $data = array_merge(self::$shared, $data);

        if (! on_test() && ! isset($data['errors'])) {
            $data['errors'] = $this->setValidationErrors();
        }

        $this->adapter->addData($data, $context);

        return $this;
    }

    /**
     * Définit plusieurs éléments de données de vue à la fois.
     */
    public function with(array|string $key, mixed $value = null, ?string $context = null): static
    {
        if (is_array($key)) {

            $context = $value;
        } else {
            $key = [$key => $value];
        }

        return $this->addData($key, $context);
    }

    /**
     * Ajoute des erreurs à la session en tant que Flashdata.
     */
    public function withErrors(array|ErrorBag|string $errors): static
    {
        if (is_string($errors)) {

            $errors = ['default' => $errors];
        }
        if (! ($errors instanceof ErrorBag)) {

            $errors = new ErrorBag($errors);
        }

        if (isset(self::$shared['errors']) && self::$shared['errors'] instanceof ErrorBag) {
            $messages = array_merge(
                self::$shared['errors']->toArray(),
                $errors->toArray()
            );
            $errors = new ErrorBag($messages);
        }

        $this->share('errors', $errors);

        return $this;
    }

    /**
     * Définit une seule donnée de vue.
     *
     * @param mixed|null $value
     */
    public function setVar(string $name, $value = null, ?string $context = null): static
    {
        $this->adapter->setVar($name, $value, $context);

        return $this;
    }

    /**
     * Remplacer toutes les données de vue par de nouvelles données
     */
    public function setData(array $data, ?string $context = null): static
    {
        unset($data['errors']);

        $data = array_merge(self::$shared, $data);

        if (! on_test() && ! isset($data['errors'])) {
            $data['errors'] = $this->setValidationErrors();
        }

        $this->adapter->setData($data, $context);

        return $this;
    }

    /**
     * Renvoie les données actuelles qui seront affichées dans la vue.
     */
    public function getData(): array
    {
        $data = $this->adapter->getData();

        if (on_test() && isset($data['errors'])) {
            unset($data['errors']);
        }

        return $data;
    }

    /**
     * Supprime toutes les données de vue du système.
     */
    public function resetData(): static
    {
        $this->adapter->resetData();

        return $this;
    }

    /**
     * Definit le layout a utiliser par les vues
     */
    public function layout(string $layout): static
    {
        $this->adapter->setLayout($layout);

        return $this;
    }

    /**
     * @deprecated 1.0 Please use layout method instead
     */
    public function setLayout(string $layout): static
    {
        return $this->layout($layout);
    }

    /**
     * Defini l'adapteur à utiliser
     *
     * {@internal}
     */
    public function setAdapter(string $adapter, array $config = []): static
    {
        if (! array_key_exists($adapter, self::$validAdapters)) {
            $adapter = 'native';
        }
        if (empty($this->config['adapters']) || ! is_array($this->config['adapters'])) {
            $this->config['adapters'] = [];
        }

        $config = array_merge($this->config['adapters'][$adapter] ?? [], $config);
        if (empty($config)) {
            throw ConfigException::viewAdapterConfigNotFound($adapter);
        }

        $debug = $this->config['debug'] ?? 'auto';
        if ($debug === 'auto') {
            $debug = on_dev();
        }

        $this->adapter = new self::$validAdapters[$adapter](
            $config,
            $config['view_path_locator'] ?? Services::locator(),
            $debug
        );

        return $this;
    }

    /**
     * Renvoie les données de performances qui ont pu être collectées lors de l'exécution.
     * Utilisé principalement dans la barre d'outils de débogage.
     *
     * {@internal}
     */
    public function getPerformanceData(): array
    {
        return $this->adapter->getPerformanceData();
    }

    /**
     * Compresse le code html d'une vue
     */
    protected function compressView(string $output, bool|callable|string $compress = 'auto'): string
    {
        $compress = $compress === 'auto' ? ($this->options['compress_output'] ?? 'auto') : $compress;
        $compress = $compress === 'auto' ? ($this->config['compress_output'] ?? 'auto') : $compress;

        if (is_callable($compress)) {
            $compress = Services::container()->call($compress);
        }

        if ($compress === 'auto') {
            $compress = is_online();
        }

        return true === $compress ? trim(preg_replace('/\s+/', ' ', $output)) : $output;
    }

    /**
     * Defini les erreurs de validation pour la vue
     */
    private function setValidationErrors(): ErrorBag
    {
        $errors = [];

        /** @var \BlitzPHP\Session\Store $session */
        $session = session();

        if (null !== $e = $session->getFlashdata('errors')) {
            if (is_array($e)) {

                $errors = array_merge($errors, $e);
            } else {
                $errors['error'] = $e;
            }

            $session->unmarkFlashdata('errors');
        }

        if (null !== $e = $session->getFlashdata('error')) {
            if (is_array($e)) {

                $errors = array_merge($errors, $e);
            } else {
                $errors['error'] = $e;
            }

            $session->unmarkFlashdata('error');
        }

        return new ErrorBag($errors);
    }
}


1		<?php
2
3		/**
4		* This file is part of Blitz PHP framework.
5		*
6		* (c) 2022 Dimitri Sitchet Tomkeu <[email protected]>
7		*
8		* For the full copyright and license information, please view
9		* the LICENSE file that was distributed with this source code.
10		*/
11
12		namespace BlitzPHP\View;
13
14		use BlitzPHP\Container\Services;
15		use BlitzPHP\Exceptions\ConfigException;
16		use BlitzPHP\Exceptions\ViewException;
17		use BlitzPHP\Validation\ErrorBag;
18		use BlitzPHP\View\Adapters\BladeAdapter;
19		use BlitzPHP\View\Adapters\LatteAdapter;
20		use BlitzPHP\View\Adapters\NativeAdapter;
21		use BlitzPHP\View\Adapters\PlatesAdapter;
22		use BlitzPHP\View\Adapters\SmartyAdapter;
23		use BlitzPHP\View\Adapters\TwigAdapter;
24		use Closure;
25		use Stringable;
26
27		class View implements Stringable
28		{
29		/**
30		* Views configuration
31		*/
32		protected array $config = [];
33
34		/**
35		* @var RendererInterface
36		*/
37		private $adapter;
38
39		/**
40		* Liste des adapters pris en comptes
41		*/
42		public static array $validAdapters = [
43		'native' => NativeAdapter::class,
44		'blade' => BladeAdapter::class,
45		'latte' => LatteAdapter::class,
46		'plates' => PlatesAdapter::class,
47		'smarty' => SmartyAdapter::class,
48		'twig' => TwigAdapter::class,
49		];
50
51		/**
52		* Options de la vue
53		*/
54		private array $options = [];
55
56		/**
57		* La vue à rendre
58		*
59		* @var string
60		*/
61		private $view;
62
63		/**
64		* Données partagées à toutes les vues
65		*/
66		private static array $shared = [];
67
68		/**
69		* Constructeur
70		*/
71		public function __construct()
72		{
73	4	$this->config = config('view');
74	4	static::share($this->config['shared']);
75	4	$this->setAdapter($this->config['active_adapter'] ?? 'native');
76		}
77
78		/**
79		* {@inheritDoc}
80		*/
81		public function __toString(): string
82		{
83		return $this->get();
84		}
85
86		/**
87		* Defini les données partagées entre plusieurs vues
88		*/
89		public static function share(array\|Closure\|string $key, mixed $value = null): void
90		{
91		if ($key instanceof Closure) {
		0 ignored issues – show introduced 2023-10-06 15:00 UTC by Report Bug Copy Issue Report `$key` is never a sub-type of `Closure`. Loading history...
92	4	$key = Services::container()->call($key);
93		}
94		if ($value instanceof Closure) {
95	6	$value = Services::container()->call($value);
96		}
97		if (is_string($key)) {
		0 ignored issues – show introduced 2023-09-18 10:05 UTC by Report Bug Copy Issue Report The condition `is_string($key)` is always `false`. Loading history...
98	2	$key = [$key => $value];
99		}
100
101	6	self::$shared = array_merge(self::$shared, $key);
102		}
103
104		/**
105		* Recupere et retourne le code html de la vue créée
106		*/
107		public function get(bool\|string $compress = 'auto', ?bool $saveData = null): string
108		{
109	2	$output = $this->adapter->render($this->view, $this->options, $saveData);
110
111	2	return $this->compressView($output, $compress);
112		}
113
114		/**
115		* Affiche la vue generee au navigateur
116		*/
117		public function render(?bool $saveData = null): void
118		{
119	2	$compress = $this->config['compress_output'] ?? 'auto';
120
121	2	echo $this->get($compress, $saveData);
122		}
123
124		/**
125		* Construit la sortie en fonction d'une chaîne et de tout données déjà définies.
126		*/
127		public function renderString(string $view, ?array $options = null, bool $saveData = false): string
128		{
129		return $this->adapter->renderString($view, $options, $saveData);
130		}
131
132		/**
133		* Verifie qu'un fichier de vue existe
134		*/
135		public function exists(string $view, ?string $ext = null, array $options = []): bool
136		{
137	2	return $this->adapter->exists($view, $ext, $options);
138		}
139
140		/**
141		* Utilise le premier fichier de vue trouvé pour le rendu
142		*
143		* @param string[] $views
144		*/
145		public function first(array $views, array $data = [], array $options = []): static
146		{
147		foreach ($views as $view) {
148		if ($this->exists($view, null, $options)) {
149		return $this->make($view, $data, $options);
150		}
151		}
152
153		throw ViewException::invalidFile(implode(' OR ', $views));
154		}
155
156		/**
157		* Crée une instance de vue prêt à être utilisé
158		*/
159		public function make(string $view, array $data = [], array $options = []): static
160		{
161		return $this->addData($data)->options($options)->display($view);
162		}
163
164		/**
165		* Modifier les options d'affichage
166		*
167		* {@deprecated since 1.0 use options() instead}
168		*/
169		public function setOptions(?array $options = []): static
170		{
171		return $this->options($options ?: []);
172		}
173
174		/**
175		* Modifier les options d'affichage
176		*
177		* {@internal}
178		*/
179		public function options(array $options = []): static
180		{
181		if (isset($options['layout'])) {
182		$this->layout($options['layout']);
183		unset($options['layout']);
184		}
185
186		$this->options = $options;
187
188		return $this;
189		}
190
191		/**
192		* Définir la vue à afficher
193		*
194		* {@internal}
195		*/
196		public function display(string $view, ?array $options = null): static
197		{
198	2	$this->view = $view;
199
200		if ($options !== null) {
201	2	$this->options($options);
202		}
203
204	2	return $this;
205		}
206
207		/**
208		* Définit plusieurs éléments de données de vue à la fois.
209		*
210		* {@internal}
211		*/
212		public function addData(array $data = [], ?string $context = null): static
213		{
214		unset($data['errors']);
215
216		$data = array_merge(self::$shared, $data);
217
218		if (! on_test() && ! isset($data['errors'])) {
219		$data['errors'] = $this->setValidationErrors();
220		}
221
222		$this->adapter->addData($data, $context);
223
224		return $this;
225		}
226
227		/**
228		* Définit plusieurs éléments de données de vue à la fois.
229		*/
230		public function with(array\|string $key, mixed $value = null, ?string $context = null): static
231		{
232		if (is_array($key)) {
		0 ignored issues – show introduced 2023-09-18 10:05 UTC by Report Bug Copy Issue Report The condition `is_array($key)` is always `true`. Loading history...
233		$context = $value;
234		} else {
235		$key = [$key => $value];
236		}
237
238		return $this->addData($key, $context);
239		}
240
241		/**
242		* Ajoute des erreurs à la session en tant que Flashdata.
243		*/
244		public function withErrors(array\|ErrorBag\|string $errors): static
245		{
246		if (is_string($errors)) {
		0 ignored issues – show introduced 2023-11-16 13:55 UTC by Report Bug Copy Issue Report The condition `is_string($errors)` is always `false`. Loading history...
247		$errors = ['default' => $errors];
248		}
249		if (! ($errors instanceof ErrorBag)) {
		0 ignored issues – show introduced 2023-11-16 13:55 UTC by Report Bug Copy Issue Report `$errors` is never a sub-type of `BlitzPHP\Validation\ErrorBag`. Loading history...
250		$errors = new ErrorBag($errors);
251		}
252
253		if (isset(self::$shared['errors']) && self::$shared['errors'] instanceof ErrorBag) {
254		$messages = array_merge(
255		self::$shared['errors']->toArray(),
256		$errors->toArray()
257		);
258		$errors = new ErrorBag($messages);
259		}
260
261		$this->share('errors', $errors);
262
263		return $this;
264		}
265
266		/**
267		* Définit une seule donnée de vue.
268		*
269		* @param mixed\|null $value
270		*/
271		public function setVar(string $name, $value = null, ?string $context = null): static
272		{
273	2	$this->adapter->setVar($name, $value, $context);
274
275	2	return $this;
276		}
277
278		/**
279		* Remplacer toutes les données de vue par de nouvelles données
280		*/
281		public function setData(array $data, ?string $context = null): static
282		{
283		unset($data['errors']);
284
285		$data = array_merge(self::$shared, $data);
286
287		if (! on_test() && ! isset($data['errors'])) {
288		$data['errors'] = $this->setValidationErrors();
289		}
290
291		$this->adapter->setData($data, $context);
292
293		return $this;
294		}
295
296		/**
297		* Renvoie les données actuelles qui seront affichées dans la vue.
298		*/
299		public function getData(): array
300		{
301		$data = $this->adapter->getData();
302
303		if (on_test() && isset($data['errors'])) {
304		unset($data['errors']);
305		}
306
307		return $data;
308		}
309
310		/**
311		* Supprime toutes les données de vue du système.
312		*/
313		public function resetData(): static
314		{
315		$this->adapter->resetData();
316
317		return $this;
318		}
319
320		/**
321		* Definit le layout a utiliser par les vues
322		*/
323		public function layout(string $layout): static
324		{
325		$this->adapter->setLayout($layout);
326
327		return $this;
328		}
329
330		/**
331		* @deprecated 1.0 Please use layout method instead
332		*/
333		public function setLayout(string $layout): static
334		{
335		return $this->layout($layout);
336		}
337
338		/**
339		* Defini l'adapteur à utiliser
340		*
341		* {@internal}
342		*/
343		public function setAdapter(string $adapter, array $config = []): static
344		{
345		if (! array_key_exists($adapter, self::$validAdapters)) {
346	4	$adapter = 'native';
347		}
348		if (empty($this->config['adapters']) \|\| ! is_array($this->config['adapters'])) {
349	4	$this->config['adapters'] = [];
350		}
351
352	4	$config = array_merge($this->config['adapters'][$adapter] ?? [], $config);
353		if (empty($config)) {
354	4	throw ConfigException::viewAdapterConfigNotFound($adapter);
355		}
356
357	4	$debug = $this->config['debug'] ?? 'auto';
358		if ($debug === 'auto') {
359	4	$debug = on_dev();
360		}
361
362		$this->adapter = new self::$validAdapters[$adapter](
363		$config,
364		$config['view_path_locator'] ?? Services::locator(),
365		$debug
366	4	);
367
368	4	return $this;
369		}
370
371		/**
372		* Renvoie les données de performances qui ont pu être collectées lors de l'exécution.
373		* Utilisé principalement dans la barre d'outils de débogage.
374		*
375		* {@internal}
376		*/
377		public function getPerformanceData(): array
378		{
379		return $this->adapter->getPerformanceData();
380		}
381
382		/**
383		* Compresse le code html d'une vue
384		*/
385		protected function compressView(string $output, bool\|callable\|string $compress = 'auto'): string
386		{
387	2	$compress = $compress === 'auto' ? ($this->options['compress_output'] ?? 'auto') : $compress;
388	2	$compress = $compress === 'auto' ? ($this->config['compress_output'] ?? 'auto') : $compress;
389
390		if (is_callable($compress)) {
391	2	$compress = Services::container()->call($compress);
392		}
393
394		if ($compress === 'auto') {
395	2	$compress = is_online();
396		}
397
398	2	return true === $compress ? trim(preg_replace('/\s+/', ' ', $output)) : $output;
399		}
400
401		/**
402		* Defini les erreurs de validation pour la vue
403		*/
404		private function setValidationErrors(): ErrorBag
405		{
406		$errors = [];
407
408		/** @var \BlitzPHP\Session\Store $session */
409		$session = session();
410
411		if (null !== $e = $session->getFlashdata('errors')) {
412		if (is_array($e)) {
		0 ignored issues – show introduced 2023-09-18 10:05 UTC by Report Bug Copy Issue Report The condition `is_array($e)` is always `true`. Loading history...
413		$errors = array_merge($errors, $e);
414		} else {
415		$errors['error'] = $e;
416		}
417
418		$session->unmarkFlashdata('errors');
419		}
420
421		if (null !== $e = $session->getFlashdata('error')) {
422		if (is_array($e)) {
		0 ignored issues – show introduced 2023-09-18 10:05 UTC by Report Bug Copy Issue Report The condition `is_array($e)` is always `true`. Loading history...
423		$errors = array_merge($errors, $e);
424		} else {
425		$errors['error'] = $e;
426		}
427
428		$session->unmarkFlashdata('error');
429		}
430
431		return new ErrorBag($errors);
432		}
433		}
434

blitz-php / framework

Push — main ( e1affe...2e6d72 )

View::layout() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like