QtView::renderDebugBar() - Code Metrics - Inspection of "Major refactoring and code enhancements" - softberg/quantum-php-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#43)

by Arman

created 2021-07-30 12:00 UTC

QtView::renderDebugBar() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php

/**
 * Quantum PHP Framework
 *
 * An open source software development framework for PHP
 *
 * @package Quantum
 * @author Arman Ag. <[email protected]>
 * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
 * @link http://quantum.softberg.org/
 * @since 2.5.0
 */

namespace Quantum\Mvc;

use Quantum\Libraries\Storage\FileSystem;
use Quantum\Exceptions\ViewException;
use Quantum\Factory\ViewFactory;
use Quantum\Hooks\HookManager;
use Quantum\Di\Di;
use Error;

/**
 * Class QtView
 * @package Quantum\Mvc
 */
class QtView
{

    /**
     * Layout file
     * @var string
     */
    private $layout = null;

    /**
     * Rendered view
     * @var string
     */
    private $view = null;

    /**
     * View data
     * @var array
     */
    private $data = [];

    /**
     * QtView constructor.
     * @throws \Quantum\Exceptions\ViewException
     */
    public function __construct()
    {
        if (get_caller_class() != ViewFactory::class) {
            throw ViewException::directInstantiation(ViewFactory::class);
        }
    }

    /**
     * Sets a layout
     * @param string $layout
     */
    public function setLayout(string $layout)
    {
        $this->layout = $layout;
    }

    /**
     * Gets the layout
     * @return string|null
     */
    public function getLayout(): ?string
    {
        return $this->layout;
    }

    /**
     * Sets view parameter
     * @param string $key
     * @param mixed $value
     */
    public function setParam(string $key, $value)
    {
        $this->data[$key] = $value;
    }

    /**
     * Gets the view parameter
     * @param string $key
     * @return mixed|null
     */
    public function getParam(string $key)
    {
        return $this->data[$key] ?? null;
    }

    /**
     * Sets multiple view parameters
     * @param array $params
     */
    public function setParams(array $params)
    {
        foreach ($params as $key => $value) {
            $this->setParam($key, $value);
        }
    }

    /**
     * Gets all view parameters
     * @return array
     */
    public function getParams(): array
    {
        return $this->data;
    }

    /**
     * @param string $view
     * @param array $params
     * @return string|null
     * @throws \Quantum\Exceptions\DiException
     * @throws \Quantum\Exceptions\HookException
     * @throws \Quantum\Exceptions\ViewException
     * @throws \ReflectionException
     */
    public function render(string $view, array $params = []): ?string
    {
        if (!$this->layout) {
            throw ViewException::noLayoutSet();
        }

        if (!empty($params)) {
            $this->data = array_merge($this->data, $params);
        }

        $this->view = $this->renderFile($view);

        if (filter_var(config()->get('debug'), FILTER_VALIDATE_BOOLEAN)) {
            HookManager::call('updateDebuggerStore', ['view' => $view]);
        }

        return $this->renderFile($this->layout);
    }

    /**
     * Renders partial view
     * @param string $view
     * @param array $params
     * @return string|null
     * @throws \Quantum\Exceptions\DiException
     * @throws \Quantum\Exceptions\HookException
     * @throws \Quantum\Exceptions\ViewException
     * @throws \ReflectionException
     */
    public function renderPartial(string $view, array $params = []): ?string
    {
        if (!empty($params)) {
            $this->data = array_merge($this->data, $params);
        }

        return $this->renderFile($view);
    }

    /**
     * Gets the rendered view
     * @return string
     */
    public function getView(): string
    {
        return $this->view;
    }

    /**
     * Finds a given file
     * @param string $file
     * @return string
     * @throws \Quantum\Exceptions\DiException
     * @throws \Quantum\Exceptions\ViewException
     * @throws \ReflectionException
     */
    private function findFile(string $file): string
    {
        $fs = Di::get(FileSystem::class);

        $filePath = modules_dir() . DS . current_module() . DS . 'Views' . DS . $file . '.php';

        if (!$fs->exists($filePath)) {
            $filePath = base_dir() . DS . 'base' . DS . 'views' . DS . $file . '.php';
            if (!$fs->exists($filePath)) {
                throw ViewException::fileNotFound($file);
            }
        }

        return $filePath;
    }

    /**
     * Renders the view
     * @param string $view
     * @return mixed|string
     * @throws \Quantum\Exceptions\DiException
     * @throws \Quantum\Exceptions\HookException
     * @throws \Quantum\Exceptions\ViewException
     * @throws \ReflectionException
     */
    private function renderFile(string $view)
    {
        $params = $this->xssFilter($this->data);

        $templateEngine = config()->get('template_engine');

        if ($templateEngine) {
            $engineName = key($templateEngine);
            $engineConfigs = $templateEngine[$engineName];

            return HookManager::call('templateRenderer', [
                'configs' => $engineConfigs,
                'view' => $view,
                'params' => $params
            ]);
        } else {
            return $this->defaultRenderer($view, $params);
        }
    }

    /**
     * Default Renderer
     * @param string $view
     * @param array $params
     * @return string|null
     * @throws \Quantum\Exceptions\DiException
     * @throws \Quantum\Exceptions\ViewException
     * @throws \ReflectionException
     */
    private function defaultRenderer(string $view, array $params = []): ?string
    {
        try {
            ob_start();
            ob_implicit_flush(0);

            if (!empty($params)) {
                extract($params, EXTR_OVERWRITE);
            }

            require $this->findFile($view);

            return ob_get_clean();
        } catch (Error $e) {
            ob_clean();
            exit($e->getMessage());

        }
    }

    /**
     * XSS Filter
     * @param mixed $data
     * @return mixed
     */
    private function xssFilter($data)
    {
        if (is_string($data)) {
            $this->cleaner($data);
            $data = [$data];
        } else {
            array_walk_recursive($data, [$this, 'cleaner']);
        }

        return $data;
    }

    /**
     * Cleaner
     * @param mixed $value
     */
    private function cleaner(&$value)
    {
        if (is_object($value)) {
            $this->xssFilter($value);
        } else {
            $value = htmlspecialchars($value, ENT_QUOTES, 'UTF-8');
        }
    }

}


1			<?php
2
3			/**
4			* Quantum PHP Framework
5			*
6			* An open source software development framework for PHP
7			*
8			* @package Quantum
9			* @author Arman Ag. <[email protected]>
10			* @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
11			* @link http://quantum.softberg.org/
12			* @since 2.5.0
13			*/
14
15			namespace Quantum\Mvc;
16
17			use Quantum\Libraries\Storage\FileSystem;
18			use Quantum\Exceptions\ViewException;
19			use Quantum\Factory\ViewFactory;
20			use Quantum\Hooks\HookManager;
21			use Quantum\Di\Di;
22			use Error;
23
24			/**
25			* Class QtView
26			* @package Quantum\Mvc
27			*/
28			class QtView
29			{
30
31			/**
32			* Layout file
33			* @var string
34			*/
35			private $layout = null;
36
37			/**
38			* Rendered view
39			* @var string
40			*/
41			private $view = null;
42
43			/**
44			* View data
45			* @var array
46			*/
47			private $data = [];
48
49			/**
50			* QtView constructor.
51			* @throws \Quantum\Exceptions\ViewException
52			*/
53			public function __construct()
54			{
55			if (get_caller_class() != ViewFactory::class) {
56			throw ViewException::directInstantiation(ViewFactory::class);
57			}
58			}
59
60			/**
61			* Sets a layout
62			* @param string $layout
63			*/
64			public function setLayout(string $layout)
65			{
66			$this->layout = $layout;
67			}
68
69			/**
70			* Gets the layout
71			* @return string\|null
72			*/
73			public function getLayout(): ?string
74			{
75			return $this->layout;
76			}
77
78			/**
79			* Sets view parameter
80			* @param string $key
81			* @param mixed $value
82			*/
83			public function setParam(string $key, $value)
84			{
85			$this->data[$key] = $value;
86			}
87
88			/**
89			* Gets the view parameter
90			* @param string $key
91			* @return mixed\|null
92			*/
93			public function getParam(string $key)
94			{
95			return $this->data[$key] ?? null;
96			}
97
98			/**
99			* Sets multiple view parameters
100			* @param array $params
101			*/
102			public function setParams(array $params)
103			{
104			foreach ($params as $key => $value) {
105			$this->setParam($key, $value);
106			}
107			}
108
109			/**
110			* Gets all view parameters
111			* @return array
112			*/
113			public function getParams(): array
114			{
115			return $this->data;
116			}
117
118			/**
119			* @param string $view
120			* @param array $params
121			* @return string\|null
122			* @throws \Quantum\Exceptions\DiException
123			* @throws \Quantum\Exceptions\HookException
124			* @throws \Quantum\Exceptions\ViewException
125			* @throws \ReflectionException
126			*/
127			public function render(string $view, array $params = []): ?string
128			{
129			if (!$this->layout) {
130			throw ViewException::noLayoutSet();
131			}
132
133			if (!empty($params)) {
134			$this->data = array_merge($this->data, $params);
135			}
136
137			$this->view = $this->renderFile($view);
138
139			if (filter_var(config()->get('debug'), FILTER_VALIDATE_BOOLEAN)) {
140			HookManager::call('updateDebuggerStore', ['view' => $view]);
141			}
142
143			return $this->renderFile($this->layout);
144			}
145
146			/**
147			* Renders partial view
148			* @param string $view
149			* @param array $params
150			* @return string\|null
151			* @throws \Quantum\Exceptions\DiException
152			* @throws \Quantum\Exceptions\HookException
153			* @throws \Quantum\Exceptions\ViewException
154			* @throws \ReflectionException
155			*/
156			public function renderPartial(string $view, array $params = []): ?string
157			{
158			if (!empty($params)) {
159			$this->data = array_merge($this->data, $params);
160			}
161
162			return $this->renderFile($view);
163			}
164
165			/**
166			* Gets the rendered view
167			* @return string
168			*/
169			public function getView(): string
170			{
171			return $this->view;
172			}
173
174			/**
175			* Finds a given file
176			* @param string $file
177			* @return string
178			* @throws \Quantum\Exceptions\DiException
179			* @throws \Quantum\Exceptions\ViewException
180			* @throws \ReflectionException
181			*/
182			private function findFile(string $file): string
183			{
184			$fs = Di::get(FileSystem::class);
185
186			$filePath = modules_dir() . DS . current_module() . DS . 'Views' . DS . $file . '.php';
187
188			if (!$fs->exists($filePath)) {
189			$filePath = base_dir() . DS . 'base' . DS . 'views' . DS . $file . '.php';
190			if (!$fs->exists($filePath)) {
191			throw ViewException::fileNotFound($file);
192			}
193			}
194
195			return $filePath;
196			}
197
198			/**
199			* Renders the view
200			* @param string $view
201			* @return mixed\|string
202			* @throws \Quantum\Exceptions\DiException
203			* @throws \Quantum\Exceptions\HookException
204			* @throws \Quantum\Exceptions\ViewException
205			* @throws \ReflectionException
206			*/
207			private function renderFile(string $view)
208			{
209			$params = $this->xssFilter($this->data);
210
211			$templateEngine = config()->get('template_engine');
212
213			if ($templateEngine) {
214			$engineName = key($templateEngine);
215			$engineConfigs = $templateEngine[$engineName];
216
217			return HookManager::call('templateRenderer', [
218			'configs' => $engineConfigs,
219			'view' => $view,
220			'params' => $params
221			]);
222			} else {
223			return $this->defaultRenderer($view, $params);
224			}
225			}
226
227			/**
228			* Default Renderer
229			* @param string $view
230			* @param array $params
231			* @return string\|null
232			* @throws \Quantum\Exceptions\DiException
233			* @throws \Quantum\Exceptions\ViewException
234			* @throws \ReflectionException
235			*/
236			private function defaultRenderer(string $view, array $params = []): ?string
237			{
238			try {
239			ob_start();
240			ob_implicit_flush(0);
241
242			if (!empty($params)) {
243			extract($params, EXTR_OVERWRITE);
244			}
245
246			require $this->findFile($view);
247
248			return ob_get_clean();
249			} catch (Error $e) {
250			ob_clean();
251			exit($e->getMessage());
			0 ignored issues – show Best Practice introduced 2020-08-15 21:04 UTC by Report Bug Copy Issue Report Using `exit` here is not recommended. In general, usage of exit should be done with care and only when running in a scripting context like a CLI script. Loading history...
252			}
253			}
254
255			/**
256			* XSS Filter
257			* @param mixed $data
258			* @return mixed
259			*/
260			private function xssFilter($data)
261			{
262			if (is_string($data)) {
263			$this->cleaner($data);
264			$data = [$data];
265			} else {
266			array_walk_recursive($data, [$this, 'cleaner']);
267			}
268
269			return $data;
270			}
271
272			/**
273			* Cleaner
274			* @param mixed $value
275			*/
276			private function cleaner(&$value)
277			{
278			if (is_object($value)) {
279			$this->xssFilter($value);
280			} else {
281			$value = htmlspecialchars($value, ENT_QUOTES, 'UTF-8');
282			}
283			}
284
285			}
286

softberg / quantum-php-core

Pull Request — master (#43)

QtView::renderDebugBar() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like