eventespresso / event-espresso-core

espresso.php

Indentation +80 added lines, -80 removed lines

@@ -38,103 +38,103 @@
  * @since           4.0
  */
 if (function_exists('espresso_version')) {
-    if (! function_exists('espresso_duplicate_plugin_error')) {
-        /**
-         *    espresso_duplicate_plugin_error
-         *    displays if more than one version of EE is activated at the same time
-         */
-        function espresso_duplicate_plugin_error()
-        {
-            ?>
+	if (! function_exists('espresso_duplicate_plugin_error')) {
+		/**
+		 *    espresso_duplicate_plugin_error
+		 *    displays if more than one version of EE is activated at the same time
+		 */
+		function espresso_duplicate_plugin_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                    ); ?>
+					echo esc_html__(
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+					); ?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
-    }
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
+	}
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '5.6.2');
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         *
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '5.6.2');
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 *
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    printf(
-                        esc_html__(
-                            'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                            'event_espresso'
-                        ),
-                        EE_MIN_PHP_VER_REQUIRED,
-                        PHP_VERSION,
-                        '<br/>',
-                        '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
-                    );
-                    ?>
+					printf(
+						esc_html__(
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+							'event_espresso'
+						),
+						EE_MIN_PHP_VER_REQUIRED,
+						PHP_VERSION,
+						'<br/>',
+						'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
+					);
+					?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '4.10.17.rc.000');
-        }
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '4.10.17.rc.000');
+		}
 
-        /**
-         * espresso_plugin_activation
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-        }
+		/**
+		 * espresso_plugin_activation
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
 
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
-        bootstrap_espresso();
-    }
+		require_once __DIR__ . '/core/bootstrap_espresso.php';
+		bootstrap_espresso();
+	}
 }
 if (! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin($plugin_basename = '')
-    {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin($plugin_basename = '')
+	{
+		if (! function_exists('deactivate_plugins')) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }

core/services/request/RequestParams.php

Indentation +310 added lines, -310 removed lines

@@ -14,314 +14,314 @@
 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;
-        }
-    }
-
-
-    /**
-     * 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;
+		}
+	}
+
+
+	/**
+	 * 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);
+		}
+	}
 }