sdc-build-wp 4.1.0 → 4.1.2

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

@@ -1,256 +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 WordPressCS\WordPress\Helpers\RulesetPropertyHelper;
-
-/**
- * Helper functions and function lists for checking whether an escaping function is being used.
- *
- * Any sniff class which incorporates this trait will automatically support the
- * following `public` properties which can be changed from within a custom ruleset:
- * - `customEscapingFunctions`.
- * - `customAutoEscapedFunctions`
- *
- * @since 3.0.0 The properties in this trait were previously contained partially in the
- *              `WordPressCS\WordPress\Sniff` class and partially in the `EscapeOutputSniff`
- *              class and have been moved here.
- */
-trait EscapingFunctionsTrait {
-
-	/**
-	 * Custom list of functions which escape values for display.
-	 *
-	 * @since 0.5.0
-	 * @since 3.0.0 Moved from the EscapeOutput Sniff class to this trait.
-	 *
-	 * @var string[]
-	 */
-	public $customEscapingFunctions = array();
-
-	/**
-	 * Custom list of functions whose return values are pre-escaped for display.
-	 *
-	 * @since 0.3.0
-	 * @since 3.0.0 Moved from the EscapeOutput Sniff class to this trait.
-	 *
-	 * @var string[]
-	 */
-	public $customAutoEscapedFunctions = array();
-
-	/**
-	 * Functions that escape values for display.
-	 *
-	 * @since 0.5.0
-	 * @since 0.11.0 Changed from public static to protected non-static.
-	 * @since 3.0.0 - Moved from the Sniff class to this trait.
-	 *              - Visibility changed from protected to private.
-	 *
-	 * @var array<string, bool>
-	 */
-	private $escapingFunctions = array(
-		'absint'                     => true,
-		'esc_attr__'                 => true,
-		'esc_attr_e'                 => true,
-		'esc_attr_x'                 => true,
-		'esc_attr'                   => true,
-		'esc_html__'                 => true,
-		'esc_html_e'                 => true,
-		'esc_html_x'                 => true,
-		'esc_html'                   => true,
-		'esc_js'                     => true,
-		'esc_sql'                    => true,
-		'esc_textarea'               => true,
-		'esc_url_raw'                => true,
-		'esc_url'                    => true,
-		'esc_xml'                    => true,
-		'filter_input'               => true,
-		'filter_var'                 => true,
-		'floatval'                   => true,
-		'highlight_string'           => true,
-		'intval'                     => true,
-		'json_encode'                => true,
-		'like_escape'                => true,
-		'number_format'              => true,
-		'rawurlencode'               => true,
-		'sanitize_hex_color'         => true,
-		'sanitize_hex_color_no_hash' => true,
-		'sanitize_html_class'        => true,
-		'sanitize_key'               => true,
-		'sanitize_locale_name'       => true,
-		'sanitize_user_field'        => true,
-		'tag_escape'                 => true,
-		'urlencode_deep'             => true,
-		'urlencode'                  => true,
-		'wp_json_encode'             => true,
-		'wp_kses_allowed_html'       => true,
-		'wp_kses_data'               => true,
-		'wp_kses_one_attr'           => true,
-		'wp_kses_post'               => true,
-		'wp_kses'                    => true,
-	);
-
-	/**
-	 * Functions whose output is automatically escaped for display.
-	 *
-	 * @since 0.5.0
-	 * @since 0.11.0 Changed from public static to protected non-static.
-	 * @since 3.0.0 - Moved from the Sniff class to this trait.
-	 *              - Visibility changed from protected to private.
-	 *
-	 * @var array<string, bool>
-	 */
-	private $autoEscapedFunctions = array(
-		'allowed_tags'            => true,
-		'bloginfo'                => true,
-		'body_class'              => true,
-		'calendar_week_mod'       => true,
-		'category_description'    => true,
-		'checked'                 => true,
-		'comment_class'           => true,
-		'count'                   => true,
-		'disabled'                => true,
-		'do_shortcode'            => true,
-		'do_shortcode_tag'        => true,
-		'get_archives_link'       => true,
-		'get_attachment_link'     => true,
-		'get_avatar'              => true,
-		'get_bookmark_field'      => true,
-		'get_calendar'            => true,
-		'get_comment_author_link' => true,
-		'get_current_blog_id'     => true,
-		'get_delete_post_link'    => true,
-		'get_search_form'         => true,
-		'get_search_query'        => true,
-		'get_the_author_link'     => true,
-		'get_the_author'          => true,
-		'get_the_date'            => true,
-		'get_the_ID'              => true,
-		'get_the_post_thumbnail'  => true,
-		'get_the_term_list'       => true,
-		'post_type_archive_title' => true,
-		'readonly'                => true,
-		'selected'                => true,
-		'single_cat_title'        => true,
-		'single_month_title'      => true,
-		'single_post_title'       => true,
-		'single_tag_title'        => true,
-		'single_term_title'       => true,
-		'tag_description'         => true,
-		'term_description'        => true,
-		'the_author'              => true,
-		'the_date'                => true,
-		'the_title_attribute'     => true,
-		'walk_nav_menu_tree'      => true,
-		'wp_dropdown_categories'  => true,
-		'wp_dropdown_users'       => true,
-		'wp_generate_tag_cloud'   => true,
-		'wp_get_archives'         => true,
-		'wp_get_attachment_image' => true,
-		'wp_get_attachment_link'  => true,
-		'wp_link_pages'           => true,
-		'wp_list_authors'         => true,
-		'wp_list_bookmarks'       => true,
-		'wp_list_categories'      => true,
-		'wp_list_comments'        => true,
-		'wp_login_form'           => true,
-		'wp_loginout'             => true,
-		'wp_nav_menu'             => true,
-		'wp_readonly'             => true,
-		'wp_register'             => true,
-		'wp_tag_cloud'            => true,
-		'wp_timezone_choice'      => true,
-		'wp_title'                => true,
-	);
-
-	/**
-	 * Cache of previously added custom functions.
-	 *
-	 * Prevents having to do the same merges over and over again.
-	 *
-	 * @since 0.4.0
-	 * @since 0.11.0 - Changed from public static to protected non-static.
-	 *               - Changed the format from simple bool to array.
-	 * @since 3.0.0  - Moved from the EscapeOutput Sniff class to this trait.
-	 *               - Visibility changed from protected to private.
-	 *
-	 * @var array<string, string[]>
-	 */
-	private $addedCustomEscapingFunctions = array(
-		'escape'     => array(),
-		'autoescape' => array(),
-	);
-
-	/**
-	 * Combined list of WP native and custom escaping functions.
-	 *
-	 * @since 3.0.0
-	 *
-	 * @var array<string, bool>
-	 */
-	private $allEscapingFunctions = array();
-
-	/**
-	 * Combined list of WP native and custom auto-escaping functions.
-	 *
-	 * @since 3.0.0
-	 *
-	 * @var array<string, bool>
-	 */
-	private $allAutoEscapedFunctions = array();
-
-	/**
-	 * Check if a particular function is regarded as an escaping function.
-	 *
-	 * @since 3.0.0
-	 *
-	 * @param string $functionName The name of the function to check.
-	 *
-	 * @return bool
-	 */
-	final public function is_escaping_function( $functionName ) {
-		if ( array() === $this->allEscapingFunctions
-			|| $this->customEscapingFunctions !== $this->addedCustomEscapingFunctions['escape']
-		) {
-			$this->allEscapingFunctions = RulesetPropertyHelper::merge_custom_array(
-				$this->customEscapingFunctions,
-				$this->escapingFunctions
-			);
-
-			$this->addedCustomEscapingFunctions['escape'] = $this->customEscapingFunctions;
-		}
-
-		return isset( $this->allEscapingFunctions[ strtolower( $functionName ) ] );
-	}
-
-	/**
-	 * Check if a particular function is regarded as an auto-escaped function.
-	 *
-	 * @since 3.0.0
-	 *
-	 * @param string $functionName The name of the function to check.
-	 *
-	 * @return bool
-	 */
-	final public function is_auto_escaped_function( $functionName ) {
-		if ( array() === $this->allAutoEscapedFunctions
-			|| $this->customAutoEscapedFunctions !== $this->addedCustomEscapingFunctions['autoescape']
-		) {
-			$this->allAutoEscapedFunctions = RulesetPropertyHelper::merge_custom_array(
-				$this->customAutoEscapedFunctions,
-				$this->autoEscapedFunctions
-			);
-
-			$this->addedCustomEscapingFunctions['autoescape'] = $this->customAutoEscapedFunctions;
-		}
-
-		return isset( $this->allAutoEscapedFunctions[ strtolower( $functionName ) ] );
-	}
-}

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

@@ -1,60 +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;
-
-/**
- * Helper functions and function lists for checking whether a function is a formatting function.
- *
- * @since 3.0.0 The property in this class was previously contained in the
- *              `WordPressCS\WordPress\Sniff` class and has been moved here.
- */
-final class FormattingFunctionsHelper {
-
-	/**
-	 * Functions that format strings.
-	 *
-	 * These functions are often used for formatting values just before output, and
-	 * it is common practice to escape the individual parameters passed to them as
-	 * needed instead of escaping the entire result. This is especially true when the
-	 * string being formatted contains HTML, which makes escaping the full result
-	 * more difficult.
-	 *
-	 * @since 0.5.0
-	 * @since 0.11.0 Changed from public static to protected non-static.
-	 * @since 3.0.0 - Moved from the Sniff class to this class.
-	 *              - Visibility changed from protected to private and property made static.
-	 *
-	 * @var array<string, bool>
-	 */
-	private static $formattingFunctions = array(
-		'antispambot' => true,
-		'array_fill'  => true,
-		'ent2ncr'     => true,
-		'implode'     => true,
-		'join'        => true,
-		'nl2br'       => true,
-		'sprintf'     => true,
-		'vsprintf'    => true,
-		'wp_sprintf'  => true,
-	);
-
-	/**
-	 * Check if a particular function is regarded as a formatting function.
-	 *
-	 * @since 3.0.0
-	 *
-	 * @param string $functionName The name of the function to check.
-	 *
-	 * @return bool
-	 */
-	public static function is_formatting_function( $functionName ) {
-		return isset( self::$formattingFunctions[ strtolower( $functionName ) ] );
-	}
-}

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

@@ -1,238 +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\Namespaces;
-use PHPCSUtils\Utils\ObjectDeclarations;
-use WordPressCS\WordPress\Helpers\RulesetPropertyHelper;
-
-/**
- * Helper utilities for sniffs which need to take into account whether the
- * code under examination is unit test code or not.
- *
- * Usage instructions:
- * - Add appropriate `use` statement(s) to the file/class which intends to use this functionality.
- * - Now the sniff will automatically support the public `custom_test_classes` property which
- *   users can set in their custom ruleset. Do not add the property to the sniff!
- * - The sniff can call the `is_test_class()` method in this trait to verify if a class is
- *   a test class. The `is_test_class()` method will take the custom property into account.
- *
- * @since 3.0.0 The properties and method in this trait were previously contained in the
- *              `WordPressCS\WordPress\Sniff` class and have been moved here.
- */
-trait IsUnitTestTrait {
-
-	/**
-	 * Custom list of classes which test classes can extend.
-	 *
-	 * This property allows end-users to add to the build-in `$known_test_classes`
-	 * via their custom PHPCS ruleset.
-	 * This property will need to be set for each sniff which uses this trait.
-	 *
-	 * Currently this property is used by the `WordPress.WP.GlobalVariablesOverride`,
-	 * `WordPress.NamingConventions.PrefixAllGlobals` and the `WordPress.Files.Filename` sniffs.
-	 *
-	 * Example usage:
-	 * ```xml
-	 * <rule ref="WordPress.[Subset].[Sniffname]">
-	 *  <properties>
-	 *   <property name="custom_test_classes" type="array">
-	 *     <element value="My_Plugin_First_Test_Class"/>
-	 *     <element value="My_Plugin_Second_Test_Class"/>
-	 *   </property>
-	 *  </properties>
-	 * </rule>
-	 * ```
-	 *
-	 * Note: it is strongly _recommended_ to exclude your test directories for
-	 * select error codes of those particular sniffs instead of relying on this
-	 * property/trait.
-	 *
-	 * @since 0.11.0
-	 * @since 3.0.0  Moved from the Sniff class to this dedicated Trait.
-	 *               Renamed from `$custom_test_class_whitelist` to `$custom_test_classes`.
-	 *
-	 * @var string[]
-	 */
-	public $custom_test_classes = array();
-
-	/**
-	 * List of PHPUnit and WP native classes which test classes can extend.
-	 *
-	 * {internal These are the test cases provided in the `/tests/phpunit/includes/`
-	 *           directory of WP Core.}
-	 *
-	 * @since 0.11.0
-	 * @since 3.0.0  - Moved from the Sniff class to this dedicated Trait.
-	 *               - Renamed from `$test_class_whitelist` to `$known_test_classes`.
-	 *               - Visibility changed from protected to private.
-	 *
-	 * @var array<string, true> Key is class name, value irrelevant.
-	 */
-	private $known_test_classes = array(
-		// Base test cases.
-		'WP_UnitTestCase'                            => true,
-		'WP_UnitTestCase_Base'                       => true,
-		'PHPUnit_Adapter_TestCase'                   => true,
-
-		// Domain specific base test cases.
-		'WP_Ajax_UnitTestCase'                       => true,
-		'WP_Canonical_UnitTestCase'                  => true,
-		'WP_Font_Face_UnitTestCase'                  => true,
-		'WP_Test_REST_Controller_Testcase'           => true,
-		'WP_Test_REST_Post_Type_Controller_Testcase' => true,
-		'WP_Test_REST_TestCase'                      => true,
-		'WP_Test_XML_TestCase'                       => true,
-		'WP_XMLRPC_UnitTestCase'                     => true,
-
-		// PHPUnit native test cases.
-		'PHPUnit_Framework_TestCase'                 => true,
-		'PHPUnit\\Framework\\TestCase'               => true,
-		// PHPUnit native TestCase class when imported via use statement.
-		'TestCase'                                   => true,
-	);
-
-	/**
-	 * Cache of previously added custom test classes.
-	 *
-	 * Prevents having to do the same merges over and over again.
-	 *
-	 * @since 3.0.0
-	 *
-	 * @var string[]
-	 */
-	private $added_custom_test_classes = array();
-
-	/**
-	 * Combined list of WP/PHPUnit native and custom test classes.
-	 *
-	 * @since 3.0.0
-	 *
-	 * @var array<string, bool>
-	 */
-	private $all_test_classes = array();
-
-	/**
-	 * Retrieve a list of all registered test classes, both WP/PHPUnit native as well as custom.
-	 *
-	 * @since 3.0.0
-	 *
-	 * @return array<string, bool>
-	 */
-	final protected function get_all_test_classes() {
-		if ( array() === $this->all_test_classes
-			|| $this->custom_test_classes !== $this->added_custom_test_classes
-		) {
-			/*
-			 * Show some tolerance for user input.
-			 * The custom test class names should be passed as FQN without a prefixing `\`.
-			 */
-			$custom_test_classes = array();
-			if ( ! empty( $this->custom_test_classes ) ) {
-				foreach ( $this->custom_test_classes as $v ) {
-					$custom_test_classes[] = ltrim( $v, '\\' );
-				}
-			}
-
-			/*
-			 * Lowercase all names, both custom as well as "known", as PHP treats namespaced names case-insensitively.
-			 */
-			$custom_test_classes = array_map( 'strtolower', $custom_test_classes );
-			$known_test_classes  = array_change_key_case( $this->known_test_classes, \CASE_LOWER );
-
-			$this->all_test_classes = RulesetPropertyHelper::merge_custom_array(
-				$custom_test_classes,
-				$known_test_classes
-			);
-
-			// Store the original value so the comparison can succeed.
-			$this->added_custom_test_classes = $this->custom_test_classes;
-		}
-
-		return $this->all_test_classes;
-	}
-
-	/**
-	 * Check if a class token is part of a unit test suite.
-	 *
-	 * Unit test classes are identified as such:
-	 * - Class which either extends one of the known test cases, such as `WP_UnitTestCase`
-	 *   or `PHPUnit_Framework_TestCase` or extends a custom unit test class as listed in the
-	 *   `custom_test_classes` property.
-	 *
-	 * @since 0.12.0 Split off from the `is_token_in_test_method()` method.
-	 * @since 1.0.0  Improved recognition of namespaced class names.
-	 * @since 3.0.0  - Moved from the Sniff class to this dedicated Trait.
-	 *               - The `$phpcsFile` parameter was added.
-	 *
-	 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
-	 * @param int                         $stackPtr  The position of the token to be examined.
-	 *                                               This should be a class, anonymous class or trait token.
-	 *
-	 * @return bool True if the class is a unit test class, false otherwise.
-	 */
-	final protected function is_test_class( File $phpcsFile, $stackPtr ) {
-
-		$tokens = $phpcsFile->getTokens();
-
-		if ( isset( $tokens[ $stackPtr ], Tokens::$ooScopeTokens[ $tokens[ $stackPtr ]['code'] ] ) === false ) {
-			return false;
-		}
-
-		// Add any potentially extra custom test classes to the known test classes list.
-		$known_test_classes = $this->get_all_test_classes();
-
-		$namespace = strtolower( Namespaces::determineNamespace( $phpcsFile, $stackPtr ) );
-
-		// Is the class/trait one of the known test classes ?
-		$className = ObjectDeclarations::getName( $phpcsFile, $stackPtr );
-		if ( empty( $className ) === false ) {
-			$className = strtolower( $className );
-			if ( '' !== $namespace ) {
-				if ( isset( $known_test_classes[ $namespace . '\\' . $className ] ) ) {
-					return true;
-				}
-			} elseif ( isset( $known_test_classes[ $className ] ) ) {
-				return true;
-			}
-		}
-
-		// Does the class/trait extend one of the known test classes ?
-		$extendedClassName = ObjectDeclarations::findExtendedClassName( $phpcsFile, $stackPtr );
-		if ( false === $extendedClassName ) {
-			return false;
-		}
-
-		$extendedClassName = strtolower( $extendedClassName );
-
-		if ( '\\' === $extendedClassName[0] ) {
-			if ( isset( $known_test_classes[ substr( $extendedClassName, 1 ) ] ) ) {
-				return true;
-			}
-		} elseif ( '' !== $namespace ) {
-			if ( isset( $known_test_classes[ $namespace . '\\' . $extendedClassName ] ) ) {
-				return true;
-			}
-		} elseif ( isset( $known_test_classes[ $extendedClassName ] ) ) {
-			return true;
-		}
-
-		/*
-		 * Not examining imported classes via `use` statements as with the variety of syntaxes,
-		 * this would get very complicated.
-		 * After all, users can add an `<exclude-pattern>` for a particular sniff to their
-		 * custom ruleset to selectively exclude the test directory.
-		 */
-
-		return false;
-	}
-}

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

@@ -1,101 +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\Exceptions\RuntimeException;
-use PHP_CodeSniffer\Files\File;
-use PHPCSUtils\Tokens\Collections;
-use PHPCSUtils\Utils\Lists;
-
-/**
- * Helper utilities for checking the context in which a token is used.
- *
- * ---------------------------------------------------------------------------------------------
- * 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 method in this class was previously contained in the
- *              `WordPressCS\WordPress\Sniff` class and has been moved here.
- */
-final class ListHelper {
-
-	/**
-	 * Get a list of the token pointers to the variables being assigned to in a list statement.
-	 *
-	 * {@internal No need to take special measures for nested lists. Nested or not,
-	 * each list part can only contain one variable being written to.}
-	 *
-	 * @since 2.2.0
-	 * @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.
-	 *              - The `$list_open_close` parameter was dropped.
-	 *
-	 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
-	 * @param int                         $stackPtr  The position of the T_LIST or T_OPEN_SHORT_ARRAY
-	 *                                               token in the stack.
-	 *
-	 * @return array Array with the stack pointers to the variables or an empty
-	 *               array when not a (short) list.
-	 */
-	public static function get_list_variables( File $phpcsFile, $stackPtr ) {
-		$tokens = $phpcsFile->getTokens();
-
-		// Is this one of the tokens this function handles ?
-		if ( isset( $tokens[ $stackPtr ], Collections::listOpenTokensBC()[ $tokens[ $stackPtr ]['code'] ] ) === false ) {
-			return array();
-		}
-
-		if ( isset( Collections::shortArrayListOpenTokensBC()[ $tokens[ $stackPtr ]['code'] ] )
-			&& Lists::isShortList( $phpcsFile, $stackPtr ) === false
-		) {
-			return array();
-		}
-
-		try {
-			$assignments = Lists::getAssignments( $phpcsFile, $stackPtr );
-		} catch ( RuntimeException $e ) {
-			// Parse error/live coding.
-			return array();
-		}
-
-		$var_pointers = array();
-
-		foreach ( $assignments as $assign ) {
-			if ( true === $assign['is_empty'] ) {
-				continue;
-			}
-
-			if ( true === $assign['is_nested_list'] ) {
-				/*
-				 * Recurse into the nested list and get the variables.
-				 * No need to `catch` any errors as only lists can be nested in lists.
-				 */
-				$var_pointers += self::get_list_variables( $phpcsFile, $assign['assignment_token'] );
-				continue;
-			}
-
-			/*
-			 * Ok, so this must be a "normal" assignment in the list.
-			 * Set the variable pointer both as the key as well as the value, so we can use array join
-			 * for nested lists (above).
-			 */
-			$var_pointers[ $assign['assignment_token'] ] = $assign['assignment_token'];
-		}
-
-		return $var_pointers;
-	}
-}