AbstractView::setter() - Code Metrics - Inspection of "Add missing cssRequirements. Minor codestyle / com..." - locomotivemtl/charcoal-view - Measure and Improve Code Quality continuously with Scrutinizer

Test Setup Failed

Branch — master (6beec3)

by Mathieu

created 2016-02-24 02:05 UTC

AbstractView::setter() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	1	Features	0

Metric	Value
c	2
b	1
f	0
dl	0
loc	6
rs	9.4285
nc	1
cc	1
eloc	3
nop	1

<?php


namespace Charcoal\View;

// Dependencies from `PHP`
use \Exception;
use \InvalidArgumentException;

// PSR-3 (logger) dependencies
use \Psr\Log\LoggerAwareInterface;
use \Psr\Log\LoggerAwareTrait;

// Module `charcoal-config` dependencies
use \Charcoal\Config\ConfigurableInterface;
use \Charcoal\Config\ConfigurableTrait;

// Local namespace dependencies
use \Charcoal\View\Mustache\MustacheEngine;
use \Charcoal\View\Php\PhpEngine;
use \Charcoal\View\PhpMustache\PhpMustacheEngine;
use \Charcoal\View\Twig\TwigEngine;
use \Charcoal\View\ViewInterface;

/**
 * Base abstract class for _View_ interfaces, implements `ViewInterface`.
 *
 * Also implements the `ConfigurableInterface`
 */
abstract class AbstractView implements

    ConfigurableInterface,
    LoggerAwareInterface,
    ViewInterface
{
    use LoggerAwareTrait;
    use ConfigurableTrait;

    /**
     * @var string $templateIdent
     */
    private $templateIdent;

    /**
     * @var string $template
     */
    private $template;

    /**
     * @var EngineInterface $engine
     */
    private $engine;

    /**
     * @var mixed $context
     */
    private $context;

    /**
     * A view object can simply be echoed to be rendered.
     *
     * @return string
     */
    public function __toString()
    {
        return $this->renderTemplate();
    }

    /**
     * > ConfigurableTrait . createConfig()
     *
     * @param array $data
     * @return ViewConfig
     */
    public function createConfig(array $data = null)
    {
        $config = new ViewConfig();
        if ($data !== null) {
            $config->merge($data);
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
        }
        return $config;
    }

    /**
     * Set the engine (`EngineInterface`) dependency.
     *
     * @param EngineInterface $engine The
     * @return ViewInterface Chainable
     */
    public function setEngine(EngineInterface $engine)
    {
        $this->engine = $engine;
        return $this;
    }

    /**
     * Get the view's rendering engine instance.
     *
     * @throws Exception If the engine is accessed before it was properly set.
     * @return EngineInterface
     */
    public function engine()
    {
        if (!isset($this->engine)) {
            throw new Exception(
                'Engine must first be set on view, with `setEngine()`'
            );
        }
        return $this->engine;
    }

    /**
     * @param string $templateIdent
     * @throws InvalidArgumentException if the provided argument is not a string
     * @return AbstractView Chainable
     */
    public function setTemplateIdent($templateIdent)
    {
        if (!is_string($templateIdent)) {
            throw new InvalidArgumentException(
                'Template ident must be a string.'
            );
        }

        $this->templateIdent = $templateIdent;
        return $this;
    }

    /**
     * @return string
     */
    public function templateIdent()
    {
        return $this->templateIdent;
    }

    /**
     * @param string $template
     * @throws InvalidArgumentException if the provided argument is not a string
     * @return AbstractView Chainable
     */
    public function setTemplate($template)
    {
        if (!is_string($template)) {
            throw new InvalidArgumentException(
                'Template must be a string.'
            );
        }

        $this->template = $template;
        return $this;
    }

    /**
     * @return string
     */
    public function template()
    {
        if ($this->template === null) {
            return $this->loadTemplate();
        }

        return $this->template;
    }

    /**
     * @param string $templateIdent
     * @throws InvalidArgumentException
     * @return string
     */
    public function loadTemplate($templateIdent = null)
    {
        if ($templateIdent === null) {
            $templateIdent = $this->templateIdent();
        }
        if (!is_string($templateIdent)) {
            throw new InvalidArgumentException(
                'Template ident must be a string'
            );
        }
        if (!$templateIdent) {
            return '';
        }
        $template = $this->engine()->loadTemplate($templateIdent);
        return $template;
    }

    /**
     * Set the rendering context ("view controller").
     *
     * @param mixed $context The context / view controller to render the template with.
     * @return AbstractView Chainable
     */
    public function setContext($context)
    {
        $this->context = $context;
        return $this;
    }

    /**
     * Get the rendering context ("view controller").
     * @return mixed
     */
    public function context()
    {
        return $this->context;
    }

    /**
     * @param string $templateIdent Optional. The template identifier to load. If none then use instance's.
     * @param mixed  $context The rendering context.
     * @return string The rendered template string.
     */
    public function render($templateIdent = null, $context = null)

    {
        if ($templateIdent === null) {
            $templateIdent = $this->templateIdent();
        }
        if ($context === null) {
            $context = $this->context();
        }
        return $this->engine()->render($templateIdent, $context);
    }

    /**
     * @param string $templateString Optional. The template string to render. If none then load instance's.
     * @param mixed  $context The rendering context.
     * @return string The rendered template string.
     */
    public function renderTemplate($templateString = null, $context = null)

    {
        if ($templateString === null) {
            $templateString = $this->template();
        }
        if ($context === null) {
            $context = $this->context();
        }
        return $this->engine()->render($templateString, $context);
    }
}


1		<?php
		0 ignored issues – show Coding Style Compatibility introduced 2016-02-04 22:17 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 62 and the first side effect is on line 29. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2
3		namespace Charcoal\View;
4
5		// Dependencies from `PHP`
6		use \Exception;
7		use \InvalidArgumentException;
8
9		// PSR-3 (logger) dependencies
10		use \Psr\Log\LoggerAwareInterface;
11		use \Psr\Log\LoggerAwareTrait;
12
13		// Module `charcoal-config` dependencies
14		use \Charcoal\Config\ConfigurableInterface;
15		use \Charcoal\Config\ConfigurableTrait;
16
17		// Local namespace dependencies
18		use \Charcoal\View\Mustache\MustacheEngine;
19		use \Charcoal\View\Php\PhpEngine;
20		use \Charcoal\View\PhpMustache\PhpMustacheEngine;
21		use \Charcoal\View\Twig\TwigEngine;
22		use \Charcoal\View\ViewInterface;
23
24		/**
25		* Base abstract class for _View_ interfaces, implements `ViewInterface`.
26		*
27		* Also implements the `ConfigurableInterface`
28		*/
29		abstract class AbstractView implements
		0 ignored issues – show Bug introduced 2016-02-04 22:17 UTC by Report Bug Copy Issue Report Possible parse error: class missing opening or closing brace Loading history...
30		ConfigurableInterface,
31		LoggerAwareInterface,
32		ViewInterface
33		{
34		use LoggerAwareTrait;
35		use ConfigurableTrait;
36
37		/**
38		* @var string $templateIdent
39		*/
40		private $templateIdent;
41
42		/**
43		* @var string $template
44		*/
45		private $template;
46
47		/**
48		* @var EngineInterface $engine
49		*/
50		private $engine;
51
52		/**
53		* @var mixed $context
54		*/
55		private $context;
56
57		/**
58		* A view object can simply be echoed to be rendered.
59		*
60		* @return string
61		*/
62		public function __toString()
63		{
64		return $this->renderTemplate();
65		}
66
67		/**
68		* > ConfigurableTrait . createConfig()
69		*
70		* @param array $data
71		* @return ViewConfig
72		*/
73		public function createConfig(array $data = null)
74		{
75		$config = new ViewConfig();
76		if ($data !== null) {
77		$config->merge($data);
		0 ignored issues – show Unused Code introduced 2016-02-04 22:17 UTC by Report Bug Copy Issue Report The call to the method `Charcoal\View\ViewConfig::merge()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
78		}
79		return $config;
80		}
81
82		/**
83		* Set the engine (`EngineInterface`) dependency.
84		*
85		* @param EngineInterface $engine The
86		* @return ViewInterface Chainable
87		*/
88		public function setEngine(EngineInterface $engine)
89		{
90		$this->engine = $engine;
91		return $this;
92		}
93
94		/**
95		* Get the view's rendering engine instance.
96		*
97		* @throws Exception If the engine is accessed before it was properly set.
98		* @return EngineInterface
99		*/
100		public function engine()
101		{
102		if (!isset($this->engine)) {
103		throw new Exception(
104		'Engine must first be set on view, with `setEngine()`'
105		);
106		}
107		return $this->engine;
108		}
109
110		/**
111		* @param string $templateIdent
112		* @throws InvalidArgumentException if the provided argument is not a string
113		* @return AbstractView Chainable
114		*/
115		public function setTemplateIdent($templateIdent)
116		{
117		if (!is_string($templateIdent)) {
118		throw new InvalidArgumentException(
119		'Template ident must be a string.'
120		);
121		}
122
123		$this->templateIdent = $templateIdent;
124		return $this;
125		}
126
127		/**
128		* @return string
129		*/
130		public function templateIdent()
131		{
132		return $this->templateIdent;
133		}
134
135		/**
136		* @param string $template
137		* @throws InvalidArgumentException if the provided argument is not a string
138		* @return AbstractView Chainable
139		*/
140		public function setTemplate($template)
141		{
142		if (!is_string($template)) {
143		throw new InvalidArgumentException(
144		'Template must be a string.'
145		);
146		}
147
148		$this->template = $template;
149		return $this;
150		}
151
152		/**
153		* @return string
154		*/
155		public function template()
156		{
157		if ($this->template === null) {
158		return $this->loadTemplate();
159		}
160
161		return $this->template;
162		}
163
164		/**
165		* @param string $templateIdent
166		* @throws InvalidArgumentException
167		* @return string
168		*/
169		public function loadTemplate($templateIdent = null)
170		{
171		if ($templateIdent === null) {
172		$templateIdent = $this->templateIdent();
173		}
174		if (!is_string($templateIdent)) {
175		throw new InvalidArgumentException(
176		'Template ident must be a string'
177		);
178		}
179		if (!$templateIdent) {
180		return '';
181		}
182		$template = $this->engine()->loadTemplate($templateIdent);
183		return $template;
184		}
185
186		/**
187		* Set the rendering context ("view controller").
188		*
189		* @param mixed $context The context / view controller to render the template with.
190		* @return AbstractView Chainable
191		*/
192		public function setContext($context)
193		{
194		$this->context = $context;
195		return $this;
196		}
197
198		/**
199		* Get the rendering context ("view controller").
200		* @return mixed
201		*/
202		public function context()
203		{
204		return $this->context;
205		}
206
207		/**
208		* @param string $templateIdent Optional. The template identifier to load. If none then use instance's.
209		* @param mixed $context The rendering context.
210		* @return string The rendered template string.
211		*/
212	View Code Duplication	public function render($templateIdent = null, $context = null)
		0 ignored issues – show Duplication introduced 2016-02-04 22:17 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		if ($templateIdent === null) {
215		$templateIdent = $this->templateIdent();
216		}
217		if ($context === null) {
218		$context = $this->context();
219		}
220		return $this->engine()->render($templateIdent, $context);
221		}
222
223		/**
224		* @param string $templateString Optional. The template string to render. If none then load instance's.
225		* @param mixed $context The rendering context.
226		* @return string The rendered template string.
227		*/
228	View Code Duplication	public function renderTemplate($templateString = null, $context = null)
		0 ignored issues – show Duplication introduced 2016-02-04 22:17 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...
229		{
230		if ($templateString === null) {
231		$templateString = $this->template();
232		}
233		if ($context === null) {
234		$context = $this->context();
235		}
236		return $this->engine()->render($templateString, $context);
237		}
238		}
239

locomotivemtl / charcoal-view

Branch — master (6beec3)

AbstractView::setter() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like