ArrayAccessIterator   A
last analyzed

Complexity

Total Complexity 7

Size/Duplication

Total Lines 42
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 0

Importance

Changes 0
Metric Value
wmc 7
lcom 1
cbo 0
dl 0
loc 42
rs 10
c 0
b 0
f 0

7 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 5 1
A rewind() 0 4 1
A valid() 0 4 1
A next() 0 4 1
A key() 0 4 1
A current() 0 4 1
A seek() 0 4 1
1
<?php
2
3
namespace itertools;
4
5
use ArrayAccess;
6
use SeekableIterator;
7
8
9
class ArrayAccessIterator implements SeekableIterator
10
{
11
	protected $array;
12
	protected $index;
13
14
	public function __construct(ArrayAccess $array, $startIndex = 0)
15
	{
16
		$this->array = $array;
17
		$this->seek($startIndex);
18
	}
19
20
	public function rewind()
21
	{
22
		$this->index = 0;
23
	}
24
25
	public function valid()
26
	{
27
		return $this->index < $this->array->count();
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface ArrayAccess as the method count() does only exist in the following implementations of said interface: ArrayIterator, ArrayObject, CachingIterator, Issue523, PHP_Token_Stream, Phar, PharData, RecursiveArrayIterator, RecursiveCachingIterator, SplDoublyLinkedList, SplFixedArray, SplObjectStorage, SplQueue, SplStack, itertools\Queue.

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

  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 interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
28
	}
29
30
	public function next()
31
	{
32
		$this->index += 1;
33
	}
34
35
	public function key()
36
	{
37
		return $this->index;
38
	}
39
40
	public function current()
41
	{
42
		return $this->array[$this->index];
43
	}
44
45
	public function seek($position)
46
	{
47
		$this->index = $position;
48
	}
49
50
}
51