View::setView() - Code Metrics - Inspection of "Psr2 moar unicorns" - zewadesign/framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#64)

by Josh

created 2016-08-13 02:19 UTC

View::setView() A

↳ Parent: View

Complexity

Conditions	3
Paths	4

Size

Total Lines	23
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes	5
Bugs	0	Features	0

Metric	Value
c	5
b	0
f	0
dl	0
loc	23
ccs	0
cts	20
cp	0
rs	9.0856
cc	3
eloc	16
nc	4
nop	1
crap	12

<?php
namespace Zewa;

/**
 * Abstract class for model extension
 *
 * @author Zechariah Walden<zech @ zewadesign.com>
 */
class View
{
    /**
     * System configuration
     *
     * @var object
     */
    protected $configuration;

    /**
     * Instantiated request class pointer
     *
     * @var object
     */
    protected $request;

    /**
     * Active layout for view
     *
     * @var string|bool
     */
    protected $layout = false;

    /**
     * Active module for view
     *
     * @var string|bool
     */
    protected $module = false;

    /**
     * Rendered view content
     *
     * @var string
     */
    protected $view = false;

    /**
     * Data object for view
     *
     * @var object
     */
    protected $properties;

    /**
     * Router object for view injection
     *
     * @var object
     */
    protected $router;

    /**
     * Load up some basic configuration settings.
     */
    public function __construct()

    {
        // This abstract is strictly to establish inheritance from a global registery.
        $app = App::getInstance();
        $this->configuration = $app->getConfiguration();
        $this->request = App::getService('request');
        $this->router = App::getService('router');
    }

    private function baseURL($path = '')
    {
        return $this->router->baseURL($path);
    }

    private function currentURL($params = false)

    {
        return $this->router->currentURL($params);
    }


    private function currentURI()

    {
        return $this->router->uri;
    }
    /**
     * Loads a view
     *
     * @access public
     *
     * @param string $requestedView relative path for the view
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param string $renderName array of data to expose to view
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @throws \Exception when a view can not be found
     */
    public function render()
    {
        if ($this->view !== false) {
            $this->view = $this->process($this->view);
        }
        if ($this->layout === false) {
            $this->setLayout($this->configuration->layouts->default);
        }

        if (is_null($this->layout)) {
            return $this->view;
        } else {
            return $this->process($this->layout);
        }
    }

    public function setView($requestedView)
    {

        if ($this->module === false) {
            $this->module = $this->configuration->router->module;
        }

        $view = APP_PATH
                . DIRECTORY_SEPARATOR
                . 'Modules'
                . DIRECTORY_SEPARATOR
                . $this->module
                . DIRECTORY_SEPARATOR
                . 'Views'
                . DIRECTORY_SEPARATOR
                . strtolower($requestedView)
                . '.php';

        if (!file_exists($view)) {
            throw new Exception\LookupException('View: "' . $view . '" could not be found.');
        }
        $this->view = $view;
    }

    public function setProperty($property, $value = false)
    {
        if ($value !== false) {
            $this->properties[$property] = $value;
        } elseif (!empty($property)) {
            $this->properties = $property;
        }
        return false;
    }

    public function setLayout($layout)
    {

        if ($layout === false) {
            $this->layout = null;
        } else {
            $layout = APP_PATH . DIRECTORY_SEPARATOR . 'Layouts' . DIRECTORY_SEPARATOR . strtolower($layout) . '.php';

            if (!file_exists($layout)) {
                throw new Exception\LookupException('Layout: "' . $layout . '" could not be found.');
            }

            $this->layout = $layout;

            return true;
        }
    }

    public function setModule($module = false)
    {
        if ($module === false) {
            $this->module = $this->configuration->router->module;
        } else {
            $this->module = ucfirst($module);
        }
    }
    /**
     * Processes view/layouts and exposes variables to the view/layout
     *
     * @access private
     *
     * @param string $file file being rendered
     *
     * @return string processed content
     */
    //@TODO: come back and clean up this and the way the view receives stuff
    private function process($file)
    {
        ob_start();

        if (is_array($this->properties)) {
            extract($this->properties); // yuck. could produce undeclared errors. hmm..
        }
        //should i set $this->data in abstract controller, and provide all access vars ? seems bad practice..

        include($file);

        $return = ob_get_contents();

        ob_end_clean();

        return $return;
    }

//    private function verifyResource($resource) {

//
//        $path = PUBLIC_PATH . DIRECTORY_SEPARATOR . $resource;
//
//        if (!file_exists($path)) {
//            return false;
//        }
//
//        return true;
//    }

    protected function fetchCSS()

    {
        $app = App::getInstance();
        $sheets = $app->getConfiguration('view::css');

        $string = "";

        if (empty($sheets)) {
            return $string;
        }

        foreach ($sheets as $sheet) {
            $string .= '<link rel="stylesheet" href="' . $sheet .'">' . "\r\n";
        }

        return $string;
    }

    protected function fetchJS()

    {

        $app = App::getInstance();
        $scripts = $app->getConfiguration('view::js');
        $string = "<script>baseURL = '" . $this->baseURL() . "/'</script>";

        if (empty($scripts)) {
            return $string;
        }

        foreach ($scripts as $script) {
            $string .= '<script src="' . $script . '"></script>' . "\r\n";
        }

        return $string;
    }

    public function addCSS($sheets = [], $place = 'append')

    {
        $app = App::getInstance();
        $existingCSS = $app->getConfiguration('view::css');

        if ($existingCSS === false) {
            $existingCSS = [];
        } else {
            $existingCSS = (array)$existingCSS;
        }
        if (empty($sheets)) {
            throw new Exception\LookupException('You must provide a valid CSS Resource.');
        }

        $files = [];

        foreach ($sheets as $file) {
            $files[] = $file;
//            if ($this->verifyResource($file)) {
//            } else {
//                throw new Exception\LookupException('The CSS Resource you\'ve specified does not exist.');
//            }
        }

        if ($place === 'prepend') {
            $existingCSS = array_merge($files, $existingCSS);
        } else {
            $existingCSS = array_merge($existingCSS, $files);
        }

        $app = App::getInstance();
        $app->setConfiguration('view::css', (object)$existingCSS);
    }

    public function addJS($scripts = [], $place = 'append')

    {

        $app = App::getInstance();
        $existingJS = $app->getConfiguration('view::js');

        if ($existingJS === false) {
            $existingJS = [];
        } else {
            $existingJS = (array)$existingJS;
        }

        if (!empty($scripts)) {
            $files = [];

            foreach ($scripts as $file) {
                $files[] = $file;
//                if ($this->verifyResource($file)) {
//                } else {
//                    throw new Exception\LookupException('The JS Resource you\'ve specified does not exist: ' . $file);
//                }
            }

            if ($place === 'prepend') {
                $existingJS = array_merge($files, $existingJS);
            } else {
                $existingJS = array_merge($existingJS, $files);
            }

            $app = App::getInstance();
            $app->setConfiguration('view::js', (object)$existingJS);
        }
    }


    /**
     * Set 401 header, and return noaccess view contents
     *
     * @access public
     * @return string
     */
    public function renderNoAccess($data)
    {
        header('HTTP/1.1 401 Access Denied');
        $this->setProperty($data);
        $this->setLayout('no-access');
        return $this->render();
    }

    /**
     * Set 404 header, and return 404 view contents
     *
     * @access public
     * @param $module string
     * @param $data array
     * @return string
     */
    public function render404($data = [])
    {
        header('HTTP/1.1 404 Not Found');
        $this->setProperty($data);
        $this->setLayout('404');
        return $this->render();
    }
}


1		<?php
2		namespace Zewa;
3
4		/**
5		* Abstract class for model extension
6		*
7		* @author Zechariah Walden<zech @ zewadesign.com>
8		*/
9		class View
10		{
11		/**
12		* System configuration
13		*
14		* @var object
15		*/
16		protected $configuration;
17
18		/**
19		* Instantiated request class pointer
20		*
21		* @var object
22		*/
23		protected $request;
24
25		/**
26		* Active layout for view
27		*
28		* @var string\|bool
29		*/
30		protected $layout = false;
31
32		/**
33		* Active module for view
34		*
35		* @var string\|bool
36		*/
37		protected $module = false;
38
39		/**
40		* Rendered view content
41		*
42		* @var string
43		*/
44		protected $view = false;
45
46		/**
47		* Data object for view
48		*
49		* @var object
50		*/
51		protected $properties;
52
53		/**
54		* Router object for view injection
55		*
56		* @var object
57		*/
58		protected $router;
59
60		/**
61		* Load up some basic configuration settings.
62		*/
63	View Code Duplication	public function __construct()
		0 ignored issues – show Duplication introduced 2016-08-13 01:11 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
64		{
65		// This abstract is strictly to establish inheritance from a global registery.
66		$app = App::getInstance();
67		$this->configuration = $app->getConfiguration();
68		$this->request = App::getService('request');
69		$this->router = App::getService('router');
70		}
71
72		private function baseURL($path = '')
73		{
74		return $this->router->baseURL($path);
75		}
76
77		private function currentURL($params = false)
		0 ignored issues – show Unused Code introduced 2016-08-13 01:11 UTC by Report Bug Copy Issue Report This method is not used, and could be removed. Loading history...
78		{
79		return $this->router->currentURL($params);
80		}
81
82
83		private function currentURI()
		0 ignored issues – show Unused Code introduced 2016-08-13 01:11 UTC by Report Bug Copy Issue Report This method is not used, and could be removed. Loading history...
84		{
85		return $this->router->uri;
86		}
87		/**
88		* Loads a view
89		*
90		* @access public
91		*
92		* @param string $requestedView relative path for the view
		0 ignored issues – show Bug introduced 2016-08-13 01:11 UTC by Report Bug Copy Issue Report There is no parameter named `$requestedView`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
93		* @param string $renderName array of data to expose to view
		0 ignored issues – show Bug introduced 2016-08-13 01:11 UTC by Report Bug Copy Issue Report There is no parameter named `$renderName`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
94		*
95		* @throws \Exception when a view can not be found
96		*/
97		public function render()
98		{
99		if ($this->view !== false) {
100		$this->view = $this->process($this->view);
101		}
102		if ($this->layout === false) {
103		$this->setLayout($this->configuration->layouts->default);
104		}
105
106		if (is_null($this->layout)) {
107		return $this->view;
108		} else {
109		return $this->process($this->layout);
110		}
111		}
112
113		public function setView($requestedView)
114		{
115
116		if ($this->module === false) {
117		$this->module = $this->configuration->router->module;
118		}
119
120		$view = APP_PATH
121		. DIRECTORY_SEPARATOR
122		. 'Modules'
123		. DIRECTORY_SEPARATOR
124		. $this->module
125		. DIRECTORY_SEPARATOR
126		. 'Views'
127		. DIRECTORY_SEPARATOR
128		. strtolower($requestedView)
129		. '.php';
130
131		if (!file_exists($view)) {
132		throw new Exception\LookupException('View: "' . $view . '" could not be found.');
133		}
134		$this->view = $view;
135		}
136
137		public function setProperty($property, $value = false)
138		{
139		if ($value !== false) {
140		$this->properties[$property] = $value;
141		} elseif (!empty($property)) {
142		$this->properties = $property;
143		}
144		return false;
145		}
146
147		public function setLayout($layout)
148		{
149
150		if ($layout === false) {
151		$this->layout = null;
152		} else {
153		$layout = APP_PATH . DIRECTORY_SEPARATOR . 'Layouts' . DIRECTORY_SEPARATOR . strtolower($layout) . '.php';
154
155		if (!file_exists($layout)) {
156		throw new Exception\LookupException('Layout: "' . $layout . '" could not be found.');
157		}
158
159		$this->layout = $layout;
160
161		return true;
162		}
163		}
164
165		public function setModule($module = false)
166		{
167		if ($module === false) {
168		$this->module = $this->configuration->router->module;
169		} else {
170		$this->module = ucfirst($module);
171		}
172		}
173		/**
174		* Processes view/layouts and exposes variables to the view/layout
175		*
176		* @access private
177		*
178		* @param string $file file being rendered
179		*
180		* @return string processed content
181		*/
182		//@TODO: come back and clean up this and the way the view receives stuff
183		private function process($file)
184		{
185		ob_start();
186
187		if (is_array($this->properties)) {
188		extract($this->properties); // yuck. could produce undeclared errors. hmm..
189		}
190		//should i set $this->data in abstract controller, and provide all access vars ? seems bad practice..
191
192		include($file);
193
194		$return = ob_get_contents();
195
196		ob_end_clean();
197
198		return $return;
199		}
200
201		// private function verifyResource($resource) {
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-08-13 01:11 UTC by Report Bug Copy Issue Report `41%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
202		//
203		// $path = PUBLIC_PATH . DIRECTORY_SEPARATOR . $resource;
204		//
205		// if (!file_exists($path)) {
206		// return false;
207		// }
208		//
209		// return true;
210		// }
211
212	View Code Duplication	protected function fetchCSS()
		0 ignored issues – show Duplication introduced 2016-08-13 01:11 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
213		{
214		$app = App::getInstance();
215		$sheets = $app->getConfiguration('view::css');
216
217		$string = "";
218
219		if (empty($sheets)) {
220		return $string;
221		}
222
223		foreach ($sheets as $sheet) {
224		$string .= '<link rel="stylesheet" href="' . $sheet .'">' . "\r\n";
225		}
226
227		return $string;
228		}
229
230	View Code Duplication	protected function fetchJS()
		0 ignored issues – show Duplication introduced 2016-08-13 01:11 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
231		{
232
233		$app = App::getInstance();
234		$scripts = $app->getConfiguration('view::js');
235		$string = "<script>baseURL = '" . $this->baseURL() . "/'</script>";
236
237		if (empty($scripts)) {
238		return $string;
239		}
240
241		foreach ($scripts as $script) {
242		$string .= '<script src="' . $script . '"></script>' . "\r\n";
243		}
244
245		return $string;
246		}
247
248	View Code Duplication	public function addCSS($sheets = [], $place = 'append')
		0 ignored issues – show Duplication introduced 2016-08-13 01:11 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
249		{
250		$app = App::getInstance();
251		$existingCSS = $app->getConfiguration('view::css');
252
253		if ($existingCSS === false) {
254		$existingCSS = [];
255		} else {
256		$existingCSS = (array)$existingCSS;
257		}
258		if (empty($sheets)) {
259		throw new Exception\LookupException('You must provide a valid CSS Resource.');
260		}
261
262		$files = [];
263
264		foreach ($sheets as $file) {
265		$files[] = $file;
266		// if ($this->verifyResource($file)) {
267		// } else {
268		// throw new Exception\LookupException('The CSS Resource you\'ve specified does not exist.');
269		// }
270		}
271
272		if ($place === 'prepend') {
273		$existingCSS = array_merge($files, $existingCSS);
274		} else {
275		$existingCSS = array_merge($existingCSS, $files);
276		}
277
278		$app = App::getInstance();
279		$app->setConfiguration('view::css', (object)$existingCSS);
280		}
281
282	View Code Duplication	public function addJS($scripts = [], $place = 'append')
		0 ignored issues – show Duplication introduced 2016-08-13 01:11 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
283		{
284
285		$app = App::getInstance();
286		$existingJS = $app->getConfiguration('view::js');
287
288		if ($existingJS === false) {
289		$existingJS = [];
290		} else {
291		$existingJS = (array)$existingJS;
292		}
293
294		if (!empty($scripts)) {
295		$files = [];
296
297		foreach ($scripts as $file) {
298		$files[] = $file;
299		// if ($this->verifyResource($file)) {
300		// } else {
301		// throw new Exception\LookupException('The JS Resource you\'ve specified does not exist: ' . $file);
302		// }
303		}
304
305		if ($place === 'prepend') {
306		$existingJS = array_merge($files, $existingJS);
307		} else {
308		$existingJS = array_merge($existingJS, $files);
309		}
310
311		$app = App::getInstance();
312		$app->setConfiguration('view::js', (object)$existingJS);
313		}
314		}
315
316
317		/**
318		* Set 401 header, and return noaccess view contents
319		*
320		* @access public
321		* @return string
322		*/
323		public function renderNoAccess($data)
324		{
325		header('HTTP/1.1 401 Access Denied');
326		$this->setProperty($data);
327		$this->setLayout('no-access');
328		return $this->render();
329		}
330
331		/**
332		* Set 404 header, and return 404 view contents
333		*
334		* @access public
335		* @param $module string
336		* @param $data array
337		* @return string
338		*/
339		public function render404($data = [])
340		{
341		header('HTTP/1.1 404 Not Found');
342		$this->setProperty($data);
343		$this->setLayout('404');
344		return $this->render();
345		}
346		}
347

zewadesign / framework

Pull Request — master (#64)

View::setView() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like