eventespresso / event-espresso-core

core/exceptions/ExceptionStackTraceDisplay.php

Indentation +279 added lines, -279 removed lines

@@ -19,159 +19,159 @@ 
 class ExceptionStackTraceDisplay
 {
 
-    /**
-     * @var   string
-     * @since 4.10.24.p
-     */
-    private $class_name = '';
+	/**
+	 * @var   string
+	 * @since 4.10.24.p
+	 */
+	private $class_name = '';
 
-    /**
-     * @var   string
-     * @since 4.10.24.p
-     */
-    private $error_code = '';
+	/**
+	 * @var   string
+	 * @since 4.10.24.p
+	 */
+	private $error_code = '';
 
 
-    /**
-     * @param Exception $exception
-     * @throws Exception
-     */
-    public function __construct(Exception $exception)
-    {
-        if (WP_DEBUG && ! defined('EE_TESTS_DIR')) {
-            $this->displayException($exception);
-        } else {
-            throw $exception;
-        }
-    }
+	/**
+	 * @param Exception $exception
+	 * @throws Exception
+	 */
+	public function __construct(Exception $exception)
+	{
+		if (WP_DEBUG && ! defined('EE_TESTS_DIR')) {
+			$this->displayException($exception);
+		} else {
+			throw $exception;
+		}
+	}
 
 
-    /**
-     * @access protected
-     * @param Exception $exception
-     * @throws ReflectionException
-     */
-    protected function displayException(Exception $exception)
-    {
-        // get separate user and developer messages if they exist
-        $msg = explode('||', $exception->getMessage());
-        $user_msg = $msg[0];
-        $dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
-        $msg = WP_DEBUG ? $dev_msg : $user_msg;
-        // process trace info
-        $trace_details = $this->traceDetails($exception);
-        $code          = $exception->getCode() ?: $this->error_code;
-        // add helpful developer messages if debugging is on
-        // or generic non-identifying messages for non-privileged users
-        $error_message = WP_DEBUG
-            ? $this->developerError($exception, $msg, $code, $trace_details)
-            : $this->genericError($msg, $code);
-        // start gathering output
-        $output = '
+	/**
+	 * @access protected
+	 * @param Exception $exception
+	 * @throws ReflectionException
+	 */
+	protected function displayException(Exception $exception)
+	{
+		// get separate user and developer messages if they exist
+		$msg = explode('||', $exception->getMessage());
+		$user_msg = $msg[0];
+		$dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
+		$msg = WP_DEBUG ? $dev_msg : $user_msg;
+		// process trace info
+		$trace_details = $this->traceDetails($exception);
+		$code          = $exception->getCode() ?: $this->error_code;
+		// add helpful developer messages if debugging is on
+		// or generic non-identifying messages for non-privileged users
+		$error_message = WP_DEBUG
+			? $this->developerError($exception, $msg, $code, $trace_details)
+			: $this->genericError($msg, $code);
+		// start gathering output
+		$output = '
 <div id="ee-error-message" class="error">
     ' . $error_message . '
 </div>';
-        $styles = $this->exceptionStyles();
-        $scripts = $this->printScripts(true);
-        if (defined('DOING_AJAX')) {
-            echo wp_json_encode(array('error' => $styles . $output . $scripts));
-            exit();
-        }
-        echo $styles, $output, $scripts; // already escaped
-    }
+		$styles = $this->exceptionStyles();
+		$scripts = $this->printScripts(true);
+		if (defined('DOING_AJAX')) {
+			echo wp_json_encode(array('error' => $styles . $output . $scripts));
+			exit();
+		}
+		echo $styles, $output, $scripts; // already escaped
+	}
 
 
-    private function genericError($msg, $code)
-    {
-        return '
+	private function genericError($msg, $code)
+	{
+		return '
     <p>
         <span class="ee-error-user-msg-spn">' . trim($msg) . '</span> &nbsp; <sup>' . $code . '</sup>
     </p>';
-    }
+	}
 
 
-    /**
-     * @throws ReflectionException
-     */
-    private function developerError(Exception $exception, $msg, $code, $trace_details)
-    {
-        $time = time();
-        return '
+	/**
+	 * @throws ReflectionException
+	 */
+	private function developerError(Exception $exception, $msg, $code, $trace_details)
+	{
+		$time = time();
+		return '
 	<div class="ee-error-dev-msg-dv">
 		<p class="ee-error-dev-msg-pg">
 		    '
-            . sprintf(
-                esc_html__('%1$sAn %2$s was thrown!%3$s code: %4$s', 'event_espresso'),
-                '<strong class="ee-error-dev-msg-str">',
-                get_class($exception),
-                '</strong>  &nbsp; <span>',
-                $code . '</span>'
-            )
-            . '<br />
+			. sprintf(
+				esc_html__('%1$sAn %2$s was thrown!%3$s code: %4$s', 'event_espresso'),
+				'<strong class="ee-error-dev-msg-str">',
+				get_class($exception),
+				'</strong>  &nbsp; <span>',
+				$code . '</span>'
+			)
+			. '<br />
             <span class="big-text">"' . trim($msg) . '"</span><br/>
             <a id="display-ee-error-trace-1'
-               . $time
-               . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-1'
-               . $time
-               . '">
+			   . $time
+			   . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-1'
+			   . $time
+			   . '">
                 ' . esc_html__('click to view backtrace and class/method details', 'event_espresso') . '
             </a><br />
             '
-            . $exception->getFile()
-            . sprintf(
-                esc_html__('%1$s( line no: %2$s )%3$s', 'event_espresso'),
-                ' &nbsp; <span class="small-text lt-grey-text">',
-                $exception->getLine(),
-                '</span>'
-            )
-            . '
+			. $exception->getFile()
+			. sprintf(
+				esc_html__('%1$s( line no: %2$s )%3$s', 'event_espresso'),
+				' &nbsp; <span class="small-text lt-grey-text">',
+				$exception->getLine(),
+				'</span>'
+			)
+			. '
         </p>
         <div id="ee-error-trace-1'
-               . $time
-               . '-dv" class="ee-error-trace-dv" style="display: none;">
+			   . $time
+			   . '-dv" class="ee-error-trace-dv" style="display: none;">
             '
-               . $trace_details
-               . $this->classDetails() . '
+			   . $trace_details
+			   . $this->classDetails() . '
         </div>
     </div>';
-    }
+	}
 
 
-    /**
-     * @throws ReflectionException
-     */
-    private function classDetails()
-    {
-        if (empty($this->class_name)) {
-            return '';
-        }
-        $a = new ReflectionClass($this->class_name);
-        return '
+	/**
+	 * @throws ReflectionException
+	 */
+	private function classDetails()
+	{
+		if (empty($this->class_name)) {
+			return '';
+		}
+		$a = new ReflectionClass($this->class_name);
+		return '
             <div style="padding:3px; margin:0 0 1em; border:1px solid #999; background:#fff; border-radius:3px;">
                 <div style="padding:1em 2em; border:1px solid #999; background:#fcfcfc;">
                     <h3>' . esc_html__('Class Details', 'event_espresso') . '</h3>
                     <pre>' . $a . '</pre>
                 </div>
             </div>';
-    }
+	}
 
-    /**
-     * @param Exception $exception
-     * @return string
-     * @throws ReflectionException
-     * @since 4.10.24.p
-     */
-    private function traceDetails(Exception $exception)
-    {
-        $trace = $exception->getTrace();
-        if (empty($trace)) {
-            return esc_html__(
-                'Sorry, but no trace information was available for this exception.',
-                'event_espresso'
-            );
-        }
+	/**
+	 * @param Exception $exception
+	 * @return string
+	 * @throws ReflectionException
+	 * @since 4.10.24.p
+	 */
+	private function traceDetails(Exception $exception)
+	{
+		$trace = $exception->getTrace();
+		if (empty($trace)) {
+			return esc_html__(
+				'Sorry, but no trace information was available for this exception.',
+				'event_espresso'
+			);
+		}
 
-        $trace_details = '
+		$trace_details = '
         <div id="ee-trace-details">
             <table>
                 <tr>
@@ -180,160 +180,160 @@ 
                     <th scope="col" class="ee-align-left" style="width:40%;">File</th>
                     <th scope="col" class="ee-align-left">
                     ' . esc_html__('Class', 'event_espresso')
-                              . '->'
-                              . esc_html__('Method( arguments )', 'event_espresso') . '
+							  . '->'
+							  . esc_html__('Method( arguments )', 'event_espresso') . '
                     </th>
                 </tr>';
-        $last_on_stack = count($trace) - 1;
-        // reverse array so that stack is in proper chronological order
-        $sorted_trace = array_reverse($trace);
-        foreach ($sorted_trace as $nmbr => $trace) {
-            $this->class_name = isset($trace['class']) ? $trace['class'] : '';
-            $file     = isset($trace['file']) ? $trace['file'] : '';
-            $type     = isset($trace['type']) ? $trace['type'] : '';
-            $function = isset($trace['function']) ? $trace['function'] : '';
-            $args     = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
-            $args     = isset($trace['args']) && count($trace['args']) > 4 ? ' <br />' . $args . '<br />' : $args;
-            $line     = isset($trace['line']) ? $trace['line'] : '';
-            if (empty($file) && ! empty($this->class_name)) {
-                $a    = new ReflectionClass($this->class_name);
-                $file = $a->getFileName();
-                if (empty($line) && ! empty($function)) {
-                    try {
-                        // if $function is a closure, this throws an exception
-                        $b    = new ReflectionMethod($this->class_name, $function);
-                        $line = $b->getStartLine();
-                    } catch (Exception $closure_exception) {
-                        $line = 'unknown';
-                    }
-                }
-            }
-            if ($nmbr === $last_on_stack) {
-                $file       = $exception->getFile() ?: $file;
-                $line       = $exception->getLine() ?: $line;
-                $this->error_code = $this->generate_error_code($file, $trace['function'], $line);
-            }
-            $file          = EEH_File::standardise_directory_separators($file);
-            $nmbr          = ! empty($nmbr) ? $nmbr : '&nbsp;';
-            $line          = ! empty($line) ? $line : '&nbsp;';
-            $file          = ! empty($file) ? $file : '&nbsp;';
-            $type          = ! empty($type) ? $type : '';
-            $function      = ! empty($function) ? $function : '';
-            $args          = ! empty($args) ? '( ' . $args . ' )' : '()';
-            $trace_details .= '
+		$last_on_stack = count($trace) - 1;
+		// reverse array so that stack is in proper chronological order
+		$sorted_trace = array_reverse($trace);
+		foreach ($sorted_trace as $nmbr => $trace) {
+			$this->class_name = isset($trace['class']) ? $trace['class'] : '';
+			$file     = isset($trace['file']) ? $trace['file'] : '';
+			$type     = isset($trace['type']) ? $trace['type'] : '';
+			$function = isset($trace['function']) ? $trace['function'] : '';
+			$args     = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
+			$args     = isset($trace['args']) && count($trace['args']) > 4 ? ' <br />' . $args . '<br />' : $args;
+			$line     = isset($trace['line']) ? $trace['line'] : '';
+			if (empty($file) && ! empty($this->class_name)) {
+				$a    = new ReflectionClass($this->class_name);
+				$file = $a->getFileName();
+				if (empty($line) && ! empty($function)) {
+					try {
+						// if $function is a closure, this throws an exception
+						$b    = new ReflectionMethod($this->class_name, $function);
+						$line = $b->getStartLine();
+					} catch (Exception $closure_exception) {
+						$line = 'unknown';
+					}
+				}
+			}
+			if ($nmbr === $last_on_stack) {
+				$file       = $exception->getFile() ?: $file;
+				$line       = $exception->getLine() ?: $line;
+				$this->error_code = $this->generate_error_code($file, $trace['function'], $line);
+			}
+			$file          = EEH_File::standardise_directory_separators($file);
+			$nmbr          = ! empty($nmbr) ? $nmbr : '&nbsp;';
+			$line          = ! empty($line) ? $line : '&nbsp;';
+			$file          = ! empty($file) ? $file : '&nbsp;';
+			$type          = ! empty($type) ? $type : '';
+			$function      = ! empty($function) ? $function : '';
+			$args          = ! empty($args) ? '( ' . $args . ' )' : '()';
+			$trace_details .= '
                 <tr>
                     <td class="ee-align-right">' . $nmbr . '</td>
                     <td class="ee-align-right">' . $line . '</td>
                     <td class="ee-align-left">' . $file . '</td>
                     <td class="ee-align-left">' . $this->class_name . $type . $function . $args . '</td>
                 </tr>';
-        }
-        $trace_details .= '
+		}
+		$trace_details .= '
             </table>
         </div>';
-        return $trace_details;
-    }
+		return $trace_details;
+	}
 
 
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    // phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	// phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
 
-    /**
-     * generate string from exception trace args
-     *
-     * @param array $arguments
-     * @param int   $indent
-     * @param bool  $array
-     * @return string
-     */
-    private function _convert_args_to_string($arguments = array(), $indent = 0, $array = false)
-    {
-        $args = array();
-        $args_count = count($arguments);
-        if ($args_count > 2) {
-            $indent++;
-            $args[] = '<br />';
-        }
-        $x = 0;
-        foreach ($arguments as $arg) {
-            $x++;
-            for ($i = 0; $i < $indent; $i++) {
-                $args[] = ' &nbsp;&nbsp; ';
-            }
-            if (is_string($arg)) {
-                if (! $array && strlen($arg) > 75) {
-                    $args[] = '<br />';
-                    for ($i = 0; $i <= $indent; $i++) {
-                        $args[] = ' &nbsp;&nbsp; ';
-                    }
-                    $args[] = "'" . $arg . "'<br />";
-                } else {
-                    $args[] = " '" . $arg . "'";
-                }
-            } elseif (is_array($arg)) {
-                $arg_count = count($arg);
-                if ($arg_count > 2) {
-                    $indent++;
-                    $args[] = ' array(' . $this->_convert_args_to_string($arg, $indent, true) . ')';
-                    $indent--;
-                } elseif ($arg_count === 0) {
-                    $args[] = ' array()';
-                } else {
-                    $args[] = ' array( ' . $this->_convert_args_to_string($arg) . ' )';
-                }
-            } elseif ($arg === null) {
-                $args[] = ' null';
-            } elseif (is_bool($arg)) {
-                $args[] = $arg ? ' true' : ' false';
-            } elseif (is_object($arg)) {
-                $args[] = get_class($arg);
-            } elseif (is_resource($arg)) {
-                $args[] = get_resource_type($arg);
-            } else {
-                $args[] = $arg;
-            }
-            if ($x === $args_count) {
-                if ($args_count > 2) {
-                    $args[] = '<br />';
-                    $indent--;
-                    for ($i = 1; $i < $indent; $i++) {
-                        $args[] = ' &nbsp;&nbsp; ';
-                    }
-                }
-            } else {
-                $args[] = $args_count > 2 ? ',<br />' : ', ';
-            }
-        }
-        return implode('', $args);
-    }
+	/**
+	 * generate string from exception trace args
+	 *
+	 * @param array $arguments
+	 * @param int   $indent
+	 * @param bool  $array
+	 * @return string
+	 */
+	private function _convert_args_to_string($arguments = array(), $indent = 0, $array = false)
+	{
+		$args = array();
+		$args_count = count($arguments);
+		if ($args_count > 2) {
+			$indent++;
+			$args[] = '<br />';
+		}
+		$x = 0;
+		foreach ($arguments as $arg) {
+			$x++;
+			for ($i = 0; $i < $indent; $i++) {
+				$args[] = ' &nbsp;&nbsp; ';
+			}
+			if (is_string($arg)) {
+				if (! $array && strlen($arg) > 75) {
+					$args[] = '<br />';
+					for ($i = 0; $i <= $indent; $i++) {
+						$args[] = ' &nbsp;&nbsp; ';
+					}
+					$args[] = "'" . $arg . "'<br />";
+				} else {
+					$args[] = " '" . $arg . "'";
+				}
+			} elseif (is_array($arg)) {
+				$arg_count = count($arg);
+				if ($arg_count > 2) {
+					$indent++;
+					$args[] = ' array(' . $this->_convert_args_to_string($arg, $indent, true) . ')';
+					$indent--;
+				} elseif ($arg_count === 0) {
+					$args[] = ' array()';
+				} else {
+					$args[] = ' array( ' . $this->_convert_args_to_string($arg) . ' )';
+				}
+			} elseif ($arg === null) {
+				$args[] = ' null';
+			} elseif (is_bool($arg)) {
+				$args[] = $arg ? ' true' : ' false';
+			} elseif (is_object($arg)) {
+				$args[] = get_class($arg);
+			} elseif (is_resource($arg)) {
+				$args[] = get_resource_type($arg);
+			} else {
+				$args[] = $arg;
+			}
+			if ($x === $args_count) {
+				if ($args_count > 2) {
+					$args[] = '<br />';
+					$indent--;
+					for ($i = 1; $i < $indent; $i++) {
+						$args[] = ' &nbsp;&nbsp; ';
+					}
+				}
+			} else {
+				$args[] = $args_count > 2 ? ',<br />' : ', ';
+			}
+		}
+		return implode('', $args);
+	}
 
 
-    /**
-     * create error code from filepath, function name,
-     * and line number where exception or error was thrown
-     *
-     * @access protected
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     * @return string
-     */
-    protected function generate_error_code($file = '', $func = '', $line = '')
-    {
-        $file_bits = explode('.', basename($file));
-        $error_code = ! empty($file_bits[0]) ? $file_bits[0] : '';
-        $error_code .= ! empty($func) ? ' - ' . $func : '';
-        $error_code .= ! empty($line) ? ' - ' . $line : '';
-        return $error_code;
-    }
+	/**
+	 * create error code from filepath, function name,
+	 * and line number where exception or error was thrown
+	 *
+	 * @access protected
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 * @return string
+	 */
+	protected function generate_error_code($file = '', $func = '', $line = '')
+	{
+		$file_bits = explode('.', basename($file));
+		$error_code = ! empty($file_bits[0]) ? $file_bits[0] : '';
+		$error_code .= ! empty($func) ? ' - ' . $func : '';
+		$error_code .= ! empty($line) ? ' - ' . $line : '';
+		return $error_code;
+	}
 
 
-    /**
-     * @return string
-     */
-    private function exceptionStyles()
-    {
-        return '
+	/**
+	 * @return string
+	 */
+	private function exceptionStyles()
+	{
+		return '
 <style media="screen">
 	#ee-error-message {
 		max-width:90% !important;
@@ -391,34 +391,34 @@ 
 		color: #999;
 	}
 </style>';
-    }
+	}
 
 
-    /**
-     * _print_scripts
-     *
-     * @param bool $force_print
-     * @return string
-     */
-    private function printScripts($force_print = false)
-    {
-        if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
-            //  if script is already enqueued then we can just get out
-            if (wp_script_is('ee_error_js')) {
-                return '';
-            }
-            if (wp_script_is('ee_error_js', 'registered')) {
-                wp_enqueue_style('espresso_default');
-                wp_enqueue_style('espresso_custom_css');
-                wp_enqueue_script('ee_error_js');
-                wp_localize_script('ee_error_js', 'ee_settings', array('wp_debug' => WP_DEBUG));
-                return '';
-            }
-        }
-        $jquery = esc_url_raw(includes_url() . 'js/jquery/jquery.js');
-        $core = esc_url_raw(EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js?ver=' . espresso_version());
-        $ee_error = esc_url_raw(EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js?ver=' . espresso_version());
-        return '
+	/**
+	 * _print_scripts
+	 *
+	 * @param bool $force_print
+	 * @return string
+	 */
+	private function printScripts($force_print = false)
+	{
+		if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
+			//  if script is already enqueued then we can just get out
+			if (wp_script_is('ee_error_js')) {
+				return '';
+			}
+			if (wp_script_is('ee_error_js', 'registered')) {
+				wp_enqueue_style('espresso_default');
+				wp_enqueue_style('espresso_custom_css');
+				wp_enqueue_script('ee_error_js');
+				wp_localize_script('ee_error_js', 'ee_settings', array('wp_debug' => WP_DEBUG));
+				return '';
+			}
+		}
+		$jquery = esc_url_raw(includes_url() . 'js/jquery/jquery.js');
+		$core = esc_url_raw(EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js?ver=' . espresso_version());
+		$ee_error = esc_url_raw(EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js?ver=' . espresso_version());
+		return '
 <script>
 /* <![CDATA[ */
 const ee_settings = {"wp_debug":"' . WP_DEBUG . '"};
@@ -428,5 +428,5 @@ 
 <script src="' . $core . '" type="text/javascript" ></script>
 <script src="' . $ee_error . '" type="text/javascript" ></script>
 ';
-    }
+	}
 }

core/services/request/Request.php

Indentation +491 added lines, -491 removed lines

@@ -17,495 +17,495 @@
 class Request implements InterminableInterface, RequestInterface, ReservedInstanceInterface
 {
 
-    /**
-     * $_COOKIE parameters
-     *
-     * @var array
-     */
-    protected $cookies;
-
-    /**
-     * $_FILES parameters
-     *
-     * @var array
-     */
-    protected $files;
-
-    /**
-     * true if current user appears to be some kind of bot
-     *
-     * @var bool
-     */
-    protected $is_bot;
-
-    /**
-     * @var RequestParams
-     */
-    protected $request_params;
-
-    /**
-     * @var RequestTypeContextCheckerInterface
-     */
-    protected $request_type;
-
-    /**
-     * @var ServerParams
-     */
-    protected $server_params;
-
-
-    public function __construct(
-        RequestParams $request_params,
-        ServerParams $server_params,
-        array $cookies = [],
-        array $files = []
-    ) {
-        $this->cookies = ! empty($cookies)
-            ? $cookies
-            : filter_input_array(INPUT_COOKIE, FILTER_SANITIZE_STRING);
-        $this->files          = ! empty($files) ? $files : $_FILES;
-        $this->request_params = $request_params;
-        $this->server_params  = $server_params;
-    }
-
-
-    /**
-     * @param RequestTypeContextCheckerInterface $type
-     */
-    public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type)
-    {
-        $this->request_type = $type;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getParams()
-    {
-        return $this->request_params->getParams();
-    }
-
-
-    /**
-     * @return array
-     */
-    public function postParams()
-    {
-        return $this->request_params->postParams();
-    }
-
-
-    /**
-     * @return array
-     */
-    public function cookieParams()
-    {
-        return $this->cookies;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function serverParams()
-    {
-        return $this->server_params->getAllServerParams();
-    }
-
-
-    /**
-     * @param string $key
-     * @param mixed|null $default
-     * @return array|int|float|string
-     */
-    public function getServerParam($key, $default = null)
-    {
-        return $this->server_params->getServerParam($key, $default);
-    }
-
-
-    /**
-     * @param string                 $key
-     * @param array|int|float|string $value
-     * @return void
-     */
-    public function setServerParam($key, $value)
-    {
-        $this->server_params->setServerParam($key, $value);
-    }
-
-
-    /**
-     * @param string $key
-     * @return bool
-     */
-    public function serverParamIsSet($key)
-    {
-        return $this->server_params->serverParamIsSet($key);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function filesParams()
-    {
-        return $this->files;
-    }
-
-
-    /**
-     * returns sanitized contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function requestParams()
-    {
-        return $this->request_params->requestParams();
-    }
-
-
-    /**
-     * @param string     $key
-     * @param mixed|null $value
-     * @param bool       $override_ee
-     * @return void
-     */
-    public function setRequestParam($key, $value, $override_ee = false)
-    {
-        $this->request_params->setRequestParam($key, $value, $override_ee);
-    }
-
-
-    /**
-     * merges the incoming array of parameters into the existing request parameters
-     *
-     * @param array $request_params
-     * @return void
-     * @since   4.10.24.p
-     */
-    public function mergeRequestParams(array $request_params)
-    {
-        $this->request_params->mergeRequestParams($request_params);
-    }
-
-
-    /**
-     * returns sanitized value for a request param if the given key exists
-     *
-     * @param string     $key
-     * @param mixed|null $default
-     * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
-     * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
-     * @param string     $delimiter for CSV type strings that should be returned as an array
-     * @return array|bool|float|int|string
-     */
-    public function getRequestParam($key, $default = null, $type = 'string', $is_array = false, $delimiter = '')
-    {
-        return $this->request_params->getRequestParam($key, $default, $type, $is_array, $delimiter);
-    }
-
-
-    /**
-     * check if param exists
-     *
-     * @param string $key
-     * @return bool
-     */
-    public function requestParamIsSet($key)
-    {
-        return $this->request_params->requestParamIsSet($key);
-    }
-
-
-    /**
-     * check if a request parameter exists whose key that matches the supplied wildcard pattern
-     * and return the sanitized value for the first match found
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     *
-     * @param string     $pattern
-     * @param mixed|null $default
-     * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
-     * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
-     * @param string     $delimiter for CSV type strings that should be returned as an array
-     * @return array|bool|float|int|string
-     */
-    public function getMatch($pattern, $default = null, $type = 'string', $is_array = false, $delimiter = '')
-    {
-        return $this->request_params->getMatch($pattern, $default, $type, $is_array, $delimiter);
-    }
-
-
-    /**
-     * check if a request parameter exists whose key matches the supplied wildcard pattern
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     * returns true if a match is found or false if not
-     *
-     * @param string $pattern
-     * @return bool
-     */
-    public function matches($pattern)
-    {
-        return $this->request_params->matches($pattern);
-    }
-
-
-    /**
-     * remove param
-     *
-     * @param      $key
-     * @param bool $unset_from_global_too
-     */
-    public function unSetRequestParam($key, $unset_from_global_too = false)
-    {
-        $this->request_params->unSetRequestParam($key, $unset_from_global_too);
-    }
-
-
-    /**
-     * remove params
-     *
-     * @param array $keys
-     * @param bool  $unset_from_global_too
-     */
-    public function unSetRequestParams(array $keys, $unset_from_global_too = false)
-    {
-        $this->request_params->unSetRequestParams($keys, $unset_from_global_too);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function ipAddress()
-    {
-        return $this->server_params->ipAddress();
-    }
-
-
-    /**
-     * Gets the request's literal URI. Related to `requestUriAfterSiteHomeUri`, see its description for a comparison.
-     *
-     * @param boolean $relativeToWpRoot If home_url() is "http://mysite.com/wp/", and a request comes to
-     *                                  "http://mysite.com/wp/wp-json", setting $relativeToWpRoot=true will return
-     *                                  "/wp-json", whereas $relativeToWpRoot=false will return "/wp/wp-json/".
-     * @return string
-     */
-    public function requestUri($relativeToWpRoot = false)
-    {
-        return $this->server_params->requestUri();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function userAgent()
-    {
-        return $this->server_params->userAgent();
-    }
-
-
-    /**
-     * @param string $user_agent
-     */
-    public function setUserAgent($user_agent = '')
-    {
-        $this->server_params->setUserAgent($user_agent);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isBot()
-    {
-        return $this->is_bot;
-    }
-
-
-    /**
-     * @param bool $is_bot
-     */
-    public function setIsBot($is_bot)
-    {
-        $this->is_bot = filter_var($is_bot, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isActivation()
-    {
-        return $this->request_type->isActivation();
-    }
-
-
-    /**
-     * @param $is_activation
-     * @return bool
-     */
-    public function setIsActivation($is_activation)
-    {
-        return $this->request_type->setIsActivation($is_activation);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isAdmin()
-    {
-        return $this->request_type->isAdmin();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isAdminAjax()
-    {
-        return $this->request_type->isAdminAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isAjax()
-    {
-        return $this->request_type->isAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isEeAjax()
-    {
-        return $this->request_type->isEeAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isOtherAjax()
-    {
-        return $this->request_type->isOtherAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isApi()
-    {
-        return $this->request_type->isApi();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isCli()
-    {
-        return $this->request_type->isCli();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isCron()
-    {
-        return $this->request_type->isCron();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isFeed()
-    {
-        return $this->request_type->isFeed();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isFrontend()
-    {
-        return $this->request_type->isFrontend();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isFrontAjax()
-    {
-        return $this->request_type->isFrontAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isIframe()
-    {
-        return $this->request_type->isIframe();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isWordPressApi()
-    {
-        return $this->request_type->isWordPressApi();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isWordPressHeartbeat()
-    {
-        return $this->request_type->isWordPressHeartbeat();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isWordPressScrape()
-    {
-        return $this->request_type->isWordPressScrape();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->request_type->slug();
-    }
-
-
-    /**
-     * @return RequestTypeContextCheckerInterface
-     */
-    public function getRequestType()
-    {
-        return $this->request_type;
-    }
+	/**
+	 * $_COOKIE parameters
+	 *
+	 * @var array
+	 */
+	protected $cookies;
+
+	/**
+	 * $_FILES parameters
+	 *
+	 * @var array
+	 */
+	protected $files;
+
+	/**
+	 * true if current user appears to be some kind of bot
+	 *
+	 * @var bool
+	 */
+	protected $is_bot;
+
+	/**
+	 * @var RequestParams
+	 */
+	protected $request_params;
+
+	/**
+	 * @var RequestTypeContextCheckerInterface
+	 */
+	protected $request_type;
+
+	/**
+	 * @var ServerParams
+	 */
+	protected $server_params;
+
+
+	public function __construct(
+		RequestParams $request_params,
+		ServerParams $server_params,
+		array $cookies = [],
+		array $files = []
+	) {
+		$this->cookies = ! empty($cookies)
+			? $cookies
+			: filter_input_array(INPUT_COOKIE, FILTER_SANITIZE_STRING);
+		$this->files          = ! empty($files) ? $files : $_FILES;
+		$this->request_params = $request_params;
+		$this->server_params  = $server_params;
+	}
+
+
+	/**
+	 * @param RequestTypeContextCheckerInterface $type
+	 */
+	public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type)
+	{
+		$this->request_type = $type;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getParams()
+	{
+		return $this->request_params->getParams();
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function postParams()
+	{
+		return $this->request_params->postParams();
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function cookieParams()
+	{
+		return $this->cookies;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function serverParams()
+	{
+		return $this->server_params->getAllServerParams();
+	}
+
+
+	/**
+	 * @param string $key
+	 * @param mixed|null $default
+	 * @return array|int|float|string
+	 */
+	public function getServerParam($key, $default = null)
+	{
+		return $this->server_params->getServerParam($key, $default);
+	}
+
+
+	/**
+	 * @param string                 $key
+	 * @param array|int|float|string $value
+	 * @return void
+	 */
+	public function setServerParam($key, $value)
+	{
+		$this->server_params->setServerParam($key, $value);
+	}
+
+
+	/**
+	 * @param string $key
+	 * @return bool
+	 */
+	public function serverParamIsSet($key)
+	{
+		return $this->server_params->serverParamIsSet($key);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function filesParams()
+	{
+		return $this->files;
+	}
+
+
+	/**
+	 * returns sanitized contents of $_REQUEST
+	 *
+	 * @return array
+	 */
+	public function requestParams()
+	{
+		return $this->request_params->requestParams();
+	}
+
+
+	/**
+	 * @param string     $key
+	 * @param mixed|null $value
+	 * @param bool       $override_ee
+	 * @return void
+	 */
+	public function setRequestParam($key, $value, $override_ee = false)
+	{
+		$this->request_params->setRequestParam($key, $value, $override_ee);
+	}
+
+
+	/**
+	 * merges the incoming array of parameters into the existing request parameters
+	 *
+	 * @param array $request_params
+	 * @return void
+	 * @since   4.10.24.p
+	 */
+	public function mergeRequestParams(array $request_params)
+	{
+		$this->request_params->mergeRequestParams($request_params);
+	}
+
+
+	/**
+	 * returns sanitized value for a request param if the given key exists
+	 *
+	 * @param string     $key
+	 * @param mixed|null $default
+	 * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
+	 * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
+	 * @param string     $delimiter for CSV type strings that should be returned as an array
+	 * @return array|bool|float|int|string
+	 */
+	public function getRequestParam($key, $default = null, $type = 'string', $is_array = false, $delimiter = '')
+	{
+		return $this->request_params->getRequestParam($key, $default, $type, $is_array, $delimiter);
+	}
+
+
+	/**
+	 * check if param exists
+	 *
+	 * @param string $key
+	 * @return bool
+	 */
+	public function requestParamIsSet($key)
+	{
+		return $this->request_params->requestParamIsSet($key);
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key that matches the supplied wildcard pattern
+	 * and return the sanitized value for the first match found
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 *
+	 * @param string     $pattern
+	 * @param mixed|null $default
+	 * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
+	 * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
+	 * @param string     $delimiter for CSV type strings that should be returned as an array
+	 * @return array|bool|float|int|string
+	 */
+	public function getMatch($pattern, $default = null, $type = 'string', $is_array = false, $delimiter = '')
+	{
+		return $this->request_params->getMatch($pattern, $default, $type, $is_array, $delimiter);
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key matches the supplied wildcard pattern
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 * returns true if a match is found or false if not
+	 *
+	 * @param string $pattern
+	 * @return bool
+	 */
+	public function matches($pattern)
+	{
+		return $this->request_params->matches($pattern);
+	}
+
+
+	/**
+	 * remove param
+	 *
+	 * @param      $key
+	 * @param bool $unset_from_global_too
+	 */
+	public function unSetRequestParam($key, $unset_from_global_too = false)
+	{
+		$this->request_params->unSetRequestParam($key, $unset_from_global_too);
+	}
+
+
+	/**
+	 * remove params
+	 *
+	 * @param array $keys
+	 * @param bool  $unset_from_global_too
+	 */
+	public function unSetRequestParams(array $keys, $unset_from_global_too = false)
+	{
+		$this->request_params->unSetRequestParams($keys, $unset_from_global_too);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function ipAddress()
+	{
+		return $this->server_params->ipAddress();
+	}
+
+
+	/**
+	 * Gets the request's literal URI. Related to `requestUriAfterSiteHomeUri`, see its description for a comparison.
+	 *
+	 * @param boolean $relativeToWpRoot If home_url() is "http://mysite.com/wp/", and a request comes to
+	 *                                  "http://mysite.com/wp/wp-json", setting $relativeToWpRoot=true will return
+	 *                                  "/wp-json", whereas $relativeToWpRoot=false will return "/wp/wp-json/".
+	 * @return string
+	 */
+	public function requestUri($relativeToWpRoot = false)
+	{
+		return $this->server_params->requestUri();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function userAgent()
+	{
+		return $this->server_params->userAgent();
+	}
+
+
+	/**
+	 * @param string $user_agent
+	 */
+	public function setUserAgent($user_agent = '')
+	{
+		$this->server_params->setUserAgent($user_agent);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isBot()
+	{
+		return $this->is_bot;
+	}
+
+
+	/**
+	 * @param bool $is_bot
+	 */
+	public function setIsBot($is_bot)
+	{
+		$this->is_bot = filter_var($is_bot, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isActivation()
+	{
+		return $this->request_type->isActivation();
+	}
+
+
+	/**
+	 * @param $is_activation
+	 * @return bool
+	 */
+	public function setIsActivation($is_activation)
+	{
+		return $this->request_type->setIsActivation($is_activation);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isAdmin()
+	{
+		return $this->request_type->isAdmin();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isAdminAjax()
+	{
+		return $this->request_type->isAdminAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isAjax()
+	{
+		return $this->request_type->isAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isEeAjax()
+	{
+		return $this->request_type->isEeAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isOtherAjax()
+	{
+		return $this->request_type->isOtherAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isApi()
+	{
+		return $this->request_type->isApi();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isCli()
+	{
+		return $this->request_type->isCli();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isCron()
+	{
+		return $this->request_type->isCron();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isFeed()
+	{
+		return $this->request_type->isFeed();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isFrontend()
+	{
+		return $this->request_type->isFrontend();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isFrontAjax()
+	{
+		return $this->request_type->isFrontAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isIframe()
+	{
+		return $this->request_type->isIframe();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isWordPressApi()
+	{
+		return $this->request_type->isWordPressApi();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isWordPressHeartbeat()
+	{
+		return $this->request_type->isWordPressHeartbeat();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isWordPressScrape()
+	{
+		return $this->request_type->isWordPressScrape();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->request_type->slug();
+	}
+
+
+	/**
+	 * @return RequestTypeContextCheckerInterface
+	 */
+	public function getRequestType()
+	{
+		return $this->request_type;
+	}
 }

core/services/request/RequestParams.php

Indentation +323 added lines, -323 removed lines

@@ -14,327 +14,327 @@
 class RequestParams
 {
 
-    /**
-     * $_GET parameters
-     *
-     * @var array
-     */
-    protected $get;
-
-    /**
-     * $_POST parameters
-     *
-     * @var array
-     */
-    protected $post;
-
-    /**
-     * $_REQUEST parameters
-     *
-     * @var array
-     */
-    protected $request;
-
-    /**
-     * @var RequestSanitizer
-     */
-    protected $sanitizer;
-
-
-    /**
-     * RequestParams constructor.
-     *
-     * @param RequestSanitizer $sanitizer
-     * @param array            $get
-     * @param array            $post
-     */
-    public function __construct(RequestSanitizer $sanitizer, array $get = [], array $post = [])
-    {
-        $this->sanitizer = $sanitizer;
-        $this->get       = ! empty($get) ? $get : $_GET;
-        $this->post      = ! empty($post) ? $post : $_POST;
-        $this->request   = array_merge($this->get, $this->post);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getParams()
-    {
-        return $this->get;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function postParams()
-    {
-        return $this->post;
-    }
-
-
-    /**
-     * returns contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function requestParams()
-    {
-        return $this->request;
-    }
-
-
-    /**
-     * @param string     $key
-     * @param mixed|null $value
-     * @param bool       $override_ee
-     * @return    void
-     */
-    public function setRequestParam($key, $value, $override_ee = false)
-    {
-        // don't allow "ee" to be overwritten unless explicitly instructed to do so
-        if ($override_ee || $key !== 'ee' || empty($this->request['ee'])) {
-            $this->request[ $key ] = $value;
-        }
-    }
-
-
-    /**
-     * merges the incoming array of parameters into the existing request parameters
-     *
-     * @param array $request_params
-     * @return void
-     * @since   4.10.24.p
-     */
-    public function mergeRequestParams(array $request_params)
-    {
-        $this->request = array_merge_recursive($this->request, $request_params);
-    }
-
-
-    /**
-     * returns   the value for a request param if the given key exists
-     *
-     * @param string     $key
-     * @param mixed|null $default
-     * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
-     * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
-     * @param string     $delimiter for CSV type strings that should be returned as an array
-     * @return array|bool|float|int|string
-     */
-    public function getRequestParam($key, $default = null, $type = 'string', $is_array = false, $delimiter = '')
-    {
-        return $this->sanitizer->clean(
-            $this->parameterDrillDown($key, $default, 'get'),
-            $type,
-            $is_array,
-            $delimiter
-        );
-    }
-
-
-    /**
-     * check if param exists
-     *
-     * @param string $key
-     * @return bool
-     */
-    public function requestParamIsSet($key)
-    {
-        return (bool) $this->parameterDrillDown($key);
-    }
-
-
-    /**
-     * check if a request parameter exists whose key that matches the supplied wildcard pattern
-     * and return the value for the first match found
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     *
-     * @param string     $pattern
-     * @param mixed|null $default
-     * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
-     * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
-     * @param string     $delimiter for CSV type strings that should be returned as an array
-     * @return array|bool|float|int|string
-     */
-    public function getMatch($pattern, $default = null, $type = 'string', $is_array = false, $delimiter = '')
-    {
-        return $this->sanitizer->clean(
-            $this->parameterDrillDown($pattern, $default, 'match'),
-            $type,
-            $is_array,
-            $delimiter
-        );
-    }
-
-
-    /**
-     * check if a request parameter exists whose key matches the supplied wildcard pattern
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     * returns true if a match is found or false if not
-     *
-     * @param string $pattern
-     * @return bool
-     */
-    public function matches($pattern)
-    {
-        return (bool) $this->parameterDrillDown($pattern, false, 'match', 'bool');
-    }
-
-
-    /**
-     * @see https://stackoverflow.com/questions/6163055/php-string-matching-with-wildcard
-     * @param string $pattern               A string including wildcards to be converted to a regex pattern
-     *                                      and used to search through the current request's parameter keys
-     * @param array  $request_params        The array of request parameters to search through
-     * @param mixed  $default               [optional] The value to be returned if no match is found.
-     *                                      Default is null
-     * @param string $return                [optional] Controls what kind of value is returned.
-     *                                      Options are:
-     *                                      'bool' will return true or false if match is found or not
-     *                                      'key' will return the first key found that matches the supplied pattern
-     *                                      'value' will return the value for the first request parameter
-     *                                      whose key matches the supplied pattern
-     *                                      Default is 'value'
-     * @return boolean|string
-     */
-    private function match($pattern, array $request_params, $default = null, $return = 'value')
-    {
-        $return = in_array($return, ['bool', 'key', 'value'], true)
-            ? $return
-            : 'is_set';
-        // replace wildcard chars with regex chars
-        $pattern = str_replace(
-            ['\*', '\?'],
-            ['.*', '.'],
-            preg_quote($pattern, '/')
-        );
-        foreach ($request_params as $key => $request_param) {
-            if (preg_match('/^' . $pattern . '$/is', $key)) {
-                // return value for request param
-                if ($return === 'value') {
-                    return $request_param;
-                }
-                // or actual key or true just to indicate it was found
-                return $return === 'key' ? $key : true;
-            }
-        }
-        // match not found so return default value or false
-        return $return === 'value' ? $default : false;
-    }
-
-
-    /**
-     * the supplied key can be a simple string to represent a "top-level" request parameter
-     * or represent a key for a request parameter that is nested deeper within the request parameter array,
-     * by using square brackets to surround keys for deeper array elements.
-     * For example :
-     * if the supplied $key was: "first[second][third]"
-     * then this will attempt to drill down into the request parameter array to find a value.
-     * Given the following request parameters:
-     *  array(
-     *      'first' => array(
-     *          'second' => array(
-     *              'third' => 'has a value'
-     *          )
-     *      )
-     *  )
-     * would return true if default parameters were set
-     *
-     * @param string $callback
-     * @param        $key
-     * @param null   $default
-     * @param string $return
-     * @param mixed  $request_params
-     * @return bool|mixed|null
-     */
-    private function parameterDrillDown(
-        $key,
-        $default = null,
-        $callback = 'is_set',
-        $return = 'value',
-        $request_params = []
-    ) {
-        $callback       = in_array($callback, ['is_set', 'get', 'match'], true)
-            ? $callback
-            : 'is_set';
-        $request_params = ! empty($request_params)
-            ? $request_params
-            : $this->request;
-        // does incoming key represent an array like 'first[second][third]'  ?
-        if (strpos($key, '[') !== false) {
-            // turn it into an actual array
-            $key  = str_replace(']', '', $key);
-            $keys = explode('[', $key);
-            $key  = array_shift($keys);
-            if ($callback === 'match') {
-                $real_key = $this->match($key, $request_params, $default, 'key');
-                $key      = $real_key ?: $key;
-            }
-            // check if top level key exists
-            if (isset($request_params[ $key ])) {
-                // build a new key to pass along like: 'second[third]'
-                // or just 'second' depending on depth of keys
-                $key_string = array_shift($keys);
-                if (! empty($keys)) {
-                    $key_string .= '[' . implode('][', $keys) . ']';
-                }
-                return $this->parameterDrillDown(
-                    $key_string,
-                    $default,
-                    $callback,
-                    $return,
-                    $request_params[ $key ]
-                );
-            }
-        }
-        if ($callback === 'is_set') {
-            return isset($request_params[ $key ]);
-        }
-        if ($callback === 'match') {
-            return $this->match($key, $request_params, $default, $return);
-        }
-        return isset($request_params[ $key ])
-            ? $request_params[ $key ]
-            : $default;
-    }
-
-
-    /**
-     * remove param
-     *
-     * @param      $key
-     * @param bool $unset_from_global_too
-     */
-    public function unSetRequestParam($key, $unset_from_global_too = false)
-    {
-        // because unset may not actually remove var
-        $this->get[ $key ]     = null;
-        $this->post[ $key ]    = null;
-        $this->request[ $key ] = null;
-        unset($this->get[ $key ], $this->post[ $key ], $this->request[ $key ]);
-        if ($unset_from_global_too) {
-            unset($_GET[ $key ], $_POST[ $key ], $_REQUEST[ $key ]);
-        }
-    }
-
-
-    /**
-     * remove params
-     *
-     * @param array $keys
-     * @param bool  $unset_from_global_too
-     */
-    public function unSetRequestParams(array $keys, $unset_from_global_too = false)
-    {
-        foreach ($keys as $key) {
-            $this->unSetRequestParam($key, $unset_from_global_too);
-        }
-    }
+	/**
+	 * $_GET parameters
+	 *
+	 * @var array
+	 */
+	protected $get;
+
+	/**
+	 * $_POST parameters
+	 *
+	 * @var array
+	 */
+	protected $post;
+
+	/**
+	 * $_REQUEST parameters
+	 *
+	 * @var array
+	 */
+	protected $request;
+
+	/**
+	 * @var RequestSanitizer
+	 */
+	protected $sanitizer;
+
+
+	/**
+	 * RequestParams constructor.
+	 *
+	 * @param RequestSanitizer $sanitizer
+	 * @param array            $get
+	 * @param array            $post
+	 */
+	public function __construct(RequestSanitizer $sanitizer, array $get = [], array $post = [])
+	{
+		$this->sanitizer = $sanitizer;
+		$this->get       = ! empty($get) ? $get : $_GET;
+		$this->post      = ! empty($post) ? $post : $_POST;
+		$this->request   = array_merge($this->get, $this->post);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getParams()
+	{
+		return $this->get;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function postParams()
+	{
+		return $this->post;
+	}
+
+
+	/**
+	 * returns contents of $_REQUEST
+	 *
+	 * @return array
+	 */
+	public function requestParams()
+	{
+		return $this->request;
+	}
+
+
+	/**
+	 * @param string     $key
+	 * @param mixed|null $value
+	 * @param bool       $override_ee
+	 * @return    void
+	 */
+	public function setRequestParam($key, $value, $override_ee = false)
+	{
+		// don't allow "ee" to be overwritten unless explicitly instructed to do so
+		if ($override_ee || $key !== 'ee' || empty($this->request['ee'])) {
+			$this->request[ $key ] = $value;
+		}
+	}
+
+
+	/**
+	 * merges the incoming array of parameters into the existing request parameters
+	 *
+	 * @param array $request_params
+	 * @return void
+	 * @since   4.10.24.p
+	 */
+	public function mergeRequestParams(array $request_params)
+	{
+		$this->request = array_merge_recursive($this->request, $request_params);
+	}
+
+
+	/**
+	 * returns   the value for a request param if the given key exists
+	 *
+	 * @param string     $key
+	 * @param mixed|null $default
+	 * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
+	 * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
+	 * @param string     $delimiter for CSV type strings that should be returned as an array
+	 * @return array|bool|float|int|string
+	 */
+	public function getRequestParam($key, $default = null, $type = 'string', $is_array = false, $delimiter = '')
+	{
+		return $this->sanitizer->clean(
+			$this->parameterDrillDown($key, $default, 'get'),
+			$type,
+			$is_array,
+			$delimiter
+		);
+	}
+
+
+	/**
+	 * check if param exists
+	 *
+	 * @param string $key
+	 * @return bool
+	 */
+	public function requestParamIsSet($key)
+	{
+		return (bool) $this->parameterDrillDown($key);
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key that matches the supplied wildcard pattern
+	 * and return the value for the first match found
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 *
+	 * @param string     $pattern
+	 * @param mixed|null $default
+	 * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
+	 * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
+	 * @param string     $delimiter for CSV type strings that should be returned as an array
+	 * @return array|bool|float|int|string
+	 */
+	public function getMatch($pattern, $default = null, $type = 'string', $is_array = false, $delimiter = '')
+	{
+		return $this->sanitizer->clean(
+			$this->parameterDrillDown($pattern, $default, 'match'),
+			$type,
+			$is_array,
+			$delimiter
+		);
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key matches the supplied wildcard pattern
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 * returns true if a match is found or false if not
+	 *
+	 * @param string $pattern
+	 * @return bool
+	 */
+	public function matches($pattern)
+	{
+		return (bool) $this->parameterDrillDown($pattern, false, 'match', 'bool');
+	}
+
+
+	/**
+	 * @see https://stackoverflow.com/questions/6163055/php-string-matching-with-wildcard
+	 * @param string $pattern               A string including wildcards to be converted to a regex pattern
+	 *                                      and used to search through the current request's parameter keys
+	 * @param array  $request_params        The array of request parameters to search through
+	 * @param mixed  $default               [optional] The value to be returned if no match is found.
+	 *                                      Default is null
+	 * @param string $return                [optional] Controls what kind of value is returned.
+	 *                                      Options are:
+	 *                                      'bool' will return true or false if match is found or not
+	 *                                      'key' will return the first key found that matches the supplied pattern
+	 *                                      'value' will return the value for the first request parameter
+	 *                                      whose key matches the supplied pattern
+	 *                                      Default is 'value'
+	 * @return boolean|string
+	 */
+	private function match($pattern, array $request_params, $default = null, $return = 'value')
+	{
+		$return = in_array($return, ['bool', 'key', 'value'], true)
+			? $return
+			: 'is_set';
+		// replace wildcard chars with regex chars
+		$pattern = str_replace(
+			['\*', '\?'],
+			['.*', '.'],
+			preg_quote($pattern, '/')
+		);
+		foreach ($request_params as $key => $request_param) {
+			if (preg_match('/^' . $pattern . '$/is', $key)) {
+				// return value for request param
+				if ($return === 'value') {
+					return $request_param;
+				}
+				// or actual key or true just to indicate it was found
+				return $return === 'key' ? $key : true;
+			}
+		}
+		// match not found so return default value or false
+		return $return === 'value' ? $default : false;
+	}
+
+
+	/**
+	 * the supplied key can be a simple string to represent a "top-level" request parameter
+	 * or represent a key for a request parameter that is nested deeper within the request parameter array,
+	 * by using square brackets to surround keys for deeper array elements.
+	 * For example :
+	 * if the supplied $key was: "first[second][third]"
+	 * then this will attempt to drill down into the request parameter array to find a value.
+	 * Given the following request parameters:
+	 *  array(
+	 *      'first' => array(
+	 *          'second' => array(
+	 *              'third' => 'has a value'
+	 *          )
+	 *      )
+	 *  )
+	 * would return true if default parameters were set
+	 *
+	 * @param string $callback
+	 * @param        $key
+	 * @param null   $default
+	 * @param string $return
+	 * @param mixed  $request_params
+	 * @return bool|mixed|null
+	 */
+	private function parameterDrillDown(
+		$key,
+		$default = null,
+		$callback = 'is_set',
+		$return = 'value',
+		$request_params = []
+	) {
+		$callback       = in_array($callback, ['is_set', 'get', 'match'], true)
+			? $callback
+			: 'is_set';
+		$request_params = ! empty($request_params)
+			? $request_params
+			: $this->request;
+		// does incoming key represent an array like 'first[second][third]'  ?
+		if (strpos($key, '[') !== false) {
+			// turn it into an actual array
+			$key  = str_replace(']', '', $key);
+			$keys = explode('[', $key);
+			$key  = array_shift($keys);
+			if ($callback === 'match') {
+				$real_key = $this->match($key, $request_params, $default, 'key');
+				$key      = $real_key ?: $key;
+			}
+			// check if top level key exists
+			if (isset($request_params[ $key ])) {
+				// build a new key to pass along like: 'second[third]'
+				// or just 'second' depending on depth of keys
+				$key_string = array_shift($keys);
+				if (! empty($keys)) {
+					$key_string .= '[' . implode('][', $keys) . ']';
+				}
+				return $this->parameterDrillDown(
+					$key_string,
+					$default,
+					$callback,
+					$return,
+					$request_params[ $key ]
+				);
+			}
+		}
+		if ($callback === 'is_set') {
+			return isset($request_params[ $key ]);
+		}
+		if ($callback === 'match') {
+			return $this->match($key, $request_params, $default, $return);
+		}
+		return isset($request_params[ $key ])
+			? $request_params[ $key ]
+			: $default;
+	}
+
+
+	/**
+	 * remove param
+	 *
+	 * @param      $key
+	 * @param bool $unset_from_global_too
+	 */
+	public function unSetRequestParam($key, $unset_from_global_too = false)
+	{
+		// because unset may not actually remove var
+		$this->get[ $key ]     = null;
+		$this->post[ $key ]    = null;
+		$this->request[ $key ] = null;
+		unset($this->get[ $key ], $this->post[ $key ], $this->request[ $key ]);
+		if ($unset_from_global_too) {
+			unset($_GET[ $key ], $_POST[ $key ], $_REQUEST[ $key ]);
+		}
+	}
+
+
+	/**
+	 * remove params
+	 *
+	 * @param array $keys
+	 * @param bool  $unset_from_global_too
+	 */
+	public function unSetRequestParams(array $keys, $unset_from_global_too = false)
+	{
+		foreach ($keys as $key) {
+			$this->unSetRequestParam($key, $unset_from_global_too);
+		}
+	}
 }

core/services/request/RequestInterface.php

Indentation +189 added lines, -189 removed lines

@@ -16,195 +16,195 @@
 interface RequestInterface extends RequestTypeContextCheckerInterface
 {
 
-    /**
-     * @param RequestTypeContextCheckerInterface $type
-     */
-    public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type);
+	/**
+	 * @param RequestTypeContextCheckerInterface $type
+	 */
+	public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type);
 
 
-    /**
-     * @return array
-     */
-    public function getParams();
-
-
-    /**
-     * @return array
-     */
-    public function postParams();
-
-
-    /**
-     * @return array
-     */
-    public function cookieParams();
-
-
-    /**
-     * @return array
-     */
-    public function serverParams();
-
-
-    /**
-     * @param string $key
-     * @param mixed|null $default
-     * @return array|int|float|string
-     */
-    public function getServerParam($key, $default = null);
-
-
-    /**
-     * @param string                 $key
-     * @param array|int|float|string $value
-     * @return void
-     */
-    public function setServerParam($key, $value);
-
-
-    /**
-     * @param string $key
-     * @return bool
-     */
-    public function serverParamIsSet($key);
-
-
-    /**
-     * @return array
-     */
-    public function filesParams();
-
-
-    /**
-     * returns sanitized contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function requestParams();
-
-
-    /**
-     * @param string $key
-     * @param string $value
-     * @param bool   $override_ee
-     * @return void
-     */
-    public function setRequestParam($key, $value, $override_ee = false);
-
-
-    /**
-     * returns   the value for a request param if the given key exists
-     *
-     * @param string     $key
-     * @param mixed|null $default
-     * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
-     * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
-     * @param string     $delimiter for CSV type strings that should be returned as an array
-     * @return array|bool|float|int|string
-     */
-    public function getRequestParam($key, $default = null, $type = 'string', $is_array = false, $delimiter = '');
-
-
-    /**
-     * check if param exists
-     *
-     * @param string $key
-     * @return bool
-     */
-    public function requestParamIsSet($key);
-
-
-    /**
-     * check if a request parameter exists whose key that matches the supplied wildcard pattern
-     * and return the value for the first match found
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     *
-     * @param string     $pattern
-     * @param mixed|null $default
-     * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
-     * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
-     * @param string     $delimiter for CSV type strings that should be returned as an array
-     * @return array|bool|float|int|string
-     */
-    public function getMatch($pattern, $default = null, $type = 'string', $is_array = false, $delimiter = '');
-
-
-    /**
-     * check if a request parameter exists whose key matches the supplied wildcard pattern
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     * returns true if a match is found or false if not
-     *
-     * @param string $pattern
-     * @return false|int
-     */
-    public function matches($pattern);
-
-
-    /**
-     * remove param
-     *
-     * @param string $key
-     * @param bool   $unset_from_global_too
-     */
-    public function unSetRequestParam($key, $unset_from_global_too = false);
-
-
-    /**
-     * remove params
-     *
-     * @param array $keys
-     * @param bool  $unset_from_global_too
-     */
-    public function unSetRequestParams(array $keys, $unset_from_global_too = false);
-
-
-    /**
-     * @return string
-     */
-    public function ipAddress();
-
-
-    /**
-     * @param boolean $relativeToWpRoot whether to return the uri relative to WordPress' home URL, or not.
-     * @return string
-     */
-    public function requestUri($relativeToWpRoot = false);
-
-
-    /**
-     * @return string
-     */
-    public function userAgent();
-
-
-    /**
-     * @param string $user_agent
-     */
-    public function setUserAgent($user_agent = '');
-
-
-    /**
-     * @return bool
-     */
-    public function isBot();
-
-
-    /**
-     * @param bool $is_bot
-     */
-    public function setIsBot($is_bot);
-
-
-    /**
-     * merges the incoming array of parameters into the existing request parameters
-     *
-     * @param array $request_params
-     * @return mixed
-     * @since   4.10.24.p
-     */
-    public function mergeRequestParams(array $request_params);
+	/**
+	 * @return array
+	 */
+	public function getParams();
+
+
+	/**
+	 * @return array
+	 */
+	public function postParams();
+
+
+	/**
+	 * @return array
+	 */
+	public function cookieParams();
+
+
+	/**
+	 * @return array
+	 */
+	public function serverParams();
+
+
+	/**
+	 * @param string $key
+	 * @param mixed|null $default
+	 * @return array|int|float|string
+	 */
+	public function getServerParam($key, $default = null);
+
+
+	/**
+	 * @param string                 $key
+	 * @param array|int|float|string $value
+	 * @return void
+	 */
+	public function setServerParam($key, $value);
+
+
+	/**
+	 * @param string $key
+	 * @return bool
+	 */
+	public function serverParamIsSet($key);
+
+
+	/**
+	 * @return array
+	 */
+	public function filesParams();
+
+
+	/**
+	 * returns sanitized contents of $_REQUEST
+	 *
+	 * @return array
+	 */
+	public function requestParams();
+
+
+	/**
+	 * @param string $key
+	 * @param string $value
+	 * @param bool   $override_ee
+	 * @return void
+	 */
+	public function setRequestParam($key, $value, $override_ee = false);
+
+
+	/**
+	 * returns   the value for a request param if the given key exists
+	 *
+	 * @param string     $key
+	 * @param mixed|null $default
+	 * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
+	 * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
+	 * @param string     $delimiter for CSV type strings that should be returned as an array
+	 * @return array|bool|float|int|string
+	 */
+	public function getRequestParam($key, $default = null, $type = 'string', $is_array = false, $delimiter = '');
+
+
+	/**
+	 * check if param exists
+	 *
+	 * @param string $key
+	 * @return bool
+	 */
+	public function requestParamIsSet($key);
+
+
+	/**
+	 * check if a request parameter exists whose key that matches the supplied wildcard pattern
+	 * and return the value for the first match found
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 *
+	 * @param string     $pattern
+	 * @param mixed|null $default
+	 * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
+	 * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
+	 * @param string     $delimiter for CSV type strings that should be returned as an array
+	 * @return array|bool|float|int|string
+	 */
+	public function getMatch($pattern, $default = null, $type = 'string', $is_array = false, $delimiter = '');
+
+
+	/**
+	 * check if a request parameter exists whose key matches the supplied wildcard pattern
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 * returns true if a match is found or false if not
+	 *
+	 * @param string $pattern
+	 * @return false|int
+	 */
+	public function matches($pattern);
+
+
+	/**
+	 * remove param
+	 *
+	 * @param string $key
+	 * @param bool   $unset_from_global_too
+	 */
+	public function unSetRequestParam($key, $unset_from_global_too = false);
+
+
+	/**
+	 * remove params
+	 *
+	 * @param array $keys
+	 * @param bool  $unset_from_global_too
+	 */
+	public function unSetRequestParams(array $keys, $unset_from_global_too = false);
+
+
+	/**
+	 * @return string
+	 */
+	public function ipAddress();
+
+
+	/**
+	 * @param boolean $relativeToWpRoot whether to return the uri relative to WordPress' home URL, or not.
+	 * @return string
+	 */
+	public function requestUri($relativeToWpRoot = false);
+
+
+	/**
+	 * @return string
+	 */
+	public function userAgent();
+
+
+	/**
+	 * @param string $user_agent
+	 */
+	public function setUserAgent($user_agent = '');
+
+
+	/**
+	 * @return bool
+	 */
+	public function isBot();
+
+
+	/**
+	 * @param bool $is_bot
+	 */
+	public function setIsBot($is_bot);
+
+
+	/**
+	 * merges the incoming array of parameters into the existing request parameters
+	 *
+	 * @param array $request_params
+	 * @return mixed
+	 * @since   4.10.24.p
+	 */
+	public function mergeRequestParams(array $request_params);
 }