sdc-build-wp 4.1.0 → 4.1.2

package/vendor/wp-coding-standards/wpcs/WordPress/Helpers/ValidationHelper.php

@@ -1,349 +0,0 @@
-<?php
-/**
- * WordPress Coding Standard.
- *
- * @package WPCS\WordPressCodingStandards
- * @link    https://github.com/WordPress/WordPress-Coding-Standards
- * @license https://opensource.org/licenses/MIT MIT
- */
-
-namespace WordPressCS\WordPress\Helpers;
-
-use PHP_CodeSniffer\Files\File;
-use PHP_CodeSniffer\Util\Tokens;
-use PHPCSUtils\Tokens\Collections;
-use PHPCSUtils\Utils\Conditions;
-use PHPCSUtils\Utils\Context;
-use PHPCSUtils\Utils\PassedParameters;
-use PHPCSUtils\Utils\TextStrings;
-use WordPressCS\WordPress\Helpers\ContextHelper;
-use WordPressCS\WordPress\Helpers\VariableHelper;
-
-/**
- * Helper function for checking whether a token is validated.
- *
- * @since 3.0.0 The method in this class was previously contained in the
- *              `WordPressCS\WordPress\Sniff` class and has been moved here.
- */
-final class ValidationHelper {
-
-	/**
-	 * The tokens the function looks for to determine whether a token is validated.
-	 *
-	 * @since 3.0.0
-	 *
-	 * @var array<int|string, string>
-	 */
-	private static $targets = array(
-		\T_ISSET          => 'construct',
-		\T_EMPTY          => 'construct',
-		\T_STRING         => 'function_call',
-		\T_COALESCE       => 'coalesce',
-		\T_COALESCE_EQUAL => 'coalesce',
-	);
-
-	/**
-	 * List of PHP native functions to check if an array index exists.
-	 *
-	 * @since 3.0.0
-	 *
-	 * @var array<string, bool>
-	 */
-	private static $key_exists_functions = array(
-		'array_key_exists' => true,
-		'key_exists'       => true, // Alias.
-	);
-
-	/**
-	 * Check if the existence of a variable is validated with isset(), empty(), array_key_exists()
-	 * or key_exists().
-	 *
-	 * When $in_condition_only is `false`, (which is the default), this is considered
-	 * valid:
-	 *
-	 * ```php
-	 * if ( isset( $var ) ) {
-	 *     // Do stuff, like maybe return or exit (but could be anything)
-	 * }
-	 *
-	 * foo( $var );
-	 * ```
-	 *
-	 * When it is `true`, that would be invalid; the use of the variable must be within
-	 * the scope of the validating condition, like this:
-	 *
-	 * ```php
-	 * if ( isset( $var ) ) {
-	 *     foo( $var );
-	 * }
-	 * ```
-	 *
-	 * @since 0.5.0
-	 * @since 2.1.0 Now recognizes array_key_exists() and key_exists() as validation functions.
-	 * @since 2.1.0 Stricter check on whether the correct variable and the correct
-	 *              array keys are being validated.
-	 * @since 3.0.0 - Moved from the Sniff class to this class.
-	 *              - The method visibility was changed from `protected` to `public static`.
-	 *              - The `$phpcsFile` parameter was added.
-	 *
-	 * @param \PHP_CodeSniffer\Files\File $phpcsFile         The file being scanned.
-	 * @param int                         $stackPtr          The index of this token in the stack.
-	 * @param array|string                $array_keys        An array key to check for ("bar" in $foo['bar'])
-	 *                                                       or an array of keys for multi-level array access.
-	 * @param bool                        $in_condition_only Whether to require that this use of the
-	 *                                                       variable occurs within the scope of the
-	 *                                                       validating condition, or just in the same
-	 *                                                       scope (default).
-	 *
-	 * @return bool Whether the var is validated.
-	 */
-	public static function is_validated( File $phpcsFile, $stackPtr, $array_keys = array(), $in_condition_only = false ) {
-		$tokens = $phpcsFile->getTokens();
-		if ( isset( $tokens[ $stackPtr ] ) === false ) {
-			return false;
-		}
-
-		if ( $in_condition_only ) {
-			/*
-			 * This is a stricter check, requiring the variable to be used only
-			 * within the validation condition.
-			 */
-			$conditionPtr = Conditions::getLastCondition( $phpcsFile, $stackPtr );
-			if ( false === $conditionPtr ) {
-				// If there are no conditions, there's no validation.
-				return false;
-			}
-
-			$condition = $tokens[ $conditionPtr ];
-			if ( ! isset( $condition['parenthesis_opener'] ) ) {
-				// Live coding or parse error.
-				return false;
-			}
-
-			$scope_start = $condition['parenthesis_opener'];
-			$scope_end   = $condition['parenthesis_closer'];
-
-		} else {
-			/*
-			 * We are more loose, requiring only that the variable be validated
-			 * in the same function/file scope as it is used.
-			 */
-			$scope_start = 0;
-
-			/*
-			 * Check if we are in a function.
-			 *
-			 * Note: PHP 7.4+ arrow functions are not taken into account as those are not
-			 * included in the "conditions" array. Additionally, arrow functions have
-			 * access to variables outside their direct scope.
-			 */
-			$function = Conditions::getLastCondition( $phpcsFile, $stackPtr, array( \T_FUNCTION, \T_CLOSURE ) );
-
-			// If so, we check only within the function, otherwise the whole file.
-			if ( false !== $function ) {
-				$scope_start = $tokens[ $function ]['scope_opener'];
-			}
-
-			$scope_end = $stackPtr;
-		}
-
-		if ( ! empty( $array_keys ) && ! is_array( $array_keys ) ) {
-			$array_keys = (array) $array_keys;
-		}
-
-		$bare_array_keys = self::strip_quotes_from_array_values( $array_keys );
-
-		// phpcs:ignore Generic.CodeAnalysis.JumbledIncrementer.Found -- On purpose, see below.
-		for ( $i = ( $scope_start + 1 ); $i < $scope_end; $i++ ) {
-
-			if ( isset( Collections::closedScopes()[ $tokens[ $i ]['code'] ] )
-				&& isset( $tokens[ $i ]['scope_closer'] )
-			) {
-				// Jump over nested closed scopes as validation done within those does not apply.
-				$i = $tokens[ $i ]['scope_closer'];
-				continue;
-			}
-
-			if ( \T_FN === $tokens[ $i ]['code']
-				&& isset( $tokens[ $i ]['scope_closer'] )
-				&& $tokens[ $i ]['scope_closer'] < $scope_end
-			) {
-				// Jump over nested arrow functions as long as the current variable isn't *in* the arrow function.
-				$i = $tokens[ $i ]['scope_closer'];
-				continue;
-			}
-
-			if ( isset( self::$targets[ $tokens[ $i ]['code'] ] ) === false ) {
-				continue;
-			}
-
-			switch ( self::$targets[ $tokens[ $i ]['code'] ] ) {
-				case 'construct':
-					$issetOpener = $phpcsFile->findNext( Tokens::$emptyTokens, ( $i + 1 ), null, true );
-					if ( false === $issetOpener
-						|| \T_OPEN_PARENTHESIS !== $tokens[ $issetOpener ]['code']
-						|| isset( $tokens[ $issetOpener ]['parenthesis_closer'] ) === false
-					) {
-						// Parse error or live coding.
-						continue 2;
-					}
-
-					$issetCloser = $tokens[ $issetOpener ]['parenthesis_closer'];
-
-					// Look for this variable. We purposely stomp $i from the parent loop.
-					for ( $i = ( $issetOpener + 1 ); $i < $issetCloser; $i++ ) {
-
-						if ( \T_VARIABLE !== $tokens[ $i ]['code'] ) {
-							continue;
-						}
-
-						if ( $tokens[ $stackPtr ]['content'] !== $tokens[ $i ]['content'] ) {
-							continue;
-						}
-
-						// If we're checking for specific array keys (ex: 'hello' in
-						// $_POST['hello']), that must match too. Quote-style, however, doesn't matter.
-						if ( ! empty( $bare_array_keys ) ) {
-							$found_keys = VariableHelper::get_array_access_keys( $phpcsFile, $i );
-							$found_keys = self::strip_quotes_from_array_values( $found_keys );
-							$diff       = array_diff_assoc( $bare_array_keys, $found_keys );
-							if ( ! empty( $diff ) ) {
-								continue;
-							}
-						}
-
-						return true;
-					}
-
-					break;
-
-				case 'function_call':
-					// Only check calls to array_key_exists() and key_exists().
-					if ( isset( self::$key_exists_functions[ strtolower( $tokens[ $i ]['content'] ) ] ) === false ) {
-						continue 2;
-					}
-
-					$next_non_empty = $phpcsFile->findNext( Tokens::$emptyTokens, ( $i + 1 ), null, true );
-					if ( false === $next_non_empty || \T_OPEN_PARENTHESIS !== $tokens[ $next_non_empty ]['code'] ) {
-						// Not a function call.
-						continue 2;
-					}
-
-					if ( Context::inAttribute( $phpcsFile, $i ) === true ) {
-						// Definitely not the function call as those are not allowed in attributes.
-						continue 2;
-					}
-
-					if ( ContextHelper::has_object_operator_before( $phpcsFile, $i ) === true ) {
-						// Method call.
-						continue 2;
-					}
-
-					if ( ContextHelper::is_token_namespaced( $phpcsFile, $i ) === true ) {
-						// Namespaced function call.
-						continue 2;
-					}
-
-					$params = PassedParameters::getParameters( $phpcsFile, $i );
-
-					// As `key_exists()` is an alias of `array_key_exists()`, the param positions and names are the same.
-					$array_param = PassedParameters::getParameterFromStack( $params, 2, 'array' );
-					if ( false === $array_param ) {
-						continue 2;
-					}
-
-					$array_param_first_token = $phpcsFile->findNext( Tokens::$emptyTokens, $array_param['start'], ( $array_param['end'] + 1 ), true );
-					if ( false === $array_param_first_token
-						|| \T_VARIABLE !== $tokens[ $array_param_first_token ]['code']
-						|| $tokens[ $array_param_first_token ]['content'] !== $tokens[ $stackPtr ]['content']
-					) {
-						continue 2;
-					}
-
-					if ( ! empty( $bare_array_keys ) ) {
-						// Prevent the original array from being altered.
-						$bare_keys = $bare_array_keys;
-						$last_key  = array_pop( $bare_keys );
-
-						/*
-						 * For multi-level array access, the complete set of keys could be split between
-						 * the $key and the $array parameter, but could also be completely in the $array
-						 * parameter, so we need to check both options.
-						 */
-						$found_keys = VariableHelper::get_array_access_keys( $phpcsFile, $array_param_first_token );
-						$found_keys = self::strip_quotes_from_array_values( $found_keys );
-
-						// First try matching the complete set against the array parameter.
-						$diff = array_diff_assoc( $bare_array_keys, $found_keys );
-						if ( empty( $diff ) ) {
-							return true;
-						}
-
-						// If that failed, try getting an exact match for the subset against the
-						// $array parameter and the last key against the first.
-						$key_param = PassedParameters::getParameterFromStack( $params, 1, 'key' );
-						if ( false !== $key_param
-							&& $bare_keys === $found_keys
-							&& TextStrings::stripQuotes( $key_param['raw'] ) === $last_key
-						) {
-							return true;
-						}
-
-						// Didn't find the correct array keys.
-						continue 2;
-					}
-
-					return true;
-
-				case 'coalesce':
-					$prev = $i;
-					do {
-						$prev = $phpcsFile->findPrevious( Tokens::$emptyTokens, ( $prev - 1 ), null, true );
-						// Skip over array keys, like `$_GET['key']['subkey']`.
-						if ( \T_CLOSE_SQUARE_BRACKET === $tokens[ $prev ]['code'] ) {
-							$prev = $tokens[ $prev ]['bracket_opener'];
-							continue;
-						}
-
-						break;
-					} while ( $prev >= ( $scope_start + 1 ) );
-
-					// We should now have reached the variable.
-					if ( \T_VARIABLE !== $tokens[ $prev ]['code'] ) {
-						continue 2;
-					}
-
-					if ( $tokens[ $prev ]['content'] !== $tokens[ $stackPtr ]['content'] ) {
-						continue 2;
-					}
-
-					if ( ! empty( $bare_array_keys ) ) {
-						$found_keys = VariableHelper::get_array_access_keys( $phpcsFile, $prev );
-						$found_keys = self::strip_quotes_from_array_values( $found_keys );
-						$diff       = array_diff_assoc( $bare_array_keys, $found_keys );
-						if ( ! empty( $diff ) ) {
-							continue 2;
-						}
-					}
-
-					// Right variable, correct key.
-					return true;
-			}
-		}
-
-		return false;
-	}
-
-	/**
-	 * Strip quotes of all the values in an array containing only text strings.
-	 *
-	 * @since 3.0.0
-	 *
-	 * @param string[] $text_strings The input array.
-	 *
-	 * @return string[]
-	 */
-	private static function strip_quotes_from_array_values( array $text_strings ) {
-		return array_map( array( 'PHPCSUtils\Utils\TextStrings', 'stripQuotes' ), $text_strings );
-	}
-}

package/vendor/wp-coding-standards/wpcs/WordPress/Helpers/VariableHelper.php

@@ -1,262 +0,0 @@
-<?php
-/**
- * WordPress Coding Standard.
- *
- * @package WPCS\WordPressCodingStandards
- * @link    https://github.com/WordPress/WordPress-Coding-Standards
- * @license https://opensource.org/licenses/MIT MIT
- */
-
-namespace WordPressCS\WordPress\Helpers;
-
-use PHP_CodeSniffer\Files\File;
-use PHP_CodeSniffer\Util\Tokens;
-use PHPCSUtils\Utils\GetTokensAsString;
-use PHPCSUtils\Utils\Parentheses;
-
-/**
- * Helper utilities for working with variables.
- *
- * ---------------------------------------------------------------------------------------------
- * This class is only intended for internal use by WordPressCS and is not part of the public API.
- * This also means that it has no promise of backward compatibility. Use at your own risk.
- * ---------------------------------------------------------------------------------------------
- *
- * {@internal The functionality in this class will likely be replaced at some point in
- * the future by functions from PHPCSUtils.}
- *
- * @internal
- *
- * @since 3.0.0 The methods in this class were previously contained in the
- *              `WordPressCS\WordPress\Sniff` class and have been moved here.
- */
-final class VariableHelper {
-
-	/**
-	 * Get the index keys of an array variable.
-	 *
-	 * E.g., "bar" and "baz" in $foo['bar']['baz'].
-	 *
-	 * @since 2.1.0
-	 * @since 3.0.0 - Moved from the Sniff class to this class.
-	 *              - Visibility is now `public` (was `protected`) and the method `static`.
-	 *              - The `$phpcsFile` parameter was added.
-	 *
-	 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
-	 * @param int                         $stackPtr  The index of the variable token in the stack.
-	 * @param bool                        $all       Whether to get all keys or only the first.
-	 *                                               Defaults to `true`(= all).
-	 *
-	 * @return array An array of index keys whose value is being accessed.
-	 *               or an empty array if this is not array access.
-	 */
-	public static function get_array_access_keys( File $phpcsFile, $stackPtr, $all = true ) {
-		$tokens = $phpcsFile->getTokens();
-		$keys   = array();
-
-		if ( isset( $tokens[ $stackPtr ] ) === false
-			|| \T_VARIABLE !== $tokens[ $stackPtr ]['code']
-		) {
-			return $keys;
-		}
-
-		$current = $stackPtr;
-
-		do {
-			// Find the next non-empty token.
-			$open_bracket = $phpcsFile->findNext(
-				Tokens::$emptyTokens,
-				( $current + 1 ),
-				null,
-				true
-			);
-
-			// If it isn't a bracket, this isn't an array-access.
-			if ( false === $open_bracket
-				|| \T_OPEN_SQUARE_BRACKET !== $tokens[ $open_bracket ]['code']
-				|| ! isset( $tokens[ $open_bracket ]['bracket_closer'] )
-			) {
-				break;
-			}
-
-			$key = GetTokensAsString::compact(
-				$phpcsFile,
-				( $open_bracket + 1 ),
-				( $tokens[ $open_bracket ]['bracket_closer'] - 1 ),
-				true
-			);
-
-			$keys[]  = trim( $key );
-			$current = $tokens[ $open_bracket ]['bracket_closer'];
-		} while ( isset( $tokens[ $current ] ) && true === $all );
-
-		return $keys;
-	}
-
-	/**
-	 * Get the index key of an array variable.
-	 *
-	 * E.g., "bar" in $foo['bar'].
-	 *
-	 * @since 0.5.0
-	 * @since 2.1.0 Now uses get_array_access_keys() under the hood.
-	 * @since 3.0.0 - Moved from the Sniff class to this class.
-	 *              - Visibility is now `public` (was `protected`) and the method `static`.
-	 *              - The `$phpcsFile` parameter was added.
-	 *
-	 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
-	 * @param int                         $stackPtr  The index of the variable token in the stack.
-	 *
-	 * @return string|false The array index key whose value is being accessed.
-	 */
-	public static function get_array_access_key( File $phpcsFile, $stackPtr ) {
-		$keys = self::get_array_access_keys( $phpcsFile, $stackPtr, false );
-		if ( isset( $keys[0] ) ) {
-			return $keys[0];
-		}
-
-		return false;
-	}
-
-	/**
-	 * Check whether a variable is being compared to another value.
-	 *
-	 * E.g., $var === 'foo', 1 <= $var, etc.
-	 *
-	 * Also recognizes `switch ( $var )` and `match ( $var )`.
-	 *
-	 * @since 0.5.0
-	 * @since 2.1.0 Added the $include_coalesce parameter.
-	 * @since 3.0.0 - Moved from the Sniff class to this class.
-	 *              - Visibility is now `public` (was `protected`) and the method `static`.
-	 *              - The `$phpcsFile` parameter was added.
-	 *
-	 * @param \PHP_CodeSniffer\Files\File $phpcsFile        The file being scanned.
-	 * @param int                         $stackPtr         The index of this token in the stack.
-	 * @param bool                        $include_coalesce Optional. Whether or not to regard the null
-	 *                                                      coalesce operator - ?? - as a comparison operator.
-	 *                                                      Defaults to true.
-	 *                                                      Null coalesce is a special comparison operator in this
-	 *                                                      sense as it doesn't compare a variable to whatever is
-	 *                                                      on the other side of the comparison operator.
-	 *
-	 * @return bool Whether this is a comparison.
-	 */
-	public static function is_comparison( File $phpcsFile, $stackPtr, $include_coalesce = true ) {
-		$tokens = $phpcsFile->getTokens();
-		if ( isset( $tokens[ $stackPtr ] ) === false ) {
-			return false;
-		}
-
-		$comparisonTokens = Tokens::$comparisonTokens;
-		if ( false === $include_coalesce ) {
-			unset( $comparisonTokens[ \T_COALESCE ] );
-		}
-
-		// We first check if this is a switch or match statement (switch ( $var )).
-		if ( Parentheses::lastOwnerIn( $phpcsFile, $stackPtr, array( \T_SWITCH, \T_MATCH ) ) !== false ) {
-			return true;
-		}
-
-		// Find the previous non-empty token. We check before the var first because
-		// yoda conditions are usually expected.
-		$previous_token = $phpcsFile->findPrevious( Tokens::$emptyTokens, ( $stackPtr - 1 ), null, true );
-
-		if ( isset( $comparisonTokens[ $tokens[ $previous_token ]['code'] ] ) ) {
-			return true;
-		}
-
-		// Maybe the comparison operator is after this.
-		$next_token = $phpcsFile->findNext( Tokens::$emptyTokens, ( $stackPtr + 1 ), null, true );
-
-		// This might be an opening square bracket in the case of arrays ($var['a']).
-		while ( false !== $next_token
-			&& \T_OPEN_SQUARE_BRACKET === $tokens[ $next_token ]['code']
-			&& isset( $tokens[ $next_token ]['bracket_closer'] )
-		) {
-			$next_token = $phpcsFile->findNext(
-				Tokens::$emptyTokens,
-				( $tokens[ $next_token ]['bracket_closer'] + 1 ),
-				null,
-				true
-			);
-		}
-
-		if ( false !== $next_token && isset( $comparisonTokens[ $tokens[ $next_token ]['code'] ] ) ) {
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * Check if this variable is being assigned a value.
-	 *
-	 * E.g., $var = 'foo';
-	 *
-	 * Also handles array assignments to arbitrary depth:
-	 *
-	 * $array['key'][ $foo ][ something() ] = $bar;
-	 *
-	 * @since 0.5.0
-	 * @since 3.0.0 - Moved from the Sniff class to this class.
-	 *              - Visibility is now `public` (was `protected`) and the method `static`.
-	 *              - The `$phpcsFile` parameter was added.
-	 *              - The `$include_coalesce` parameter was added.
-	 *
-	 * @param \PHP_CodeSniffer\Files\File $phpcsFile        The file being scanned.
-	 * @param int                         $stackPtr         The index of the token in the stack.
-	 *                                                      This must point to either a T_VARIABLE or
-	 *                                                      T_CLOSE_SQUARE_BRACKET token.
-	 * @param bool                        $include_coalesce Optional. Whether or not to regard the null
-	 *                                                      coalesce operator - ?? - as a comparison operator.
-	 *                                                      Defaults to true.
-	 *                                                      Null coalesce is a special comparison operator in this
-	 *                                                      sense as it doesn't compare a variable to whatever is
-	 *                                                      on the other side of the comparison operator.
-	 *
-	 * @return bool Whether the token is a variable being assigned a value.
-	 */
-	public static function is_assignment( File $phpcsFile, $stackPtr, $include_coalesce = true ) {
-		$tokens = $phpcsFile->getTokens();
-		if ( isset( $tokens[ $stackPtr ] ) === false ) {
-			return false;
-		}
-
-		static $valid = array(
-			\T_VARIABLE             => true,
-			\T_CLOSE_SQUARE_BRACKET => true,
-		);
-
-		// Must be a variable or closing square bracket (see below).
-		if ( ! isset( $valid[ $tokens[ $stackPtr ]['code'] ] ) ) {
-			return false;
-		}
-
-		$next_non_empty = $phpcsFile->findNext( Tokens::$emptyTokens, ( $stackPtr + 1 ), null, true, null, true );
-
-		// No token found.
-		if ( false === $next_non_empty ) {
-			return false;
-		}
-
-		$assignmentTokens = Tokens::$assignmentTokens;
-		if ( false === $include_coalesce ) {
-			unset( $assignmentTokens[ \T_COALESCE_EQUAL ] );
-		}
-
-		// If the next token is an assignment, that's all we need to know.
-		if ( isset( $assignmentTokens[ $tokens[ $next_non_empty ]['code'] ] ) ) {
-			return true;
-		}
-
-		// Check if this is an array assignment, e.g., `$var['key'] = 'val';` .
-		if ( \T_OPEN_SQUARE_BRACKET === $tokens[ $next_non_empty ]['code']
-			&& isset( $tokens[ $next_non_empty ]['bracket_closer'] )
-		) {
-			return self::is_assignment( $phpcsFile, $tokens[ $next_non_empty ]['bracket_closer'], $include_coalesce );
-		}
-
-		return false;
-	}
-}