CViewContainerBasic::setFileSuffix() - Code Metrics - mosbth/Anax-MVC - Measure and Improve Code Quality continuously with Scrutinizer

CViewContainerBasic::setFileSuffix() A
last analyzed 2016-05-12 12:16 UTC

↳ Parent: CViewContainerBasic

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

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

<?php

namespace Anax\View;

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



    /**
     * Properties
     *
     */
    private $views = []; // Array for all views
    private $suffix;     // Template file suffix
    private $path;       // Base path for views



    /**
     * 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)
    {
        $view = $this->di->get('view');

        if (is_string($template)) {
            $tpl = $this->path . $template . $this->suffix;
            $type = 'file';
        } elseif (is_array($template)) {
            $tpl = $template;
            $type = 'callback';
        }

        $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;
    }



    /**
     * Set the suffix of the template files to include.
     *
     * @param string $suffix file suffix of template files, append to filenames for template files
     *
     * @return $this
     */
    public function setFileSuffix($suffix)
    {
        $this->suffix = $suffix;
    }


    /**
     * Set base path where  to find views.
     *
     * @param string $path where all views reside
     *
     * @return $this
     * @throws \Exception
     */
    public function setBasePath($path)

    {
        if (!is_dir($path)) {
            throw new \Exception("Base path for views is not a directory: " . $path);
        }
        $this->path = rtrim($path, '/') . '/';
    }



    /**
     * 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 CViewContainerBasic implements \Anax\DI\IInjectionAware
10		{
11		use \Anax\DI\TInjectionAware;
12
13
14
15		/**
16		* Properties
17		*
18		*/
19		private $views = []; // Array for all views
20		private $suffix; // Template file suffix
21		private $path; // Base path for views
22
23
24
25		/**
26		* Add a view to be included as a template file.
27		*
28		* @param string $template the name of the template file to include
29		* @param array $data variables to make available to the view, default is empty
30		* @param string $region which region to attach the view
31		* @param int $sort which order to display the views
32		*
33		* @return $this
34		*/
35		public function add($template, $data = [], $region = 'main', $sort = 0)
36		{
37		$view = $this->di->get('view');
38
39		if (is_string($template)) {
40		$tpl = $this->path . $template . $this->suffix;
41		$type = 'file';
42		} elseif (is_array($template)) {
43		$tpl = $template;
44		$type = 'callback';
45		}
46
47		$view->set($tpl, $data, $sort, $type);
		0 ignored issues – show Bug introduced 2015-11-29 16:29 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-11-29 16:29 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...
48		$view->setDI($this->di);
49		$this->views[$region][] = $view;
50
51		return $this;
52		}
53
54
55
56		/**
57		* Add a callback to be rendered as a view.
58		*
59		* @param string $callback function to call to get the content of the view
60		* @param array $data variables to make available to the view, default is empty
61		* @param string $region which region to attach the view
62		* @param int $sort which order to display the views
63		*
64		* @return $this
65		*/
66	View Code Duplication	public function addCallback($callback, $data = [], $region = 'main', $sort = 0)
		0 ignored issues – show Duplication introduced 2015-11-29 16:29 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...
67		{
68		$view = $this->di->get('view');
69
70		$view->set(['callback' => $callback], $data, $sort, 'callback');
71		$view->setDI($this->di);
72		$this->views[$region][] = $view;
73
74		return $this;
75		}
76
77
78
79		/**
80		* Add a string as a view.
81		*
82		* @param string $content the content
83		* @param string $region which region to attach the view
84		* @param int $sort which order to display the views
85		*
86		* @return $this
87		*/
88	View Code Duplication	public function addString($content, $region = 'main', $sort = 0)
		0 ignored issues – show Duplication introduced 2015-11-29 16:29 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...
89		{
90		$view = $this->di->get('view');
91		$view->set($content, [], $sort, 'string');
92		$view->setDI($this->di);
93		$this->views[$region][] = $view;
94
95		return $this;
96		}
97
98
99
100		/**
101		* Set the suffix of the template files to include.
102		*
103		* @param string $suffix file suffix of template files, append to filenames for template files
104		*
105		* @return $this
106		*/
107		public function setFileSuffix($suffix)
108		{
109		$this->suffix = $suffix;
110		}
111
112
113		/**
114		* Set base path where to find views.
115		*
116		* @param string $path where all views reside
117		*
118		* @return $this
119		* @throws \Exception
120		*/
121	View Code Duplication	public function setBasePath($path)
		0 ignored issues – show Duplication introduced 2015-11-29 16:29 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...
122		{
123		if (!is_dir($path)) {
124		throw new \Exception("Base path for views is not a directory: " . $path);
125		}
126		$this->path = rtrim($path, '/') . '/';
127		}
128
129
130
131		/**
132		* Check if a region has views to render.
133		*
134		* @param string $region which region to check
135		*
136		* @return $this
137		*/
138		public function hasContent($region)
139		{
140		return isset($this->views[$region]);
141		}
142
143
144
145		/**
146		* Render all views for a specific region.
147		*
148		* @param string $region which region to use
149		*
150		* @return $this
151		*/
152		public function render($region = 'main')
153		{
154		if (!isset($this->views[$region])) {
155		return $this;
156		}
157
158		mergesort($this->views[$region], function ($a, $b) {
159		$sa = $a->sortOrder();
160		$sb = $b->sortOrder();
161
162		if ($sa == $sb) {
163		return 0;
164		}
165
166		return $sa < $sb ? -1 : 1;
167		});
168
169		foreach ($this->views[$region] as $view) {
170		$view->render();
171		}
172
173		return $this;
174		}
175		}
176

mosbth / Anax-MVC

CViewContainerBasic::setFileSuffix() A last analyzed 2016-05-12 12:16 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

CViewContainerBasic::setFileSuffix() A
last analyzed 2016-05-12 12:16 UTC