PHPCompatibility_Sniffs_PHP_NewInterfacesSniff::getItemArray() - Code Metrics - Inspection of ":rocket: Run travis builds against various PHPCS v..." - wimg/PHPCompatibility - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/travis-add-interim-php... ( d1bcd9...c11f41 )

by Juliette

created 2017-05-14 17:17 UTC

getItemArray() A

↳ Parent: PHPCompatibility_Sniffs_PHP_NewInterfacesSniff

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	1

<?php
/**
 * PHPCompatibility_Sniffs_PHP_NewInterfacesSniff.
 *
 * @category PHP
 * @package  PHPCompatibility
 * @author   Juliette Reinders Folmer <[email protected]>
 */

/**
 * PHPCompatibility_Sniffs_PHP_NewInterfacesSniff.
 *
 * @category PHP
 * @package  PHPCompatibility
 * @author   Juliette Reinders Folmer <[email protected]>
 */
class PHPCompatibility_Sniffs_PHP_NewInterfacesSniff extends PHPCompatibility_AbstractNewFeatureSniff
namespace YourVendor;

class YourClass { }
{

    /**
     * A list of new interfaces, not present in older versions.
     *
     * The array lists : version number with false (not present) or true (present).
     * If's sufficient to list the first version where the interface appears.
     *
     * @var array(string => array(string => int|string|null))
     */
    protected $newInterfaces = array(
        'Traversable' => array(
            '4.4' => false,
            '5.0' => true,
        ),

        'Countable' => array(
            '5.0' => false,
            '5.1' => true,
        ),
        'OuterIterator' => array(
            '5.0' => false,
            '5.1' => true,
        ),
        'RecursiveIterator' => array(
            '5.0' => false,
            '5.1' => true,
        ),
        'SeekableIterator' => array(
            '5.0' => false,
            '5.1' => true,
        ),
        'Serializable' => array(
            '5.0' => false,
            '5.1' => true,
        ),
        'SplObserver' => array(
            '5.0' => false,
            '5.1' => true,
        ),
        'SplSubject' => array(
            '5.0' => false,
            '5.1' => true,
        ),

        'JsonSerializable' => array(
            '5.3' => false,
            '5.4' => true,
        ),
        'SessionHandlerInterface' => array(
            '5.3' => false,
            '5.4' => true,
        ),

        'DateTimeInterface' => array(
            '5.4' => false,
            '5.5' => true,
        ),

        'Throwable' => array(
            '5.6' => false,
            '7.0' => true,
        ),

    );

    /**
     * A list of methods which cannot be used in combination with particular interfaces.
     *
     * @var array(string => array(string => string))
     */
    protected $unsupportedMethods = array(
        'Serializable' => array(
            '__sleep'  => 'http://php.net/serializable',
            '__wakeup' => 'http://php.net/serializable',
        ),
    );

    /**
     * Returns an array of tokens this test wants to listen for.
     *
     * @return array
     */
    public function register()
    {
        // Handle case-insensitivity of interface names.
        $this->newInterfaces      = $this->arrayKeysToLowercase($this->newInterfaces);
        $this->unsupportedMethods = $this->arrayKeysToLowercase($this->unsupportedMethods);

        $targets = array(
            T_CLASS,
            T_FUNCTION,
            T_CLOSURE,
        );

        if (defined('T_ANON_CLASS')) {
            $targets[] = constant('T_ANON_CLASS');
        }

        return $targets;

    }//end register()


    /**
     * Processes this test, when one of its tokens is encountered.
     *
     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
     * @param int                  $stackPtr  The position of the current token in
     *                                        the stack passed in $tokens.
     *
     * @return void
     */
    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)

    {
        $tokens = $phpcsFile->getTokens();

        switch ($tokens[$stackPtr]['type']) {
            case 'T_CLASS':
            case 'T_ANON_CLASS':
                $this->processClassToken($phpcsFile, $stackPtr);
                break;

            case 'T_FUNCTION':
            case 'T_CLOSURE':
                $this->processFunctionToken($phpcsFile, $stackPtr);
                break;

            default:
                // Deliberately left empty.
                break;
        }

    }//end process()


    /**
     * Processes this test for when a class token is encountered.
     *
     * - Detect classes implementing the new interfaces.
     * - Detect classes implementing the new interfaces with unsupported functions.
     *
     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
     * @param int                  $stackPtr  The position of the current token in
     *                                        the stack passed in $tokens.
     *
     * @return void
     */
    private function processClassToken(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
    {
        $interfaces = $this->findImplementedInterfaceNames($phpcsFile, $stackPtr);

        if (is_array($interfaces) === false || $interfaces === array()) {
            return;
        }

        $tokens       = $phpcsFile->getTokens();
        $checkMethods = false;

        if (isset($tokens[$stackPtr]['scope_closer'])) {
            $checkMethods = true;
            $scopeCloser  = $tokens[$stackPtr]['scope_closer'];
        }

        foreach ($interfaces as $interface) {
            $interfaceLc = strtolower($interface);

            if (isset($this->newInterfaces[$interfaceLc]) === true) {
                $itemInfo = array(
                    'name'   => $interface,
                    'nameLc' => $interfaceLc,
                );
                $this->handleFeature($phpcsFile, $stackPtr, $itemInfo);
            }

            if ($checkMethods === true && isset($this->unsupportedMethods[$interfaceLc]) === true) {
                $nextFunc = $stackPtr;
                while (($nextFunc = $phpcsFile->findNext(T_FUNCTION, ($nextFunc + 1), $scopeCloser)) !== false) {
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
                    $funcName   = $phpcsFile->getDeclarationName($nextFunc);
                    $funcNameLc = strtolower($funcName);
                    if ($funcNameLc === '') {
                        continue;
                    }

                    if (isset($this->unsupportedMethods[$interfaceLc][$funcNameLc]) === true) {
                        $error     = 'Classes that implement interface %s do not support the method %s(). See %s';
                        $errorCode = $this->stringToErrorCode($interface).'UnsupportedMethod';
                        $data      = array(
                            $interface,
                            $funcName,
                            $this->unsupportedMethods[$interfaceLc][$funcNameLc],
                        );

                        $phpcsFile->addError($error, $nextFunc, $errorCode, $data);
                    }
                }
            }
        }
    }//end processClassToken()


    /**
     * Processes this test for when a function token is encountered.
     *
     * - Detect new interfaces when used as a type hint.
     *
     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
     * @param int                  $stackPtr  The position of the current token in
     *                                        the stack passed in $tokens.
     *
     * @return void
     */
    private function processFunctionToken(PHP_CodeSniffer_File $phpcsFile, $stackPtr)

    {
        $typeHints = $this->getTypeHintsFromFunctionDeclaration($phpcsFile, $stackPtr);
        if (empty($typeHints) || is_array($typeHints) === false) {
            return;
        }

        foreach ($typeHints as $hint) {

            $typeHintLc = strtolower($hint);

            if (isset($this->newInterfaces[$typeHintLc]) === true) {
                $itemInfo = array(
                    'name'   => $hint,
                    'nameLc' => $typeHintLc,
                );
                $this->handleFeature($phpcsFile, $stackPtr, $itemInfo);
            }
        }
    }


    /**
     * Get the relevant sub-array for a specific item from a multi-dimensional array.
     *
     * @param array $itemInfo Base information about the item.
     *
     * @return array Version and other information about the item.
     */
    public function getItemArray(array $itemInfo)
    {
        return $this->newInterfaces[$itemInfo['nameLc']];
    }


    /**
     * Get the error message template for this sniff.
     *
     * @return string
     */
    protected function getErrorMsgTemplate()
    {
        return 'The built-in interface '.parent::getErrorMsgTemplate();
    }


}//end class


1		<?php
2		/**
3		* PHPCompatibility_Sniffs_PHP_NewInterfacesSniff.
4		*
5		* @category PHP
6		* @package PHPCompatibility
7		* @author Juliette Reinders Folmer <[email protected]>
8		*/
9
10		/**
11		* PHPCompatibility_Sniffs_PHP_NewInterfacesSniff.
12		*
13		* @category PHP
14		* @package PHPCompatibility
15		* @author Juliette Reinders Folmer <[email protected]>
16		*/
17		class PHPCompatibility_Sniffs_PHP_NewInterfacesSniff extends PHPCompatibility_AbstractNewFeatureSniff
		0 ignored issues – show Coding Style Compatibility introduced 2016-08-04 22:56 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
18		{
19
20		/**
21		* A list of new interfaces, not present in older versions.
22		*
23		* The array lists : version number with false (not present) or true (present).
24		* If's sufficient to list the first version where the interface appears.
25		*
26		* @var array(string => array(string => int\|string\|null))
27		*/
28		protected $newInterfaces = array(
29		'Traversable' => array(
30		'4.4' => false,
31		'5.0' => true,
32		),
33
34		'Countable' => array(
35		'5.0' => false,
36		'5.1' => true,
37		),
38		'OuterIterator' => array(
39		'5.0' => false,
40		'5.1' => true,
41		),
42		'RecursiveIterator' => array(
43		'5.0' => false,
44		'5.1' => true,
45		),
46		'SeekableIterator' => array(
47		'5.0' => false,
48		'5.1' => true,
49		),
50		'Serializable' => array(
51		'5.0' => false,
52		'5.1' => true,
53		),
54		'SplObserver' => array(
55		'5.0' => false,
56		'5.1' => true,
57		),
58		'SplSubject' => array(
59		'5.0' => false,
60		'5.1' => true,
61		),
62
63		'JsonSerializable' => array(
64		'5.3' => false,
65		'5.4' => true,
66		),
67		'SessionHandlerInterface' => array(
68		'5.3' => false,
69		'5.4' => true,
70		),
71
72		'DateTimeInterface' => array(
73		'5.4' => false,
74		'5.5' => true,
75		),
76
77		'Throwable' => array(
78		'5.6' => false,
79		'7.0' => true,
80		),
81
82		);
83
84		/**
85		* A list of methods which cannot be used in combination with particular interfaces.
86		*
87		* @var array(string => array(string => string))
88		*/
89		protected $unsupportedMethods = array(
90		'Serializable' => array(
91		'__sleep' => 'http://php.net/serializable',
92		'__wakeup' => 'http://php.net/serializable',
93		),
94		);
95
96		/**
97		* Returns an array of tokens this test wants to listen for.
98		*
99		* @return array
100		*/
101		public function register()
102		{
103		// Handle case-insensitivity of interface names.
104		$this->newInterfaces = $this->arrayKeysToLowercase($this->newInterfaces);
105		$this->unsupportedMethods = $this->arrayKeysToLowercase($this->unsupportedMethods);
106
107		$targets = array(
108		T_CLASS,
109		T_FUNCTION,
110		T_CLOSURE,
111		);
112
113		if (defined('T_ANON_CLASS')) {
114		$targets[] = constant('T_ANON_CLASS');
115		}
116
117		return $targets;
118
119		}//end register()
120
121
122		/**
123		* Processes this test, when one of its tokens is encountered.
124		*
125		* @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
126		* @param int $stackPtr The position of the current token in
127		* the stack passed in $tokens.
128		*
129		* @return void
130		*/
131	View Code Duplication	public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
		0 ignored issues – show Duplication introduced 2016-08-03 20:28 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...
132		{
133		$tokens = $phpcsFile->getTokens();
134
135		switch ($tokens[$stackPtr]['type']) {
136		case 'T_CLASS':
137		case 'T_ANON_CLASS':
138		$this->processClassToken($phpcsFile, $stackPtr);
139		break;
140
141		case 'T_FUNCTION':
142		case 'T_CLOSURE':
143		$this->processFunctionToken($phpcsFile, $stackPtr);
144		break;
145
146		default:
147		// Deliberately left empty.
148		break;
149		}
150
151		}//end process()
152
153
154		/**
155		* Processes this test for when a class token is encountered.
156		*
157		* - Detect classes implementing the new interfaces.
158		* - Detect classes implementing the new interfaces with unsupported functions.
159		*
160		* @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
161		* @param int $stackPtr The position of the current token in
162		* the stack passed in $tokens.
163		*
164		* @return void
165		*/
166		private function processClassToken(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
167		{
168		$interfaces = $this->findImplementedInterfaceNames($phpcsFile, $stackPtr);
169
170		if (is_array($interfaces) === false \|\| $interfaces === array()) {
171		return;
172		}
173
174		$tokens = $phpcsFile->getTokens();
175		$checkMethods = false;
176
177		if (isset($tokens[$stackPtr]['scope_closer'])) {
178		$checkMethods = true;
179		$scopeCloser = $tokens[$stackPtr]['scope_closer'];
180		}
181
182		foreach ($interfaces as $interface) {
183		$interfaceLc = strtolower($interface);
184
185		if (isset($this->newInterfaces[$interfaceLc]) === true) {
186		$itemInfo = array(
187		'name' => $interface,
188		'nameLc' => $interfaceLc,
189		);
190		$this->handleFeature($phpcsFile, $stackPtr, $itemInfo);
191		}
192
193		if ($checkMethods === true && isset($this->unsupportedMethods[$interfaceLc]) === true) {
194		$nextFunc = $stackPtr;
195		while (($nextFunc = $phpcsFile->findNext(T_FUNCTION, ($nextFunc + 1), $scopeCloser)) !== false) {
		0 ignored issues – show Bug introduced 2016-08-04 08:07 UTC by Report Bug Copy Issue Report The variable `$scopeCloser` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
196		$funcName = $phpcsFile->getDeclarationName($nextFunc);
197		$funcNameLc = strtolower($funcName);
198		if ($funcNameLc === '') {
199		continue;
200		}
201
202		if (isset($this->unsupportedMethods[$interfaceLc][$funcNameLc]) === true) {
203		$error = 'Classes that implement interface %s do not support the method %s(). See %s';
204		$errorCode = $this->stringToErrorCode($interface).'UnsupportedMethod';
205		$data = array(
206		$interface,
207		$funcName,
208		$this->unsupportedMethods[$interfaceLc][$funcNameLc],
209		);
210
211		$phpcsFile->addError($error, $nextFunc, $errorCode, $data);
212		}
213		}
214		}
215		}
216		}//end processClassToken()
217
218
219		/**
220		* Processes this test for when a function token is encountered.
221		*
222		* - Detect new interfaces when used as a type hint.
223		*
224		* @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
225		* @param int $stackPtr The position of the current token in
226		* the stack passed in $tokens.
227		*
228		* @return void
229		*/
230	View Code Duplication	private function processFunctionToken(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
		0 ignored issues – show Duplication introduced 2017-04-28 11:44 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...
231		{
232		$typeHints = $this->getTypeHintsFromFunctionDeclaration($phpcsFile, $stackPtr);
233		if (empty($typeHints) \|\| is_array($typeHints) === false) {
234		return;
235		}
236
237		foreach ($typeHints as $hint) {
238
239		$typeHintLc = strtolower($hint);
240
241		if (isset($this->newInterfaces[$typeHintLc]) === true) {
242		$itemInfo = array(
243		'name' => $hint,
244		'nameLc' => $typeHintLc,
245		);
246		$this->handleFeature($phpcsFile, $stackPtr, $itemInfo);
247		}
248		}
249		}
250
251
252		/**
253		* Get the relevant sub-array for a specific item from a multi-dimensional array.
254		*
255		* @param array $itemInfo Base information about the item.
256		*
257		* @return array Version and other information about the item.
258		*/
259		public function getItemArray(array $itemInfo)
260		{
261		return $this->newInterfaces[$itemInfo['nameLc']];
262		}
263
264
265		/**
266		* Get the error message template for this sniff.
267		*
268		* @return string
269		*/
270		protected function getErrorMsgTemplate()
271		{
272		return 'The built-in interface '.parent::getErrorMsgTemplate();
273		}
274
275
276		}//end class
277

wimg / PHPCompatibility

Push — feature/travis-add-interim-php... ( d1bcd9...c11f41 )

getItemArray() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like