gravityview / GravityView

vendor/phpcompatibility/php-compatibility/PHPCompatibility/Sniffs/LanguageConstructs/NewEmptyNonVariableSniff.php

Indentation +45 added lines, -45 removed lines

@@ -29,56 +29,56 @@
 class NewEmptyNonVariableSniff extends Sniff
 {
 
-    /**
-     * Returns an array of tokens this test wants to listen for.
-     *
-     * @return array
-     */
-    public function register()
-    {
-        return array(\T_EMPTY);
-    }
+	/**
+	 * Returns an array of tokens this test wants to listen for.
+	 *
+	 * @return array
+	 */
+	public function register()
+	{
+		return array(\T_EMPTY);
+	}
 
-    /**
-     * 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(File $phpcsFile, $stackPtr)
-    {
-        if ($this->supportsBelow('5.4') === false) {
-            return;
-        }
+	/**
+	 * 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(File $phpcsFile, $stackPtr)
+	{
+		if ($this->supportsBelow('5.4') === false) {
+			return;
+		}
 
-        $tokens = $phpcsFile->getTokens();
+		$tokens = $phpcsFile->getTokens();
 
-        $open = $phpcsFile->findNext(Tokens::$emptyTokens, ($stackPtr + 1), null, true, null, true);
-        if ($open === false
-            || $tokens[$open]['code'] !== \T_OPEN_PARENTHESIS
-            || isset($tokens[$open]['parenthesis_closer']) === false
-        ) {
-            return;
-        }
+		$open = $phpcsFile->findNext(Tokens::$emptyTokens, ($stackPtr + 1), null, true, null, true);
+		if ($open === false
+			|| $tokens[$open]['code'] !== \T_OPEN_PARENTHESIS
+			|| isset($tokens[$open]['parenthesis_closer']) === false
+		) {
+			return;
+		}
 
-        $close = $tokens[$open]['parenthesis_closer'];
+		$close = $tokens[$open]['parenthesis_closer'];
 
-        $nestingLevel = 0;
-        if ($close !== ($open + 1) && isset($tokens[$open + 1]['nested_parenthesis'])) {
-            $nestingLevel = \count($tokens[$open + 1]['nested_parenthesis']);
-        }
+		$nestingLevel = 0;
+		if ($close !== ($open + 1) && isset($tokens[$open + 1]['nested_parenthesis'])) {
+			$nestingLevel = \count($tokens[$open + 1]['nested_parenthesis']);
+		}
 
-        if ($this->isVariable($phpcsFile, ($open + 1), $close, $nestingLevel) === true) {
-            return;
-        }
+		if ($this->isVariable($phpcsFile, ($open + 1), $close, $nestingLevel) === true) {
+			return;
+		}
 
-        $phpcsFile->addError(
-            'Only variables can be passed to empty() prior to PHP 5.5.',
-            $stackPtr,
-            'Found'
-        );
-    }
+		$phpcsFile->addError(
+			'Only variables can be passed to empty() prior to PHP 5.5.',
+			$stackPtr,
+			'Found'
+		);
+	}
 }

vendor/phpcompatibility/php-compatibility/PHPCompatibility/Sniffs/LanguageConstructs/NewLanguageConstructsSniff.php

Indentation +113 added lines, -113 removed lines

@@ -24,117 +24,117 @@
 class NewLanguageConstructsSniff extends AbstractNewFeatureSniff
 {
 
-    /**
-     * A list of new language constructs, 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 keyword appears.
-     *
-     * @var array(string => array(string => int|string|null))
-     */
-    protected $newConstructs = array(
-        'T_NS_SEPARATOR' => array(
-            '5.2' => false,
-            '5.3' => true,
-            'description' => 'the \ operator (for namespaces)',
-        ),
-        'T_ELLIPSIS' => array(
-            '5.5' => false,
-            '5.6' => true,
-            'description' => 'the ... spread operator',
-        ),
-    );
-
-
-    /**
-     * Returns an array of tokens this test wants to listen for.
-     *
-     * @return array
-     */
-    public function register()
-    {
-        $tokens = array();
-        foreach ($this->newConstructs as $token => $versions) {
-            $tokens[] = constant($token);
-        }
-        return $tokens;
-    }
-
-
-    /**
-     * 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(File $phpcsFile, $stackPtr)
-    {
-        $tokens    = $phpcsFile->getTokens();
-        $tokenType = $tokens[$stackPtr]['type'];
-
-        $itemInfo = array(
-            'name' => $tokenType,
-        );
-        $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->newConstructs[$itemInfo['name']];
-    }
-
-
-    /**
-     * Get an array of the non-PHP-version array keys used in a sub-array.
-     *
-     * @return array
-     */
-    protected function getNonVersionArrayKeys()
-    {
-        return array('description');
-    }
-
-
-    /**
-     * Retrieve the relevant detail (version) information for use in an error message.
-     *
-     * @param array $itemArray Version and other information about the item.
-     * @param array $itemInfo  Base information about the item.
-     *
-     * @return array
-     */
-    public function getErrorInfo(array $itemArray, array $itemInfo)
-    {
-        $errorInfo                = parent::getErrorInfo($itemArray, $itemInfo);
-        $errorInfo['description'] = $itemArray['description'];
-
-        return $errorInfo;
-    }
-
-
-    /**
-     * Allow for concrete child classes to filter the error data before it's passed to PHPCS.
-     *
-     * @param array $data      The error data array which was created.
-     * @param array $itemInfo  Base information about the item this error message applies to.
-     * @param array $errorInfo Detail information about an item this error message applies to.
-     *
-     * @return array
-     */
-    protected function filterErrorData(array $data, array $itemInfo, array $errorInfo)
-    {
-        $data[0] = $errorInfo['description'];
-        return $data;
-    }
+	/**
+	 * A list of new language constructs, 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 keyword appears.
+	 *
+	 * @var array(string => array(string => int|string|null))
+	 */
+	protected $newConstructs = array(
+		'T_NS_SEPARATOR' => array(
+			'5.2' => false,
+			'5.3' => true,
+			'description' => 'the \ operator (for namespaces)',
+		),
+		'T_ELLIPSIS' => array(
+			'5.5' => false,
+			'5.6' => true,
+			'description' => 'the ... spread operator',
+		),
+	);
+
+
+	/**
+	 * Returns an array of tokens this test wants to listen for.
+	 *
+	 * @return array
+	 */
+	public function register()
+	{
+		$tokens = array();
+		foreach ($this->newConstructs as $token => $versions) {
+			$tokens[] = constant($token);
+		}
+		return $tokens;
+	}
+
+
+	/**
+	 * 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(File $phpcsFile, $stackPtr)
+	{
+		$tokens    = $phpcsFile->getTokens();
+		$tokenType = $tokens[$stackPtr]['type'];
+
+		$itemInfo = array(
+			'name' => $tokenType,
+		);
+		$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->newConstructs[$itemInfo['name']];
+	}
+
+
+	/**
+	 * Get an array of the non-PHP-version array keys used in a sub-array.
+	 *
+	 * @return array
+	 */
+	protected function getNonVersionArrayKeys()
+	{
+		return array('description');
+	}
+
+
+	/**
+	 * Retrieve the relevant detail (version) information for use in an error message.
+	 *
+	 * @param array $itemArray Version and other information about the item.
+	 * @param array $itemInfo  Base information about the item.
+	 *
+	 * @return array
+	 */
+	public function getErrorInfo(array $itemArray, array $itemInfo)
+	{
+		$errorInfo                = parent::getErrorInfo($itemArray, $itemInfo);
+		$errorInfo['description'] = $itemArray['description'];
+
+		return $errorInfo;
+	}
+
+
+	/**
+	 * Allow for concrete child classes to filter the error data before it's passed to PHPCS.
+	 *
+	 * @param array $data      The error data array which was created.
+	 * @param array $itemInfo  Base information about the item this error message applies to.
+	 * @param array $errorInfo Detail information about an item this error message applies to.
+	 *
+	 * @return array
+	 */
+	protected function filterErrorData(array $data, array $itemInfo, array $errorInfo)
+	{
+		$data[0] = $errorInfo['description'];
+		return $data;
+	}
 }

vendor/phpcompatibility/php-compatibility/PHPCompatibility/AbstractRemovedFeatureSniff.php

Indentation +122 added lines, -122 removed lines

@@ -22,126 +22,126 @@
 {
 
 
-    /**
-     * Determine whether an error/warning should be thrown for an item based on collected information.
-     *
-     * @param array $errorInfo Detail information about an item.
-     *
-     * @return bool
-     */
-    protected function shouldThrowError(array $errorInfo)
-    {
-        return ($errorInfo['deprecated'] !== '' || $errorInfo['removed'] !== '');
-    }
-
-
-    /**
-     * Get an array of the non-PHP-version array keys used in a sub-array.
-     *
-     * By default, removed feature version arrays, contain an additional 'alternative' array key.
-     *
-     * @return array
-     */
-    protected function getNonVersionArrayKeys()
-    {
-        return array('alternative');
-    }
-
-
-    /**
-     * Retrieve the relevant detail (version) information for use in an error message.
-     *
-     * @param array $itemArray Version and other information about the item.
-     * @param array $itemInfo  Base information about the item.
-     *
-     * @return array
-     */
-    public function getErrorInfo(array $itemArray, array $itemInfo)
-    {
-        $errorInfo = array(
-            'deprecated'  => '',
-            'removed'     => '',
-            'alternative' => '',
-            'error'       => false,
-        );
-
-        $versionArray = $this->getVersionArray($itemArray);
-
-        if (empty($versionArray) === false) {
-            foreach ($versionArray as $version => $removed) {
-                if ($this->supportsAbove($version) === true) {
-                    if ($removed === true && $errorInfo['removed'] === '') {
-                        $errorInfo['removed'] = $version;
-                        $errorInfo['error']   = true;
-                    } elseif ($errorInfo['deprecated'] === '') {
-                        $errorInfo['deprecated'] = $version;
-                    }
-                }
-            }
-        }
-
-        if (isset($itemArray['alternative']) === true) {
-            $errorInfo['alternative'] = $itemArray['alternative'];
-        }
-
-        return $errorInfo;
-    }
-
-
-    /**
-     * Get the error message template for suggesting an alternative for a specific sniff.
-     *
-     * @return string
-     */
-    protected function getAlternativeOptionTemplate()
-    {
-        return '; Use %s instead';
-    }
-
-
-    /**
-     * Generates the error or warning for this item.
-     *
-     * @param \PHP_CodeSniffer_File $phpcsFile The file being scanned.
-     * @param int                   $stackPtr  The position of the relevant token in
-     *                                         the stack.
-     * @param array                 $itemInfo  Base information about the item.
-     * @param array                 $errorInfo Array with detail (version) information
-     *                                         relevant to the item.
-     *
-     * @return void
-     */
-    public function addError(File $phpcsFile, $stackPtr, array $itemInfo, array $errorInfo)
-    {
-        $itemName = $this->getItemName($itemInfo, $errorInfo);
-        $error    = $this->getErrorMsgTemplate();
-
-        $errorCode = $this->stringToErrorCode($itemName);
-        $data      = array($itemName);
-
-        if ($errorInfo['deprecated'] !== '') {
-            $error     .= 'deprecated since PHP %s and ';
-            $errorCode .= 'Deprecated';
-            $data[]     = $errorInfo['deprecated'];
-        }
-
-        if ($errorInfo['removed'] !== '') {
-            $error     .= 'removed since PHP %s and ';
-            $errorCode .= 'Removed';
-            $data[]     = $errorInfo['removed'];
-        }
-
-        // Remove the last 'and' from the message.
-        $error = substr($error, 0, (\strlen($error) - 5));
-
-        if ($errorInfo['alternative'] !== '') {
-            $error .= $this->getAlternativeOptionTemplate();
-            $data[] = $errorInfo['alternative'];
-        }
-
-        $error = $this->filterErrorMsg($error, $itemInfo, $errorInfo);
-        $data  = $this->filterErrorData($data, $itemInfo, $errorInfo);
-
-        $this->addMessage($phpcsFile, $error, $stackPtr, $errorInfo['error'], $errorCode, $data);
-    }
+	/**
+	 * Determine whether an error/warning should be thrown for an item based on collected information.
+	 *
+	 * @param array $errorInfo Detail information about an item.
+	 *
+	 * @return bool
+	 */
+	protected function shouldThrowError(array $errorInfo)
+	{
+		return ($errorInfo['deprecated'] !== '' || $errorInfo['removed'] !== '');
+	}
+
+
+	/**
+	 * Get an array of the non-PHP-version array keys used in a sub-array.
+	 *
+	 * By default, removed feature version arrays, contain an additional 'alternative' array key.
+	 *
+	 * @return array
+	 */
+	protected function getNonVersionArrayKeys()
+	{
+		return array('alternative');
+	}
+
+
+	/**
+	 * Retrieve the relevant detail (version) information for use in an error message.
+	 *
+	 * @param array $itemArray Version and other information about the item.
+	 * @param array $itemInfo  Base information about the item.
+	 *
+	 * @return array
+	 */
+	public function getErrorInfo(array $itemArray, array $itemInfo)
+	{
+		$errorInfo = array(
+			'deprecated'  => '',
+			'removed'     => '',
+			'alternative' => '',
+			'error'       => false,
+		);
+
+		$versionArray = $this->getVersionArray($itemArray);
+
+		if (empty($versionArray) === false) {
+			foreach ($versionArray as $version => $removed) {
+				if ($this->supportsAbove($version) === true) {
+					if ($removed === true && $errorInfo['removed'] === '') {
+						$errorInfo['removed'] = $version;
+						$errorInfo['error']   = true;
+					} elseif ($errorInfo['deprecated'] === '') {
+						$errorInfo['deprecated'] = $version;
+					}
+				}
+			}
+		}
+
+		if (isset($itemArray['alternative']) === true) {
+			$errorInfo['alternative'] = $itemArray['alternative'];
+		}
+
+		return $errorInfo;
+	}
+
+
+	/**
+	 * Get the error message template for suggesting an alternative for a specific sniff.
+	 *
+	 * @return string
+	 */
+	protected function getAlternativeOptionTemplate()
+	{
+		return '; Use %s instead';
+	}
+
+
+	/**
+	 * Generates the error or warning for this item.
+	 *
+	 * @param \PHP_CodeSniffer_File $phpcsFile The file being scanned.
+	 * @param int                   $stackPtr  The position of the relevant token in
+	 *                                         the stack.
+	 * @param array                 $itemInfo  Base information about the item.
+	 * @param array                 $errorInfo Array with detail (version) information
+	 *                                         relevant to the item.
+	 *
+	 * @return void
+	 */
+	public function addError(File $phpcsFile, $stackPtr, array $itemInfo, array $errorInfo)
+	{
+		$itemName = $this->getItemName($itemInfo, $errorInfo);
+		$error    = $this->getErrorMsgTemplate();
+
+		$errorCode = $this->stringToErrorCode($itemName);
+		$data      = array($itemName);
+
+		if ($errorInfo['deprecated'] !== '') {
+			$error     .= 'deprecated since PHP %s and ';
+			$errorCode .= 'Deprecated';
+			$data[]     = $errorInfo['deprecated'];
+		}
+
+		if ($errorInfo['removed'] !== '') {
+			$error     .= 'removed since PHP %s and ';
+			$errorCode .= 'Removed';
+			$data[]     = $errorInfo['removed'];
+		}
+
+		// Remove the last 'and' from the message.
+		$error = substr($error, 0, (\strlen($error) - 5));
+
+		if ($errorInfo['alternative'] !== '') {
+			$error .= $this->getAlternativeOptionTemplate();
+			$data[] = $errorInfo['alternative'];
+		}
+
+		$error = $this->filterErrorMsg($error, $itemInfo, $errorInfo);
+		$data  = $this->filterErrorData($data, $itemInfo, $errorInfo);
+
+		$this->addMessage($phpcsFile, $error, $stackPtr, $errorInfo['error'], $errorCode, $data);
+	}
 }

vendor/phpcompatibility/php-compatibility/PHPCompatibility/AbstractFunctionCallParameterSniff.php

Indentation +153 added lines, -153 removed lines

@@ -24,157 +24,157 @@
  */
 abstract class AbstractFunctionCallParameterSniff extends Sniff
 {
-    /**
-     * Is the sniff looking for a function call or a method call ?
-     *
-     * Note: the child class may need to do additional checks to make sure that
-     * the method called is of the right class/object.
-     * Checking that is outside of the scope of this abstract sniff.
-     *
-     * @var bool False (default) if the sniff is looking for function calls.
-     *           True if the sniff is looking for method calls.
-     */
-    protected $isMethod = false;
-
-    /**
-     * Functions the sniff is looking for. Should be defined in the child class.
-     *
-     * @var array The only requirement for this array is that the top level
-     *            array keys are the names of the functions you're looking for.
-     *            Other than that, the array can have arbitrary content
-     *            depending on your needs.
-     */
-    protected $targetFunctions = array();
-
-    /**
-     * List of tokens which when they preceed the $stackPtr indicate that this
-     * is not a function call.
-     *
-     * @var array
-     */
-    private $ignoreTokens = array(
-        \T_DOUBLE_COLON    => true,
-        \T_OBJECT_OPERATOR => true,
-        \T_FUNCTION        => true,
-        \T_NEW             => true,
-        \T_CONST           => true,
-        \T_USE             => true,
-    );
-
-
-    /**
-     * Returns an array of tokens this test wants to listen for.
-     *
-     * @return array
-     */
-    public function register()
-    {
-        // Handle case-insensitivity of function names.
-        $this->targetFunctions = $this->arrayKeysToLowercase($this->targetFunctions);
-
-        return array(\T_STRING);
-    }
-
-
-    /**
-     * 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 int|void Integer stack pointer to skip forward or void to continue
-     *                  normal file processing.
-     */
-    public function process(File $phpcsFile, $stackPtr)
-    {
-        if ($this->bowOutEarly() === true) {
-            return;
-        }
-
-        $tokens     = $phpcsFile->getTokens();
-        $function   = $tokens[$stackPtr]['content'];
-        $functionLc = strtolower($function);
-
-        if (isset($this->targetFunctions[$functionLc]) === false) {
-            return;
-        }
-
-        $prevNonEmpty = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($stackPtr - 1), null, true);
-
-        if ($this->isMethod === true) {
-            if ($tokens[$prevNonEmpty]['code'] !== \T_DOUBLE_COLON
-                && $tokens[$prevNonEmpty]['code'] !== \T_OBJECT_OPERATOR
-            ) {
-                // Not a call to a PHP method.
-                return;
-            }
-        } else {
-            if (isset($this->ignoreTokens[$tokens[$prevNonEmpty]['code']]) === true) {
-                // Not a call to a PHP function.
-                return;
-            }
-
-            if ($tokens[$prevNonEmpty]['code'] === \T_NS_SEPARATOR
-                && $tokens[$prevNonEmpty - 1]['code'] === \T_STRING
-            ) {
-                // Namespaced function.
-                return;
-            }
-        }
-
-        $parameters = $this->getFunctionCallParameters($phpcsFile, $stackPtr);
-
-        if (empty($parameters)) {
-            return $this->processNoParameters($phpcsFile, $stackPtr, $function);
-        } else {
-            return $this->processParameters($phpcsFile, $stackPtr, $function, $parameters);
-        }
-    }
-
-
-    /**
-     * Do a version check to determine if this sniff needs to run at all.
-     *
-     * If the check done in a child class is not specific to one PHP version,
-     * this function should return `false`.
-     *
-     * @return bool
-     */
-    abstract protected function bowOutEarly();
-
-
-    /**
-     * Process the parameters of a matched function.
-     *
-     * This method has to be made concrete in child classes.
-     *
-     * @param \PHP_CodeSniffer_File $phpcsFile    The file being scanned.
-     * @param int                   $stackPtr     The position of the current token in the stack.
-     * @param string                $functionName The token content (function name) which was matched.
-     * @param array                 $parameters   Array with information about the parameters.
-     *
-     * @return int|void Integer stack pointer to skip forward or void to continue
-     *                  normal file processing.
-     */
-    abstract public function processParameters(File $phpcsFile, $stackPtr, $functionName, $parameters);
-
-
-    /**
-     * Process the function if no parameters were found.
-     *
-     * Defaults to doing nothing. Can be overloaded in child classes to handle functions
-     * were parameters are expected, but none found.
-     *
-     * @param \PHP_CodeSniffer_File $phpcsFile    The file being scanned.
-     * @param int                   $stackPtr     The position of the current token in the stack.
-     * @param string                $functionName The token content (function name) which was matched.
-     *
-     * @return int|void Integer stack pointer to skip forward or void to continue
-     *                  normal file processing.
-     */
-    public function processNoParameters(File $phpcsFile, $stackPtr, $functionName)
-    {
-        return;
-    }
+	/**
+	 * Is the sniff looking for a function call or a method call ?
+	 *
+	 * Note: the child class may need to do additional checks to make sure that
+	 * the method called is of the right class/object.
+	 * Checking that is outside of the scope of this abstract sniff.
+	 *
+	 * @var bool False (default) if the sniff is looking for function calls.
+	 *           True if the sniff is looking for method calls.
+	 */
+	protected $isMethod = false;
+
+	/**
+	 * Functions the sniff is looking for. Should be defined in the child class.
+	 *
+	 * @var array The only requirement for this array is that the top level
+	 *            array keys are the names of the functions you're looking for.
+	 *            Other than that, the array can have arbitrary content
+	 *            depending on your needs.
+	 */
+	protected $targetFunctions = array();
+
+	/**
+	 * List of tokens which when they preceed the $stackPtr indicate that this
+	 * is not a function call.
+	 *
+	 * @var array
+	 */
+	private $ignoreTokens = array(
+		\T_DOUBLE_COLON    => true,
+		\T_OBJECT_OPERATOR => true,
+		\T_FUNCTION        => true,
+		\T_NEW             => true,
+		\T_CONST           => true,
+		\T_USE             => true,
+	);
+
+
+	/**
+	 * Returns an array of tokens this test wants to listen for.
+	 *
+	 * @return array
+	 */
+	public function register()
+	{
+		// Handle case-insensitivity of function names.
+		$this->targetFunctions = $this->arrayKeysToLowercase($this->targetFunctions);
+
+		return array(\T_STRING);
+	}
+
+
+	/**
+	 * 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 int|void Integer stack pointer to skip forward or void to continue
+	 *                  normal file processing.
+	 */
+	public function process(File $phpcsFile, $stackPtr)
+	{
+		if ($this->bowOutEarly() === true) {
+			return;
+		}
+
+		$tokens     = $phpcsFile->getTokens();
+		$function   = $tokens[$stackPtr]['content'];
+		$functionLc = strtolower($function);
+
+		if (isset($this->targetFunctions[$functionLc]) === false) {
+			return;
+		}
+
+		$prevNonEmpty = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($stackPtr - 1), null, true);
+
+		if ($this->isMethod === true) {
+			if ($tokens[$prevNonEmpty]['code'] !== \T_DOUBLE_COLON
+				&& $tokens[$prevNonEmpty]['code'] !== \T_OBJECT_OPERATOR
+			) {
+				// Not a call to a PHP method.
+				return;
+			}
+		} else {
+			if (isset($this->ignoreTokens[$tokens[$prevNonEmpty]['code']]) === true) {
+				// Not a call to a PHP function.
+				return;
+			}
+
+			if ($tokens[$prevNonEmpty]['code'] === \T_NS_SEPARATOR
+				&& $tokens[$prevNonEmpty - 1]['code'] === \T_STRING
+			) {
+				// Namespaced function.
+				return;
+			}
+		}
+
+		$parameters = $this->getFunctionCallParameters($phpcsFile, $stackPtr);
+
+		if (empty($parameters)) {
+			return $this->processNoParameters($phpcsFile, $stackPtr, $function);
+		} else {
+			return $this->processParameters($phpcsFile, $stackPtr, $function, $parameters);
+		}
+	}
+
+
+	/**
+	 * Do a version check to determine if this sniff needs to run at all.
+	 *
+	 * If the check done in a child class is not specific to one PHP version,
+	 * this function should return `false`.
+	 *
+	 * @return bool
+	 */
+	abstract protected function bowOutEarly();
+
+
+	/**
+	 * Process the parameters of a matched function.
+	 *
+	 * This method has to be made concrete in child classes.
+	 *
+	 * @param \PHP_CodeSniffer_File $phpcsFile    The file being scanned.
+	 * @param int                   $stackPtr     The position of the current token in the stack.
+	 * @param string                $functionName The token content (function name) which was matched.
+	 * @param array                 $parameters   Array with information about the parameters.
+	 *
+	 * @return int|void Integer stack pointer to skip forward or void to continue
+	 *                  normal file processing.
+	 */
+	abstract public function processParameters(File $phpcsFile, $stackPtr, $functionName, $parameters);
+
+
+	/**
+	 * Process the function if no parameters were found.
+	 *
+	 * Defaults to doing nothing. Can be overloaded in child classes to handle functions
+	 * were parameters are expected, but none found.
+	 *
+	 * @param \PHP_CodeSniffer_File $phpcsFile    The file being scanned.
+	 * @param int                   $stackPtr     The position of the current token in the stack.
+	 * @param string                $functionName The token content (function name) which was matched.
+	 *
+	 * @return int|void Integer stack pointer to skip forward or void to continue
+	 *                  normal file processing.
+	 */
+	public function processNoParameters(File $phpcsFile, $stackPtr, $functionName)
+	{
+		return;
+	}
 }

vendor/phpcompatibility/php-compatibility/PHPCompatibility/PHPCSHelper.php

Indentation +619 added lines, -619 removed lines

@@ -30,623 +30,623 @@
 class PHPCSHelper
 {
 
-    /**
-     * Get the PHPCS version number.
-     *
-     * @return string
-     */
-    public static function getVersion()
-    {
-        if (\defined('\PHP_CodeSniffer\Config::VERSION')) {
-            // PHPCS 3.x.
-            return \PHP_CodeSniffer\Config::VERSION;
-        } else {
-            // PHPCS 2.x.
-            return \PHP_CodeSniffer::VERSION;
-        }
-    }
-
-
-    /**
-     * Pass config data to PHPCS.
-     *
-     * PHPCS cross-version compatibility helper.
-     *
-     * @param string      $key   The name of the config value.
-     * @param string|null $value The value to set. If null, the config entry
-     *                           is deleted, reverting it to the default value.
-     * @param boolean     $temp  Set this config data temporarily for this script run.
-     *                           This will not write the config data to the config file.
-     *
-     * @return void
-     */
-    public static function setConfigData($key, $value, $temp = false)
-    {
-        if (method_exists('\PHP_CodeSniffer\Config', 'setConfigData')) {
-            // PHPCS 3.x.
-            \PHP_CodeSniffer\Config::setConfigData($key, $value, $temp);
-        } else {
-            // PHPCS 2.x.
-            \PHP_CodeSniffer::setConfigData($key, $value, $temp);
-        }
-    }
-
-
-    /**
-     * Get the value of a single PHPCS config key.
-     *
-     * @param string $key The name of the config value.
-     *
-     * @return string|null
-     */
-    public static function getConfigData($key)
-    {
-        if (method_exists('\PHP_CodeSniffer\Config', 'getConfigData')) {
-            // PHPCS 3.x.
-            return \PHP_CodeSniffer\Config::getConfigData($key);
-        } else {
-            // PHPCS 2.x.
-            return \PHP_CodeSniffer::getConfigData($key);
-        }
-    }
-
-
-    /**
-     * Get the value of a single PHPCS config key.
-     *
-     * This config key can be set in the `CodeSniffer.conf` file, on the
-     * command-line or in a ruleset.
-     *
-     * @param \PHP_CodeSniffer_File $phpcsFile The file being scanned.
-     * @param string                $key       The name of the config value.
-     *
-     * @return string|null
-     */
-    public static function getCommandLineData(File $phpcsFile, $key)
-    {
-        if (class_exists('\PHP_CodeSniffer\Config')) {
-            // PHPCS 3.x.
-            $config = $phpcsFile->config;
-            if (isset($config->{$key})) {
-                return $config->{$key};
-            }
-        } else {
-            // PHPCS 2.x.
-            $config = $phpcsFile->phpcs->cli->getCommandLineValues();
-            if (isset($config[$key])) {
-                return $config[$key];
-            }
-        }
-
-        return null;
-    }
-
-
-    /**
-     * Returns the position of the first non-whitespace token in a statement.
-     *
-     * {@internal Duplicate of same method as contained in the `\PHP_CodeSniffer_File`
-     * class and introduced in PHPCS 2.1.0 and improved in PHPCS 2.7.1.
-     *
-     * Once the minimum supported PHPCS version for this standard goes beyond
-     * that, this method can be removed and calls to it replaced with
-     * `$phpcsFile->findStartOfStatement($start, $ignore)` calls.
-     *
-     * Last synced with PHPCS version: PHPCS 3.3.2 at commit 6ad28354c04b364c3c71a34e4a18b629cc3b231e}}
-     *
-     * @param \PHP_CodeSniffer_File $phpcsFile Instance of phpcsFile.
-     * @param int                   $start     The position to start searching from in the token stack.
-     * @param int|array             $ignore    Token types that should not be considered stop points.
-     *
-     * @return int
-     */
-    public static function findStartOfStatement(File $phpcsFile, $start, $ignore = null)
-    {
-        if (version_compare(self::getVersion(), '2.7.1', '>=') === true) {
-            return $phpcsFile->findStartOfStatement($start, $ignore);
-        }
-
-        $tokens    = $phpcsFile->getTokens();
-        $endTokens = Tokens::$blockOpeners;
-
-        $endTokens[\T_COLON]            = true;
-        $endTokens[\T_COMMA]            = true;
-        $endTokens[\T_DOUBLE_ARROW]     = true;
-        $endTokens[\T_SEMICOLON]        = true;
-        $endTokens[\T_OPEN_TAG]         = true;
-        $endTokens[\T_CLOSE_TAG]        = true;
-        $endTokens[\T_OPEN_SHORT_ARRAY] = true;
-
-        if ($ignore !== null) {
-            $ignore = (array) $ignore;
-            foreach ($ignore as $code) {
-                if (isset($endTokens[$code]) === true) {
-                    unset($endTokens[$code]);
-                }
-            }
-        }
-
-        $lastNotEmpty = $start;
-
-        for ($i = $start; $i >= 0; $i--) {
-            if (isset($endTokens[$tokens[$i]['code']]) === true) {
-                // Found the end of the previous statement.
-                return $lastNotEmpty;
-            }
-
-            if (isset($tokens[$i]['scope_opener']) === true
-                && $i === $tokens[$i]['scope_closer']
-            ) {
-                // Found the end of the previous scope block.
-                return $lastNotEmpty;
-            }
-
-            // Skip nested statements.
-            if (isset($tokens[$i]['bracket_opener']) === true
-                && $i === $tokens[$i]['bracket_closer']
-            ) {
-                $i = $tokens[$i]['bracket_opener'];
-            } elseif (isset($tokens[$i]['parenthesis_opener']) === true
-                && $i === $tokens[$i]['parenthesis_closer']
-            ) {
-                $i = $tokens[$i]['parenthesis_opener'];
-            }
-
-            if (isset(Tokens::$emptyTokens[$tokens[$i]['code']]) === false) {
-                $lastNotEmpty = $i;
-            }
-        }//end for
-
-        return 0;
-    }
-
-
-    /**
-     * Returns the position of the last non-whitespace token in a statement.
-     *
-     * {@internal Duplicate of same method as contained in the `\PHP_CodeSniffer_File`
-     * class and introduced in PHPCS 2.1.0 and improved in PHPCS 2.7.1 and 3.3.0.
-     *
-     * Once the minimum supported PHPCS version for this standard goes beyond
-     * that, this method can be removed and calls to it replaced with
-     * `$phpcsFile->findEndOfStatement($start, $ignore)` calls.
-     *
-     * Last synced with PHPCS version: PHPCS 3.3.0-alpha at commit f5d899dcb5c534a1c3cca34668624517856ba823}}
-     *
-     * @param \PHP_CodeSniffer_File $phpcsFile Instance of phpcsFile.
-     * @param int                   $start     The position to start searching from in the token stack.
-     * @param int|array             $ignore    Token types that should not be considered stop points.
-     *
-     * @return int
-     */
-    public static function findEndOfStatement(File $phpcsFile, $start, $ignore = null)
-    {
-        if (version_compare(self::getVersion(), '3.3.0', '>=') === true) {
-            return $phpcsFile->findEndOfStatement($start, $ignore);
-        }
-
-        $tokens    = $phpcsFile->getTokens();
-        $endTokens = array(
-            \T_COLON                => true,
-            \T_COMMA                => true,
-            \T_DOUBLE_ARROW         => true,
-            \T_SEMICOLON            => true,
-            \T_CLOSE_PARENTHESIS    => true,
-            \T_CLOSE_SQUARE_BRACKET => true,
-            \T_CLOSE_CURLY_BRACKET  => true,
-            \T_CLOSE_SHORT_ARRAY    => true,
-            \T_OPEN_TAG             => true,
-            \T_CLOSE_TAG            => true,
-        );
-
-        if ($ignore !== null) {
-            $ignore = (array) $ignore;
-            foreach ($ignore as $code) {
-                if (isset($endTokens[$code]) === true) {
-                    unset($endTokens[$code]);
-                }
-            }
-        }
-
-        $lastNotEmpty = $start;
-
-        for ($i = $start; $i < $phpcsFile->numTokens; $i++) {
-            if ($i !== $start && isset($endTokens[$tokens[$i]['code']]) === true) {
-                // Found the end of the statement.
-                if ($tokens[$i]['code'] === \T_CLOSE_PARENTHESIS
-                    || $tokens[$i]['code'] === \T_CLOSE_SQUARE_BRACKET
-                    || $tokens[$i]['code'] === \T_CLOSE_CURLY_BRACKET
-                    || $tokens[$i]['code'] === \T_CLOSE_SHORT_ARRAY
-                    || $tokens[$i]['code'] === \T_OPEN_TAG
-                    || $tokens[$i]['code'] === \T_CLOSE_TAG
-                ) {
-                    return $lastNotEmpty;
-                }
-
-                return $i;
-            }
-
-            // Skip nested statements.
-            if (isset($tokens[$i]['scope_closer']) === true
-                && ($i === $tokens[$i]['scope_opener']
-                || $i === $tokens[$i]['scope_condition'])
-            ) {
-                if ($i === $start && isset(Tokens::$scopeOpeners[$tokens[$i]['code']]) === true) {
-                    return $tokens[$i]['scope_closer'];
-                }
-
-                $i = $tokens[$i]['scope_closer'];
-            } elseif (isset($tokens[$i]['bracket_closer']) === true
-                && $i === $tokens[$i]['bracket_opener']
-            ) {
-                $i = $tokens[$i]['bracket_closer'];
-            } elseif (isset($tokens[$i]['parenthesis_closer']) === true
-                && $i === $tokens[$i]['parenthesis_opener']
-            ) {
-                $i = $tokens[$i]['parenthesis_closer'];
-            }
-
-            if (isset(Tokens::$emptyTokens[$tokens[$i]['code']]) === false) {
-                $lastNotEmpty = $i;
-            }
-        }//end for
-
-        return ($phpcsFile->numTokens - 1);
-    }
-
-
-    /**
-     * Returns the name of the class that the specified class extends
-     * (works for classes, anonymous classes and interfaces).
-     *
-     * Returns FALSE on error or if there is no extended class name.
-     *
-     * {@internal Duplicate of same method as contained in the `\PHP_CodeSniffer_File`
-     * class, but with some improvements which have been introduced in
-     * PHPCS 2.8.0.
-     * {@link https://github.com/squizlabs/PHP_CodeSniffer/commit/0011d448119d4c568e3ac1f825ae78815bf2cc34}.
-     *
-     * Once the minimum supported PHPCS version for this standard goes beyond
-     * that, this method can be removed and calls to it replaced with
-     * `$phpcsFile->findExtendedClassName($stackPtr)` calls.
-     *
-     * Last synced with PHPCS version: PHPCS 3.1.0-alpha at commit a9efcc9b0703f3f9f4a900623d4e97128a6aafc6}}
-     *
-     * @param \PHP_CodeSniffer_File $phpcsFile Instance of phpcsFile.
-     * @param int                   $stackPtr  The position of the class token in the stack.
-     *
-     * @return string|false
-     */
-    public static function findExtendedClassName(File $phpcsFile, $stackPtr)
-    {
-        if (version_compare(self::getVersion(), '3.1.0', '>=') === true) {
-            return $phpcsFile->findExtendedClassName($stackPtr);
-        }
-
-        $tokens = $phpcsFile->getTokens();
-
-        // Check for the existence of the token.
-        if (isset($tokens[$stackPtr]) === false) {
-            return false;
-        }
-
-        if ($tokens[$stackPtr]['code'] !== \T_CLASS
-            && $tokens[$stackPtr]['type'] !== 'T_ANON_CLASS'
-            && $tokens[$stackPtr]['type'] !== 'T_INTERFACE'
-        ) {
-            return false;
-        }
-
-        if (isset($tokens[$stackPtr]['scope_closer']) === false) {
-            return false;
-        }
-
-        $classCloserIndex = $tokens[$stackPtr]['scope_closer'];
-        $extendsIndex     = $phpcsFile->findNext(\T_EXTENDS, $stackPtr, $classCloserIndex);
-        if ($extendsIndex === false) {
-            return false;
-        }
-
-        $find = array(
-            \T_NS_SEPARATOR,
-            \T_STRING,
-            \T_WHITESPACE,
-        );
-
-        $end  = $phpcsFile->findNext($find, ($extendsIndex + 1), $classCloserIndex, true);
-        $name = $phpcsFile->getTokensAsString(($extendsIndex + 1), ($end - $extendsIndex - 1));
-        $name = trim($name);
-
-        if ($name === '') {
-            return false;
-        }
-
-        return $name;
-    }
-
-
-    /**
-     * Returns the name(s) of the interface(s) that the specified class implements.
-     *
-     * Returns FALSE on error or if there are no implemented interface names.
-     *
-     * {@internal Duplicate of same method as introduced in PHPCS 2.7.
-     * This method also includes an improvement we use which was only introduced
-     * in PHPCS 2.8.0, so only defer to upstream for higher versions.
-     * Once the minimum supported PHPCS version for this sniff library goes beyond
-     * that, this method can be removed and calls to it replaced with
-     * `$phpcsFile->findImplementedInterfaceNames($stackPtr)` calls.}}
-     *
-     * @param \PHP_CodeSniffer_File $phpcsFile The file being scanned.
-     * @param int                   $stackPtr  The position of the class token.
-     *
-     * @return array|false
-     */
-    public static function findImplementedInterfaceNames(File $phpcsFile, $stackPtr)
-    {
-        if (version_compare(self::getVersion(), '2.7.1', '>') === true) {
-            return $phpcsFile->findImplementedInterfaceNames($stackPtr);
-        }
-
-        $tokens = $phpcsFile->getTokens();
-
-        // Check for the existence of the token.
-        if (isset($tokens[$stackPtr]) === false) {
-            return false;
-        }
-
-        if ($tokens[$stackPtr]['code'] !== \T_CLASS
-            && $tokens[$stackPtr]['type'] !== 'T_ANON_CLASS'
-        ) {
-            return false;
-        }
-
-        if (isset($tokens[$stackPtr]['scope_closer']) === false) {
-            return false;
-        }
-
-        $classOpenerIndex = $tokens[$stackPtr]['scope_opener'];
-        $implementsIndex  = $phpcsFile->findNext(\T_IMPLEMENTS, $stackPtr, $classOpenerIndex);
-        if ($implementsIndex === false) {
-            return false;
-        }
-
-        $find = array(
-            \T_NS_SEPARATOR,
-            \T_STRING,
-            \T_WHITESPACE,
-            \T_COMMA,
-        );
-
-        $end  = $phpcsFile->findNext($find, ($implementsIndex + 1), ($classOpenerIndex + 1), true);
-        $name = $phpcsFile->getTokensAsString(($implementsIndex + 1), ($end - $implementsIndex - 1));
-        $name = trim($name);
-
-        if ($name === '') {
-            return false;
-        } else {
-            $names = explode(',', $name);
-            $names = array_map('trim', $names);
-            return $names;
-        }
-    }
-
-
-    /**
-     * Returns the method parameters for the specified function token.
-     *
-     * Each parameter is in the following format:
-     *
-     * <code>
-     *   0 => array(
-     *         'name'              => '$var',  // The variable name.
-     *         'token'             => integer, // The stack pointer to the variable name.
-     *         'content'           => string,  // The full content of the variable definition.
-     *         'pass_by_reference' => boolean, // Is the variable passed by reference?
-     *         'variable_length'   => boolean, // Is the param of variable length through use of `...` ?
-     *         'type_hint'         => string,  // The type hint for the variable.
-     *         'type_hint_token'   => integer, // The stack pointer to the type hint
-     *                                         // or false if there is no type hint.
-     *         'nullable_type'     => boolean, // Is the variable using a nullable type?
-     *        )
-     * </code>
-     *
-     * Parameters with default values have an additional array index of
-     * 'default' with the value of the default as a string.
-     *
-     * {@internal Duplicate of same method as contained in the `\PHP_CodeSniffer_File`
-     * class.
-     *
-     * Last synced with PHPCS version: PHPCS 3.3.0-alpha at commit 53a28408d345044c0360c2c1b4a2aaebf4a3b8c9}}
-     *
-     * @param \PHP_CodeSniffer_File $phpcsFile Instance of phpcsFile.
-     * @param int                   $stackPtr  The position in the stack of the
-     *                                         function token to acquire the
-     *                                         parameters for.
-     *
-     * @return array|false
-     * @throws \PHP_CodeSniffer_Exception If the specified $stackPtr is not of
-     *                                    type T_FUNCTION or T_CLOSURE.
-     */
-    public static function getMethodParameters(File $phpcsFile, $stackPtr)
-    {
-        if (version_compare(self::getVersion(), '3.3.0', '>=') === true) {
-            return $phpcsFile->getMethodParameters($stackPtr);
-        }
-
-        $tokens = $phpcsFile->getTokens();
-
-        // Check for the existence of the token.
-        if (isset($tokens[$stackPtr]) === false) {
-            return false;
-        }
-
-        if ($tokens[$stackPtr]['code'] !== \T_FUNCTION
-            && $tokens[$stackPtr]['code'] !== \T_CLOSURE
-        ) {
-            throw new PHPCS_Exception('$stackPtr must be of type T_FUNCTION or T_CLOSURE');
-        }
-
-        $opener = $tokens[$stackPtr]['parenthesis_opener'];
-        $closer = $tokens[$stackPtr]['parenthesis_closer'];
-
-        $vars            = array();
-        $currVar         = null;
-        $paramStart      = ($opener + 1);
-        $defaultStart    = null;
-        $paramCount      = 0;
-        $passByReference = false;
-        $variableLength  = false;
-        $typeHint        = '';
-        $typeHintToken   = false;
-        $nullableType    = false;
-
-        for ($i = $paramStart; $i <= $closer; $i++) {
-            // Check to see if this token has a parenthesis or bracket opener. If it does
-            // it's likely to be an array which might have arguments in it. This
-            // could cause problems in our parsing below, so lets just skip to the
-            // end of it.
-            if (isset($tokens[$i]['parenthesis_opener']) === true) {
-                // Don't do this if it's the close parenthesis for the method.
-                if ($i !== $tokens[$i]['parenthesis_closer']) {
-                    $i = ($tokens[$i]['parenthesis_closer'] + 1);
-                }
-            }
-
-            if (isset($tokens[$i]['bracket_opener']) === true) {
-                // Don't do this if it's the close parenthesis for the method.
-                if ($i !== $tokens[$i]['bracket_closer']) {
-                    $i = ($tokens[$i]['bracket_closer'] + 1);
-                }
-            }
-
-            switch ($tokens[$i]['type']) {
-                case 'T_BITWISE_AND':
-                    if ($defaultStart === null) {
-                        $passByReference = true;
-                    }
-                    break;
-                case 'T_VARIABLE':
-                    $currVar = $i;
-                    break;
-                case 'T_ELLIPSIS':
-                    $variableLength = true;
-                    break;
-                case 'T_ARRAY_HINT': // Pre-PHPCS 3.3.0.
-                case 'T_CALLABLE':
-                    if ($typeHintToken === false) {
-                        $typeHintToken = $i;
-                    }
-
-                    $typeHint .= $tokens[$i]['content'];
-                    break;
-                case 'T_SELF':
-                case 'T_PARENT':
-                case 'T_STATIC':
-                    // Self and parent are valid, static invalid, but was probably intended as type hint.
-                    if (isset($defaultStart) === false) {
-                        if ($typeHintToken === false) {
-                            $typeHintToken = $i;
-                        }
-
-                        $typeHint .= $tokens[$i]['content'];
-                    }
-                    break;
-                case 'T_STRING':
-                    // This is a string, so it may be a type hint, but it could
-                    // also be a constant used as a default value.
-                    $prevComma = false;
-                    for ($t = $i; $t >= $opener; $t--) {
-                        if ($tokens[$t]['code'] === \T_COMMA) {
-                            $prevComma = $t;
-                            break;
-                        }
-                    }
-
-                    if ($prevComma !== false) {
-                        $nextEquals = false;
-                        for ($t = $prevComma; $t < $i; $t++) {
-                            if ($tokens[$t]['code'] === \T_EQUAL) {
-                                $nextEquals = $t;
-                                break;
-                            }
-                        }
-
-                        if ($nextEquals !== false) {
-                            break;
-                        }
-                    }
-
-                    if ($defaultStart === null) {
-                        if ($typeHintToken === false) {
-                            $typeHintToken = $i;
-                        }
-
-                        $typeHint .= $tokens[$i]['content'];
-                    }
-                    break;
-                case 'T_NS_SEPARATOR':
-                    // Part of a type hint or default value.
-                    if ($defaultStart === null) {
-                        if ($typeHintToken === false) {
-                            $typeHintToken = $i;
-                        }
-
-                        $typeHint .= $tokens[$i]['content'];
-                    }
-                    break;
-                case 'T_NULLABLE':
-                case 'T_INLINE_THEN': // Pre-PHPCS 2.8.0.
-                    if ($defaultStart === null) {
-                        $nullableType = true;
-                        $typeHint    .= $tokens[$i]['content'];
-                    }
-                    break;
-                case 'T_CLOSE_PARENTHESIS':
-                case 'T_COMMA':
-                    // If it's null, then there must be no parameters for this
-                    // method.
-                    if ($currVar === null) {
-                        break;
-                    }
-
-                    $vars[$paramCount]            = array();
-                    $vars[$paramCount]['token']   = $currVar;
-                    $vars[$paramCount]['name']    = $tokens[$currVar]['content'];
-                    $vars[$paramCount]['content'] = trim($phpcsFile->getTokensAsString($paramStart, ($i - $paramStart)));
-
-                    if ($defaultStart !== null) {
-                        $vars[$paramCount]['default'] = trim(
-                            $phpcsFile->getTokensAsString(
-                                $defaultStart,
-                                ($i - $defaultStart)
-                            )
-                        );
-                    }
-
-                    $vars[$paramCount]['pass_by_reference'] = $passByReference;
-                    $vars[$paramCount]['variable_length']   = $variableLength;
-                    $vars[$paramCount]['type_hint']         = $typeHint;
-                    $vars[$paramCount]['type_hint_token']   = $typeHintToken;
-                    $vars[$paramCount]['nullable_type']     = $nullableType;
-
-                    // Reset the vars, as we are about to process the next parameter.
-                    $defaultStart    = null;
-                    $paramStart      = ($i + 1);
-                    $passByReference = false;
-                    $variableLength  = false;
-                    $typeHint        = '';
-                    $typeHintToken   = false;
-                    $nullableType    = false;
-
-                    $paramCount++;
-                    break;
-                case 'T_EQUAL':
-                    $defaultStart = ($i + 1);
-                    break;
-            }//end switch
-        }//end for
-
-        return $vars;
-    }
+	/**
+	 * Get the PHPCS version number.
+	 *
+	 * @return string
+	 */
+	public static function getVersion()
+	{
+		if (\defined('\PHP_CodeSniffer\Config::VERSION')) {
+			// PHPCS 3.x.
+			return \PHP_CodeSniffer\Config::VERSION;
+		} else {
+			// PHPCS 2.x.
+			return \PHP_CodeSniffer::VERSION;
+		}
+	}
+
+
+	/**
+	 * Pass config data to PHPCS.
+	 *
+	 * PHPCS cross-version compatibility helper.
+	 *
+	 * @param string      $key   The name of the config value.
+	 * @param string|null $value The value to set. If null, the config entry
+	 *                           is deleted, reverting it to the default value.
+	 * @param boolean     $temp  Set this config data temporarily for this script run.
+	 *                           This will not write the config data to the config file.
+	 *
+	 * @return void
+	 */
+	public static function setConfigData($key, $value, $temp = false)
+	{
+		if (method_exists('\PHP_CodeSniffer\Config', 'setConfigData')) {
+			// PHPCS 3.x.
+			\PHP_CodeSniffer\Config::setConfigData($key, $value, $temp);
+		} else {
+			// PHPCS 2.x.
+			\PHP_CodeSniffer::setConfigData($key, $value, $temp);
+		}
+	}
+
+
+	/**
+	 * Get the value of a single PHPCS config key.
+	 *
+	 * @param string $key The name of the config value.
+	 *
+	 * @return string|null
+	 */
+	public static function getConfigData($key)
+	{
+		if (method_exists('\PHP_CodeSniffer\Config', 'getConfigData')) {
+			// PHPCS 3.x.
+			return \PHP_CodeSniffer\Config::getConfigData($key);
+		} else {
+			// PHPCS 2.x.
+			return \PHP_CodeSniffer::getConfigData($key);
+		}
+	}
+
+
+	/**
+	 * Get the value of a single PHPCS config key.
+	 *
+	 * This config key can be set in the `CodeSniffer.conf` file, on the
+	 * command-line or in a ruleset.
+	 *
+	 * @param \PHP_CodeSniffer_File $phpcsFile The file being scanned.
+	 * @param string                $key       The name of the config value.
+	 *
+	 * @return string|null
+	 */
+	public static function getCommandLineData(File $phpcsFile, $key)
+	{
+		if (class_exists('\PHP_CodeSniffer\Config')) {
+			// PHPCS 3.x.
+			$config = $phpcsFile->config;
+			if (isset($config->{$key})) {
+				return $config->{$key};
+			}
+		} else {
+			// PHPCS 2.x.
+			$config = $phpcsFile->phpcs->cli->getCommandLineValues();
+			if (isset($config[$key])) {
+				return $config[$key];
+			}
+		}
+
+		return null;
+	}
+
+
+	/**
+	 * Returns the position of the first non-whitespace token in a statement.
+	 *
+	 * {@internal Duplicate of same method as contained in the `\PHP_CodeSniffer_File`
+	 * class and introduced in PHPCS 2.1.0 and improved in PHPCS 2.7.1.
+	 *
+	 * Once the minimum supported PHPCS version for this standard goes beyond
+	 * that, this method can be removed and calls to it replaced with
+	 * `$phpcsFile->findStartOfStatement($start, $ignore)` calls.
+	 *
+	 * Last synced with PHPCS version: PHPCS 3.3.2 at commit 6ad28354c04b364c3c71a34e4a18b629cc3b231e}}
+	 *
+	 * @param \PHP_CodeSniffer_File $phpcsFile Instance of phpcsFile.
+	 * @param int                   $start     The position to start searching from in the token stack.
+	 * @param int|array             $ignore    Token types that should not be considered stop points.
+	 *
+	 * @return int
+	 */
+	public static function findStartOfStatement(File $phpcsFile, $start, $ignore = null)
+	{
+		if (version_compare(self::getVersion(), '2.7.1', '>=') === true) {
+			return $phpcsFile->findStartOfStatement($start, $ignore);
+		}
+
+		$tokens    = $phpcsFile->getTokens();
+		$endTokens = Tokens::$blockOpeners;
+
+		$endTokens[\T_COLON]            = true;
+		$endTokens[\T_COMMA]            = true;
+		$endTokens[\T_DOUBLE_ARROW]     = true;
+		$endTokens[\T_SEMICOLON]        = true;
+		$endTokens[\T_OPEN_TAG]         = true;
+		$endTokens[\T_CLOSE_TAG]        = true;
+		$endTokens[\T_OPEN_SHORT_ARRAY] = true;
+
+		if ($ignore !== null) {
+			$ignore = (array) $ignore;
+			foreach ($ignore as $code) {
+				if (isset($endTokens[$code]) === true) {
+					unset($endTokens[$code]);
+				}
+			}
+		}
+
+		$lastNotEmpty = $start;
+
+		for ($i = $start; $i >= 0; $i--) {
+			if (isset($endTokens[$tokens[$i]['code']]) === true) {
+				// Found the end of the previous statement.
+				return $lastNotEmpty;
+			}
+
+			if (isset($tokens[$i]['scope_opener']) === true
+				&& $i === $tokens[$i]['scope_closer']
+			) {
+				// Found the end of the previous scope block.
+				return $lastNotEmpty;
+			}
+
+			// Skip nested statements.
+			if (isset($tokens[$i]['bracket_opener']) === true
+				&& $i === $tokens[$i]['bracket_closer']
+			) {
+				$i = $tokens[$i]['bracket_opener'];
+			} elseif (isset($tokens[$i]['parenthesis_opener']) === true
+				&& $i === $tokens[$i]['parenthesis_closer']
+			) {
+				$i = $tokens[$i]['parenthesis_opener'];
+			}
+
+			if (isset(Tokens::$emptyTokens[$tokens[$i]['code']]) === false) {
+				$lastNotEmpty = $i;
+			}
+		}//end for
+
+		return 0;
+	}
+
+
+	/**
+	 * Returns the position of the last non-whitespace token in a statement.
+	 *
+	 * {@internal Duplicate of same method as contained in the `\PHP_CodeSniffer_File`
+	 * class and introduced in PHPCS 2.1.0 and improved in PHPCS 2.7.1 and 3.3.0.
+	 *
+	 * Once the minimum supported PHPCS version for this standard goes beyond
+	 * that, this method can be removed and calls to it replaced with
+	 * `$phpcsFile->findEndOfStatement($start, $ignore)` calls.
+	 *
+	 * Last synced with PHPCS version: PHPCS 3.3.0-alpha at commit f5d899dcb5c534a1c3cca34668624517856ba823}}
+	 *
+	 * @param \PHP_CodeSniffer_File $phpcsFile Instance of phpcsFile.
+	 * @param int                   $start     The position to start searching from in the token stack.
+	 * @param int|array             $ignore    Token types that should not be considered stop points.
+	 *
+	 * @return int
+	 */
+	public static function findEndOfStatement(File $phpcsFile, $start, $ignore = null)
+	{
+		if (version_compare(self::getVersion(), '3.3.0', '>=') === true) {
+			return $phpcsFile->findEndOfStatement($start, $ignore);
+		}
+
+		$tokens    = $phpcsFile->getTokens();
+		$endTokens = array(
+			\T_COLON                => true,
+			\T_COMMA                => true,
+			\T_DOUBLE_ARROW         => true,
+			\T_SEMICOLON            => true,
+			\T_CLOSE_PARENTHESIS    => true,
+			\T_CLOSE_SQUARE_BRACKET => true,
+			\T_CLOSE_CURLY_BRACKET  => true,
+			\T_CLOSE_SHORT_ARRAY    => true,
+			\T_OPEN_TAG             => true,
+			\T_CLOSE_TAG            => true,
+		);
+
+		if ($ignore !== null) {
+			$ignore = (array) $ignore;
+			foreach ($ignore as $code) {
+				if (isset($endTokens[$code]) === true) {
+					unset($endTokens[$code]);
+				}
+			}
+		}
+
+		$lastNotEmpty = $start;
+
+		for ($i = $start; $i < $phpcsFile->numTokens; $i++) {
+			if ($i !== $start && isset($endTokens[$tokens[$i]['code']]) === true) {
+				// Found the end of the statement.
+				if ($tokens[$i]['code'] === \T_CLOSE_PARENTHESIS
+					|| $tokens[$i]['code'] === \T_CLOSE_SQUARE_BRACKET
+					|| $tokens[$i]['code'] === \T_CLOSE_CURLY_BRACKET
+					|| $tokens[$i]['code'] === \T_CLOSE_SHORT_ARRAY
+					|| $tokens[$i]['code'] === \T_OPEN_TAG
+					|| $tokens[$i]['code'] === \T_CLOSE_TAG
+				) {
+					return $lastNotEmpty;
+				}
+
+				return $i;
+			}
+
+			// Skip nested statements.
+			if (isset($tokens[$i]['scope_closer']) === true
+				&& ($i === $tokens[$i]['scope_opener']
+				|| $i === $tokens[$i]['scope_condition'])
+			) {
+				if ($i === $start && isset(Tokens::$scopeOpeners[$tokens[$i]['code']]) === true) {
+					return $tokens[$i]['scope_closer'];
+				}
+
+				$i = $tokens[$i]['scope_closer'];
+			} elseif (isset($tokens[$i]['bracket_closer']) === true
+				&& $i === $tokens[$i]['bracket_opener']
+			) {
+				$i = $tokens[$i]['bracket_closer'];
+			} elseif (isset($tokens[$i]['parenthesis_closer']) === true
+				&& $i === $tokens[$i]['parenthesis_opener']
+			) {
+				$i = $tokens[$i]['parenthesis_closer'];
+			}
+
+			if (isset(Tokens::$emptyTokens[$tokens[$i]['code']]) === false) {
+				$lastNotEmpty = $i;
+			}
+		}//end for
+
+		return ($phpcsFile->numTokens - 1);
+	}
+
+
+	/**
+	 * Returns the name of the class that the specified class extends
+	 * (works for classes, anonymous classes and interfaces).
+	 *
+	 * Returns FALSE on error or if there is no extended class name.
+	 *
+	 * {@internal Duplicate of same method as contained in the `\PHP_CodeSniffer_File`
+	 * class, but with some improvements which have been introduced in
+	 * PHPCS 2.8.0.
+	 * {@link https://github.com/squizlabs/PHP_CodeSniffer/commit/0011d448119d4c568e3ac1f825ae78815bf2cc34}.
+	 *
+	 * Once the minimum supported PHPCS version for this standard goes beyond
+	 * that, this method can be removed and calls to it replaced with
+	 * `$phpcsFile->findExtendedClassName($stackPtr)` calls.
+	 *
+	 * Last synced with PHPCS version: PHPCS 3.1.0-alpha at commit a9efcc9b0703f3f9f4a900623d4e97128a6aafc6}}
+	 *
+	 * @param \PHP_CodeSniffer_File $phpcsFile Instance of phpcsFile.
+	 * @param int                   $stackPtr  The position of the class token in the stack.
+	 *
+	 * @return string|false
+	 */
+	public static function findExtendedClassName(File $phpcsFile, $stackPtr)
+	{
+		if (version_compare(self::getVersion(), '3.1.0', '>=') === true) {
+			return $phpcsFile->findExtendedClassName($stackPtr);
+		}
+
+		$tokens = $phpcsFile->getTokens();
+
+		// Check for the existence of the token.
+		if (isset($tokens[$stackPtr]) === false) {
+			return false;
+		}
+
+		if ($tokens[$stackPtr]['code'] !== \T_CLASS
+			&& $tokens[$stackPtr]['type'] !== 'T_ANON_CLASS'
+			&& $tokens[$stackPtr]['type'] !== 'T_INTERFACE'
+		) {
+			return false;
+		}
+
+		if (isset($tokens[$stackPtr]['scope_closer']) === false) {
+			return false;
+		}
+
+		$classCloserIndex = $tokens[$stackPtr]['scope_closer'];
+		$extendsIndex     = $phpcsFile->findNext(\T_EXTENDS, $stackPtr, $classCloserIndex);
+		if ($extendsIndex === false) {
+			return false;
+		}
+
+		$find = array(
+			\T_NS_SEPARATOR,
+			\T_STRING,
+			\T_WHITESPACE,
+		);
+
+		$end  = $phpcsFile->findNext($find, ($extendsIndex + 1), $classCloserIndex, true);
+		$name = $phpcsFile->getTokensAsString(($extendsIndex + 1), ($end - $extendsIndex - 1));
+		$name = trim($name);
+
+		if ($name === '') {
+			return false;
+		}
+
+		return $name;
+	}
+
+
+	/**
+	 * Returns the name(s) of the interface(s) that the specified class implements.
+	 *
+	 * Returns FALSE on error or if there are no implemented interface names.
+	 *
+	 * {@internal Duplicate of same method as introduced in PHPCS 2.7.
+	 * This method also includes an improvement we use which was only introduced
+	 * in PHPCS 2.8.0, so only defer to upstream for higher versions.
+	 * Once the minimum supported PHPCS version for this sniff library goes beyond
+	 * that, this method can be removed and calls to it replaced with
+	 * `$phpcsFile->findImplementedInterfaceNames($stackPtr)` calls.}}
+	 *
+	 * @param \PHP_CodeSniffer_File $phpcsFile The file being scanned.
+	 * @param int                   $stackPtr  The position of the class token.
+	 *
+	 * @return array|false
+	 */
+	public static function findImplementedInterfaceNames(File $phpcsFile, $stackPtr)
+	{
+		if (version_compare(self::getVersion(), '2.7.1', '>') === true) {
+			return $phpcsFile->findImplementedInterfaceNames($stackPtr);
+		}
+
+		$tokens = $phpcsFile->getTokens();
+
+		// Check for the existence of the token.
+		if (isset($tokens[$stackPtr]) === false) {
+			return false;
+		}
+
+		if ($tokens[$stackPtr]['code'] !== \T_CLASS
+			&& $tokens[$stackPtr]['type'] !== 'T_ANON_CLASS'
+		) {
+			return false;
+		}
+
+		if (isset($tokens[$stackPtr]['scope_closer']) === false) {
+			return false;
+		}
+
+		$classOpenerIndex = $tokens[$stackPtr]['scope_opener'];
+		$implementsIndex  = $phpcsFile->findNext(\T_IMPLEMENTS, $stackPtr, $classOpenerIndex);
+		if ($implementsIndex === false) {
+			return false;
+		}
+
+		$find = array(
+			\T_NS_SEPARATOR,
+			\T_STRING,
+			\T_WHITESPACE,
+			\T_COMMA,
+		);
+
+		$end  = $phpcsFile->findNext($find, ($implementsIndex + 1), ($classOpenerIndex + 1), true);
+		$name = $phpcsFile->getTokensAsString(($implementsIndex + 1), ($end - $implementsIndex - 1));
+		$name = trim($name);
+
+		if ($name === '') {
+			return false;
+		} else {
+			$names = explode(',', $name);
+			$names = array_map('trim', $names);
+			return $names;
+		}
+	}
+
+
+	/**
+	 * Returns the method parameters for the specified function token.
+	 *
+	 * Each parameter is in the following format:
+	 *
+	 * <code>
+	 *   0 => array(
+	 *         'name'              => '$var',  // The variable name.
+	 *         'token'             => integer, // The stack pointer to the variable name.
+	 *         'content'           => string,  // The full content of the variable definition.
+	 *         'pass_by_reference' => boolean, // Is the variable passed by reference?
+	 *         'variable_length'   => boolean, // Is the param of variable length through use of `...` ?
+	 *         'type_hint'         => string,  // The type hint for the variable.
+	 *         'type_hint_token'   => integer, // The stack pointer to the type hint
+	 *                                         // or false if there is no type hint.
+	 *         'nullable_type'     => boolean, // Is the variable using a nullable type?
+	 *        )
+	 * </code>
+	 *
+	 * Parameters with default values have an additional array index of
+	 * 'default' with the value of the default as a string.
+	 *
+	 * {@internal Duplicate of same method as contained in the `\PHP_CodeSniffer_File`
+	 * class.
+	 *
+	 * Last synced with PHPCS version: PHPCS 3.3.0-alpha at commit 53a28408d345044c0360c2c1b4a2aaebf4a3b8c9}}
+	 *
+	 * @param \PHP_CodeSniffer_File $phpcsFile Instance of phpcsFile.
+	 * @param int                   $stackPtr  The position in the stack of the
+	 *                                         function token to acquire the
+	 *                                         parameters for.
+	 *
+	 * @return array|false
+	 * @throws \PHP_CodeSniffer_Exception If the specified $stackPtr is not of
+	 *                                    type T_FUNCTION or T_CLOSURE.
+	 */
+	public static function getMethodParameters(File $phpcsFile, $stackPtr)
+	{
+		if (version_compare(self::getVersion(), '3.3.0', '>=') === true) {
+			return $phpcsFile->getMethodParameters($stackPtr);
+		}
+
+		$tokens = $phpcsFile->getTokens();
+
+		// Check for the existence of the token.
+		if (isset($tokens[$stackPtr]) === false) {
+			return false;
+		}
+
+		if ($tokens[$stackPtr]['code'] !== \T_FUNCTION
+			&& $tokens[$stackPtr]['code'] !== \T_CLOSURE
+		) {
+			throw new PHPCS_Exception('$stackPtr must be of type T_FUNCTION or T_CLOSURE');
+		}
+
+		$opener = $tokens[$stackPtr]['parenthesis_opener'];
+		$closer = $tokens[$stackPtr]['parenthesis_closer'];
+
+		$vars            = array();
+		$currVar         = null;
+		$paramStart      = ($opener + 1);
+		$defaultStart    = null;
+		$paramCount      = 0;
+		$passByReference = false;
+		$variableLength  = false;
+		$typeHint        = '';
+		$typeHintToken   = false;
+		$nullableType    = false;
+
+		for ($i = $paramStart; $i <= $closer; $i++) {
+			// Check to see if this token has a parenthesis or bracket opener. If it does
+			// it's likely to be an array which might have arguments in it. This
+			// could cause problems in our parsing below, so lets just skip to the
+			// end of it.
+			if (isset($tokens[$i]['parenthesis_opener']) === true) {
+				// Don't do this if it's the close parenthesis for the method.
+				if ($i !== $tokens[$i]['parenthesis_closer']) {
+					$i = ($tokens[$i]['parenthesis_closer'] + 1);
+				}
+			}
+
+			if (isset($tokens[$i]['bracket_opener']) === true) {
+				// Don't do this if it's the close parenthesis for the method.
+				if ($i !== $tokens[$i]['bracket_closer']) {
+					$i = ($tokens[$i]['bracket_closer'] + 1);
+				}
+			}
+
+			switch ($tokens[$i]['type']) {
+				case 'T_BITWISE_AND':
+					if ($defaultStart === null) {
+						$passByReference = true;
+					}
+					break;
+				case 'T_VARIABLE':
+					$currVar = $i;
+					break;
+				case 'T_ELLIPSIS':
+					$variableLength = true;
+					break;
+				case 'T_ARRAY_HINT': // Pre-PHPCS 3.3.0.
+				case 'T_CALLABLE':
+					if ($typeHintToken === false) {
+						$typeHintToken = $i;
+					}
+
+					$typeHint .= $tokens[$i]['content'];
+					break;
+				case 'T_SELF':
+				case 'T_PARENT':
+				case 'T_STATIC':
+					// Self and parent are valid, static invalid, but was probably intended as type hint.
+					if (isset($defaultStart) === false) {
+						if ($typeHintToken === false) {
+							$typeHintToken = $i;
+						}
+
+						$typeHint .= $tokens[$i]['content'];
+					}
+					break;
+				case 'T_STRING':
+					// This is a string, so it may be a type hint, but it could
+					// also be a constant used as a default value.
+					$prevComma = false;
+					for ($t = $i; $t >= $opener; $t--) {
+						if ($tokens[$t]['code'] === \T_COMMA) {
+							$prevComma = $t;
+							break;
+						}
+					}
+
+					if ($prevComma !== false) {
+						$nextEquals = false;
+						for ($t = $prevComma; $t < $i; $t++) {
+							if ($tokens[$t]['code'] === \T_EQUAL) {
+								$nextEquals = $t;
+								break;
+							}
+						}
+
+						if ($nextEquals !== false) {
+							break;
+						}
+					}
+
+					if ($defaultStart === null) {
+						if ($typeHintToken === false) {
+							$typeHintToken = $i;
+						}
+
+						$typeHint .= $tokens[$i]['content'];
+					}
+					break;
+				case 'T_NS_SEPARATOR':
+					// Part of a type hint or default value.
+					if ($defaultStart === null) {
+						if ($typeHintToken === false) {
+							$typeHintToken = $i;
+						}
+
+						$typeHint .= $tokens[$i]['content'];
+					}
+					break;
+				case 'T_NULLABLE':
+				case 'T_INLINE_THEN': // Pre-PHPCS 2.8.0.
+					if ($defaultStart === null) {
+						$nullableType = true;
+						$typeHint    .= $tokens[$i]['content'];
+					}
+					break;
+				case 'T_CLOSE_PARENTHESIS':
+				case 'T_COMMA':
+					// If it's null, then there must be no parameters for this
+					// method.
+					if ($currVar === null) {
+						break;
+					}
+
+					$vars[$paramCount]            = array();
+					$vars[$paramCount]['token']   = $currVar;
+					$vars[$paramCount]['name']    = $tokens[$currVar]['content'];
+					$vars[$paramCount]['content'] = trim($phpcsFile->getTokensAsString($paramStart, ($i - $paramStart)));
+
+					if ($defaultStart !== null) {
+						$vars[$paramCount]['default'] = trim(
+							$phpcsFile->getTokensAsString(
+								$defaultStart,
+								($i - $defaultStart)
+							)
+						);
+					}
+
+					$vars[$paramCount]['pass_by_reference'] = $passByReference;
+					$vars[$paramCount]['variable_length']   = $variableLength;
+					$vars[$paramCount]['type_hint']         = $typeHint;
+					$vars[$paramCount]['type_hint_token']   = $typeHintToken;
+					$vars[$paramCount]['nullable_type']     = $nullableType;
+
+					// Reset the vars, as we are about to process the next parameter.
+					$defaultStart    = null;
+					$paramStart      = ($i + 1);
+					$passByReference = false;
+					$variableLength  = false;
+					$typeHint        = '';
+					$typeHintToken   = false;
+					$nullableType    = false;
+
+					$paramCount++;
+					break;
+				case 'T_EQUAL':
+					$defaultStart = ($i + 1);
+					break;
+			}//end switch
+		}//end for
+
+		return $vars;
+	}
 }

vendor/phpcompatibility/php-compatibility/PHPCSAliases.php

Indentation +30 added lines, -30 removed lines

@@ -24,44 +24,44 @@
  * manner.}}
  */
 if (defined('PHPCOMPATIBILITY_PHPCS_ALIASES_SET') === false) {
-    if (interface_exists('\PHP_CodeSniffer_Sniff') === false) {
-        class_alias('PHP_CodeSniffer\Sniffs\Sniff', '\PHP_CodeSniffer_Sniff');
-    }
-    if (class_exists('\PHP_CodeSniffer_File') === false) {
-        class_alias('PHP_CodeSniffer\Files\File', '\PHP_CodeSniffer_File');
-    }
-    if (class_exists('\PHP_CodeSniffer_Tokens') === false) {
-        class_alias('PHP_CodeSniffer\Util\Tokens', '\PHP_CodeSniffer_Tokens');
-    }
-    if (class_exists('\PHP_CodeSniffer_Exception') === false) {
-        class_alias('PHP_CodeSniffer\Exceptions\RuntimeException', '\PHP_CodeSniffer_Exception');
-    }
-    if (class_exists('\PHP_CodeSniffer_Standards_AbstractScopeSniff') === false) {
-        class_alias('PHP_CodeSniffer\Sniffs\AbstractScopeSniff', '\PHP_CodeSniffer_Standards_AbstractScopeSniff');
-    }
-    if (class_exists('\Generic_Sniffs_NamingConventions_CamelCapsFunctionNameSniff') === false) {
-        class_alias('PHP_CodeSniffer\Standards\Generic\Sniffs\NamingConventions\CamelCapsFunctionNameSniff', '\Generic_Sniffs_NamingConventions_CamelCapsFunctionNameSniff');
-    }
+	if (interface_exists('\PHP_CodeSniffer_Sniff') === false) {
+		class_alias('PHP_CodeSniffer\Sniffs\Sniff', '\PHP_CodeSniffer_Sniff');
+	}
+	if (class_exists('\PHP_CodeSniffer_File') === false) {
+		class_alias('PHP_CodeSniffer\Files\File', '\PHP_CodeSniffer_File');
+	}
+	if (class_exists('\PHP_CodeSniffer_Tokens') === false) {
+		class_alias('PHP_CodeSniffer\Util\Tokens', '\PHP_CodeSniffer_Tokens');
+	}
+	if (class_exists('\PHP_CodeSniffer_Exception') === false) {
+		class_alias('PHP_CodeSniffer\Exceptions\RuntimeException', '\PHP_CodeSniffer_Exception');
+	}
+	if (class_exists('\PHP_CodeSniffer_Standards_AbstractScopeSniff') === false) {
+		class_alias('PHP_CodeSniffer\Sniffs\AbstractScopeSniff', '\PHP_CodeSniffer_Standards_AbstractScopeSniff');
+	}
+	if (class_exists('\Generic_Sniffs_NamingConventions_CamelCapsFunctionNameSniff') === false) {
+		class_alias('PHP_CodeSniffer\Standards\Generic\Sniffs\NamingConventions\CamelCapsFunctionNameSniff', '\Generic_Sniffs_NamingConventions_CamelCapsFunctionNameSniff');
+	}
 
-    define('PHPCOMPATIBILITY_PHPCS_ALIASES_SET', true);
+	define('PHPCOMPATIBILITY_PHPCS_ALIASES_SET', true);
 
-    /*
+	/*
      * Register an autoloader.
      *
      * {@internal When `installed_paths` is set via the ruleset, this autoloader
      * is needed to run the sniffs.
      * Upstream issue: {@link https://github.com/squizlabs/PHP_CodeSniffer/issues/1591} }}
      */
-    spl_autoload_register(function ($class) {
-        // Only try & load our own classes.
-        if (stripos($class, 'PHPCompatibility') !== 0) {
-            return;
-        }
+	spl_autoload_register(function ($class) {
+		// Only try & load our own classes.
+		if (stripos($class, 'PHPCompatibility') !== 0) {
+			return;
+		}
 
-        $file = realpath(__DIR__) . DIRECTORY_SEPARATOR . strtr($class, '\\', DIRECTORY_SEPARATOR) . '.php';
+		$file = realpath(__DIR__) . DIRECTORY_SEPARATOR . strtr($class, '\\', DIRECTORY_SEPARATOR) . '.php';
 
-        if (file_exists($file)) {
-            include_once $file;
-        }
-    });
+		if (file_exists($file)) {
+			include_once $file;
+		}
+	});
 }

vendor/phpcompatibility/php-compatibility/phpunit-bootstrap.php

Indentation +20 added lines, -20 removed lines

@@ -6,16 +6,16 @@ 
  */
 
 if (defined('PHP_CODESNIFFER_IN_TESTS') === false) {
-    define('PHP_CODESNIFFER_IN_TESTS', true);
+	define('PHP_CODESNIFFER_IN_TESTS', true);
 }
 
 // The below two defines are needed for PHPCS 3.x.
 if (defined('PHP_CODESNIFFER_CBF') === false) {
-    define('PHP_CODESNIFFER_CBF', false);
+	define('PHP_CODESNIFFER_CBF', false);
 }
 
 if (defined('PHP_CODESNIFFER_VERBOSITY') === false) {
-    define('PHP_CODESNIFFER_VERBOSITY', 0);
+	define('PHP_CODESNIFFER_VERBOSITY', 0);
 }
 
 $ds = DIRECTORY_SEPARATOR;
@@ -25,34 +25,34 @@ 
 
 // This may be a Composer install.
 if ($phpcsDir === false && is_dir(__DIR__ . $ds . 'vendor' . $ds . 'squizlabs' . $ds . 'php_codesniffer')) {
-    $vendorDir = __DIR__ . $ds . 'vendor';
-    $phpcsDir  = $vendorDir . $ds . 'squizlabs' . $ds . 'php_codesniffer';
+	$vendorDir = __DIR__ . $ds . 'vendor';
+	$phpcsDir  = $vendorDir . $ds . 'squizlabs' . $ds . 'php_codesniffer';
 } elseif ($phpcsDir !== false) {
-    $phpcsDir = realpath($phpcsDir);
+	$phpcsDir = realpath($phpcsDir);
 }
 
 // Try and load the PHPCS autoloader.
 if ($phpcsDir !== false && file_exists($phpcsDir . $ds . 'autoload.php')) {
-    // PHPCS 3.x.
-    require_once $phpcsDir . $ds . 'autoload.php';
+	// PHPCS 3.x.
+	require_once $phpcsDir . $ds . 'autoload.php';
 
-    /*
+	/*
      * Alias the PHPCS 3.x classes to their PHPCS 2.x equivalent if necessary.
      * Also provide a custom autoloader for our abstract base classes as the PHPCS native autoloader
      * has trouble with them in combination with the PHPCompatibility custom unit test suite.
      */
-    require_once __DIR__ . $ds . 'PHPCSAliases.php';
+	require_once __DIR__ . $ds . 'PHPCSAliases.php';
 
 } elseif ($phpcsDir !== false && file_exists($phpcsDir . $ds . 'CodeSniffer.php')) {
-    // PHPCS 2.x.
-    require_once $phpcsDir . $ds . 'CodeSniffer.php';
+	// PHPCS 2.x.
+	require_once $phpcsDir . $ds . 'CodeSniffer.php';
 
-    if (isset($vendorDir) && file_exists($vendorDir . $ds . 'autoload.php')) {
-        require_once $vendorDir . $ds . 'autoload.php';
-    }
+	if (isset($vendorDir) && file_exists($vendorDir . $ds . 'autoload.php')) {
+		require_once $vendorDir . $ds . 'autoload.php';
+	}
 
 } else {
-    echo 'Uh oh... can\'t find PHPCS.
+	echo 'Uh oh... can\'t find PHPCS.
 
 If you use Composer, please run `composer install --prefer-source`.
 Otherwise, make sure you set a `PHPCS_DIR` environment variable in your phpunit.xml file
@@ -62,16 +62,16 @@ 
 https://is.gd/PHPCompatibilityContrib
 ';
 
-    die(1);
+	die(1);
 }
 
 
 // PHPUnit cross version compatibility.
 if (class_exists('PHPUnit\Runner\Version')
-    && version_compare(PHPUnit\Runner\Version::id(), '6.0', '>=')
-    && class_exists('PHPUnit_Framework_TestCase') === false
+	&& version_compare(PHPUnit\Runner\Version::id(), '6.0', '>=')
+	&& class_exists('PHPUnit_Framework_TestCase') === false
 ) {
-    class_alias('PHPUnit\Framework\TestCase', 'PHPUnit_Framework_TestCase');
+	class_alias('PHPUnit\Framework\TestCase', 'PHPUnit_Framework_TestCase');
 }
 
 require_once __DIR__ . $ds . 'PHPCompatibility' . $ds . 'Tests' . $ds . 'BaseSniffTest.php';

vendor/dealerdirect/phpcodesniffer-composer-installer/src/Plugin.php

Indentation +441 added lines, -441 removed lines

@@ -34,445 +34,445 @@
 class Plugin implements PluginInterface, EventSubscriberInterface
 {
 
-    const KEY_MAX_DEPTH = 'phpcodesniffer-search-depth';
-
-    const MESSAGE_ERROR_WRONG_MAX_DEPTH =
-        'The value of "%s" (in the composer.json "extra".section) must be an integer larger then %d, %s given.';
-    const MESSAGE_NOT_INSTALLED = 'PHPCodeSniffer is not installed';
-    const MESSAGE_NOTHING_TO_INSTALL = 'Nothing to install or update';
-    const MESSAGE_RUNNING_INSTALLER = 'Running PHPCodeSniffer Composer Installer';
-
-    const PACKAGE_NAME = 'squizlabs/php_codesniffer';
-    const PACKAGE_TYPE = 'phpcodesniffer-standard';
-
-    const PHPCS_CONFIG_KEY = 'installed_paths';
-
-    /**
-     * @var Composer
-     */
-    private $composer;
-
-    /**
-     * @var string
-     */
-    private $cwd;
-
-    /**
-     * @var Filesystem
-     */
-    private $filesystem;
-
-    /**
-     * @var array
-     */
-    private $installedPaths;
-
-    /**
-     * @var IOInterface
-     */
-    private $io;
-
-    /**
-     * @var ProcessExecutor
-     */
-    private $processExecutor;
-
-    /**
-     * Triggers the plugin's main functionality.
-     *
-     * Makes it possible to run the plugin as a custom command.
-     *
-     * @param Event $event
-     *
-     * @throws \InvalidArgumentException
-     * @throws \RuntimeException
-     * @throws LogicException
-     * @throws ProcessFailedException
-     * @throws RuntimeException
-     */
-    public static function run(Event $event)
-    {
-        $io = $event->getIO();
-        $composer = $event->getComposer();
-
-        $instance = new static();
-
-        $instance->io = $io;
-        $instance->composer = $composer;
-        $instance->init();
-        $instance->onDependenciesChangedEvent();
-    }
-
-    /**
-     * {@inheritDoc}
-     *
-     * @throws \RuntimeException
-     * @throws LogicException
-     * @throws ProcessFailedException
-     * @throws RuntimeException
-     */
-    public function activate(Composer $composer, IOInterface $io)
-    {
-        $this->composer = $composer;
-        $this->io = $io;
-
-        $this->init();
-    }
-
-    /**
-     * Prepares the plugin so it's main functionality can be run.
-     *
-     * @throws \RuntimeException
-     * @throws LogicException
-     * @throws ProcessFailedException
-     * @throws RuntimeException
-     */
-    private function init()
-    {
-        $this->cwd = getcwd();
-        $this->installedPaths = array();
-
-        $this->processExecutor = new ProcessExecutor($this->io);
-        $this->filesystem = new Filesystem($this->processExecutor);
-    }
-
-    /**
-     * {@inheritDoc}
-     */
-    public static function getSubscribedEvents()
-    {
-        return array(
-            ScriptEvents::POST_INSTALL_CMD => array(
-                array('onDependenciesChangedEvent', 0),
-            ),
-            ScriptEvents::POST_UPDATE_CMD => array(
-                array('onDependenciesChangedEvent', 0),
-            ),
-        );
-    }
-
-    /**
-     * Entry point for post install and post update events.
-     *
-     * @throws \InvalidArgumentException
-     * @throws LogicException
-     * @throws ProcessFailedException
-     * @throws RuntimeException
-     */
-    public function onDependenciesChangedEvent()
-    {
-        $io = $this->io;
-        $isVerbose = $io->isVerbose();
-
-        if ($isVerbose) {
-            $io->write(sprintf('<info>%s</info>', self::MESSAGE_RUNNING_INSTALLER));
-        }
-
-        if ($this->isPHPCodeSnifferInstalled() === true) {
-            $this->loadInstalledPaths();
-            $installPathCleaned = $this->cleanInstalledPaths();
-            $installPathUpdated = $this->updateInstalledPaths();
-
-            if ($installPathCleaned === true || $installPathUpdated === true) {
-                $this->saveInstalledPaths();
-            } elseif ($isVerbose) {
-                $io->write(sprintf('<info>%s</info>', self::MESSAGE_NOTHING_TO_INSTALL));
-            }
-        } elseif ($isVerbose) {
-            $io->write(sprintf('<info>%s</info>', self::MESSAGE_NOT_INSTALLED));
-        }
-    }
-
-    /**
-     * Load all paths from PHP_CodeSniffer into an array.
-     *
-     * @throws LogicException
-     * @throws ProcessFailedException
-     * @throws RuntimeException
-     */
-    private function loadInstalledPaths()
-    {
-        if ($this->isPHPCodeSnifferInstalled() === true) {
-            $this->processExecutor->execute(
-                sprintf(
-                    'phpcs --config-show %s',
-                    self::PHPCS_CONFIG_KEY
-                ),
-                $output,
-                $this->composer->getConfig()->get('bin-dir')
-            );
-
-            $phpcsInstalledPaths = str_replace(self::PHPCS_CONFIG_KEY . ': ', '', $output);
-            $phpcsInstalledPaths = trim($phpcsInstalledPaths);
-
-            if ($phpcsInstalledPaths !== '') {
-                $this->installedPaths = explode(',', $phpcsInstalledPaths);
-            }
-        }
-    }
-
-    /**
-     * Save all coding standard paths back into PHP_CodeSniffer
-     *
-     * @throws LogicException
-     * @throws ProcessFailedException
-     * @throws RuntimeException
-     */
-    private function saveInstalledPaths()
-    {
-        // Check if we found installed paths to set.
-        if (count($this->installedPaths) !== 0) {
-            $paths = implode(',', $this->installedPaths);
-            $arguments = array('--config-set', self::PHPCS_CONFIG_KEY, $paths);
-            $configMessage = sprintf(
-                'PHP CodeSniffer Config <info>%s</info> <comment>set to</comment> <info>%s</info>',
-                self::PHPCS_CONFIG_KEY,
-                $paths
-            );
-        } else {
-            // Delete the installed paths if none were found.
-            $arguments = array('--config-delete', self::PHPCS_CONFIG_KEY);
-            $configMessage = sprintf(
-                'PHP CodeSniffer Config <info>%s</info> <comment>delete</comment>',
-                self::PHPCS_CONFIG_KEY
-            );
-        }
-
-        $this->io->write($configMessage);
-
-        $this->processExecutor->execute(
-            sprintf(
-                'phpcs %s',
-                implode(' ', $arguments)
-            ),
-            $configResult,
-            $this->composer->getConfig()->get('bin-dir')
-        );
-
-        if ($this->io->isVerbose() && !empty($configResult)) {
-            $this->io->write(sprintf('<info>%s</info>', $configResult));
-        }
-    }
-
-    /**
-     * Iterate trough all known paths and check if they are still valid.
-     *
-     * If path does not exists, is not an directory or isn't readable, the path
-     * is removed from the list.
-     *
-     * @return bool True if changes where made, false otherwise
-     */
-    private function cleanInstalledPaths()
-    {
-        $changes = false;
-        foreach ($this->installedPaths as $key => $path) {
-            // This might be a relative path as well
-            $alternativePath = realpath($this->getPHPCodeSnifferInstallPath() . DIRECTORY_SEPARATOR . $path);
-
-            if ((is_dir($path) === false || is_readable($path) === false) &&
-                (is_dir($alternativePath) === false || is_readable($alternativePath) === false)
-            ) {
-                unset($this->installedPaths[$key]);
-                $changes = true;
-            }
-        }
-        return $changes;
-    }
-
-    /**
-     * Check all installed packages (including the root package) against
-     * the installed paths from PHP_CodeSniffer and add the missing ones.
-     *
-     * @return bool True if changes where made, false otherwise
-     *
-     * @throws \InvalidArgumentException
-     * @throws \RuntimeException
-     */
-    private function updateInstalledPaths()
-    {
-        $changes = false;
-
-        $searchPaths = array($this->cwd);
-        $codingStandardPackages = $this->getPHPCodingStandardPackages();
-        foreach ($codingStandardPackages as $package) {
-            $installPath = $this->composer->getInstallationManager()->getInstallPath($package);
-            if ($this->filesystem->isAbsolutePath($installPath) === false) {
-                $installPath = $this->filesystem->normalizePath(
-                    $this->cwd . DIRECTORY_SEPARATOR . $installPath
-                );
-            }
-            $searchPaths[] = $installPath;
-        }
-
-        $finder = new Finder();
-        $finder->files()
-            ->depth('<= ' . $this->getMaxDepth())
-            ->depth('>= ' . $this->getMinDepth())
-            ->ignoreUnreadableDirs()
-            ->ignoreVCS(true)
-            ->in($searchPaths)
-            ->name('ruleset.xml');
-
-        // Process each found possible ruleset.
-        foreach ($finder as $ruleset) {
-            $standardsPath = $ruleset->getPath();
-
-            // Pick the directory above the directory containing the standard, unless this is the project root.
-            if ($standardsPath !== $this->cwd) {
-                $standardsPath = dirname($standardsPath);
-            }
-
-            // Use relative paths for local project repositories.
-            if ($this->isRunningGlobally() === false) {
-                $standardsPath = $this->filesystem->findShortestPath(
-                    $this->getPHPCodeSnifferInstallPath(),
-                    $standardsPath,
-                    true
-                );
-            }
-
-            // De-duplicate and add when directory is not configured.
-            if (in_array($standardsPath, $this->installedPaths, true) === false) {
-                $this->installedPaths[] = $standardsPath;
-                $changes = true;
-            }
-        }
-
-        return $changes;
-    }
-
-    /**
-     * Iterates through Composers' local repository looking for valid Coding
-     * Standard packages.
-     *
-     * If the package is the RootPackage (the one the plugin is installed into),
-     * the package is ignored for now since it needs a different install path logic.
-     *
-     * @return array Composer packages containing coding standard(s)
-     */
-    private function getPHPCodingStandardPackages()
-    {
-        $codingStandardPackages = array_filter(
-            $this->composer->getRepositoryManager()->getLocalRepository()->getPackages(),
-            function (PackageInterface $package) {
-                if ($package instanceof AliasPackage) {
-                    return false;
-                }
-                return $package->getType() === Plugin::PACKAGE_TYPE;
-            }
-        );
-
-        if (! $this->composer->getPackage() instanceof RootpackageInterface
-            && $this->composer->getPackage()->getType() === self::PACKAGE_TYPE
-        ) {
-            $codingStandardPackages[] = $this->composer->getPackage();
-        }
-
-        return $codingStandardPackages;
-    }
-
-    /**
-     * Searches for the installed PHP_CodeSniffer Composer package
-     *
-     * @param null|string|\Composer\Semver\Constraint\ConstraintInterface $versionConstraint to match against
-     *
-     * @return PackageInterface|null
-     */
-    private function getPHPCodeSnifferPackage($versionConstraint = null)
-    {
-        $packages = $this
-            ->composer
-            ->getRepositoryManager()
-            ->getLocalRepository()
-            ->findPackages(self::PACKAGE_NAME, $versionConstraint);
-
-        return array_shift($packages);
-    }
-
-    /**
-     * Returns the path to the PHP_CodeSniffer package installation location
-     *
-     * @return string
-     */
-    private function getPHPCodeSnifferInstallPath()
-    {
-        return $this->composer->getInstallationManager()->getInstallPath($this->getPHPCodeSnifferPackage());
-    }
-
-    /**
-     * Simple check if PHP_CodeSniffer is installed.
-     *
-     * @param null|string|\Composer\Semver\Constraint\ConstraintInterface $versionConstraint to match against
-     *
-     * @return bool Whether PHP_CodeSniffer is installed
-     */
-    private function isPHPCodeSnifferInstalled($versionConstraint = null)
-    {
-        return ($this->getPHPCodeSnifferPackage($versionConstraint) !== null);
-    }
-
-    /**
-     * Test if composer is running "global"
-     * This check kinda dirty, but it is the "Composer Way"
-     *
-     * @return bool Whether Composer is running "globally"
-     *
-     * @throws \RuntimeException
-     */
-    private function isRunningGlobally()
-    {
-        return ($this->composer->getConfig()->get('home') === $this->cwd);
-    }
-
-    /**
-     * Determines the maximum search depth when searching for Coding Standards.
-     *
-     * @return int
-     *
-     * @throws \InvalidArgumentException
-     */
-    private function getMaxDepth()
-    {
-        $maxDepth = 3;
-
-        $extra = $this->composer->getPackage()->getExtra();
-
-        if (array_key_exists(self::KEY_MAX_DEPTH, $extra)) {
-            $maxDepth = $extra[self::KEY_MAX_DEPTH];
-            $minDepth = $this->getMinDepth();
-
-            if (is_int($maxDepth) === false     /* Must be an integer */
-                || $maxDepth <= $minDepth       /* Larger than the minimum */
-                || is_float($maxDepth) === true /* Within the boundaries of integer */
-            ) {
-                $message = vsprintf(
-                    self::MESSAGE_ERROR_WRONG_MAX_DEPTH,
-                    array(
-                        'key' => self::KEY_MAX_DEPTH,
-                        'min' => $minDepth,
-                        'given' => var_export($maxDepth, true),
-                    )
-                );
-
-                throw new \InvalidArgumentException($message);
-            }
-        }
-
-        return $maxDepth;
-    }
-
-    /**
-     * Returns the minimal search depth for Coding Standard packages.
-     *
-     * Usually this is 0, unless PHP_CodeSniffer >= 3 is used.
-     *
-     * @return int
-     */
-    private function getMinDepth()
-    {
-        if ($this->isPHPCodeSnifferInstalled('>= 3.0.0') !== true) {
-            return 1;
-        }
-        return 0;
-    }
+	const KEY_MAX_DEPTH = 'phpcodesniffer-search-depth';
+
+	const MESSAGE_ERROR_WRONG_MAX_DEPTH =
+		'The value of "%s" (in the composer.json "extra".section) must be an integer larger then %d, %s given.';
+	const MESSAGE_NOT_INSTALLED = 'PHPCodeSniffer is not installed';
+	const MESSAGE_NOTHING_TO_INSTALL = 'Nothing to install or update';
+	const MESSAGE_RUNNING_INSTALLER = 'Running PHPCodeSniffer Composer Installer';
+
+	const PACKAGE_NAME = 'squizlabs/php_codesniffer';
+	const PACKAGE_TYPE = 'phpcodesniffer-standard';
+
+	const PHPCS_CONFIG_KEY = 'installed_paths';
+
+	/**
+	 * @var Composer
+	 */
+	private $composer;
+
+	/**
+	 * @var string
+	 */
+	private $cwd;
+
+	/**
+	 * @var Filesystem
+	 */
+	private $filesystem;
+
+	/**
+	 * @var array
+	 */
+	private $installedPaths;
+
+	/**
+	 * @var IOInterface
+	 */
+	private $io;
+
+	/**
+	 * @var ProcessExecutor
+	 */
+	private $processExecutor;
+
+	/**
+	 * Triggers the plugin's main functionality.
+	 *
+	 * Makes it possible to run the plugin as a custom command.
+	 *
+	 * @param Event $event
+	 *
+	 * @throws \InvalidArgumentException
+	 * @throws \RuntimeException
+	 * @throws LogicException
+	 * @throws ProcessFailedException
+	 * @throws RuntimeException
+	 */
+	public static function run(Event $event)
+	{
+		$io = $event->getIO();
+		$composer = $event->getComposer();
+
+		$instance = new static();
+
+		$instance->io = $io;
+		$instance->composer = $composer;
+		$instance->init();
+		$instance->onDependenciesChangedEvent();
+	}
+
+	/**
+	 * {@inheritDoc}
+	 *
+	 * @throws \RuntimeException
+	 * @throws LogicException
+	 * @throws ProcessFailedException
+	 * @throws RuntimeException
+	 */
+	public function activate(Composer $composer, IOInterface $io)
+	{
+		$this->composer = $composer;
+		$this->io = $io;
+
+		$this->init();
+	}
+
+	/**
+	 * Prepares the plugin so it's main functionality can be run.
+	 *
+	 * @throws \RuntimeException
+	 * @throws LogicException
+	 * @throws ProcessFailedException
+	 * @throws RuntimeException
+	 */
+	private function init()
+	{
+		$this->cwd = getcwd();
+		$this->installedPaths = array();
+
+		$this->processExecutor = new ProcessExecutor($this->io);
+		$this->filesystem = new Filesystem($this->processExecutor);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 */
+	public static function getSubscribedEvents()
+	{
+		return array(
+			ScriptEvents::POST_INSTALL_CMD => array(
+				array('onDependenciesChangedEvent', 0),
+			),
+			ScriptEvents::POST_UPDATE_CMD => array(
+				array('onDependenciesChangedEvent', 0),
+			),
+		);
+	}
+
+	/**
+	 * Entry point for post install and post update events.
+	 *
+	 * @throws \InvalidArgumentException
+	 * @throws LogicException
+	 * @throws ProcessFailedException
+	 * @throws RuntimeException
+	 */
+	public function onDependenciesChangedEvent()
+	{
+		$io = $this->io;
+		$isVerbose = $io->isVerbose();
+
+		if ($isVerbose) {
+			$io->write(sprintf('<info>%s</info>', self::MESSAGE_RUNNING_INSTALLER));
+		}
+
+		if ($this->isPHPCodeSnifferInstalled() === true) {
+			$this->loadInstalledPaths();
+			$installPathCleaned = $this->cleanInstalledPaths();
+			$installPathUpdated = $this->updateInstalledPaths();
+
+			if ($installPathCleaned === true || $installPathUpdated === true) {
+				$this->saveInstalledPaths();
+			} elseif ($isVerbose) {
+				$io->write(sprintf('<info>%s</info>', self::MESSAGE_NOTHING_TO_INSTALL));
+			}
+		} elseif ($isVerbose) {
+			$io->write(sprintf('<info>%s</info>', self::MESSAGE_NOT_INSTALLED));
+		}
+	}
+
+	/**
+	 * Load all paths from PHP_CodeSniffer into an array.
+	 *
+	 * @throws LogicException
+	 * @throws ProcessFailedException
+	 * @throws RuntimeException
+	 */
+	private function loadInstalledPaths()
+	{
+		if ($this->isPHPCodeSnifferInstalled() === true) {
+			$this->processExecutor->execute(
+				sprintf(
+					'phpcs --config-show %s',
+					self::PHPCS_CONFIG_KEY
+				),
+				$output,
+				$this->composer->getConfig()->get('bin-dir')
+			);
+
+			$phpcsInstalledPaths = str_replace(self::PHPCS_CONFIG_KEY . ': ', '', $output);
+			$phpcsInstalledPaths = trim($phpcsInstalledPaths);
+
+			if ($phpcsInstalledPaths !== '') {
+				$this->installedPaths = explode(',', $phpcsInstalledPaths);
+			}
+		}
+	}
+
+	/**
+	 * Save all coding standard paths back into PHP_CodeSniffer
+	 *
+	 * @throws LogicException
+	 * @throws ProcessFailedException
+	 * @throws RuntimeException
+	 */
+	private function saveInstalledPaths()
+	{
+		// Check if we found installed paths to set.
+		if (count($this->installedPaths) !== 0) {
+			$paths = implode(',', $this->installedPaths);
+			$arguments = array('--config-set', self::PHPCS_CONFIG_KEY, $paths);
+			$configMessage = sprintf(
+				'PHP CodeSniffer Config <info>%s</info> <comment>set to</comment> <info>%s</info>',
+				self::PHPCS_CONFIG_KEY,
+				$paths
+			);
+		} else {
+			// Delete the installed paths if none were found.
+			$arguments = array('--config-delete', self::PHPCS_CONFIG_KEY);
+			$configMessage = sprintf(
+				'PHP CodeSniffer Config <info>%s</info> <comment>delete</comment>',
+				self::PHPCS_CONFIG_KEY
+			);
+		}
+
+		$this->io->write($configMessage);
+
+		$this->processExecutor->execute(
+			sprintf(
+				'phpcs %s',
+				implode(' ', $arguments)
+			),
+			$configResult,
+			$this->composer->getConfig()->get('bin-dir')
+		);
+
+		if ($this->io->isVerbose() && !empty($configResult)) {
+			$this->io->write(sprintf('<info>%s</info>', $configResult));
+		}
+	}
+
+	/**
+	 * Iterate trough all known paths and check if they are still valid.
+	 *
+	 * If path does not exists, is not an directory or isn't readable, the path
+	 * is removed from the list.
+	 *
+	 * @return bool True if changes where made, false otherwise
+	 */
+	private function cleanInstalledPaths()
+	{
+		$changes = false;
+		foreach ($this->installedPaths as $key => $path) {
+			// This might be a relative path as well
+			$alternativePath = realpath($this->getPHPCodeSnifferInstallPath() . DIRECTORY_SEPARATOR . $path);
+
+			if ((is_dir($path) === false || is_readable($path) === false) &&
+				(is_dir($alternativePath) === false || is_readable($alternativePath) === false)
+			) {
+				unset($this->installedPaths[$key]);
+				$changes = true;
+			}
+		}
+		return $changes;
+	}
+
+	/**
+	 * Check all installed packages (including the root package) against
+	 * the installed paths from PHP_CodeSniffer and add the missing ones.
+	 *
+	 * @return bool True if changes where made, false otherwise
+	 *
+	 * @throws \InvalidArgumentException
+	 * @throws \RuntimeException
+	 */
+	private function updateInstalledPaths()
+	{
+		$changes = false;
+
+		$searchPaths = array($this->cwd);
+		$codingStandardPackages = $this->getPHPCodingStandardPackages();
+		foreach ($codingStandardPackages as $package) {
+			$installPath = $this->composer->getInstallationManager()->getInstallPath($package);
+			if ($this->filesystem->isAbsolutePath($installPath) === false) {
+				$installPath = $this->filesystem->normalizePath(
+					$this->cwd . DIRECTORY_SEPARATOR . $installPath
+				);
+			}
+			$searchPaths[] = $installPath;
+		}
+
+		$finder = new Finder();
+		$finder->files()
+			->depth('<= ' . $this->getMaxDepth())
+			->depth('>= ' . $this->getMinDepth())
+			->ignoreUnreadableDirs()
+			->ignoreVCS(true)
+			->in($searchPaths)
+			->name('ruleset.xml');
+
+		// Process each found possible ruleset.
+		foreach ($finder as $ruleset) {
+			$standardsPath = $ruleset->getPath();
+
+			// Pick the directory above the directory containing the standard, unless this is the project root.
+			if ($standardsPath !== $this->cwd) {
+				$standardsPath = dirname($standardsPath);
+			}
+
+			// Use relative paths for local project repositories.
+			if ($this->isRunningGlobally() === false) {
+				$standardsPath = $this->filesystem->findShortestPath(
+					$this->getPHPCodeSnifferInstallPath(),
+					$standardsPath,
+					true
+				);
+			}
+
+			// De-duplicate and add when directory is not configured.
+			if (in_array($standardsPath, $this->installedPaths, true) === false) {
+				$this->installedPaths[] = $standardsPath;
+				$changes = true;
+			}
+		}
+
+		return $changes;
+	}
+
+	/**
+	 * Iterates through Composers' local repository looking for valid Coding
+	 * Standard packages.
+	 *
+	 * If the package is the RootPackage (the one the plugin is installed into),
+	 * the package is ignored for now since it needs a different install path logic.
+	 *
+	 * @return array Composer packages containing coding standard(s)
+	 */
+	private function getPHPCodingStandardPackages()
+	{
+		$codingStandardPackages = array_filter(
+			$this->composer->getRepositoryManager()->getLocalRepository()->getPackages(),
+			function (PackageInterface $package) {
+				if ($package instanceof AliasPackage) {
+					return false;
+				}
+				return $package->getType() === Plugin::PACKAGE_TYPE;
+			}
+		);
+
+		if (! $this->composer->getPackage() instanceof RootpackageInterface
+			&& $this->composer->getPackage()->getType() === self::PACKAGE_TYPE
+		) {
+			$codingStandardPackages[] = $this->composer->getPackage();
+		}
+
+		return $codingStandardPackages;
+	}
+
+	/**
+	 * Searches for the installed PHP_CodeSniffer Composer package
+	 *
+	 * @param null|string|\Composer\Semver\Constraint\ConstraintInterface $versionConstraint to match against
+	 *
+	 * @return PackageInterface|null
+	 */
+	private function getPHPCodeSnifferPackage($versionConstraint = null)
+	{
+		$packages = $this
+			->composer
+			->getRepositoryManager()
+			->getLocalRepository()
+			->findPackages(self::PACKAGE_NAME, $versionConstraint);
+
+		return array_shift($packages);
+	}
+
+	/**
+	 * Returns the path to the PHP_CodeSniffer package installation location
+	 *
+	 * @return string
+	 */
+	private function getPHPCodeSnifferInstallPath()
+	{
+		return $this->composer->getInstallationManager()->getInstallPath($this->getPHPCodeSnifferPackage());
+	}
+
+	/**
+	 * Simple check if PHP_CodeSniffer is installed.
+	 *
+	 * @param null|string|\Composer\Semver\Constraint\ConstraintInterface $versionConstraint to match against
+	 *
+	 * @return bool Whether PHP_CodeSniffer is installed
+	 */
+	private function isPHPCodeSnifferInstalled($versionConstraint = null)
+	{
+		return ($this->getPHPCodeSnifferPackage($versionConstraint) !== null);
+	}
+
+	/**
+	 * Test if composer is running "global"
+	 * This check kinda dirty, but it is the "Composer Way"
+	 *
+	 * @return bool Whether Composer is running "globally"
+	 *
+	 * @throws \RuntimeException
+	 */
+	private function isRunningGlobally()
+	{
+		return ($this->composer->getConfig()->get('home') === $this->cwd);
+	}
+
+	/**
+	 * Determines the maximum search depth when searching for Coding Standards.
+	 *
+	 * @return int
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	private function getMaxDepth()
+	{
+		$maxDepth = 3;
+
+		$extra = $this->composer->getPackage()->getExtra();
+
+		if (array_key_exists(self::KEY_MAX_DEPTH, $extra)) {
+			$maxDepth = $extra[self::KEY_MAX_DEPTH];
+			$minDepth = $this->getMinDepth();
+
+			if (is_int($maxDepth) === false     /* Must be an integer */
+				|| $maxDepth <= $minDepth       /* Larger than the minimum */
+				|| is_float($maxDepth) === true /* Within the boundaries of integer */
+			) {
+				$message = vsprintf(
+					self::MESSAGE_ERROR_WRONG_MAX_DEPTH,
+					array(
+						'key' => self::KEY_MAX_DEPTH,
+						'min' => $minDepth,
+						'given' => var_export($maxDepth, true),
+					)
+				);
+
+				throw new \InvalidArgumentException($message);
+			}
+		}
+
+		return $maxDepth;
+	}
+
+	/**
+	 * Returns the minimal search depth for Coding Standard packages.
+	 *
+	 * Usually this is 0, unless PHP_CodeSniffer >= 3 is used.
+	 *
+	 * @return int
+	 */
+	private function getMinDepth()
+	{
+		if ($this->isPHPCodeSnifferInstalled('>= 3.0.0') !== true) {
+			return 1;
+		}
+		return 0;
+	}
 }

vendor/squizlabs/php_codesniffer/tests/bootstrap.php

Indentation +30 added lines, -30 removed lines

@@ -8,40 +8,40 @@ 
  */
 
 if (defined('PHP_CODESNIFFER_IN_TESTS') === false) {
-    define('PHP_CODESNIFFER_IN_TESTS', true);
+	define('PHP_CODESNIFFER_IN_TESTS', true);
 }
 
 if (defined('PHP_CODESNIFFER_CBF') === false) {
-    define('PHP_CODESNIFFER_CBF', false);
+	define('PHP_CODESNIFFER_CBF', false);
 }
 
 if (defined('PHP_CODESNIFFER_VERBOSITY') === false) {
-    define('PHP_CODESNIFFER_VERBOSITY', 0);
+	define('PHP_CODESNIFFER_VERBOSITY', 0);
 }
 
 if (is_file(__DIR__.'/../autoload.php') === true) {
-    include_once __DIR__.'/../autoload.php';
+	include_once __DIR__.'/../autoload.php';
 } else {
-    include_once 'PHP/CodeSniffer/autoload.php';
+	include_once 'PHP/CodeSniffer/autoload.php';
 }
 
 $tokens = new \PHP_CodeSniffer\Util\Tokens();
 
 // Compatibility for PHPUnit < 6 and PHPUnit 6+.
 if (class_exists('PHPUnit_Framework_TestSuite') === true && class_exists('PHPUnit\Framework\TestSuite') === false) {
-    class_alias('PHPUnit_Framework_TestSuite', 'PHPUnit'.'\Framework\TestSuite');
+	class_alias('PHPUnit_Framework_TestSuite', 'PHPUnit'.'\Framework\TestSuite');
 }
 
 if (class_exists('PHPUnit_Framework_TestCase') === true && class_exists('PHPUnit\Framework\TestCase') === false) {
-    class_alias('PHPUnit_Framework_TestCase', 'PHPUnit'.'\Framework\TestCase');
+	class_alias('PHPUnit_Framework_TestCase', 'PHPUnit'.'\Framework\TestCase');
 }
 
 if (class_exists('PHPUnit_TextUI_TestRunner') === true && class_exists('PHPUnit\TextUI\TestRunner') === false) {
-    class_alias('PHPUnit_TextUI_TestRunner', 'PHPUnit'.'\TextUI\TestRunner');
+	class_alias('PHPUnit_TextUI_TestRunner', 'PHPUnit'.'\TextUI\TestRunner');
 }
 
 if (class_exists('PHPUnit_Framework_TestResult') === true && class_exists('PHPUnit\Framework\TestResult') === false) {
-    class_alias('PHPUnit_Framework_TestResult', 'PHPUnit'.'\Framework\TestResult');
+	class_alias('PHPUnit_Framework_TestResult', 'PHPUnit'.'\Framework\TestResult');
 }
 
 
@@ -52,33 +52,33 @@ 
  */
 function printPHPCodeSnifferTestOutput()
 {
-    echo PHP_EOL.PHP_EOL;
+	echo PHP_EOL.PHP_EOL;
 
-    $output = 'The test files';
-    $data   = [];
+	$output = 'The test files';
+	$data   = [];
 
-    $codeCount = count($GLOBALS['PHP_CODESNIFFER_SNIFF_CODES']);
-    if (empty($GLOBALS['PHP_CODESNIFFER_SNIFF_CASE_FILES']) === false) {
-        $files     = call_user_func_array('array_merge', $GLOBALS['PHP_CODESNIFFER_SNIFF_CASE_FILES']);
-        $files     = array_unique($files);
-        $fileCount = count($files);
+	$codeCount = count($GLOBALS['PHP_CODESNIFFER_SNIFF_CODES']);
+	if (empty($GLOBALS['PHP_CODESNIFFER_SNIFF_CASE_FILES']) === false) {
+		$files     = call_user_func_array('array_merge', $GLOBALS['PHP_CODESNIFFER_SNIFF_CASE_FILES']);
+		$files     = array_unique($files);
+		$fileCount = count($files);
 
-        $output = '%d sniff test files';
-        $data[] = $fileCount;
-    }
+		$output = '%d sniff test files';
+		$data[] = $fileCount;
+	}
 
-    $output .= ' generated %d unique error codes';
-    $data[]  = $codeCount;
+	$output .= ' generated %d unique error codes';
+	$data[]  = $codeCount;
 
-    if ($codeCount > 0) {
-        $fixes   = count($GLOBALS['PHP_CODESNIFFER_FIXABLE_CODES']);
-        $percent = round(($fixes / $codeCount * 100), 2);
+	if ($codeCount > 0) {
+		$fixes   = count($GLOBALS['PHP_CODESNIFFER_FIXABLE_CODES']);
+		$percent = round(($fixes / $codeCount * 100), 2);
 
-        $output .= '; %d were fixable (%d%%)';
-        $data[]  = $fixes;
-        $data[]  = $percent;
-    }
+		$output .= '; %d were fixable (%d%%)';
+		$data[]  = $fixes;
+		$data[]  = $percent;
+	}
 
-    vprintf($output, $data);
+	vprintf($output, $data);
 
 }//end printPHPCodeSnifferTestOutput()