TreeNode::getResultSubject() - 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 02:45 UTC

TreeNode::getResultSubject() A

↳ Parent: TreeNode

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	10
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	5
nc	2
nop	0

<?php

namespace SRF\Formats\Tree;

use Tree\Node\Node;
use Tree\Node\NodeInterface;

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;
	}

	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.
    }
}
				return 'srf-tree-circledetected';
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());
}
			}
		}

		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 Tree\Node\Node;
6			use Tree\Node\NodeInterface;
7
8			class TreeNode extends Node {
9
10			/**
11			* SRFTreeElement constructor.
12			* @param \SMWResultArray[] \| null $row
13			*/
14			public function __construct( $row = null ) {
15			parent::__construct( $row );
16			}
17
18			/**
19			* @return string
20			*/
21			public function getHash() {
22
23			$resultSubject = $this->getResultSubject();
24
25			if ( $resultSubject !== null ) {
26			return $resultSubject->getSerialization();
27			}
28
29			return '';
30			}
31
32			/**
33			* @return null\|\SMWDIWikiPage
34			*/
35			public function getResultSubject() {
36			/** @var \SMWResultArray[] \| null $row */
37			$row = $this->getValue();
38
39			if ( $row !== null ) {
40			return $row[ 0 ]->getResultSubject();
41			}
42
43			return null;
44			}
45
46			public function addChild( NodeInterface $child ) {
47
48			foreach ( $this->getAncestorsAndSelf() as $ancestor ) {
49			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...
50			return 'srf-tree-circledetected';
			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 'srf-tree-circledetected';` (`string`) 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...
51			}
52			}
53
54			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...
55			}
56
57
58			}
59
60

SemanticMediaWiki / SemanticResultFormats

Pull Request — master (#226)

TreeNode::getResultSubject() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like