Renderer::share() - Code Metrics - Inspection of "Moved the session class." - jaxon-php/jaxon-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 0602c9...8f96ba )

by Thierry

created 2022-02-21 07:05 UTC

Renderer::share() A

↳ Parent: Renderer

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php


namespace Jaxon\Ui\View;

class Renderer

{
    /**
     * The view data store
     *
     * @var Store
     */
    protected $xStore = null;


    /**
     * The view global data
     *
     * @var array
     */
    protected $aViewData = [];

    /**
     * The view manager
     *
     * @var Manager
     */
    protected $xManager;

    /**

     * The constructor
     */
    public function __construct(Manager $xManager)

    {
        $this->xManager = $xManager;
    }


    /**
     * Get the current store or create a new store
     *
     * @return Store
     */
    protected function store()
    {
        if(!$this->xStore)
        {
            $this->xStore = new Store();
        }
        return $this->xStore;
    }


    /**
     * Make a piece of data available for the rendered view
     *
     * @param string        $name            The data name

     * @param string        $value           The data value

     *
     * @return Renderer
     */
    public function set($name, $value)
    {
        $this->store()->with($name, $value);
        return $this;
    }


    /**
     * Make a piece of data available for all views
     *
     * @param string        $name            The data name

     * @param string        $value           The data value

     *
     * @return Renderer
     */
    public function share($name, $value)
    {
        $this->aViewData[$name] = $value;
        return $this;
    }


    /**
     * Make an array of data available for all views
     *
     * @param array         $values          The data values

     *
     * @return Renderer
     */
    public function shareValues(array $values)
    {
        foreach($values as $name => $value)
        {
            $this->share($name, $value);
        }
        return $this;
    }


    /**
     * Render a view using a store
     *
     * The store returned by this function will later be used with the make() method to render the view.
     *
     * @param string        $sViewName        The view name

     * @param array         $aViewData        The view data

     *
     * @return null|Store   A store populated with the view data
     */
    public function render($sViewName, array $aViewData = [])
    {
        // Get the store
        $xStore = $this->store();

        // Get the default view namespace
        $sNamespace = $this->xManager->getDefaultNamespace();
        // Get the namespace from the view name
        $iSeparatorPosition = strrpos($sViewName, '::');
        if($iSeparatorPosition !== false)
        {
            $sNamespace = substr($sViewName, 0, $iSeparatorPosition);
        }

        $xRenderer = $this->xManager->getNamespaceRenderer($sNamespace);
        if(!$xRenderer)
        {
            // Cannot render a view if there's no renderer corresponding to the namespace.
            return null;
        }

        $xStore->setData(\array_merge($this->aViewData, $aViewData))
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
            ->setView($xRenderer, $sNamespace, $sViewName);

        // Set the store to null so a new store will be created for the next view.
        $this->xStore = null;
        // Return the store
        return $xStore;
    }

}


1			<?php
2
			0 ignored issues – show Coding Style introduced 2022-02-21 07:07 UTC by Report Bug Copy Issue Report Missing file doc comment Loading history...
3			namespace Jaxon\Ui\View;
4
5			class Renderer
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Missing doc comment for class Renderer Loading history...
6			{
7			/**
8			* The view data store
9			*
10			* @var Store
11			*/
12			protected $xStore = null;
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Expected 1 blank line(s) before first member var; 0 found Loading history...
13
14			/**
15			* The view global data
16			*
17			* @var array
18			*/
19			protected $aViewData = [];
20
21			/**
22			* The view manager
23			*
24			* @var Manager
25			*/
26			protected $xManager;
27
28			/**
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Parameter `$xManager` should have a doc-comment as per coding-style. Loading history...
29			* The constructor
30			*/
31			public function __construct(Manager $xManager)
			0 ignored issues – show Coding Style introduced 2019-12-07 05:40 UTC by Report Bug Copy Issue Report Expected 2 blank lines before function; 1 found Loading history...
32			{
33			$this->xManager = $xManager;
34			}
			0 ignored issues – show Coding Style introduced 2019-12-07 05:40 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
35
36			/**
37			* Get the current store or create a new store
38			*
39			* @return Store
40			*/
41			protected function store()
42			{
43			if(!$this->xStore)
44			{
45			$this->xStore = new Store();
46			}
47			return $this->xStore;
48			}
			0 ignored issues – show Coding Style introduced 2019-12-07 05:40 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
49
50			/**
51			* Make a piece of data available for the rendered view
52			*
53			* @param string $name The data name
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter type; 8 found Loading history... Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Expected 2 spaces after parameter name; 12 found Loading history...
54			* @param string $value The data value
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter type; 8 found Loading history... Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter name; 11 found Loading history...
55			*
56			* @return Renderer
57			*/
58			public function set($name, $value)
59			{
60			$this->store()->with($name, $value);
61			return $this;
62			}
			0 ignored issues – show Coding Style introduced 2019-12-07 05:40 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
63
64			/**
65			* Make a piece of data available for all views
66			*
67			* @param string $name The data name
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter type; 8 found Loading history... Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Expected 2 spaces after parameter name; 12 found Loading history...
68			* @param string $value The data value
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter name; 11 found Loading history... Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter type; 8 found Loading history...
69			*
70			* @return Renderer
71			*/
72			public function share($name, $value)
73			{
74			$this->aViewData[$name] = $value;
75			return $this;
76			}
			0 ignored issues – show Coding Style introduced 2022-02-21 07:07 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
77
78			/**
79			* Make an array of data available for all views
80			*
81			* @param array $values The data values
			0 ignored issues – show Coding Style introduced 2021-08-14 14:59 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter name; 10 found Loading history... Coding Style introduced 2021-08-14 14:59 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter type; 9 found Loading history...
82			*
83			* @return Renderer
84			*/
85			public function shareValues(array $values)
86			{
87			foreach($values as $name => $value)
88			{
89			$this->share($name, $value);
90			}
91			return $this;
92			}
			0 ignored issues – show Coding Style introduced 2021-08-14 14:59 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
93
94			/**
95			* Render a view using a store
96			*
97			* The store returned by this function will later be used with the make() method to render the view.
98			*
99			* @param string $sViewName The view name
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter name; 8 found Loading history... Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter type; 8 found Loading history...
100			* @param array $aViewData The view data
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Expected 2 spaces after parameter type; 9 found Loading history... Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter name; 8 found Loading history...
101			*
102			* @return null\|Store A store populated with the view data
103			*/
104			public function render($sViewName, array $aViewData = [])
105			{
106			// Get the store
107			$xStore = $this->store();
108
109			// Get the default view namespace
110			$sNamespace = $this->xManager->getDefaultNamespace();
111			// Get the namespace from the view name
112			$iSeparatorPosition = strrpos($sViewName, '::');
113			if($iSeparatorPosition !== false)
114			{
115			$sNamespace = substr($sViewName, 0, $iSeparatorPosition);
116			}
117
118			$xRenderer = $this->xManager->getNamespaceRenderer($sNamespace);
119			if(!$xRenderer)
120			{
121			// Cannot render a view if there's no renderer corresponding to the namespace.
122			return null;
123			}
124
125			$xStore->setData(\array_merge($this->aViewData, $aViewData))
			0 ignored issues – show Bug introduced 2022-02-21 07:07 UTC by Report Bug Copy Issue Report Are you sure the usage of `$xStore->setData(array_m...aViewData, $aViewData))` targeting `Jaxon\Ui\View\Store::setData()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
126			->setView($xRenderer, $sNamespace, $sViewName);
			0 ignored issues – show Coding Style introduced 2021-08-14 14:59 UTC by Report Bug Copy Issue Report Space found before object operator Loading history...
127			// Set the store to null so a new store will be created for the next view.
128			$this->xStore = null;
129			// Return the store
130			return $xStore;
131			}
			0 ignored issues – show Coding Style introduced 2019-12-07 05:40 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 0 found Loading history...
132			}
133

jaxon-php / jaxon-core

Push — master ( 0602c9...8f96ba )

Renderer::share() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like