ClassIterator::offsetGet()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 4
rs 10
c 0
b 0
f 0
cc 1
eloc 1
nc 1
nop 1
1
<?php
2
3
/**
4
 * This software package is licensed under `AGPL, Commercial` license[s].
5
 *
6
 * @package maslosoft/zamm
7
 * @license AGPL, Commercial
8
 *
9
 * @copyright Copyright (c) Peter Maselkowski <[email protected]>
10
 * @link https://maslosoft.com/zamm/
11
 */
12
13
namespace Maslosoft\Zamm;
14
15
use ArrayAccess;
16
use Exception;
17
use Maslosoft\Zamm\Interfaces\SourceAccessorInterface;
18
19
/**
20
 * @property public
21
 * @property protected
22
 * @property private
23
 * @property
24
 */
25
class ClassIterator implements ArrayAccess
26
{
27
28
	const AccessPublic = 'public';
0 ignored issues
show
Coding Style introduced by
Constant AccessPublic should be defined in uppercase
Loading history...
29
	const AccessProtected = 'protected';
0 ignored issues
show
Coding Style introduced by
Constant AccessProtected should be defined in uppercase
Loading history...
30
	const AccessPrivate = 'private';
0 ignored issues
show
Coding Style introduced by
Constant AccessPrivate should be defined in uppercase
Loading history...
31
32
	/**
33
	 * Working class name
34
	 * @var string
35
	 */
36
	private $_className = '';
37
38
	/**
39
	 * $filter could be [public, methods], [public], [protected properties]
40
	 */
41
	public function __construct(SourceAccessorInterface $accessor)
0 ignored issues
show
Unused Code introduced by
The parameter $accessor is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
42
	{
43
		$this->_className = $className;
0 ignored issues
show
Bug introduced by
The variable $className does not exist. Did you forget to declare it?

This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug.

Loading history...
44
		throw new Exception("DRAFT, pleas do not use " . __CLASS__);
45
	}
46
47
	public function __get($name)
48
	{
49
		$this->resetFilter();
0 ignored issues
show
Documentation Bug introduced by
The method resetFilter does not exist on object<Maslosoft\Zamm\ClassIterator>? Since you implemented __call, maybe consider adding a @method annotation.

If you implement __call and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class.

This is often the case, when __call is implemented by a parent class and only the child class knows which methods exist:

class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
50
		switch ($name)
51
		{
52
			case self::AccessPublic:
53
				// set filter
54
				break;
55
			///...
56
		}
57
		return $this;
58
	}
59
60
	public function __call($name, $arguments)
61
	{
62
		// Same as __get, but $arguments should contain additional filter:
63
		// a. regexp
64
		// b. filter class
65
		return $this;
66
	}
67
68
	public function offsetExists($offset)
69
	{
70
71
	}
72
73
	public function offsetGet($offset)
74
	{
75
76
	}
77
78
	public function offsetSet($offset, $value)
79
	{
80
81
	}
82
83
	public function offsetUnset($offset)
84
	{
85
86
	}
87
88
	// Array access implementation should return methods
89
}
90