View::set() - Code Metrics - Inspection of "Add view/anax/v2 for the blog." - canax/view - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4d76c2...8242e6 )

by Mikael

created 2018-12-03 20:55 UTC

View::set() B

↳ Parent: View

Complexity

Conditions	9
Paths	8

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	23
CRAP Score	9.4614

Importance

Changes

Metric	Value
cc	9
nc	8
nop	4
dl	0
loc	45
ccs	23
cts	28
cp	0.8214
crap	9.4614
rs	7.6444
c	0
b	0
f	0

<?php

namespace Anax\View;

use Anax\View\Exception;
use Anax\View\ViewRenderFile;
use Psr\Container\ContainerInterface;

/**
 * A view connected to a template file, supporting Anax DI.
 */
class View
{
    /**
     * @var $template     Template file or array
     * @var $templateData Data to send to template file
     * @var $sortOrder    For sorting views
     * @var $type         Type of view
     */
    private $template;
    private $templateData = [];
    private $sortOrder;
    private $type;



    /**
     * Set values for the view.
     *
     * @param array|string|callable $template the template file, array
     *                                        or callable
     * @param array        $data     variables to make available to the
     *                               view, default is empty
     * @param integer      $sort     which order to display the views,
     *                               if suitable
     * @param string       $type     which type of view
     *
     * @return self
     */
    public function set($template, $data = [], $sort = 0, $type = "file")
    {
        if (empty($template)) {
            $type = "empty";
        } elseif (is_array($template)) {
            if (isset($template["callback"])) {
                $type = "callback";
                $this->template = $template["callback"];
            } else {
                $this->template = $template["template"];
            }

            $this->sortOrder = $template["sort"] ?? $sort;
            $this->type = $template["type"] ?? $type;

            // Merge data array
            $data1 = $template["data"] ?? [];
            if (empty($data)) {
                $this->templateData = $data1;
            } else if (empty($data1)) {
                $this->templateData = $data;
            } else {
                foreach ($data as $key => $val) {
                    if (is_array($val)) {
                        if (!array_key_exists($key, $data1)) {
                            $data1[$key] = [];
                        }
                        $data1[$key] = array_merge($data1[$key], $val);
                    } else {
                        $data1[$key] = $val;
                    }
                    $this->templateData = $data1;
                }
            }

            return;
        }

        $this->template     = $template;
        $this->templateData = $data;
        $this->sortOrder    = $sort;
        $this->type         = $type;

        return $this;
    }



    /**
     * Render the view by its type.
     *
     * @param object $di optional with access to the framework resources.
     *
     * @return void
     */
    public function render(ContainerInterface $di = null)
    {
        switch ($this->type) {
            case "file":
                if ($di->has("viewRenderFile")) {
                    $viewRender = $di->get("viewRenderFile");
function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
                } else {
                    $viewRender = new ViewRenderFile($di);

                    $viewRender->setDI($di);
function notNullable(stdClass $x) { }

// Unsafe
function withoutCheck(stdClass $x = null) {
    notNullable($x);
}

// Safe - Alternative 1: Adding Additional Type-Check
function withCheck(stdClass $x = null) {
    if ($x instanceof stdClass) {
        notNullable($x);
    }
}

// Safe - Alternative 2: Changing Parameter
function withNonNullableParam(stdClass $x) {
    notNullable($x);
}
                }
                $viewRender->render($this->template, $this->templateData);
                break;

            case "callback":
                if (!is_callable($this->template)) {
                    throw new Exception("View is expecting a valid callback, provided callback seems to not be a callable.");
                }
                echo call_user_func($this->template, $this->templateData);
                break;

            case "string":
                echo $this->template;
                break;

            case "empty":
                break;

            default:
                throw new Exception("Not a valid template type: '{$this->type}'.");
        }
    }



    /**
     * Give the sort order for this view.
     *
     * @return int
     */
    public function sortOrder()
    {
        return $this->sortOrder;
    }
}


1		<?php
2
3		namespace Anax\View;
4
5		use Anax\View\Exception;
6		use Anax\View\ViewRenderFile;
7		use Psr\Container\ContainerInterface;
8
9		/**
10		* A view connected to a template file, supporting Anax DI.
11		*/
12		class View
13		{
14		/**
15		* @var $template Template file or array
16		* @var $templateData Data to send to template file
17		* @var $sortOrder For sorting views
18		* @var $type Type of view
19		*/
20		private $template;
21		private $templateData = [];
22		private $sortOrder;
23		private $type;
24
25
26
27		/**
28		* Set values for the view.
29		*
30		* @param array\|string\|callable $template the template file, array
31		* or callable
32		* @param array $data variables to make available to the
33		* view, default is empty
34		* @param integer $sort which order to display the views,
35		* if suitable
36		* @param string $type which type of view
37		*
38		* @return self
39		*/
40	6	public function set($template, $data = [], $sort = 0, $type = "file")
41		{
42	6	if (empty($template)) {
43		$type = "empty";
44	6	} elseif (is_array($template)) {
45	2	if (isset($template["callback"])) {
46	2	$type = "callback";
47	2	$this->template = $template["callback"];
48		} else {
49		$this->template = $template["template"];
50		}
51
52	2	$this->sortOrder = $template["sort"] ?? $sort;
53	2	$this->type = $template["type"] ?? $type;
54
55		// Merge data array
56	2	$data1 = $template["data"] ?? [];
57	2	if (empty($data)) {
58		$this->templateData = $data1;
59	2	} else if (empty($data1)) {
60		$this->templateData = $data;
61		} else {
62	2	foreach ($data as $key => $val) {
63	2	if (is_array($val)) {
64	1	if (!array_key_exists($key, $data1)) {
65		$data1[$key] = [];
66		}
67	1	$data1[$key] = array_merge($data1[$key], $val);
68		} else {
69	2	$data1[$key] = $val;
70		}
71	2	$this->templateData = $data1;
72		}
73		}
74
75	2	return;
76		}
77
78	4	$this->template = $template;
79	4	$this->templateData = $data;
80	4	$this->sortOrder = $sort;
81	4	$this->type = $type;
82
83	4	return $this;
84		}
85
86
87
88		/**
89		* Render the view by its type.
90		*
91		* @param object $di optional with access to the framework resources.
92		*
93		* @return void
94		*/
95	6	public function render(ContainerInterface $di = null)
96		{
97	6	switch ($this->type) {
98		case "file":
99		if ($di->has("viewRenderFile")) {
100		$viewRender = $di->get("viewRenderFile");
		0 ignored issues – show Bug introduced 2017-09-12 21:06 UTC by Report Bug Copy Issue Report It seems like `$di` is not always an object, but can also be of type `null`. Maybe add an additional type check? If a variable is not always an object, we recommend to add an additional type check to ensure your method call is safe: function someFunction(A $objectMaybe = null) { if ($objectMaybe instanceof A) { $objectMaybe->doSomething(); } } Loading history...
101		} else {
102		$viewRender = new ViewRenderFile($di);
		0 ignored issues – show Unused Code introduced 2018-08-09 12:53 UTC by Report Bug Copy Issue Report The call to `ViewRenderFile::__construct()` has too many arguments starting with `$di`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
103		$viewRender->setDI($di);
		0 ignored issues – show Bug introduced 2018-08-09 12:53 UTC by Report Bug Copy Issue Report It seems like `$di` defined by parameter `$di` on line `95` can be `null`; however, `Anax\Commons\ContainerInjectableTrait::setDI()` does not accept `null`, maybe add an additional type check? It seems like you allow that null is being passed for a parameter, however the function which is called does not seem to accept null. We recommend to add an additional type check (or disallow null for the parameter): function notNullable(stdClass $x) { } // Unsafe function withoutCheck(stdClass $x = null) { notNullable($x); } // Safe - Alternative 1: Adding Additional Type-Check function withCheck(stdClass $x = null) { if ($x instanceof stdClass) { notNullable($x); } } // Safe - Alternative 2: Changing Parameter function withNonNullableParam(stdClass $x) { notNullable($x); } Loading history...
104		}
105		$viewRender->render($this->template, $this->templateData);
106		break;
107
108		case "callback":
109	4	if (!is_callable($this->template)) {
110		throw new Exception("View is expecting a valid callback, provided callback seems to not be a callable.");
111		}
112	4	echo call_user_func($this->template, $this->templateData);
113	4	break;
114
115		case "string":
116	1	echo $this->template;
117	1	break;
118
119		case "empty":
120		break;
121
122		default:
123	1	throw new Exception("Not a valid template type: '{$this->type}'.");
124		}
125	5	}
126
127
128
129		/**
130		* Give the sort order for this view.
131		*
132		* @return int
133		*/
134		public function sortOrder()
135		{
136		return $this->sortOrder;
137		}
138		}
139

canax / view

Push — master ( 4d76c2...8242e6 )

View::set() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like