CViewHelper - Code Metrics - Inspection of "[WIP] Sequencer to replace regular expressions" - TYPO3/Fluid - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#457)

by Claus

created 2019-06-03 11:15 UTC

CViewHelper A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	34
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Importance

Changes

Metric	Value
dl	0
loc	34
rs	10
c	0
b	0
f	0
wmc	4
lcom	0
cbo	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	initializeArguments()	0	10	1
A	renderStatic()	0	16	3

<?php
namespace TYPO3Fluid\Fluid\ViewHelpers;

/*
 * This file belongs to the package "TYPO3 Fluid".
 * See LICENSE.txt that was shipped with this package.
 */

use TYPO3Fluid\Fluid\Core\Parser\SyntaxTree\ViewHelperNode;
use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
use TYPO3Fluid\Fluid\Core\Variables\VariableProviderInterface;
use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;

class CViewHelper extends AbstractViewHelper
{
    protected $escapeChildren = false;

    protected $escapeOutput = false;

    public function initializeArguments()
    {
        $this->registerArgument('s', 'string', 'A string argument');
        $this->registerArgument('i', 'int', 'An integer argument');
        $this->registerArgument('f', 'float', 'A float argument');
        $this->registerArgument('b', 'bool', 'A boolean argument');
        $this->registerArgument('a', 'array', 'An array argument');
        $this->registerArgument('dt', \DateTime::class, 'A DateTime object argument');
        $this->registerArgument('return', 'bool', 'Return the arguments array, do not encode');
    }

    public static function renderStatic(array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)
    {
        $data = [
            'string' => $arguments['s'],
            'int' => $arguments['i'],
            'float' => $arguments['f'],
            'bool' => $arguments['b'],
            'array' => $arguments['a'],
            'datetime' => ($arguments['dt'] instanceof \DateTime ? $arguments['dt']->format('U') : null),
            'child' => $renderChildrenClosure(),
        ];
        if ($arguments['return']) {
            return $data;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }
        return json_encode($data, JSON_PRETTY_PRINT);
    }
}

1			<?php
2			namespace TYPO3Fluid\Fluid\ViewHelpers;
3
4			/*
5			* This file belongs to the package "TYPO3 Fluid".
6			* See LICENSE.txt that was shipped with this package.
7			*/
8
9			use TYPO3Fluid\Fluid\Core\Parser\SyntaxTree\ViewHelperNode;
10			use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
11			use TYPO3Fluid\Fluid\Core\Variables\VariableProviderInterface;
12			use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
13
14			class CViewHelper extends AbstractViewHelper
15			{
16			protected $escapeChildren = false;
17
18			protected $escapeOutput = false;
19
20			public function initializeArguments()
21			{
22			$this->registerArgument('s', 'string', 'A string argument');
23			$this->registerArgument('i', 'int', 'An integer argument');
24			$this->registerArgument('f', 'float', 'A float argument');
25			$this->registerArgument('b', 'bool', 'A boolean argument');
26			$this->registerArgument('a', 'array', 'An array argument');
27			$this->registerArgument('dt', \DateTime::class, 'A DateTime object argument');
28			$this->registerArgument('return', 'bool', 'Return the arguments array, do not encode');
29			}
30
31			public static function renderStatic(array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)
32			{
33			$data = [
34			'string' => $arguments['s'],
35			'int' => $arguments['i'],
36			'float' => $arguments['f'],
37			'bool' => $arguments['b'],
38			'array' => $arguments['a'],
39			'datetime' => ($arguments['dt'] instanceof \DateTime ? $arguments['dt']->format('U') : null),
40			'child' => $renderChildrenClosure(),
41			];
42			if ($arguments['return']) {
43			return $data;
			0 ignored issues – show Bug Best Practice introduced 2019-05-31 19:29 UTC by Report Bug Copy Issue Report The return type of `return $data;` (`array`) is incompatible with the return type declared by the interface `TYPO3Fluid\Fluid\Core\Vi...Interface::renderStatic` of type `string`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
44			}
45			return json_encode($data, JSON_PRETTY_PRINT);
46			}
47			}

TYPO3 / Fluid

Pull Request — master (#457)

CViewHelper A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

2 Methods

Duplication Side-by-Side

Filter issues like