WordPress_Sniffs_Arrays_ArrayDeclarationSniff::processMultiLineArray()

Complexity

Conditions	68
Paths	> 20000

Size

Total Lines	407
Code Lines	223

Duplication

Lines	181
Ratio	44.47 %

Importance

Changes

0

<?php
	public function processMultiLineArray( PHP_CodeSniffer_File $phpcsFile, $stackPtr, $arrayStart, $arrayEnd ) {
		$tokens       = $phpcsFile->getTokens();
		$keywordStart = $tokens[ $stackPtr ]['column'];

		// Check the closing bracket is on a new line.
		$lastContent = $phpcsFile->findPrevious( T_WHITESPACE, ( $arrayEnd - 1 ), $arrayStart, true );
		if ( $tokens[ $lastContent ]['line'] === $tokens[ $arrayEnd ]['line'] ) {
			$error = 'Closing parenthesis of array declaration must be on a new line';
			$fix   = $phpcsFile->addFixableError( $error, $arrayEnd, 'CloseBraceNewLine' );
			if ( true === $fix ) {
				$phpcsFile->fixer->addNewlineBefore( $arrayEnd );
			}
		} // end if

		$nextToken  = $stackPtr;

$nextToken is not used, you could remove the assignment.

		$keyUsed    = false;
		$singleUsed = false;

$singleUsed is not used, you could remove the assignment.

		$indices    = array();
		$maxLength  = 0;

		if ( T_ARRAY === $tokens[ $stackPtr ]['code'] ) {

This code seems to be duplicated across your project.

			$lastToken = $tokens[ $stackPtr ]['parenthesis_opener'];
		} else {
			$lastToken = $stackPtr;
		}

		// Find all the double arrows that reside in this scope.
		for ( $nextToken = ( $stackPtr + 1 ); $nextToken < $arrayEnd; $nextToken++ ) {
			// Skip bracketed statements, like function calls.
			if ( T_OPEN_PARENTHESIS === $tokens[ $nextToken ]['code']

This code seems to be duplicated across your project.

			    && ( ! isset( $tokens[ $nextToken ]['parenthesis_owner'] )
			        || $tokens[ $nextToken ]['parenthesis_owner'] !== $stackPtr )
			) {
				$nextToken = $tokens[ $nextToken ]['parenthesis_closer'];
				continue;
			}

			if ( T_ARRAY === $tokens[ $nextToken ]['code'] ) {

This code seems to be duplicated across your project.

				// Let subsequent calls of this test handle nested arrays.
				if ( T_DOUBLE_ARROW !== $tokens[ $lastToken ]['code'] ) {
					$indices[] = array( 'value' => $nextToken );
					$lastToken = $nextToken;
				}

				$nextToken = $tokens[ $tokens[ $nextToken ]['parenthesis_opener'] ]['parenthesis_closer'];
				$nextToken = $phpcsFile->findNext( T_WHITESPACE, ( $nextToken + 1 ), null, true );
				if ( T_COMMA !== $tokens[ $nextToken ]['code'] ) {
					$nextToken--;
				} else {
					$lastToken = $nextToken;
				}

				continue;
			}

			if ( T_OPEN_SHORT_ARRAY === $tokens[ $nextToken ]['code'] ) {

This code seems to be duplicated across your project.

				// Let subsequent calls of this test handle nested arrays.
				if ( T_DOUBLE_ARROW !== $tokens[ $lastToken ]['code'] ) {
					$indices[] = array( 'value' => $nextToken );
					$lastToken = $nextToken;
				}

				$nextToken = $tokens[ $nextToken ]['bracket_closer'];
				$nextToken = $phpcsFile->findNext( T_WHITESPACE, ( $nextToken + 1 ), null, true );
				if ( T_COMMA !== $tokens[ $nextToken ]['code'] ) {
					$nextToken--;
				} else {
					$lastToken = $nextToken;
				}

				continue;
			}

			if ( T_CLOSURE === $tokens[ $nextToken ]['code'] ) {

This code seems to be duplicated across your project.

				if ( T_DOUBLE_ARROW !== $tokens[ $lastToken ]['code'] ) {
					$indices[] = array( 'value' => $nextToken );
					$lastToken = $nextToken;
				}

				$nextToken = $tokens[ $nextToken ]['scope_closer'];
				$nextToken = $phpcsFile->findNext( T_WHITESPACE, ( $nextToken + 1 ), null, true );
				if ( T_COMMA !== $tokens[ $nextToken ]['code'] ) {
					$nextToken--;
				} else {
					$lastToken = $nextToken;
				}

				continue;
			}

			if ( T_DOUBLE_ARROW !== $tokens[ $nextToken ]['code'] && T_COMMA !== $tokens[ $nextToken ]['code'] ) {

This code seems to be duplicated across your project.

				continue;
			}

			$currentEntry = array();

			if ( T_COMMA === $tokens[ $nextToken ]['code'] ) {
				$stackPtrCount = 0;
				if ( isset( $tokens[ $stackPtr ]['nested_parenthesis'] ) ) {

This code seems to be duplicated across your project.

					$stackPtrCount = count( $tokens[ $stackPtr ]['nested_parenthesis'] );
				}

				$commaCount = 0;
				if ( isset( $tokens[ $nextToken ]['nested_parenthesis'] ) ) {
					$commaCount = count( $tokens[ $nextToken ]['nested_parenthesis'] );
					if ( T_ARRAY === $tokens[ $stackPtr ]['code'] ) {
						// Remove parenthesis that are used to define the array.
						$commaCount--;
					}
				}

				if ( $commaCount > $stackPtrCount ) {
					// This comma is inside more parenthesis than the ARRAY keyword,
					// then there it is actually a comma used to separate arguments
					// in a function call.
					continue;
				}

				if ( false === $keyUsed ) {

This code seems to be duplicated across your project.

					if ( T_WHITESPACE === $tokens[ ( $nextToken - 1 ) ]['code'] ) {
						$content = $tokens[ ( $nextToken - 2 ) ]['content'];
						if ( $tokens[ ( $nextToken - 1 ) ]['content'] === $phpcsFile->eolChar ) {
							$spaceLength = 'newline';
						} else {
							$spaceLength = $tokens[ ( $nextToken - 1 ) ]['length'];
						}

						$error = 'Expected 0 spaces between "%s" and comma; %s found';
						$data  = array(
							$content,
							$spaceLength,
						);

						$fix = $phpcsFile->addFixableError( $error, $nextToken, 'SpaceBeforeComma', $data );
						if ( true === $fix ) {
							$phpcsFile->fixer->replaceToken( ( $nextToken - 1 ), '' );
						}
					}

					$valueContent = $phpcsFile->findNext(
						PHP_CodeSniffer_Tokens::$emptyTokens,
						( $lastToken + 1 ),
						$nextToken,
						true
					);

					$indices[]  = array( 'value' => $valueContent );
					$singleUsed = true;

$singleUsed is not used, you could remove the assignment.

				} // end if

				$lastToken = $nextToken;
				continue;
			} // end if

			if ( T_DOUBLE_ARROW === $tokens[ $nextToken ]['code'] ) {

				$currentEntry['arrow'] = $nextToken;
				$keyUsed               = true;

				// Find the start of index that uses this double arrow.
				$indexEnd   = $phpcsFile->findPrevious( T_WHITESPACE, ( $nextToken - 1 ), $arrayStart, true );
				$indexStart = $phpcsFile->findStartOfStatement( $indexEnd );

It seems like $indexEnd defined by $phpcsFile->findPrevious(T_WHITESPACE, $nextToken - 1, $arrayStart, true) on line 278 can also be of type boolean; however, PHP_CodeSniffer_File::findStartOfStatement() does only seem to accept integer, maybe add an additional type check?

				if ( $indexStart === $indexEnd ) {

This code seems to be duplicated across your project.

					$currentEntry['index']         = $indexEnd;
					$currentEntry['index_content'] = $tokens[ $indexEnd ]['content'];
				} else {
					$currentEntry['index']         = $indexStart;
					$currentEntry['index_content'] = $phpcsFile->getTokensAsString( $indexStart, ( $indexEnd - $indexStart + 1 ) );
				}

				$indexLength = strlen( $currentEntry['index_content'] );
				if ( $maxLength < $indexLength ) {
					$maxLength = $indexLength;
				}

				// Find the value of this index.
				$nextContent = $phpcsFile->findNext(
					PHP_CodeSniffer_Tokens::$emptyTokens,
					( $nextToken + 1 ),
					$arrayEnd,
					true
				);

				$currentEntry['value'] = $nextContent;
				$indices[]             = $currentEntry;
				$lastToken             = $nextToken;
			} // end if
		} // end for

		// Check for mutli-line arrays that should be single-line.
		$singleValue = false;

$singleValue is not used, you could remove the assignment.

		if ( empty( $indices ) ) {

This code seems to be duplicated across your project.

			$singleValue = true;

$singleValue is not used, you could remove the assignment.

		} elseif ( 1 === count( $indices ) && T_COMMA === $tokens[ $lastToken ]['code'] ) {
			// There may be another array value without a comma.
			$exclude     = PHP_CodeSniffer_Tokens::$emptyTokens;
			$exclude[]   = T_COMMA;
			$nextContent = $phpcsFile->findNext( $exclude, ( $indices[0]['value'] + 1 ), $arrayEnd, true );
			if ( false === $nextContent ) {
				$singleValue = true;

$singleValue is not used, you could remove the assignment.

			}
		}

		/*
			This section checks for arrays that don't specify keys.

			Arrays such as:
			   array(
				'aaa',
				'bbb',
				'd',
			   );
		*/

		if ( false === $keyUsed && ! empty( $indices ) ) {
			$count     = count( $indices );
			$lastIndex = $indices[ ( $count - 1 ) ]['value'];

			$trailingContent = $phpcsFile->findPrevious(
				PHP_CodeSniffer_Tokens::$emptyTokens,
				( $arrayEnd - 1 ),
				$lastIndex,
				true
			);

			if ( T_COMMA !== $tokens[ $trailingContent ]['code'] ) {
				$phpcsFile->recordMetric( $stackPtr, 'Array end comma', 'no' );
				$error = 'Comma required after last value in array declaration';
				$fix   = $phpcsFile->addFixableError( $error, $trailingContent, 'NoCommaAfterLast' );

It seems like $trailingContent defined by $phpcsFile->findPrevious(\PHP_CodeSniffer_Tokens::$emptyTokens, $arrayEnd - 1, $lastIndex, true) on line 338 can also be of type boolean; however, PHP_CodeSniffer_File::addFixableError() does only seem to accept integer, maybe add an additional type check?

				if ( true === $fix ) {
					$phpcsFile->fixer->addContent( $trailingContent, ',' );

It seems like $trailingContent defined by $phpcsFile->findPrevious(\PHP_CodeSniffer_Tokens::$emptyTokens, $arrayEnd - 1, $lastIndex, true) on line 338 can also be of type boolean; however, PHP_CodeSniffer_Fixer::addContent() does only seem to accept integer, maybe add an additional type check?

				}
			} else {
				$phpcsFile->recordMetric( $stackPtr, 'Array end comma', 'yes' );
			}

			$lastValueLine = false;
			foreach ( $indices as $value ) {
				if ( empty( $value['value'] ) ) {
					// Array was malformed and we couldn't figure out
					// the array value correctly, so we have to ignore it.
					// Other parts of this sniff will correct the error.
					continue;
				}

				if ( false !== $lastValueLine && $tokens[ $value['value'] ]['line'] === $lastValueLine ) {
					$error = 'Each value in a multi-line array must be on a new line';
					$fix   = $phpcsFile->addFixableError( $error, $value['value'], 'ValueNoNewline' );
					if ( true === $fix ) {
						if ( T_WHITESPACE === $tokens[ ( $value['value'] - 1 ) ]['code'] ) {
							$phpcsFile->fixer->replaceToken( ( $value['value'] - 1 ), '' );
						}

						$phpcsFile->fixer->addNewlineBefore( $value['value'] );
					}
				} // end if

				$lastValueLine = $tokens[ $value['value'] ]['line'];
			} // end foreach
		} // end if

		/*
			Below the actual indentation of the array is checked.
			Errors will be thrown when a key is not aligned, when
			a double arrow is not aligned, and when a value is not
			aligned correctly.
			If an error is found in one of the above areas, then errors
			are not reported for the rest of the line to avoid reporting
			spaces and columns incorrectly. Often fixing the first
			problem will fix the other 2 anyway.

			For example:

			$a = array(
				  'index'  => '2',
				 );

			or

			$a = [
				  'index'  => '2',
				 ];

			In this array, the double arrow is indented too far, but this
			will also cause an error in the value's alignment. If the arrow were
			to be moved back one space however, then both errors would be fixed.
		 */

		$numValues = count( $indices );

		$indicesStart  = ( $keywordStart + 1 );
		$arrowStart    = ( $indicesStart + $maxLength + 1 );
		$valueStart    = ( $arrowStart + 3 );

$valueStart is not used, you could remove the assignment.

		$indexLine     = $tokens[ $stackPtr ]['line'];
		$lastIndexLine = null;

$lastIndexLine is not used, you could remove the assignment.

		foreach ( $indices as $index ) {
			if ( ! isset( $index['index'] ) ) {

This code seems to be duplicated across your project.

				// Array value only.
				if ( $tokens[ $index['value'] ]['line'] === $tokens[ $stackPtr ]['line'] && $numValues > 1 ) {
					$error = 'The first value in a multi-value array must be on a new line';
					$fix   = $phpcsFile->addFixableError( $error, $stackPtr, 'FirstValueNoNewline' );
					if ( true === $fix ) {
						$phpcsFile->fixer->addNewlineBefore( $index['value'] );
					}
				}

				continue;
			}

			$lastIndexLine = $indexLine;
			$indexLine     = $tokens[ $index['index'] ]['line'];

			if ( $indexLine === $tokens[ $stackPtr ]['line'] ) {
				$error = 'The first index in a multi-value array must be on a new line';
				$fix   = $phpcsFile->addFixableError( $error, $index['index'], 'FirstIndexNoNewline' );
				if ( true === $fix ) {
					$phpcsFile->fixer->addNewlineBefore( $index['index'] );
				}

				continue;
			}

			if ( $indexLine === $lastIndexLine ) {

This code seems to be duplicated across your project.

				$error = 'Each index in a multi-line array must be on a new line';
				$fix   = $phpcsFile->addFixableError( $error, $index['index'], 'IndexNoNewline' );
				if ( true === $fix ) {
					if ( T_WHITESPACE === $tokens[ ( $index['index'] - 1 ) ]['code'] ) {
						$phpcsFile->fixer->replaceToken( ( $index['index'] - 1 ), '' );
					}

					$phpcsFile->fixer->addNewlineBefore( $index['index'] );
				}

				continue;
			}

			// Check each line ends in a comma.
			$valueLine = $tokens[ $index['value'] ]['line'];
			$nextComma = false;
			for ( $i = $index['value']; $i < $arrayEnd; $i++ ) {
				// Skip bracketed statements, like function calls.
				if ( T_OPEN_PARENTHESIS === $tokens[ $i ]['code'] ) {

This code seems to be duplicated across your project.

					$i         = $tokens[ $i ]['parenthesis_closer'];
					$valueLine = $tokens[ $i ]['line'];
					continue;
				}

				if ( T_ARRAY === $tokens[ $i ]['code'] ) {
					$i         = $tokens[ $tokens[ $i ]['parenthesis_opener'] ]['parenthesis_closer'];
					$valueLine = $tokens[ $i ]['line'];
					continue;
				}

				if ( T_OPEN_SHORT_ARRAY === $tokens[ $i ]['code'] ) {

This code seems to be duplicated across your project.

					$i         = $tokens[ $i ]['bracket_closer'];
					$valueLine = $tokens[ $i ]['line'];
					continue;
				}

				if ( T_CLOSURE === $tokens[ $i ]['code'] ) {

This code seems to be duplicated across your project.

					$i         = $tokens[ $i ]['scope_closer'];
					$valueLine = $tokens[ $i ]['line'];
					continue;
				}

				if ( T_COMMA === $tokens[ $i ]['code'] ) {
					$nextComma = $i;
					break;
				}
			} // End for.

			if ( false === $nextComma ) {
				$error = 'Each line in an array declaration must end in a comma';
				$fix   = $phpcsFile->addFixableError( $error, $index['value'], 'NoComma' );

				if ( true === $fix ) {

This code seems to be duplicated across your project.

					// Find the end of the line and put a comma there.
					for ( $i = ( $index['value'] + 1 ); $i < $phpcsFile->numTokens; $i++ ) {
						if ( $tokens[ $i ]['line'] > $valueLine ) {
							break;
						}
					}

					$phpcsFile->fixer->addContentBefore( ( $i - 1 ), ',' );
				}
			}

			// Check that there is no space before the comma.
			if ( false !== $nextComma && T_WHITESPACE === $tokens[ ( $nextComma - 1 ) ]['code'] ) {

This code seems to be duplicated across your project.

				$content     = $tokens[ ( $nextComma - 2 ) ]['content'];
				$spaceLength = $tokens[ ( $nextComma - 1 ) ]['length'];
				$error       = 'Expected 0 spaces between "%s" and comma; %s found';
				$data        = array(
					$content,
					$spaceLength,
				);

				$fix = $phpcsFile->addFixableError( $error, $nextComma, 'SpaceBeforeComma', $data );
				if ( true === $fix ) {
					$phpcsFile->fixer->replaceToken( ( $nextComma - 1 ), '' );
				}
			}
		} // end foreach

	} // end processMultiLineArray()