Issues in TreeNode.php - All Issues - Inspection of "Gallery: Remove feature switch, always use Traditi..." - SemanticMediaWiki/SemanticResultFormats - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9b2ed5...981814 )

by Jeroen De

created 2018-10-18 23:07 UTC

formats/tree/TreeNode.php (1 issue)

Showing only issues like (Show All)

strict.coding_against_concrete_implementation

Bug Minor

Stephan Gambke 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

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

}



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		*
15		* @param \SMWResultArray[] \| null $row
16		*/
17	5	public function __construct( $row = null ) {
18	5	parent::__construct( $row );
19	5	}
20
21		/**
22		* @return string
23		*/
24	5	public function getHash() {
25
26	5	$resultSubject = $this->getResultSubject();
27
28	5	if ( $resultSubject !== null ) {
29	5	return $resultSubject->getSerialization();
30		}
31
32	5	return '';
33		}
34
35		/**
36		* @return null\|\SMWDIWikiPage
37		*/
38	5	public function getResultSubject() {
39		/** @var \SMWResultArray[] \| null $row */
40	5	$row = $this->getValue();
41
42	5	if ( $row !== null ) {
43	5	return $row[0]->getResultSubject();
44		}
45
46	5	return null;
47		}
48
49		/**
50		* @param NodeInterface $child
51		*
52		* @return NodeTrait
53		* @throws Exception
54		*/
55	5	public function addChild( NodeInterface $child ) {
56
57	5	foreach ( $this->getAncestorsAndSelf() as $ancestor ) {
58	5	if ( $ancestor->getHash() === $child->getHash() ) {
		0 ignored issues – show Bug introduced 2017-06-10 01:28 UTC by Report Bug Copy Issue Report Show Similar Issues like this 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...
59	5	throw new Exception( 'srf-tree-circledetected' );
60		}
61		}
62
63	5	return parent::addChild( $child );
64		}
65
66		}
67
68

SemanticMediaWiki / SemanticResultFormats

Push — master ( 9b2ed5...981814 )

formats/tree/TreeNode.php (1 issue)

Showing only issues like (Show All)

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

Duplication Side-by-Side

Filter issues like