ExtendViewHelper - Code Metrics - Inspection of "[!!!] DO NOT MERGE - Fluid 3.0 diff" - TYPO3/Fluid - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#470)

by Claus

created 2019-09-08 13:03 UTC

ExtendViewHelper A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	35
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

Metric	Value
dl	0
loc	35
rs	10
c	0
b	0
f	0
wmc	5
lcom	1
cbo	5

4 Methods

Rating	Name	Size	Complexity
A	initializeArguments()	4	1
A	evaluate()	4	1
A	onOpen()	10	2
A	getAtom()	4	1

<?php
declare(strict_types=1);
namespace TYPO3Fluid\Fluid\ViewHelpers;

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

use TYPO3Fluid\Fluid\Component\ComponentInterface;
use TYPO3Fluid\Fluid\Component\TransparentComponentInterface;
use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;

/**
 * Makes a template extend from an Atom identified by name.
 *
 * Extending from an Atom means:
 *
 * 1) Sections from the Atom are imported to current template
 * 2) Any body content in the Atom which is *not* enclosed in
 *    a section is imported at the place where this ViewHelper
 *    is used.
 * 3) Sections contained within the Atom technically do not
 *    exist *before* this ViewHelper is used, in terms of
 *    parsing sequence (order matters).
 * 4) Any embedded documentation from the extended Atom becomes
 *    the documentation for this template (but can be overwritten).
 *
 * Note that sections from the Atom can then both be extracted
 * from the template importing it, and the template can overwrite
 * any sections coming from the Atom by simply declaring a new
 * section of the same name, after the f:extends usage.
 */
class ExtendViewHelper extends AbstractViewHelper implements TransparentComponentInterface
{
    protected $escapeOutput = false;

    /**
     * @var ComponentInterface|null
     */
    protected $atom;

    public function initializeArguments()
    {
        $this->registerArgument('atom', 'string', 'Name of Atom to extend', true);
    }

    public function evaluate(RenderingContextInterface $renderingContext)
    {
        return null;
    }

    public function onOpen(RenderingContextInterface $renderingContext): ComponentInterface
    {
        list ($namespace, $atomName) = explode(':', $this->getArguments()->setRenderingContext($renderingContext)['atom']);
        $atom = $renderingContext->getViewHelperResolver()->resolveAtom($namespace, $atomName);
        foreach ($atom->getChildren() as $child) {
            $this->addChild($child);
        }
        $this->atom = $atom;
        return parent::onOpen($renderingContext);
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());
}
    }

    public function getAtom(): ?ComponentInterface
    {
        return $this->atom;
    }
}


1			<?php
2			declare(strict_types=1);
3			namespace TYPO3Fluid\Fluid\ViewHelpers;
4
5			/*
6			* This file belongs to the package "TYPO3 Fluid".
7			* See LICENSE.txt that was shipped with this package.
8			*/
9
10			use TYPO3Fluid\Fluid\Component\ComponentInterface;
11			use TYPO3Fluid\Fluid\Component\TransparentComponentInterface;
12			use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
13			use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
14
15			/**
16			* Makes a template extend from an Atom identified by name.
17			*
18			* Extending from an Atom means:
19			*
20			* 1) Sections from the Atom are imported to current template
21			* 2) Any body content in the Atom which is not enclosed in
22			* a section is imported at the place where this ViewHelper
23			* is used.
24			* 3) Sections contained within the Atom technically do not
25			* exist before this ViewHelper is used, in terms of
26			* parsing sequence (order matters).
27			* 4) Any embedded documentation from the extended Atom becomes
28			* the documentation for this template (but can be overwritten).
29			*
30			* Note that sections from the Atom can then both be extracted
31			* from the template importing it, and the template can overwrite
32			* any sections coming from the Atom by simply declaring a new
33			* section of the same name, after the f:extends usage.
34			*/
35			class ExtendViewHelper extends AbstractViewHelper implements TransparentComponentInterface
36			{
37			protected $escapeOutput = false;
38
39			/**
40			* @var ComponentInterface\|null
41			*/
42			protected $atom;
43
44			public function initializeArguments()
45			{
46			$this->registerArgument('atom', 'string', 'Name of Atom to extend', true);
47			}
48
49			public function evaluate(RenderingContextInterface $renderingContext)
50			{
51			return null;
52			}
53
54			public function onOpen(RenderingContextInterface $renderingContext): ComponentInterface
55			{
56			list ($namespace, $atomName) = explode(':', $this->getArguments()->setRenderingContext($renderingContext)['atom']);
57			$atom = $renderingContext->getViewHelperResolver()->resolveAtom($namespace, $atomName);
58			foreach ($atom->getChildren() as $child) {
59			$this->addChild($child);
60			}
61			$this->atom = $atom;
62			return parent::onOpen($renderingContext);
			0 ignored issues – show Bug Best Practice introduced 2019-08-25 13:04 UTC by Report Bug Copy Issue Report The return type of `return parent::onOpen($renderingContext);` (`TYPO3Fluid\Fluid\ViewHelpers\ExtendViewHelper`) is incompatible with the return type declared by the interface `TYPO3Fluid\Fluid\Compone...ponentInterface::onOpen` of type `self`. 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...
63			}
64
65			public function getAtom(): ?ComponentInterface
66			{
67			return $this->atom;
68			}
69			}
70

TYPO3 / Fluid

Pull Request — master (#470)

ExtendViewHelper A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

4 Methods

Duplication Side-by-Side

Filter issues like