RecursiveSortNodeSimplifier   A
last analyzed

Complexity

Total Complexity 4

Size/Duplication

Total Lines 36
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 3

Test Coverage

Coverage 100%

Importance

Changes 1
Bugs 0 Features 0
Metric Value
wmc 4
c 1
b 0
f 0
lcom 1
cbo 3
dl 0
loc 36
ccs 12
cts 12
cp 1
rs 10

3 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 3 1
A isSimplifierFor() 0 3 1
A simplify() 0 10 2
1
<?php
2
3
namespace PPP\Module\TreeSimplifier;
4
5
use InvalidArgumentException;
6
use PPP\DataModel\AbstractNode;
7
use PPP\DataModel\SortNode;
8
9
class RecursiveSortNodeSimplifier implements NodeSimplifier {
10
11
	/**
12
	 * @var NodeSimplifierFactory
13
	 */
14
	private $simplifierFactory;
15
16
	/**
17
	 * @param NodeSimplifierFactory $simplifierFactory
18
	 */
19 5
	public function __construct(NodeSimplifierFactory $simplifierFactory) {
20 5
		$this->simplifierFactory = $simplifierFactory;
21 5
	}
22
23
	/**
24
	 * @see NodeSimplifier::isSimplifierFor
25
	 */
26 4
	public function isSimplifierFor(AbstractNode $node) {
27 4
		return $node instanceof SortNode;
28
	}
29
30
	/**
31
	 * @see NodeSimplifier::simplify
32
	 * @param SortNode $node
33
	 */
34 2
	public function simplify(AbstractNode $node) {
35 2
		if(!$this->isSimplifierFor($node)) {
36 1
			throw new InvalidArgumentException('RecursiveSortSimplifier can only simplify SortNode');
37
		}
38
39 1
		return new SortNode(
40 1
			$this->simplifierFactory->newNodeSimplifier()->simplify($node->getOperand()),
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class PPP\DataModel\AbstractNode as the method getOperand() does only exist in the following sub-classes of PPP\DataModel\AbstractNode: PPP\DataModel\FirstNode, PPP\DataModel\LastNode, PPP\DataModel\ReducerNode, PPP\DataModel\SortNode. Maybe you want to instanceof check for one of these explicitly?

Let’s take a look at an example:

abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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 sub-classes of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the parent class:

    abstract class User
    {
        /** @return string */
        abstract public function getPassword();
    
        /** @return string */
        abstract public function getDisplayName();
    }
    
Loading history...
41 1
			$node->getPredicate()
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class PPP\DataModel\AbstractNode as the method getPredicate() does only exist in the following sub-classes of PPP\DataModel\AbstractNode: PPP\DataModel\SortNode, PPP\DataModel\TripleNode. Maybe you want to instanceof check for one of these explicitly?

Let’s take a look at an example:

abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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 sub-classes of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the parent class:

    abstract class User
    {
        /** @return string */
        abstract public function getPassword();
    
        /** @return string */
        abstract public function getDisplayName();
    }
    
Loading history...
42 1
		);
43
	}
44
}
45