EvaluateTask - Code Metrics - netresearch/kite - Measure and Improve Code Quality continuously with Scrutinizer

EvaluateTask A
last analyzed 2017-12-07 07:58 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	54
Duplicated Lines	20.37 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

Metric	Value
dl	11
loc	54
rs	10
c	0
b	0
f	0
wmc	5
lcom	1
cbo	3

3 Methods

Rating	Name	Duplication	Size	Complexity
A	configureVariables()	11	11	1
A	offsetSet()	0	7	2
A	execute()	0	7	2

How to fix Duplicated Code

<?php
/**
 * See class comment
 *
 * PHP Version 5
 *
 * @category   Netresearch
 * @package    Netresearch\Kite
 * @subpackage Task
 * @author     Christian Opitz <[email protected]>
 * @license    http://www.netresearch.de Netresearch Copyright
 * @link       http://www.netresearch.de
 */

namespace Netresearch\Kite\Task;
use Netresearch\Kite\Exception;
use Netresearch\Kite\Task;

/**
 * Evaluate an expression and return the result
 *
 * @category   Netresearch
 * @package    Netresearch\Kite
 * @subpackage Task
 * @author     Christian Opitz <[email protected]>
 * @license    http://www.netresearch.de Netresearch Copyright
 * @link       http://www.netresearch.de
 */
class EvaluateTask extends Task
{
    /**
     * @var string
     */
    protected $expression;

    /**
     * Configure the options
     *
     * @return array
     */
    protected function configureVariables()

    {
        return array(
class Author {
    private $name;

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

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

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

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

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

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
            'expression' => array(
                'type' => 'string',
                'required' => true,
                'label' => 'The question to ask'
            ),
            '--'
        ) + parent::configureVariables();
    }

    /**
     * Set a variable and it's value
     *
     * @param string $name  The variable name
     * @param mixed  $value The value
     *
     * @return $this
     */
    public function offsetSet($name, $value)
    {
        if ($name === 'expression') {
            $this->expression = $value;
        }
        parent::offsetSet($name, $value);
    }


    /**
     * Execute the task
     *
     * @return mixed
     */
    public function execute()
    {
        if (!$this->expression) {
            throw new Exception('Missing expression');
        }
        return $this->getParent()->expand('{' . $this->expression . '}');
    }
}
?>


1		<?php
2		/**
3		* See class comment
4		*
5		* PHP Version 5
6		*
7		* @category Netresearch
8		* @package Netresearch\Kite
9		* @subpackage Task
10		* @author Christian Opitz <[email protected]>
11		* @license http://www.netresearch.de Netresearch Copyright
12		* @link http://www.netresearch.de
13		*/
14
15		namespace Netresearch\Kite\Task;
16		use Netresearch\Kite\Exception;
17		use Netresearch\Kite\Task;
18
19		/**
20		* Evaluate an expression and return the result
21		*
22		* @category Netresearch
23		* @package Netresearch\Kite
24		* @subpackage Task
25		* @author Christian Opitz <[email protected]>
26		* @license http://www.netresearch.de Netresearch Copyright
27		* @link http://www.netresearch.de
28		*/
29		class EvaluateTask extends Task
30		{
31		/**
32		* @var string
33		*/
34		protected $expression;
35
36		/**
37		* Configure the options
38		*
39		* @return array
40		*/
41	View Code Duplication	protected function configureVariables()
		0 ignored issues – show Duplication introduced 2017-11-14 14:37 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...
42		{
43		return array(
		0 ignored issues – show Best Practice introduced 2016-03-18 14:36 UTC by Report Bug Copy Issue Report The expression `return array('expression...::configureVariables();` seems to be an `array`, but some of its elements' types (`string`) are incompatible with the return type of the parent method `Netresearch\Kite\Task::configureVariables` of type `array<string,array>`. 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 new Author('Johannes'); } } class BlogPost extends Post { public function getAuthor() { return '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		'expression' => array(
45		'type' => 'string',
46		'required' => true,
47		'label' => 'The question to ask'
48		),
49		'--'
50		) + parent::configureVariables();
51		}
52
53		/**
54		* Set a variable and it's value
55		*
56		* @param string $name The variable name
57		* @param mixed $value The value
58		*
59		* @return $this
60		*/
61		public function offsetSet($name, $value)
62		{
63		if ($name === 'expression') {
64		$this->expression = $value;
65		}
66		parent::offsetSet($name, $value);
67		}
68
69
70		/**
71		* Execute the task
72		*
73		* @return mixed
74		*/
75		public function execute()
76		{
77		if (!$this->expression) {
78		throw new Exception('Missing expression');
79		}
80		return $this->getParent()->expand('{' . $this->expression . '}');
81		}
82		}
83		?>
84

netresearch / kite

GitHub Access Token became invalid

EvaluateTask A last analyzed 2017-12-07 07:58 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like

EvaluateTask A
last analyzed 2017-12-07 07:58 UTC