LanguageConstruct - Code Metrics - Inspection of "removed Query::compile_var" - lechimp-p/dicto.php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 608de6...159902 )

by Richard

created 2016-05-28 20:23 UTC

LanguageConstruct A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	55
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

96%

Importance

Changes	4
Bugs	0	Features	1

Metric	Value
c	4
b	0
f	1
dl	0
loc	55
wmc	5
lcom	1
cbo	2
ccs	24
cts	25
cp	0.96
rs	10

4 Methods

Rating	Name	Size	Complexity
A	__construct()	6	1
A	construct_name()	3	1
A	id()	3	1
B	compile()	24	2

<?php
/******************************************************************************
 * An implementation of dicto (scg.unibe.ch/dicto) in and for PHP.
 *
 * Copyright (c) 2016 Richard Klees <[email protected]>
 *
 * This software is licensed under The MIT License. You should have received
 * a copy of the licence along with the code.
 */

namespace Lechimp\Dicto\Variables;

use Doctrine\DBAL\Query\Expression\ExpressionBuilder;

class LanguageConstruct extends Entities {
    /**
     * @var string
     */
    private $construct_name;

    public function __construct($name, $construct_name) {
        parent::__construct($name);
        assert('is_string($construct_name)');
        // TODO: Restrict the possible construct_names (like @, unset, echo, ...)

        $this->construct_name = $construct_name;     
    }

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

    /**
     * @inheritdoc
     */
    public function id() {
        return Variable::LANGUAGE_CONSTRUCT_TYPE;
    }

    /**
     * @inheritdocs
     */
    public function compile(ExpressionBuilder $builder, $table_name, $negate = false) {
        $type_expr = $this->eq_op
            ( $builder
            , "$table_name.type"
            , $builder->literal(Variable::LANGUAGE_CONSTRUCT_TYPE)
            , $negate
            );
        $name_expr = $this->eq_op
            ( $builder
            , "$table_name.name"
            , $builder->literal($this->construct_name())
            , $negate
            );

        // normal case : language construct and name matches
        if (!$negate) {
            return $builder->andX($type_expr, $name_expr);
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());
}
        }
        // negated case: not (language construct and name matches)
        //             = not language construct or not name matches
        else {
            return $builder->orX($type_expr, $name_expr);
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		/******************************************************************************
3		* An implementation of dicto (scg.unibe.ch/dicto) in and for PHP.
4		*
5		* Copyright (c) 2016 Richard Klees <[email protected]>
6		*
7		* This software is licensed under The MIT License. You should have received
8		* a copy of the licence along with the code.
9		*/
10
11		namespace Lechimp\Dicto\Variables;
12
13		use Doctrine\DBAL\Query\Expression\ExpressionBuilder;
14
15		class LanguageConstruct extends Entities {
16		/**
17		* @var string
18		*/
19		private $construct_name;
20
21	99	public function __construct($name, $construct_name) {
22	99	parent::__construct($name);
23	99	assert('is_string($construct_name)');
24		// TODO: Restrict the possible construct_names (like @, unset, echo, ...)
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-05-06 10:32 UTC by Report Bug Copy Issue Report `36%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
25	99	$this->construct_name = $construct_name;
26	99	}
27
28		/**
29		* @return string
30		*/
31	8	public function construct_name() {
32	8	return $this->construct_name;
33		}
34
35		/**
36		* @inheritdoc
37		*/
38	1	public function id() {
39	1	return Variable::LANGUAGE_CONSTRUCT_TYPE;
40		}
41
42		/**
43		* @inheritdocs
44		*/
45	7	public function compile(ExpressionBuilder $builder, $table_name, $negate = false) {
46	7	$type_expr = $this->eq_op
47	7	( $builder
48	7	, "$table_name.type"
49	7	, $builder->literal(Variable::LANGUAGE_CONSTRUCT_TYPE)
50	7	, $negate
51	7	);
52	7	$name_expr = $this->eq_op
53	7	( $builder
54	7	, "$table_name.name"
55	7	, $builder->literal($this->construct_name())
56	7	, $negate
57	7	);
58
59		// normal case : language construct and name matches
60	7	if (!$negate) {
61	7	return $builder->andX($type_expr, $name_expr);
		0 ignored issues – show Bug Best Practice introduced 2016-05-28 20:29 UTC by Report Bug Copy Issue Report The return type of `return $builder->andX($type_expr, $name_expr);` (`Doctrine\DBAL\Query\Expression\CompositeExpression`) is incompatible with the return type declared by the abstract method `Lechimp\Dicto\Variables\Variable::compile` of type `string\|Lechimp\Dicto\Variables\CompositeExpression`. 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...
62		}
63		// negated case: not (language construct and name matches)
64		// = not language construct or not name matches
65		else {
66		return $builder->orX($type_expr, $name_expr);
		0 ignored issues – show Bug Best Practice introduced 2016-05-28 20:29 UTC by Report Bug Copy Issue Report The return type of `return $builder->orX($type_expr, $name_expr);` (`Doctrine\DBAL\Query\Expression\CompositeExpression`) is incompatible with the return type declared by the abstract method `Lechimp\Dicto\Variables\Variable::compile` of type `string\|Lechimp\Dicto\Variables\CompositeExpression`. 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...
67		}
68		}
69		}
70
71

lechimp-p / dicto.php

Push — master ( 608de6...159902 )

LanguageConstruct A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

4 Methods

Duplication Side-by-Side

Filter issues like