CViewContainer - Code Metrics - mosbth/anax - Measure and Improve Code Quality continuously with Scrutinizer

CViewContainer A
last analyzed 2018-10-19 17:34 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	179
Duplicated Lines	10.06 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

Importance

Changes

Metric	Value
dl	18
loc	179
ccs	0
cts	62
cp	0
rs	10
c	0
b	0
f	0
wmc	20
lcom	1
cbo	3

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getTemplateFile()	0	14	3
B	add()	0	37	9
A	addCallback()	9	9	1
A	addString()	9	9	1
A	hasContent()	0	4	1
A	render()	0	23	5

How to fix Duplicated Code

<?php

namespace Anax\View;

/**
 * A view container, store all views per region, render at will.
 *
 */
class CViewContainer implements \Anax\DI\IInjectionAware
{
    use \Anax\TConfigure,
        \Anax\DI\TInjectionAware;



    /**
     * Properties
     *
     */
    private $views = []; // Array for all views



    /**
     * Convert template to path to template file.
     *
     * @param string $template the name of the template file to include
     *
     * @throws Anax\View\Exception when template file is missing
     *
     * @return string as path to the template file
     */
    public function getTemplateFile($template)
    {
        $paths  = $this->config["path"];
        $suffix = $this->config["suffix"];

        foreach ($paths as $path) {
            $file = $path . "/" . $template . $suffix;
            if (is_file($file)) {
                return $file;
            }
        }

        throw new Exception("Could not find template file '$template'.");
    }



    /**
     * Add a view to be included as a template file.
     *
     * @param string $template the name of the template file to include
     * @param array  $data     variables to make available to the view, default is empty
     * @param string $region   which region to attach the view
     * @param int    $sort     which order to display the views
     *
     * @return $this
     */
    public function add($template, $data = [], $region = "main", $sort = 0)
    {
        if (empty($template)) {
            return $this;
        }

        $view = $this->di->get("view");

        if (is_string($template)) {
            $tpl = $this->getTemplateFile($template);
            $type = "file";
        } elseif (is_array($template)) {
            // Can be array with complete view or array with callback
            $tpl = $template;
            $type = null;
            $region = isset($tpl["region"])
                ? $tpl["region"]
                : $region;

            if (isset($tpl["callback"])) {
                // Need to test the callback!
                $tpl["template"] = $template;
                $tpl["type"] = "callback";
            } elseif (isset($tpl["template"])) {
                if (!isset($tpl["type"]) || $tpl["type"] === "file") {
                    $tpl["type"] = "file";
                    $tpl["template"] = $this->getTemplateFile($tpl["template"]);
                }
            }
        }

        $view->set($tpl, $data, $sort, $type);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
        $view->setDI($this->di);
        $this->views[$region][] = $view;

        return $this;
    }



    /**
     * Add a callback to be rendered as a view.
     *
     * @param string $callback function to call to get the content of the view
     * @param array  $data     variables to make available to the view, default is empty
     * @param string $region   which region to attach the view
     * @param int    $sort     which order to display the views
     *
     * @return $this
     */
    public function addCallback($callback, $data = [], $region = "main", $sort = 0)

    {
        $view = $this->di->get("view");
        $view->set(["callback" => $callback], $data, $sort, "callback");
        $view->setDI($this->di);
        $this->views[$region][] = $view;

        return $this;
    }



    /**
     * Add a string as a view.
     *
     * @param string $content the content
     * @param string $region  which region to attach the view
     * @param int    $sort    which order to display the views
     *
     * @return $this
     */
    public function addString($content, $region = "main", $sort = 0)

    {
        $view = $this->di->get("view");
        $view->set($content, [], $sort, "string");
        $view->setDI($this->di);
        $this->views[$region][] = $view;
        
        return $this;
    }



    /**
     * Check if a region has views to render.
     *
     * @param string $region which region to check
     *
     * @return $this
     */
    public function hasContent($region)
    {
        return isset($this->views[$region]);
    }



    /**
     * Render all views for a specific region.
     *
     * @param string $region which region to use
     *
     * @return $this
     */
    public function render($region = "main")
    {
        if (!isset($this->views[$region])) {
            return $this;
        }

        mergesort($this->views[$region], function ($a, $b) {
            $sa = $a->sortOrder();
            $sb = $b->sortOrder();

            if ($sa == $sb) {
                return 0;
            }

            return $sa < $sb ? -1 : 1;
        });

        foreach ($this->views[$region] as $view) {
            $view->render();
        }

        return $this;
    }
}


1		<?php
2
3		namespace Anax\View;
4
5		/**
6		* A view container, store all views per region, render at will.
7		*
8		*/
9		class CViewContainer implements \Anax\DI\IInjectionAware
10		{
11		use \Anax\TConfigure,
12		\Anax\DI\TInjectionAware;
13
14
15
16		/**
17		* Properties
18		*
19		*/
20		private $views = []; // Array for all views
21
22
23
24		/**
25		* Convert template to path to template file.
26		*
27		* @param string $template the name of the template file to include
28		*
29		* @throws Anax\View\Exception when template file is missing
30		*
31		* @return string as path to the template file
32		*/
33		public function getTemplateFile($template)
34		{
35		$paths = $this->config["path"];
36		$suffix = $this->config["suffix"];
37
38		foreach ($paths as $path) {
39		$file = $path . "/" . $template . $suffix;
40		if (is_file($file)) {
41		return $file;
42		}
43		}
44
45		throw new Exception("Could not find template file '$template'.");
46		}
47
48
49
50		/**
51		* Add a view to be included as a template file.
52		*
53		* @param string $template the name of the template file to include
54		* @param array $data variables to make available to the view, default is empty
55		* @param string $region which region to attach the view
56		* @param int $sort which order to display the views
57		*
58		* @return $this
59		*/
60		public function add($template, $data = [], $region = "main", $sort = 0)
61		{
62		if (empty($template)) {
63		return $this;
64		}
65
66		$view = $this->di->get("view");
67
68		if (is_string($template)) {
69		$tpl = $this->getTemplateFile($template);
70		$type = "file";
71		} elseif (is_array($template)) {
72		// Can be array with complete view or array with callback
73		$tpl = $template;
74		$type = null;
75		$region = isset($tpl["region"])
76		? $tpl["region"]
77		: $region;
78
79		if (isset($tpl["callback"])) {
80		// Need to test the callback!
81		$tpl["template"] = $template;
82		$tpl["type"] = "callback";
83		} elseif (isset($tpl["template"])) {
84		if (!isset($tpl["type"]) \|\| $tpl["type"] === "file") {
85		$tpl["type"] = "file";
86		$tpl["template"] = $this->getTemplateFile($tpl["template"]);
87		}
88		}
89		}
90
91		$view->set($tpl, $data, $sort, $type);
		0 ignored issues – show Bug introduced 2015-12-03 20:17 UTC by Report Bug Copy Issue Report The variable `$tpl` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history... Bug introduced 2015-12-03 20:17 UTC by Report Bug Copy Issue Report The variable `$type` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
92		$view->setDI($this->di);
93		$this->views[$region][] = $view;
94
95		return $this;
96		}
97
98
99
100		/**
101		* Add a callback to be rendered as a view.
102		*
103		* @param string $callback function to call to get the content of the view
104		* @param array $data variables to make available to the view, default is empty
105		* @param string $region which region to attach the view
106		* @param int $sort which order to display the views
107		*
108		* @return $this
109		*/
110	View Code Duplication	public function addCallback($callback, $data = [], $region = "main", $sort = 0)
		0 ignored issues – show Duplication introduced 2017-10-18 15:23 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...
111		{
112		$view = $this->di->get("view");
113		$view->set(["callback" => $callback], $data, $sort, "callback");
114		$view->setDI($this->di);
115		$this->views[$region][] = $view;
116
117		return $this;
118		}
119
120
121
122		/**
123		* Add a string as a view.
124		*
125		* @param string $content the content
126		* @param string $region which region to attach the view
127		* @param int $sort which order to display the views
128		*
129		* @return $this
130		*/
131	View Code Duplication	public function addString($content, $region = "main", $sort = 0)
		0 ignored issues – show Duplication introduced 2017-10-18 15:23 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...
132		{
133		$view = $this->di->get("view");
134		$view->set($content, [], $sort, "string");
135		$view->setDI($this->di);
136		$this->views[$region][] = $view;
137
138		return $this;
139		}
140
141
142
143		/**
144		* Check if a region has views to render.
145		*
146		* @param string $region which region to check
147		*
148		* @return $this
149		*/
150		public function hasContent($region)
151		{
152		return isset($this->views[$region]);
153		}
154
155
156
157		/**
158		* Render all views for a specific region.
159		*
160		* @param string $region which region to use
161		*
162		* @return $this
163		*/
164		public function render($region = "main")
165		{
166		if (!isset($this->views[$region])) {
167		return $this;
168		}
169
170		mergesort($this->views[$region], function ($a, $b) {
171		$sa = $a->sortOrder();
172		$sb = $b->sortOrder();
173
174		if ($sa == $sb) {
175		return 0;
176		}
177
178		return $sa < $sb ? -1 : 1;
179		});
180
181		foreach ($this->views[$region] as $view) {
182		$view->render();
183		}
184
185		return $this;
186		}
187		}
188

mosbth / anax

CViewContainer A last analyzed 2018-10-19 17:34 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

6 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

CViewContainer A
last analyzed 2018-10-19 17:34 UTC