BlitzPHP\View\View

Complexity

Total Complexity

40

Size/Duplication

Total Lines	315
Duplicated Lines	0 %

Importance

Changes	5
Bugs	2	Features	0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	setAdapter()	0	26	6
A	getData()	0	3	1
A	get()	0	6	1
A	with()	0	9	2
A	setValidationErrors()	0	25	5
A	__construct()	0	5	1
A	setData()	0	13	2
A	display()	0	5	1
A	resetData()	0	5	1
A	compressView()	0	14	6
A	__toString()	0	3	1
A	setVar()	0	5	1
A	share()	0	10	3
A	setOptions()	0	5	1
A	getPerformanceData()	0	3	1
A	render()	0	5	1
A	decorate()	0	11	3
A	setLayout()	0	5	1
A	addData()	0	13	2

<?php

/**
 * This file is part of Blitz PHP framework.
 *
 * (c) 2022 Dimitri Sitchet Tomkeu <devcode.dst@gmail.com>
 *
 * 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;

class View
{
    /**
     * Views configuration
     *
     * @var array
     */
    protected $config;

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

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

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

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

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

    /**
     * Constructeur
     */
    public function __construct()
    {
        $this->config = config('view');

It seems like config('view') can also be of type BlitzPHP\Config\Config. However, the property $config is declared as type array. Maybe add an additional type check?

        static::share($this->config['shared']);
        $this->setAdapter($this->config['active_adapter'] ?? 'native');
    }

    public function __toString()
    {
        return $this->get();
    }

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

$key is never a sub-type of Closure.

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

The condition is_string($key) is always false.

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

        static::$shared = array_merge(static::$shared, $key);

Since $shared is declared private, accessing it with static will lead to errors in possible sub-classes; you can either use self, or increase the visibility of $shared to at least protected.

    }

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

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

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

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

    /**
     * Modifier les options d'affichage
     */
    public function setOptions(?array $options = []): self
    {
        $this->options = (array) $options;

        return $this;
    }

    /**
     * Définir la vue à afficher
     */
    public function display(string $view): self
    {
        $this->view = $view;

        return $this;
    }

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

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

Since $shared is declared private, accessing it with static will lead to errors in possible sub-classes; you can either use self, or increase the visibility of $shared to at least protected.

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

        if (! array_key_exists('errors', $this->getData())) {
            $this->setValidationErrors();
        }

        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): self
    {
        if (is_array($key)) {

The condition is_array($key) is always true.

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

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

    /**
     * Définit une seule donnée de vue.
     *
     * @param mixed|null $value
     */
    public function setVar(string $name, $value = null, ?string $context = null): self
    {
        $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): self
    {
        unset($data['errors']);

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

Since $shared is declared private, accessing it with static will lead to errors in possible sub-classes; you can either use self, or increase the visibility of $shared to at least protected.

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

        if (! array_key_exists('errors', $this->getData())) {
            $this->setValidationErrors();
        }

        return $this;
    }

    /**
     * Remplacer toutes les données de vue par de nouvelles données
     */
    public function getData(): array
    {
        return $this->adapter->getData();
    }

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

        return $this;
    }

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

        return $this;
    }

    /**
     * Defini l'adapteur à utiliser
     */
    public function setAdapter(string $adapter, array $config = []): self
    {
        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.
     */
    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;
    }

    /**
     * Exécute la sortie générée via tous les décorateurs de vue déclarés.
     */
    protected function decorate(string $output): string
    {
        foreach ($this->config['decorators'] as $decorator) {
            if (!is_subclass_of($decorator, ViewDecoratorInterface::class)) {
                throw ViewException::invalidDecorator($decorator);
            }

            $output = $decorator::decorate($output);
        }

        return $output;
    }

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

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

The condition is_array($e) is always true.

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

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

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

The condition is_array($e) is always true.

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

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

        $this->adapter->addData(['errors' => new ErrorBag($errors)]);
    }
}