CachingReflector::getDocBlock() - Code Metrics - cmpayments/atreyu - Measure and Improve Code Quality continuously with Scrutinizer

CachingReflector::getDocBlock() A
last analyzed 2017-02-08 16:25 UTC

↳ Parent: CachingReflector

Complexity

Conditions	2
Paths	2

Size

Total Lines	20
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	20
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	11
nc	2
nop	1

<?php

namespace Atreyu;

use phpDocumentor\Reflection\DocBlock;
use phpDocumentor\Reflection\DocBlock\Context;

class CachingReflector extends BaseReflector implements Reflector
{
    const CACHE_KEY_CLASSES = 'atreyu.refls.classes.';
    const CACHE_KEY_CTORS = 'atreyu.refls.ctors.';
    const CACHE_KEY_CTOR_PARAMS = 'atreyu.refls.ctor-params.';
    const CACHE_KEY_FUNCS = 'atreyu.refls.funcs.';
    const CACHE_KEY_METHODS = 'atreyu.refls.methods.';
    const CACHE_KEY_DOC_BLOCK = 'atreyu.refls.doc-block.';
    const CACHE_KEY_IMPLEMENTED = 'atreyu.refls.implemented.';

    private $reflector;
    private $cache;

    public function __construct(Reflector $reflector = null, ReflectionCache $cache = null)
    {
        $this->reflector = $reflector ?: new StandardReflector;
        $this->cache = $cache ?: new ReflectionCacheArray;
    }

    public function getClass($class)

    {
        $cacheKey = self::CACHE_KEY_CLASSES.strtolower($class);

        if (!$reflectionClass = $this->cache->fetch($cacheKey)) {
            $reflectionClass = new ExtendedReflectionClass($class);
            $this->cache->store($cacheKey, $reflectionClass);
        }

        return $reflectionClass;
    }

    public function getCtor($class)

    {
        $cacheKey = self::CACHE_KEY_CTORS.strtolower($class);

        $reflectedCtor = $this->cache->fetch($cacheKey);

        if ($reflectedCtor === false) {
            $reflectionClass = $this->getClass($class);
            $reflectedCtor = $reflectionClass->getConstructor();
            $this->cache->store($cacheKey, $reflectedCtor);
        }

        return $reflectedCtor;
    }

    public function getCtorParams($class)
    {
        $cacheKey = self::CACHE_KEY_CTOR_PARAMS.strtolower($class);

        $reflectedCtorParams = $this->cache->fetch($cacheKey);

        if (false !== $reflectedCtorParams) {
            return $reflectedCtorParams;
        } elseif ($reflectedCtor = $this->getCtor($class)) {
            $reflectedCtorParams = $reflectedCtor->getParameters();
        } else {
            $reflectedCtorParams = null;
        }

        $this->cache->store($cacheKey, $reflectedCtorParams);

        return $reflectedCtorParams;
    }

    public function getParamTypeHint(\ReflectionFunctionAbstract $function, \ReflectionParameter $param, array $arguments = [])
    {
        $lowParam = strtolower($param->name);

        if ($function instanceof \ReflectionMethod) {
            $lowClass = strtolower($function->class);
            $lowMethod = strtolower($function->name);
            $paramCacheKey = self::CACHE_KEY_CLASSES."{$lowClass}.{$lowMethod}.param-{$lowParam}";
        } else {
            $lowFunc = strtolower($function->name);
            $paramCacheKey = ($lowFunc !== '{closure}')
                ? self::CACHE_KEY_FUNCS.".{$lowFunc}.param-{$lowParam}"
                : null;
        }

        $typeHint = ($paramCacheKey === null) ? false : $this->cache->fetch($paramCacheKey);

        if (false !== $typeHint) {
            return $typeHint;
        }

        if ($reflectionClass = $param->getClass()) {
            $typeHint = $reflectionClass->getName();
            $classCacheKey = self::CACHE_KEY_CLASSES.strtolower($typeHint);
            $this->cache->store($classCacheKey, $this->getClass($param->getClass()->getName()));
        } elseif (($function instanceof \ReflectionMethod)
            && ($docBlockParams = $this->getDocBlock($function)->getTagsByName('param'))
            && !empty($docBlockParams)
        ) {
            $typeHint = $this->getParamDocBlockHint($docBlockParams, $param, $arguments);

            // store the ExtendedReflectionClass in the cache
            if ($typeHint !== false) {

                $classCacheKey = self::CACHE_KEY_CLASSES.strtolower($typeHint);
                $this->cache->store($classCacheKey, $this->getClass($typeHint));
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            }
        } else {
            $typeHint = null;
        }

        $this->cache->store($paramCacheKey, $typeHint);

        return $typeHint;
    }

    public function getFunction($functionName)

    {
        $lowFunc = strtolower($functionName);
        $cacheKey = self::CACHE_KEY_FUNCS.$lowFunc;

        $reflectedFunc = $this->cache->fetch($cacheKey);

        if (false === $reflectedFunc) {
            $reflectedFunc = new \ReflectionFunction($functionName);
            $this->cache->store($cacheKey, $reflectedFunc);
        }

        return $reflectedFunc;
    }

    public function getMethod($classNameOrInstance, $methodName)
    {
        $className = is_string($classNameOrInstance)
            ? $classNameOrInstance
            : get_class($classNameOrInstance);

        $cacheKey = self::CACHE_KEY_METHODS.strtolower($className).'.'.strtolower($methodName);

        if (!$reflectedMethod = $this->cache->fetch($cacheKey)) {
            $reflectedMethod = new \ReflectionMethod($className, $methodName);
            $this->cache->store($cacheKey, $reflectedMethod);
        }

        return $reflectedMethod;
    }

    public function getDocBlock(\ReflectionMethod $method)
    {
        $cacheKey = self::CACHE_KEY_DOC_BLOCK.strtolower($method->class);
        if (!$docBlock = $this->cache->fetch($cacheKey)) {

            $class = $this->getClass($method->class);

            $docBlock = new DocBlock(
                $method->getDocComment(),
                new Context(
                    $class->getNamespaceName(),
                    $class->getUseStatements()
                )
            );

            $this->cache->store($cacheKey, $docBlock);
        }

        return $docBlock;
    }

    /**
     * @param $className
     *
     * @return array|bool
     */
    public function getImplemented($className)

    {
        $cacheKey = self::CACHE_KEY_IMPLEMENTED.strtolower($className);

        if (!$implemented = $this->cache->fetch($cacheKey)) {
            $implemented = parent::getImplemented($className);
            $this->cache->store($cacheKey, $implemented);
        }

        return $implemented;
    }
}


1		<?php
2
3		namespace Atreyu;
4
5		use phpDocumentor\Reflection\DocBlock;
6		use phpDocumentor\Reflection\DocBlock\Context;
7
8		class CachingReflector extends BaseReflector implements Reflector
9		{
10		const CACHE_KEY_CLASSES = 'atreyu.refls.classes.';
11		const CACHE_KEY_CTORS = 'atreyu.refls.ctors.';
12		const CACHE_KEY_CTOR_PARAMS = 'atreyu.refls.ctor-params.';
13		const CACHE_KEY_FUNCS = 'atreyu.refls.funcs.';
14		const CACHE_KEY_METHODS = 'atreyu.refls.methods.';
15		const CACHE_KEY_DOC_BLOCK = 'atreyu.refls.doc-block.';
16		const CACHE_KEY_IMPLEMENTED = 'atreyu.refls.implemented.';
17
18		private $reflector;
19		private $cache;
20
21		public function __construct(Reflector $reflector = null, ReflectionCache $cache = null)
22		{
23		$this->reflector = $reflector ?: new StandardReflector;
24		$this->cache = $cache ?: new ReflectionCacheArray;
25		}
26
27	View Code Duplication	public function getClass($class)
		0 ignored issues – show Duplication introduced 2016-03-25 15:23 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
28		{
29		$cacheKey = self::CACHE_KEY_CLASSES.strtolower($class);
30
31		if (!$reflectionClass = $this->cache->fetch($cacheKey)) {
32		$reflectionClass = new ExtendedReflectionClass($class);
33		$this->cache->store($cacheKey, $reflectionClass);
34		}
35
36		return $reflectionClass;
37		}
38
39	View Code Duplication	public function getCtor($class)
		0 ignored issues – show Duplication introduced 2016-03-25 15:23 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
40		{
41		$cacheKey = self::CACHE_KEY_CTORS.strtolower($class);
42
43		$reflectedCtor = $this->cache->fetch($cacheKey);
44
45		if ($reflectedCtor === false) {
46		$reflectionClass = $this->getClass($class);
47		$reflectedCtor = $reflectionClass->getConstructor();
48		$this->cache->store($cacheKey, $reflectedCtor);
49		}
50
51		return $reflectedCtor;
52		}
53
54		public function getCtorParams($class)
55		{
56		$cacheKey = self::CACHE_KEY_CTOR_PARAMS.strtolower($class);
57
58		$reflectedCtorParams = $this->cache->fetch($cacheKey);
59
60		if (false !== $reflectedCtorParams) {
61		return $reflectedCtorParams;
62		} elseif ($reflectedCtor = $this->getCtor($class)) {
63		$reflectedCtorParams = $reflectedCtor->getParameters();
64		} else {
65		$reflectedCtorParams = null;
66		}
67
68		$this->cache->store($cacheKey, $reflectedCtorParams);
69
70		return $reflectedCtorParams;
71		}
72
73		public function getParamTypeHint(\ReflectionFunctionAbstract $function, \ReflectionParameter $param, array $arguments = [])
74		{
75		$lowParam = strtolower($param->name);
76
77		if ($function instanceof \ReflectionMethod) {
78		$lowClass = strtolower($function->class);
79		$lowMethod = strtolower($function->name);
80		$paramCacheKey = self::CACHE_KEY_CLASSES."{$lowClass}.{$lowMethod}.param-{$lowParam}";
81		} else {
82		$lowFunc = strtolower($function->name);
83		$paramCacheKey = ($lowFunc !== '{closure}')
84		? self::CACHE_KEY_FUNCS.".{$lowFunc}.param-{$lowParam}"
85		: null;
86		}
87
88		$typeHint = ($paramCacheKey === null) ? false : $this->cache->fetch($paramCacheKey);
89
90		if (false !== $typeHint) {
91		return $typeHint;
92		}
93
94		if ($reflectionClass = $param->getClass()) {
95		$typeHint = $reflectionClass->getName();
96		$classCacheKey = self::CACHE_KEY_CLASSES.strtolower($typeHint);
97		$this->cache->store($classCacheKey, $this->getClass($param->getClass()->getName()));
98		} elseif (($function instanceof \ReflectionMethod)
99		&& ($docBlockParams = $this->getDocBlock($function)->getTagsByName('param'))
100		&& !empty($docBlockParams)
101		) {
102		$typeHint = $this->getParamDocBlockHint($docBlockParams, $param, $arguments);
103
104		// store the ExtendedReflectionClass in the cache
105		if ($typeHint !== false) {
106
107		$classCacheKey = self::CACHE_KEY_CLASSES.strtolower($typeHint);
108		$this->cache->store($classCacheKey, $this->getClass($typeHint));
		0 ignored issues – show Bug introduced 2016-11-24 07:41 UTC by Report Bug Copy Issue Report It seems like `$typeHint` defined by `$this->getParamDocBlockH...ms, $param, $arguments)` on line `102` can also be of type `boolean`; however, `Atreyu\CachingReflector::getClass()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
109		}
110		} else {
111		$typeHint = null;
112		}
113
114		$this->cache->store($paramCacheKey, $typeHint);
115
116		return $typeHint;
117		}
118
119	View Code Duplication	public function getFunction($functionName)
		0 ignored issues – show Duplication introduced 2016-03-25 15:23 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
120		{
121		$lowFunc = strtolower($functionName);
122		$cacheKey = self::CACHE_KEY_FUNCS.$lowFunc;
123
124		$reflectedFunc = $this->cache->fetch($cacheKey);
125
126		if (false === $reflectedFunc) {
127		$reflectedFunc = new \ReflectionFunction($functionName);
128		$this->cache->store($cacheKey, $reflectedFunc);
129		}
130
131		return $reflectedFunc;
132		}
133
134		public function getMethod($classNameOrInstance, $methodName)
135		{
136		$className = is_string($classNameOrInstance)
137		? $classNameOrInstance
138		: get_class($classNameOrInstance);
139
140		$cacheKey = self::CACHE_KEY_METHODS.strtolower($className).'.'.strtolower($methodName);
141
142		if (!$reflectedMethod = $this->cache->fetch($cacheKey)) {
143		$reflectedMethod = new \ReflectionMethod($className, $methodName);
144		$this->cache->store($cacheKey, $reflectedMethod);
145		}
146
147		return $reflectedMethod;
148		}
149
150		public function getDocBlock(\ReflectionMethod $method)
151		{
152		$cacheKey = self::CACHE_KEY_DOC_BLOCK.strtolower($method->class);
153		if (!$docBlock = $this->cache->fetch($cacheKey)) {
154
155		$class = $this->getClass($method->class);
156
157		$docBlock = new DocBlock(
158		$method->getDocComment(),
159		new Context(
160		$class->getNamespaceName(),
161		$class->getUseStatements()
162		)
163		);
164
165		$this->cache->store($cacheKey, $docBlock);
166		}
167
168		return $docBlock;
169		}
170
171		/**
172		* @param $className
173		*
174		* @return array\|bool
175		*/
176	View Code Duplication	public function getImplemented($className)
		0 ignored issues – show Duplication introduced 2016-03-25 15:23 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
177		{
178		$cacheKey = self::CACHE_KEY_IMPLEMENTED.strtolower($className);
179
180		if (!$implemented = $this->cache->fetch($cacheKey)) {
181		$implemented = parent::getImplemented($className);
182		$this->cache->store($cacheKey, $implemented);
183		}
184
185		return $implemented;
186		}
187		}
188

cmpayments / atreyu

CachingReflector::getDocBlock() A last analyzed 2017-02-08 16:25 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

CachingReflector::getDocBlock() A
last analyzed 2017-02-08 16:25 UTC