TreeNode - Code Metrics - Inspection of "Rework tree format" - SemanticMediaWiki/SemanticResultFormats - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#226)

by Stephan

created 2017-06-10 03:14 UTC

TreeNode A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	56
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Importance

Changes

Metric	Value
wmc	8
lcom	0
cbo	3
dl	0
loc	56
rs	10
c	0
b	0
f	0

4 Methods

Rating	Name	Size	Complexity
A	__construct()	3	1
A	getHash()	10	2
A	getResultSubject()	10	2
A	addChild()	10	3

<?php

namespace SRF\Formats\Tree;

use Cdb\Exception;
use Tree\Node\Node;
use Tree\Node\NodeInterface;
use Tree\Node\NodeTrait;

class TreeNode extends Node {

	/**
	 * SRFTreeElement constructor.
	 * @param \SMWResultArray[] | null $row
	 */
	public function __construct( $row = null ) {
		parent::__construct( $row );
	}

	/**
	 * @return string
	 */
	public function getHash() {

		$resultSubject = $this->getResultSubject();

		if ( $resultSubject !== null ) {
			return $resultSubject->getSerialization();
		}

		return '';
	}

	/**
	 * @return null|\SMWDIWikiPage
	 */
	public function getResultSubject() {
		/** @var \SMWResultArray[] | null $row */
		$row = $this->getValue();

		if ( $row !== null ) {
			return $row[ 0 ]->getResultSubject();
		}

		return null;
	}

	/**
	 * @param NodeInterface $child
	 * @return NodeTrait

	 * @throws Exception
	 */
	public function addChild( NodeInterface $child ) {

		foreach ( $this->getAncestorsAndSelf() as $ancestor ) {
			if ( $ancestor->getHash() === $child->getHash() ) {
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
				throw new Exception( 'srf-tree-circledetected' );
			}
		}

		return parent::addChild( $child );
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			namespace SRF\Formats\Tree;
4
5			use Cdb\Exception;
6			use Tree\Node\Node;
7			use Tree\Node\NodeInterface;
8			use Tree\Node\NodeTrait;
9
10			class TreeNode extends Node {
11
12			/**
13			* SRFTreeElement constructor.
14			* @param \SMWResultArray[] \| null $row
15			*/
16			public function __construct( $row = null ) {
17			parent::__construct( $row );
18			}
19
20			/**
21			* @return string
22			*/
23			public function getHash() {
24
25			$resultSubject = $this->getResultSubject();
26
27			if ( $resultSubject !== null ) {
28			return $resultSubject->getSerialization();
29			}
30
31			return '';
32			}
33
34			/**
35			* @return null\|\SMWDIWikiPage
36			*/
37			public function getResultSubject() {
38			/** @var \SMWResultArray[] \| null $row */
39			$row = $this->getValue();
40
41			if ( $row !== null ) {
42			return $row[ 0 ]->getResultSubject();
43			}
44
45			return null;
46			}
47
48			/**
49			* @param NodeInterface $child
50			* @return NodeTrait
			0 ignored issues – show Comprehensibility Bug introduced 2017-06-10 03:16 UTC by Report Bug Copy Issue Report The return type `NodeTrait` is a trait, and thus cannot be used for type-hinting in PHP. Maybe consider adding an interface and use that for type-hinting? In PHP traits cannot be used for type-hinting as they do not define a well-defined structure. This is because any class that uses a trait can rename that trait’s methods. If you would like to return an object that has a guaranteed set of methods, you could create a companion interface that lists these methods explicitly. Loading history...
51			* @throws Exception
52			*/
53			public function addChild( NodeInterface $child ) {
54
55			foreach ( $this->getAncestorsAndSelf() as $ancestor ) {
56			if ( $ancestor->getHash() === $child->getHash() ) {
			0 ignored issues – show Bug introduced 2017-06-10 01:28 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Tree\Node\NodeInterface` as the method `getHash()` does only exist in the following implementations of said interface: `SRF\Formats\Tree\TreeNode`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
57			throw new Exception( 'srf-tree-circledetected' );
58			}
59			}
60
61			return parent::addChild( $child );
			0 ignored issues – show Bug Best Practice introduced 2017-06-10 01:28 UTC by Report Bug Copy Issue Report The return type of `return parent::addChild($child);` (`SRF\Formats\Tree\TreeNode`) is incompatible with the return type of the parent method `Tree\Node\Node::addChild` of type `Tree\Node\NodeTrait`. 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
64
65			}
66
67

SemanticMediaWiki / SemanticResultFormats

Pull Request — master (#226)

TreeNode A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

4 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like