AbstractProxy::__construct() - Code Metrics - Inspection of "Add support for scalar type hints for PHP7.0, reso..." - goaop/framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#255)

by Alexander

created 2016-02-20 20:54 UTC

AbstractProxy::__construct() A

↳ Parent: AbstractProxy

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes	2
Bugs	1	Features	0

Metric	Value
c	2
b	1
f	0
dl	0
loc	4
ccs	3
cts	3
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	1
crap	1

<?php
/*
 * Go! AOP framework
 *
 * @copyright Copyright 2012, Lisachenko Alexander <[email protected]>
 *
 * This source file is subject to the license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Go\Proxy;

use ReflectionFunctionAbstract;
use ReflectionParameter;

/**
 * Abstract class for building different proxies
 */
abstract class AbstractProxy
{

    /**
     * Indent for source code
     *
     * @var int
     */
    protected $indent = 4;

    /**
     * List of advices that are used for generation of child
     *
     * @var array
     */
    protected $advices = [];

    /**
     * PHP expression string for accessing LSB information
     *
     * @var string
     */
    protected static $staticLsbExpression = 'static::class';

    /**
     * Constructs an abstract proxy class
     *
     * @param array $advices List of advices
     */
    public function __construct(array $advices = [])
    {
        $this->advices = $this->flattenAdvices($advices);
    }

    /**
     * Returns text representation of class
     *
     * @return string
     */
    abstract public function __toString();

    /**
     * Indent block of code
     *
     * @param string $text Non-indented text
     *
     * @return string Indented text
     */
    protected function indent($text)
    {
        $pad   = str_pad('', $this->indent, ' ');
        $lines = array_map(function($line) use ($pad) {
            return $pad . $line;
        }, explode("\n", $text));

        return join("\n", $lines);
    }

    /**
     * Returns list of string representation of parameters
     *
     * @param array|ReflectionParameter[] $parameters List of parameters
     *
     * @return array
     */
    protected function getParameters(array $parameters)
    {
        $parameterDefinitions = [];
        foreach ($parameters as $parameter) {
            $parameterDefinitions[] = $this->getParameterCode($parameter);
        }

        return $parameterDefinitions;
    }

    /**
     * Return string representation of parameter
     *
     * @param ReflectionParameter $parameter Reflection parameter
     *
     * @return string
     */
    protected function getParameterCode(ReflectionParameter $parameter)
    {
        $type = '';
        if (PHP_VERSION_ID >= 50700) {
            $reflectionType = $parameter->getType();
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.
    }
}
            if ($reflectionType) {
                $nsPrefix = $reflectionType->isBuiltin() ? '' : '\\';
                $type     = $nsPrefix . (string) $reflectionType;
            }
        } else {
            if ($parameter->isArray()) {
                $type = 'array';
            } elseif ($parameter->isCallable()) {
                $type = 'callable';
            } elseif ($parameter->getClass()) {
                $type = '\\' . $parameter->getClass()->name;
            }
        }
        $defaultValue = null;
        $isDefaultValueAvailable = $parameter->isDefaultValueAvailable();
        if ($isDefaultValueAvailable) {
            $defaultValue = var_export($parameter->getDefaultValue(), true);
        } elseif ($parameter->isOptional()) {
            $defaultValue = 'null';
        }
        $code = (
            ($type ? "$type " : '') . // Typehint
            ($parameter->isPassedByReference() ? '&' : '') . // By reference sign
            ($parameter->isVariadic() ? '...' : '') . // Variadic symbol
            '$' . // Variable symbol
            ($parameter->name) . // Name of the argument
            ($defaultValue !== null ? (" = " . $defaultValue) : '') // Default value if present
        );

        return $code;
    }

    /**
     * Replace concrete advices with list of ids
     *
     * @param $advices
     *
     * @return array flatten list of advices
     */
    private function flattenAdvices($advices)
    {
        $flattenAdvices = [];
        foreach ($advices as $type => $typedAdvices) {
            foreach ($typedAdvices as $name => $concreteAdvices) {
                if (is_array($concreteAdvices)) {
                    $flattenAdvices[$type][$name] = array_keys($concreteAdvices);
                }
            }
        }

        return $flattenAdvices;
    }

    /**
     * Prepares a line with args from the method definition
     *
     * @param ReflectionFunctionAbstract $functionLike
     *
     * @return string
     */
    protected function prepareArgsLine(ReflectionFunctionAbstract $functionLike)
    {
        $argumentsPart = [];
        $arguments     = [];
        $hasOptionals  = false;

        foreach ($functionLike->getParameters() as $parameter) {
            $byReference  = ($parameter->isPassedByReference() && !$parameter->isVariadic()) ? '&' : '';
            $hasOptionals = $hasOptionals || $parameter->isOptional();

            $arguments[] = $byReference . '$' . $parameter->name;
        }

        $isVariadic = $functionLike->isVariadic();
        if ($isVariadic) {
            $argumentsPart[] = array_pop($arguments);
        }
        if (!empty($arguments)) {
            // Unshifting to keep correct order
            $argumentLine = '[' . join(', ', $arguments) . ']';
            if ($hasOptionals) {
                $argumentLine = "\\array_slice($argumentLine, 0, \\func_num_args())";
            }
            array_unshift($argumentsPart, $argumentLine);
        }

        return join(', ', $argumentsPart);
    }
}


1		<?php
2		/*
3		* Go! AOP framework
4		*
5		* @copyright Copyright 2012, Lisachenko Alexander <[email protected]>
6		*
7		* This source file is subject to the license that is bundled
8		* with this source code in the file LICENSE.
9		*/
10
11		namespace Go\Proxy;
12
13		use ReflectionFunctionAbstract;
14		use ReflectionParameter;
15
16		/**
17		* Abstract class for building different proxies
18		*/
19		abstract class AbstractProxy
20		{
21
22		/**
23		* Indent for source code
24		*
25		* @var int
26		*/
27		protected $indent = 4;
28
29		/**
30		* List of advices that are used for generation of child
31		*
32		* @var array
33		*/
34		protected $advices = [];
35
36		/**
37		* PHP expression string for accessing LSB information
38		*
39		* @var string
40		*/
41		protected static $staticLsbExpression = 'static::class';
42
43		/**
44		* Constructs an abstract proxy class
45		*
46		* @param array $advices List of advices
47		*/
48	6	public function __construct(array $advices = [])
49		{
50	6	$this->advices = $this->flattenAdvices($advices);
51	6	}
52
53		/**
54		* Returns text representation of class
55		*
56		* @return string
57		*/
58		abstract public function __toString();
59
60		/**
61		* Indent block of code
62		*
63		* @param string $text Non-indented text
64		*
65		* @return string Indented text
66		*/
67	6	protected function indent($text)
68		{
69	6	$pad = str_pad('', $this->indent, ' ');
70	6	$lines = array_map(function($line) use ($pad) {
71	6	return $pad . $line;
72	6	}, explode("\n", $text));
73
74	6	return join("\n", $lines);
75		}
76
77		/**
78		* Returns list of string representation of parameters
79		*
80		* @param array\|ReflectionParameter[] $parameters List of parameters
81		*
82		* @return array
83		*/
84	6	protected function getParameters(array $parameters)
85		{
86	6	$parameterDefinitions = [];
87	6	foreach ($parameters as $parameter) {
88	3	$parameterDefinitions[] = $this->getParameterCode($parameter);
89		}
90
91	6	return $parameterDefinitions;
92		}
93
94		/**
95		* Return string representation of parameter
96		*
97		* @param ReflectionParameter $parameter Reflection parameter
98		*
99		* @return string
100		*/
101	3	protected function getParameterCode(ReflectionParameter $parameter)
102		{
103	3	$type = '';
104	3	if (PHP_VERSION_ID >= 50700) {
105	3	$reflectionType = $parameter->getType();
		1 ignored issue – show Bug introduced 2016-02-20 20:58 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `ReflectionParameter` as the method `getType()` does only exist in the following sub-classes of `ReflectionParameter`: `Go\ParserReflection\ReflectionParameter`. 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 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
106	3	if ($reflectionType) {
107	1	$nsPrefix = $reflectionType->isBuiltin() ? '' : '\\';
108	3	$type = $nsPrefix . (string) $reflectionType;
109		}
110		} else {
111		if ($parameter->isArray()) {
112		$type = 'array';
113		} elseif ($parameter->isCallable()) {
114		$type = 'callable';
115		} elseif ($parameter->getClass()) {
116		$type = '\\' . $parameter->getClass()->name;
117		}
118		}
119	3	$defaultValue = null;
120	3	$isDefaultValueAvailable = $parameter->isDefaultValueAvailable();
121	3	if ($isDefaultValueAvailable) {
122	2	$defaultValue = var_export($parameter->getDefaultValue(), true);
123	3	} elseif ($parameter->isOptional()) {
124		$defaultValue = 'null';
125		}
126		$code = (
127	3	($type ? "$type " : '') . // Typehint
128	3	($parameter->isPassedByReference() ? '&' : '') . // By reference sign
129	3	($parameter->isVariadic() ? '...' : '') . // Variadic symbol
130	3	'$' . // Variable symbol
131	3	($parameter->name) . // Name of the argument
132	3	($defaultValue !== null ? (" = " . $defaultValue) : '') // Default value if present
133		);
134
135	3	return $code;
136		}
137
138		/**
139		* Replace concrete advices with list of ids
140		*
141		* @param $advices
142		*
143		* @return array flatten list of advices
144		*/
145	6	private function flattenAdvices($advices)
146		{
147	6	$flattenAdvices = [];
148	6	foreach ($advices as $type => $typedAdvices) {
149	6	foreach ($typedAdvices as $name => $concreteAdvices) {
150	6	if (is_array($concreteAdvices)) {
151	6	$flattenAdvices[$type][$name] = array_keys($concreteAdvices);
152		}
153		}
154		}
155
156	6	return $flattenAdvices;
157		}
158
159		/**
160		* Prepares a line with args from the method definition
161		*
162		* @param ReflectionFunctionAbstract $functionLike
163		*
164		* @return string
165		*/
166	6	protected function prepareArgsLine(ReflectionFunctionAbstract $functionLike)
167		{
168	6	$argumentsPart = [];
169	6	$arguments = [];
170	6	$hasOptionals = false;
171
172	6	foreach ($functionLike->getParameters() as $parameter) {
173	3	$byReference = ($parameter->isPassedByReference() && !$parameter->isVariadic()) ? '&' : '';
174	3	$hasOptionals = $hasOptionals \|\| $parameter->isOptional();
175
176	3	$arguments[] = $byReference . '$' . $parameter->name;
177		}
178
179	6	$isVariadic = $functionLike->isVariadic();
180	6	if ($isVariadic) {
181	1	$argumentsPart[] = array_pop($arguments);
182		}
183	6	if (!empty($arguments)) {
184		// Unshifting to keep correct order
185	3	$argumentLine = '[' . join(', ', $arguments) . ']';
186	3	if ($hasOptionals) {
187	2	$argumentLine = "\\array_slice($argumentLine, 0, \\func_num_args())";
188		}
189	3	array_unshift($argumentsPart, $argumentLine);
190		}
191
192	6	return join(', ', $argumentsPart);
193		}
194		}
195

goaop / framework

Pull Request — master (#255)

AbstractProxy::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like