IsBoostedFieldViewHelper::evaluateCondition() - Code Metrics - Inspection of "[TASK] Move all backend related ViewHelpers to Bac..." - TYPO3-Solr/ext-solr - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#1329)

by Timo

created 2017-06-17 05:22 UTC

IsBoostedFieldViewHelper::evaluateCondition() A

↳ Parent: IsBoostedFieldViewHelper

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1.064

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	6
ccs	3
cts	5
cp	0.6
rs	9.4285
cc	1
eloc	3
nc	1
nop	1
crap	1.064

<?php
namespace ApacheSolrForTypo3\Solr\ViewHelpers\Backend\Document;

/***************************************************************
 *  Copyright notice
 *
 *  (c) 2017 Rafael Kähm <[email protected]>
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project is
 *  free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
 *
 *  This script is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/


use TYPO3\CMS\Fluid\Core\ViewHelper\AbstractConditionViewHelper;

/**
 * Condition for checking if type is a string.
 */
class IsBoostedFieldViewHelper extends AbstractConditionViewHelper
{

    /**
     * Initialize ViewHelper arguments
     *
     * @return void
     */
    public function initializeArguments()
    {
        parent::initializeArguments();
        $this->registerArgument('fieldName', 'string', 'Fieldname to be verified.', true);
        $this->registerArgument('document', '\Apache_Solr_Document', '\Apache_Solr_Document to be verified.', true);
    }

    /**
     * This method decides if the condition is true or false
     *
     * @param array $arguments ViewHelper arguments to evaluate the condition for this ViewHelper.
     * @return bool
     */
    protected static function evaluateCondition($arguments = null)
    {
        /* @var $document \Apache_Solr_Document */
        $document = $arguments['document'];
        return $document->getFieldBoost($arguments['fieldName']);
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());
}
    }
}


1		<?php
2		namespace ApacheSolrForTypo3\Solr\ViewHelpers\Backend\Document;
3
4		/***************************************************************
5		* Copyright notice
6		*
7		* (c) 2017 Rafael Kähm <[email protected]>
8		* All rights reserved
9		*
10		* This script is part of the TYPO3 project. The TYPO3 project is
11		* free software; you can redistribute it and/or modify
12		* it under the terms of the GNU General Public License as published by
13		* the Free Software Foundation; either version 2 of the License, or
14		* (at your option) any later version.
15		*
16		* The GNU General Public License can be found at
17		* http://www.gnu.org/copyleft/gpl.html.
18		*
19		* This script is distributed in the hope that it will be useful,
20		* but WITHOUT ANY WARRANTY; without even the implied warranty of
21		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22		* GNU General Public License for more details.
23		*
24		* This copyright notice MUST APPEAR in all copies of the script!
25		***************************************************************/
26
27
28		use TYPO3\CMS\Fluid\Core\ViewHelper\AbstractConditionViewHelper;
29
30		/**
31		* Condition for checking if type is a string.
32		*/
33		class IsBoostedFieldViewHelper extends AbstractConditionViewHelper
34		{
35
36		/**
37		* Initialize ViewHelper arguments
38		*
39		* @return void
40		*/
41	2	public function initializeArguments()
42		{
43	2	parent::initializeArguments();
44	2	$this->registerArgument('fieldName', 'string', 'Fieldname to be verified.', true);
45	2	$this->registerArgument('document', '\Apache_Solr_Document', '\Apache_Solr_Document to be verified.', true);
46	2	}
47
48		/**
49		* This method decides if the condition is true or false
50		*
51		* @param array $arguments ViewHelper arguments to evaluate the condition for this ViewHelper.
52		* @return bool
53		*/
54	2	protected static function evaluateCondition($arguments = null)
55		{
56		/* @var $document \Apache_Solr_Document */
57	2	$document = $arguments['document'];
58	2	return $document->getFieldBoost($arguments['fieldName']);
		0 ignored issues – show Bug Best Practice introduced 2017-04-07 13:51 UTC by Report Bug Copy Issue Report The return type of `return $document->getFie...rguments['fieldName']);` (`double`) is incompatible with the return type of the parent method `TYPO3Fluid\Fluid\Core\Vi...lper::evaluateCondition` of type `boolean`. 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...
59		}
60		}
61

TYPO3-Solr / ext-solr

Pull Request — master (#1329)

IsBoostedFieldViewHelper::evaluateCondition() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like