View::getRequest() - Code Metrics - starweb/starlit-app - Measure and Improve Code Quality continuously with Scrutinizer

View::getRequest() A
last analyzed 2019-09-25 07:06 UTC

↳ Parent: View

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php declare(strict_types=1);
/**
 * Starlit App.
 *
 * @copyright Copyright (c) 2016 Starweb AB
 * @license   BSD 3-Clause
 */

namespace Starlit\App;

use Starlit\App\ViewHelper\Capturer;
use Starlit\App\ViewHelper\InlineScriptCapturer;
use Starlit\App\ViewHelper\MustacheTmplCapturer;
use Starlit\App\ViewHelper\Pagination;
use Starlit\App\ViewHelper\Url;
use Symfony\Component\HttpFoundation\Request;
use Starlit\App\ViewHelper\AbstractViewHelper;

class View implements ViewInterface
{
    /**
     * @var string
     */
    protected $scriptRootPath = 'app/views';

    /**
     * @var string
     */
    protected $fileExtension = 'html.php';

    /**
     * Default helpers.
     *
     * @var array
     */
    protected $helperClasses = [
        'capturer'             => Capturer::class,
        'mustacheTmplCapturer' => MustacheTmplCapturer::class,
        'pagination'           => Pagination::class,
        'url'                  => Url::class,
        'inlineScriptCapturer' => InlineScriptCapturer::class,
    ];

    /**
     * @var array
     */
    protected $helpers = [];

    /**
     * @var array
     */
    protected $variables = [];

    /**
     * @var string|null
     */
    protected $layoutScript;

    /**
     * @var string|null
     */
    protected $layoutContent;

    /**
     * @var Request
     */
    private $request;

    public function __construct(array $options = [])
    {
        $this->setOptions($options);
    }

    public function setOptions(array $options): void
    {
        if (isset($options['scriptRootPath'])) {
            $this->scriptRootPath = $options['scriptRootPath'];
        }

        if (isset($options['fileExtension'])) {
            $this->fileExtension = $options['fileExtension'];
        }
    }

    /**
     * Magic method to set view variables.
     *
     * @param   string $name
     * @param   mixed  $value
     */
    public function __set(string $name, $value): void
    {
        $this->variables[$name] = $value;
    }

    /**
     * Magic method to get view variables.
     *
     * @param string $name
     * @return mixed
     */
    public function __get(string $name)
    {
        if (!isset($this->variables[$name])) {
            return null;
        }

        return $this->variables[$name];
    }

    /**
     * Magic method to test if view variable is set.
     */
    public function __isset(string $name): bool
    {
        return isset($this->variables[$name]);
    }

    public function setLayout(string $script): void
    {
        $this->layoutScript = $script;
    }

    /**
     * Render output (returns) of the specified view script (with layout if that exists).
     *
     * @param string $script Relative script path (without file extension!). Eg. "some-script" or "admin/some-script".
     * @param bool   $renderLayout
     * @return string
     */
    public function render(string $script, bool $renderLayout = false): string
    {
        // Check If script should be rendered with a layout
        if ($renderLayout && !empty($this->layoutScript)) {
            $this->layoutContent = $this->renderScript($script);

            return $this->renderScript($this->layoutScript);
        } else {
            return $this->renderScript($script);
        }
    }

    /**
     * Internal method that does the actual script rendering.
     */
    protected function renderScript(string $script): string
    {
        $fullScriptPath = $this->scriptRootPath . '/' . $script . '.' . $this->fileExtension;
        // We don't unit test invalid script because it slows down the test process an entire second or more
        if (!file_exists($fullScriptPath)) {
            throw new \RuntimeException("Couldn't find view script \"{$fullScriptPath}\"");
        }

        ob_start();

        include $fullScriptPath;

        return ob_get_clean();
    }

    public function layoutContent(): string
    {
        return $this->layoutContent;
    }

    /**
     * Escape a string for output in view script.
     */
    public function escape(?string $string, int $flags = \ENT_QUOTES): string
    {
        return htmlspecialchars((string) $string, $flags, BaseApp::CHARSET);
    }

    /**
     * Returns view variable escaped for view script output.
     */
    public function getEscaped(string $name): string
    {
        if (empty($this->variables[$name])) {
            return '';
        }

        return $this->escape((string) $this->variables[$name]);
    }

    public function addHelperClass(string $helperName, string $className): void
    {
        $this->helperClasses[$helperName] = $className;
    }

    public function getHelper(string $helperName): AbstractViewHelper
    {
        // If helper has not already been instantiated
        if (!isset($this->helpers[$helperName])) {
            // Check that helper is defined
            if (!isset($this->helperClasses[$helperName])) {
                throw new \InvalidArgumentException("No helper named \"{$helperName}\"");
            }

            $this->helpers[$helperName] = new $this->helperClasses[$helperName]();
            $this->helpers[$helperName]->setView($this);
        }

        return $this->helpers[$helperName];
    }

    /**
     * Magic method to call view helpers.
     * If the helper has not defined __invoke(), the helper object will be returned.
     * Otherwise, the result of the __invoke() is returned.
     */
    public function __call(string $name, array $arguments = [])
    {
        $helper = $this->getHelper($name);
        if (is_callable($helper)) {
            return \call_user_func_array($helper, $arguments);
        }

        return $helper;
    }

    public function setRequest(Request $request): void

    {
        $this->request = $request;
    }

    public function getRequest(): Request
    {
        return $this->request;
    }

    public function setLayoutContent(string $value): void
    {
        $this->layoutContent = $value;
    }
}


1		<?php declare(strict_types=1);
2		/**
3		* Starlit App.
4		*
5		* @copyright Copyright (c) 2016 Starweb AB
6		* @license BSD 3-Clause
7		*/
8
9		namespace Starlit\App;
10
11		use Starlit\App\ViewHelper\Capturer;
12		use Starlit\App\ViewHelper\InlineScriptCapturer;
13		use Starlit\App\ViewHelper\MustacheTmplCapturer;
14		use Starlit\App\ViewHelper\Pagination;
15		use Starlit\App\ViewHelper\Url;
16		use Symfony\Component\HttpFoundation\Request;
17		use Starlit\App\ViewHelper\AbstractViewHelper;
18
19		class View implements ViewInterface
20		{
21		/**
22		* @var string
23		*/
24		protected $scriptRootPath = 'app/views';
25
26		/**
27		* @var string
28		*/
29		protected $fileExtension = 'html.php';
30
31		/**
32		* Default helpers.
33		*
34		* @var array
35		*/
36		protected $helperClasses = [
37		'capturer' => Capturer::class,
38		'mustacheTmplCapturer' => MustacheTmplCapturer::class,
39		'pagination' => Pagination::class,
40		'url' => Url::class,
41		'inlineScriptCapturer' => InlineScriptCapturer::class,
42		];
43
44		/**
45		* @var array
46		*/
47		protected $helpers = [];
48
49		/**
50		* @var array
51		*/
52		protected $variables = [];
53
54		/**
55		* @var string\|null
56		*/
57		protected $layoutScript;
58
59		/**
60		* @var string\|null
61		*/
62		protected $layoutContent;
63
64		/**
65		* @var Request
66		*/
67		private $request;
68
69	15	public function __construct(array $options = [])
70		{
71	15	$this->setOptions($options);
72	15	}
73
74	15	public function setOptions(array $options): void
75		{
76	15	if (isset($options['scriptRootPath'])) {
77	12	$this->scriptRootPath = $options['scriptRootPath'];
78		}
79
80	15	if (isset($options['fileExtension'])) {
81	1	$this->fileExtension = $options['fileExtension'];
82		}
83	15	}
84
85		/**
86		* Magic method to set view variables.
87		*
88		* @param string $name
89		* @param mixed $value
90		*/
91	4	public function __set(string $name, $value): void
92		{
93	4	$this->variables[$name] = $value;
94	4	}
95
96		/**
97		* Magic method to get view variables.
98		*
99		* @param string $name
100		* @return mixed
101		*/
102	2	public function __get(string $name)
103		{
104	2	if (!isset($this->variables[$name])) {
105	1	return null;
106		}
107
108	2	return $this->variables[$name];
109		}
110
111		/**
112		* Magic method to test if view variable is set.
113		*/
114	1	public function __isset(string $name): bool
115		{
116	1	return isset($this->variables[$name]);
117		}
118
119	1	public function setLayout(string $script): void
120		{
121	1	$this->layoutScript = $script;
122	1	}
123
124		/**
125		* Render output (returns) of the specified view script (with layout if that exists).
126		*
127		* @param string $script Relative script path (without file extension!). Eg. "some-script" or "admin/some-script".
128		* @param bool $renderLayout
129		* @return string
130		*/
131	2	public function render(string $script, bool $renderLayout = false): string
132		{
133		// Check If script should be rendered with a layout
134	2	if ($renderLayout && !empty($this->layoutScript)) {
135	1	$this->layoutContent = $this->renderScript($script);
136
137	1	return $this->renderScript($this->layoutScript);
138		} else {
139	1	return $this->renderScript($script);
140		}
141		}
142
143		/**
144		* Internal method that does the actual script rendering.
145		*/
146	3	protected function renderScript(string $script): string
147		{
148	3	$fullScriptPath = $this->scriptRootPath . '/' . $script . '.' . $this->fileExtension;
149		// We don't unit test invalid script because it slows down the test process an entire second or more
150	3	if (!file_exists($fullScriptPath)) {
151	1	throw new \RuntimeException("Couldn't find view script \"{$fullScriptPath}\"");
152		}
153
154	2	ob_start();
155
156	2	include $fullScriptPath;
157
158	2	return ob_get_clean();
159		}
160
161	2	public function layoutContent(): string
162		{
163	2	return $this->layoutContent;
164		}
165
166		/**
167		* Escape a string for output in view script.
168		*/
169	2	public function escape(?string $string, int $flags = \ENT_QUOTES): string
170		{
171	2	return htmlspecialchars((string) $string, $flags, BaseApp::CHARSET);
172		}
173
174		/**
175		* Returns view variable escaped for view script output.
176		*/
177	1	public function getEscaped(string $name): string
178		{
179	1	if (empty($this->variables[$name])) {
180	1	return '';
181		}
182
183	1	return $this->escape((string) $this->variables[$name]);
184		}
185
186	2	public function addHelperClass(string $helperName, string $className): void
187		{
188	2	$this->helperClasses[$helperName] = $className;
189	2	}
190
191	3	public function getHelper(string $helperName): AbstractViewHelper
192		{
193		// If helper has not already been instantiated
194	3	if (!isset($this->helpers[$helperName])) {
195		// Check that helper is defined
196	3	if (!isset($this->helperClasses[$helperName])) {
197	1	throw new \InvalidArgumentException("No helper named \"{$helperName}\"");
198		}
199
200	2	$this->helpers[$helperName] = new $this->helperClasses[$helperName]();
201	2	$this->helpers[$helperName]->setView($this);
202		}
203
204	2	return $this->helpers[$helperName];
205		}
206
207		/**
208		* Magic method to call view helpers.
209		* If the helper has not defined __invoke(), the helper object will be returned.
210		* Otherwise, the result of the __invoke() is returned.
211		*/
212	2	public function __call(string $name, array $arguments = [])
213		{
214	2	$helper = $this->getHelper($name);
215	2	if (is_callable($helper)) {
216	1	return \call_user_func_array($helper, $arguments);
217		}
218
219	1	return $helper;
220		}
221
222	1	public function setRequest(Request $request): void
		0 ignored issues – show Bug introduced 2018-11-13 14:57 UTC by Report Bug Copy Issue Report You have injected the Request via parameter `$request`. This is generally not recommended as there might be multiple instances during a request cycle (f.e. when using sub-requests). Instead, it is recommended to inject the RequestStack and retrieve the current request each time you need it via `getCurrentRequest()`. Loading history...
223		{
224	1	$this->request = $request;
225	1	}
226
227	1	public function getRequest(): Request
228		{
229	1	return $this->request;
230		}
231
232	1	public function setLayoutContent(string $value): void
233		{
234	1	$this->layoutContent = $value;
235	1	}
236		}
237

starweb / starlit-app

GitHub Access Token became invalid

View::getRequest() A last analyzed 2019-09-25 07:06 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

View::getRequest() A
last analyzed 2019-09-25 07:06 UTC