eventespresso / event-espresso-core

core/services/request/RequestInterface.php

Indentation +122 added lines, -122 removed lines

@@ -16,145 +16,145 @@
 interface RequestInterface extends RequestTypeContextCheckerInterface
 {
 
-    /**
-     * @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();
-
-
-    /**
-     * @return array
-     */
-    public function filesParams();
+	/**
+	 * @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();
+
+
+	/**
+	 * @return array
+	 */
+	public function filesParams();
 
 
-    /**
-     * returns contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function requestParams();
+	/**
+	 * returns 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);
+	/**
+	 * @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 null   $default
-     * @return mixed
-     */
-    public function getRequestParam($key, $default = null);
+	/**
+	 * returns the value for a request param if the given key exists
+	 *
+	 * @param string $key
+	 * @param null   $default
+	 * @return mixed
+	 */
+	public function getRequestParam($key, $default = null);
 
 
-    /**
-     * check if param exists
-     *
-     * @param string $key
-     * @return bool
-     */
-    public function requestParamIsSet($key);
+	/**
+	 * 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 null|mixed $default
-     * @return false|int
-     */
-    public function getMatch($pattern, $default = null);
+	/**
+	 * 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 null|mixed $default
+	 * @return false|int
+	 */
+	public function getMatch($pattern, $default = null);
 
 
-    /**
-     * 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);
+	/**
+	 * 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 param
+	 *
+	 * @param string $key
+	 * @param bool   $unset_from_global_too
+	 */
+	public function unSetRequestParam($key, $unset_from_global_too = false);
 
 
-    /**
-     * @return string
-     */
-    public function ipAddress();
+	/**
+	 * @return string
+	 */
+	public function ipAddress();
 
 
-    /**
-     * @return string
-     */
-    public function requestUri();
-
+	/**
+	 * @return string
+	 */
+	public function requestUri();
+
 
-    /**
-     * @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);
+	/**
+	 * @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);
 }

core/services/request/Request.php

Indentation +620 added lines, -620 removed lines

@@ -17,624 +17,624 @@
 class Request implements InterminableInterface, RequestInterface, ReservedInstanceInterface
 {
 
-    /**
-     * $_GET parameters
-     *
-     * @var array $get
-     */
-    private $get;
-
-    /**
-     * $_POST parameters
-     *
-     * @var array $post
-     */
-    private $post;
-
-    /**
-     * $_COOKIE parameters
-     *
-     * @var array $cookie
-     */
-    private $cookie;
-
-    /**
-     * $_SERVER parameters
-     *
-     * @var array $server
-     */
-    private $server;
-
-    /**
-     * $_FILES parameters
-     *
-     * @var array $files
-     */
-    private $files;
-
-    /**
-     * $_REQUEST parameters
-     *
-     * @var array $request
-     */
-    private $request;
-
-    /**
-     * @var RequestTypeContextCheckerInterface
-     */
-    private $request_type;
-
-    /**
-     * IP address for request
-     *
-     * @var string $ip_address
-     */
-    private $ip_address;
-
-    /**
-     * @var string $user_agent
-     */
-    private $user_agent;
-
-    /**
-     * true if current user appears to be some kind of bot
-     *
-     * @var bool $is_bot
-     */
-    private $is_bot;
-
-
-    /**
-     * @param array $get
-     * @param array $post
-     * @param array $cookie
-     * @param array $server
-     * @param array $files
-     */
-    public function __construct(array $get, array $post, array $cookie, array $server, array $files = array())
-    {
-        // grab request vars
-        $this->get = $get;
-        $this->post = $post;
-        $this->cookie = $cookie;
-        $this->server = $server;
-        $this->files = $files;
-        $this->request = array_merge($this->get, $this->post);
-        $this->ip_address = $this->visitorIp();
-    }
-
-
-    /**
-     * @param RequestTypeContextCheckerInterface $type
-     */
-    public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type)
-    {
-        $this->request_type = $type;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getParams()
-    {
-        return $this->get;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function postParams()
-    {
-        return $this->post;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function cookieParams()
-    {
-        return $this->cookie;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function serverParams()
-    {
-        return $this->server;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function filesParams()
-    {
-        return $this->files;
-    }
-
-
-    /**
-     * returns contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function requestParams()
-    {
-        return $this->request;
-    }
-
-
-    /**
-     * @param      $key
-     * @param      $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 ($key !== 'ee'
-            || ($key === 'ee' && empty($this->request['ee']))
-            || ($key === 'ee' && ! empty($this->request['ee']) && $override_ee)
-        ) {
-            $this->request[ $key ] = $value;
-        }
-    }
-
-
-    /**
-     * returns   the value for a request param if the given key exists
-     *
-     * @param       $key
-     * @param null  $default
-     * @return mixed
-     */
-    public function getRequestParam($key, $default = null)
-    {
-        return $this->requestParameterDrillDown($key, $default, 'get');
-    }
-
-
-    /**
-     * check if param exists
-     *
-     * @param       $key
-     * @return bool
-     */
-    public function requestParamIsSet($key)
-    {
-        return $this->requestParameterDrillDown($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 null|mixed $default
-     * @return mixed
-     */
-    public function getMatch($pattern, $default = null)
-    {
-        return $this->requestParameterDrillDown($pattern, $default, 'match');
-    }
-
-
-    /**
-     * 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->requestParameterDrillDown($pattern, null, 'match') !== null;
-    }
-
-
-    /**
-     * @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, array('bool', 'key', 'value'), true)
-            ? $return
-            : 'is_set';
-        // replace wildcard chars with regex chars
-        $pattern = str_replace(
-            array("\*", "\?"),
-            array('.*', '.'),
-            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_params[ $key ];
-                }
-                // 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 array  $request_params
-     * @return bool|mixed|null
-     */
-    private function requestParameterDrillDown(
-        $key,
-        $default = null,
-        $callback = 'is_set',
-        array $request_params = array()
-    ) {
-        $callback = in_array($callback, array('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 ? $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->requestParameterDrillDown(
-                    $key_string,
-                    $default,
-                    $callback,
-                    $request_params[ $key ]
-                );
-            }
-        }
-        if ($callback === 'is_set') {
-            return isset($request_params[ $key ]);
-        }
-        if ($callback === 'match') {
-            return $this->match($key, $request_params, $default);
-        }
-        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)
-    {
-        unset($this->request[ $key ]);
-        if ($unset_from_global_too) {
-            unset($_REQUEST[ $key ]);
-        }
-    }
-
-
-    /**
-     * @return string
-     */
-    public function ipAddress()
-    {
-        return $this->ip_address;
-    }
-
-
-    /**
-     * attempt to get IP address of current visitor from server
-     * plz see: http://stackoverflow.com/a/2031935/1475279
-     *
-     * @access public
-     * @return string
-     */
-    private function visitorIp()
-    {
-        $visitor_ip = '0.0.0.0';
-        $server_keys = array(
-            'HTTP_CLIENT_IP',
-            'HTTP_X_FORWARDED_FOR',
-            'HTTP_X_FORWARDED',
-            'HTTP_X_CLUSTER_CLIENT_IP',
-            'HTTP_FORWARDED_FOR',
-            'HTTP_FORWARDED',
-            'REMOTE_ADDR',
-        );
-        foreach ($server_keys as $key) {
-            if (isset($this->server[ $key ])) {
-                foreach (array_map('trim', explode(',', $this->server[ $key ])) as $ip) {
-                    if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
-                        $visitor_ip = $ip;
-                    }
-                }
-            }
-        }
-        return $visitor_ip;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function requestUri()
-    {
-        $request_uri = filter_input(
-            INPUT_SERVER,
-            'REQUEST_URI',
-            FILTER_SANITIZE_URL,
-            FILTER_NULL_ON_FAILURE
-        );
-        if (empty($request_uri)) {
-            // fallback sanitization if the above fails
-            $request_uri = wp_sanitize_redirect($this->server['REQUEST_URI']);
-        }
-        return $request_uri;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function userAgent()
-    {
-        return $this->user_agent;
-    }
-
-
-    /**
-     * @param string $user_agent
-     */
-    public function setUserAgent($user_agent = '')
-    {
-        if ($user_agent === '' || ! is_string($user_agent)) {
-            $user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? (string) esc_attr($_SERVER['HTTP_USER_AGENT']) : '';
-        }
-        $this->user_agent = $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();
-    }
+	/**
+	 * $_GET parameters
+	 *
+	 * @var array $get
+	 */
+	private $get;
+
+	/**
+	 * $_POST parameters
+	 *
+	 * @var array $post
+	 */
+	private $post;
+
+	/**
+	 * $_COOKIE parameters
+	 *
+	 * @var array $cookie
+	 */
+	private $cookie;
+
+	/**
+	 * $_SERVER parameters
+	 *
+	 * @var array $server
+	 */
+	private $server;
+
+	/**
+	 * $_FILES parameters
+	 *
+	 * @var array $files
+	 */
+	private $files;
+
+	/**
+	 * $_REQUEST parameters
+	 *
+	 * @var array $request
+	 */
+	private $request;
+
+	/**
+	 * @var RequestTypeContextCheckerInterface
+	 */
+	private $request_type;
+
+	/**
+	 * IP address for request
+	 *
+	 * @var string $ip_address
+	 */
+	private $ip_address;
+
+	/**
+	 * @var string $user_agent
+	 */
+	private $user_agent;
+
+	/**
+	 * true if current user appears to be some kind of bot
+	 *
+	 * @var bool $is_bot
+	 */
+	private $is_bot;
+
+
+	/**
+	 * @param array $get
+	 * @param array $post
+	 * @param array $cookie
+	 * @param array $server
+	 * @param array $files
+	 */
+	public function __construct(array $get, array $post, array $cookie, array $server, array $files = array())
+	{
+		// grab request vars
+		$this->get = $get;
+		$this->post = $post;
+		$this->cookie = $cookie;
+		$this->server = $server;
+		$this->files = $files;
+		$this->request = array_merge($this->get, $this->post);
+		$this->ip_address = $this->visitorIp();
+	}
+
+
+	/**
+	 * @param RequestTypeContextCheckerInterface $type
+	 */
+	public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type)
+	{
+		$this->request_type = $type;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getParams()
+	{
+		return $this->get;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function postParams()
+	{
+		return $this->post;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function cookieParams()
+	{
+		return $this->cookie;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function serverParams()
+	{
+		return $this->server;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function filesParams()
+	{
+		return $this->files;
+	}
+
+
+	/**
+	 * returns contents of $_REQUEST
+	 *
+	 * @return array
+	 */
+	public function requestParams()
+	{
+		return $this->request;
+	}
+
+
+	/**
+	 * @param      $key
+	 * @param      $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 ($key !== 'ee'
+			|| ($key === 'ee' && empty($this->request['ee']))
+			|| ($key === 'ee' && ! empty($this->request['ee']) && $override_ee)
+		) {
+			$this->request[ $key ] = $value;
+		}
+	}
+
+
+	/**
+	 * returns   the value for a request param if the given key exists
+	 *
+	 * @param       $key
+	 * @param null  $default
+	 * @return mixed
+	 */
+	public function getRequestParam($key, $default = null)
+	{
+		return $this->requestParameterDrillDown($key, $default, 'get');
+	}
+
+
+	/**
+	 * check if param exists
+	 *
+	 * @param       $key
+	 * @return bool
+	 */
+	public function requestParamIsSet($key)
+	{
+		return $this->requestParameterDrillDown($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 null|mixed $default
+	 * @return mixed
+	 */
+	public function getMatch($pattern, $default = null)
+	{
+		return $this->requestParameterDrillDown($pattern, $default, 'match');
+	}
+
+
+	/**
+	 * 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->requestParameterDrillDown($pattern, null, 'match') !== null;
+	}
+
+
+	/**
+	 * @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, array('bool', 'key', 'value'), true)
+			? $return
+			: 'is_set';
+		// replace wildcard chars with regex chars
+		$pattern = str_replace(
+			array("\*", "\?"),
+			array('.*', '.'),
+			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_params[ $key ];
+				}
+				// 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 array  $request_params
+	 * @return bool|mixed|null
+	 */
+	private function requestParameterDrillDown(
+		$key,
+		$default = null,
+		$callback = 'is_set',
+		array $request_params = array()
+	) {
+		$callback = in_array($callback, array('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 ? $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->requestParameterDrillDown(
+					$key_string,
+					$default,
+					$callback,
+					$request_params[ $key ]
+				);
+			}
+		}
+		if ($callback === 'is_set') {
+			return isset($request_params[ $key ]);
+		}
+		if ($callback === 'match') {
+			return $this->match($key, $request_params, $default);
+		}
+		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)
+	{
+		unset($this->request[ $key ]);
+		if ($unset_from_global_too) {
+			unset($_REQUEST[ $key ]);
+		}
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function ipAddress()
+	{
+		return $this->ip_address;
+	}
+
+
+	/**
+	 * attempt to get IP address of current visitor from server
+	 * plz see: http://stackoverflow.com/a/2031935/1475279
+	 *
+	 * @access public
+	 * @return string
+	 */
+	private function visitorIp()
+	{
+		$visitor_ip = '0.0.0.0';
+		$server_keys = array(
+			'HTTP_CLIENT_IP',
+			'HTTP_X_FORWARDED_FOR',
+			'HTTP_X_FORWARDED',
+			'HTTP_X_CLUSTER_CLIENT_IP',
+			'HTTP_FORWARDED_FOR',
+			'HTTP_FORWARDED',
+			'REMOTE_ADDR',
+		);
+		foreach ($server_keys as $key) {
+			if (isset($this->server[ $key ])) {
+				foreach (array_map('trim', explode(',', $this->server[ $key ])) as $ip) {
+					if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
+						$visitor_ip = $ip;
+					}
+				}
+			}
+		}
+		return $visitor_ip;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function requestUri()
+	{
+		$request_uri = filter_input(
+			INPUT_SERVER,
+			'REQUEST_URI',
+			FILTER_SANITIZE_URL,
+			FILTER_NULL_ON_FAILURE
+		);
+		if (empty($request_uri)) {
+			// fallback sanitization if the above fails
+			$request_uri = wp_sanitize_redirect($this->server['REQUEST_URI']);
+		}
+		return $request_uri;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function userAgent()
+	{
+		return $this->user_agent;
+	}
+
+
+	/**
+	 * @param string $user_agent
+	 */
+	public function setUserAgent($user_agent = '')
+	{
+		if ($user_agent === '' || ! is_string($user_agent)) {
+			$user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? (string) esc_attr($_SERVER['HTTP_USER_AGENT']) : '';
+		}
+		$this->user_agent = $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();
+	}
 }

core/services/bootstrap/BootstrapRequestResponseObjects.php

Indentation +65 added lines, -65 removed lines

@@ -25,80 +25,80 @@
 class BootstrapRequestResponseObjects
 {
 
-    /**
-     * @type LegacyRequestInterface $legacy_request
-     */
-    protected $legacy_request;
+	/**
+	 * @type LegacyRequestInterface $legacy_request
+	 */
+	protected $legacy_request;
 
-    /**
-     * @type LoaderInterface $loader
-     */
-    protected $loader;
+	/**
+	 * @type LoaderInterface $loader
+	 */
+	protected $loader;
 
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
 
-    /**
-     * @var ResponseInterface $response
-     */
-    protected $response;
+	/**
+	 * @var ResponseInterface $response
+	 */
+	protected $response;
 
 
-    /**
-     * BootstrapRequestResponseObjects constructor.
-     *
-     * @param LoaderInterface $loader
-     */
-    public function __construct(LoaderInterface $loader)
-    {
-        $this->loader = $loader;
-    }
+	/**
+	 * BootstrapRequestResponseObjects constructor.
+	 *
+	 * @param LoaderInterface $loader
+	 */
+	public function __construct(LoaderInterface $loader)
+	{
+		$this->loader = $loader;
+	}
 
 
-    /**
-     * @return void
-     */
-    public function buildRequestResponse()
-    {
-        // load our Request and Response objects
-        $this->request = new Request($_GET, $_POST, $_COOKIE, $_SERVER, $_FILES);
-        $this->response = new Response();
-    }
+	/**
+	 * @return void
+	 */
+	public function buildRequestResponse()
+	{
+		// load our Request and Response objects
+		$this->request = new Request($_GET, $_POST, $_COOKIE, $_SERVER, $_FILES);
+		$this->response = new Response();
+	}
 
 
-    /**
-     * @return void
-     * @throws InvalidArgumentException
-     */
-    public function shareRequestResponse()
-    {
-        $this->loader->share('EventEspresso\core\services\request\Request', $this->request);
-        $this->loader->share('EventEspresso\core\services\request\Response', $this->response);
-        EE_Dependency_Map::instance()->setRequest($this->request);
-        EE_Dependency_Map::instance()->setResponse($this->response);
-    }
+	/**
+	 * @return void
+	 * @throws InvalidArgumentException
+	 */
+	public function shareRequestResponse()
+	{
+		$this->loader->share('EventEspresso\core\services\request\Request', $this->request);
+		$this->loader->share('EventEspresso\core\services\request\Response', $this->response);
+		EE_Dependency_Map::instance()->setRequest($this->request);
+		EE_Dependency_Map::instance()->setResponse($this->response);
+	}
 
 
-    /**
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws EE_Error
-     */
-    public function setupLegacyRequest()
-    {
-        espresso_load_required(
-            'EE_Request',
-            EE_CORE . 'request_stack' . DS . 'EE_Request.core.php'
-        );
-        $this->legacy_request = new EE_Request($_GET, $_POST, $_COOKIE, $_SERVER);
-        $this->legacy_request->setRequest($this->request);
-        $this->legacy_request->admin = $this->request->isAdmin();
-        $this->legacy_request->ajax = $this->request->isAjax();
-        $this->legacy_request->front_ajax = $this->request->isFrontAjax();
-        EE_Dependency_Map::instance()->setLegacyRequest($this->legacy_request);
-        $this->loader->share('EE_Request', $this->legacy_request);
-        $this->loader->share('EventEspresso\core\services\request\LegacyRequestInterface', $this->legacy_request);
-    }
+	/**
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws EE_Error
+	 */
+	public function setupLegacyRequest()
+	{
+		espresso_load_required(
+			'EE_Request',
+			EE_CORE . 'request_stack' . DS . 'EE_Request.core.php'
+		);
+		$this->legacy_request = new EE_Request($_GET, $_POST, $_COOKIE, $_SERVER);
+		$this->legacy_request->setRequest($this->request);
+		$this->legacy_request->admin = $this->request->isAdmin();
+		$this->legacy_request->ajax = $this->request->isAjax();
+		$this->legacy_request->front_ajax = $this->request->isFrontAjax();
+		EE_Dependency_Map::instance()->setLegacyRequest($this->legacy_request);
+		$this->loader->share('EE_Request', $this->legacy_request);
+		$this->loader->share('EventEspresso\core\services\request\LegacyRequestInterface', $this->legacy_request);
+	}
 }

core/services/request/files/FileSubmission.php

Spacing +4 added lines, -4 removed lines

@@ -71,7 +71,7 @@ 
      */
     public function getType()
     {
-        if (!$this->type) {
+        if ( ! $this->type) {
             $this->type = $this->determineType();
         }
         return $this->type;
@@ -83,7 +83,7 @@ 
      */
     protected function determineType()
     {
-        if (!$this->getTmpFile()) {
+        if ( ! $this->getTmpFile()) {
             return '';
         }
         $finfo = new finfo(FILEINFO_MIME_TYPE);
@@ -97,7 +97,7 @@ 
      */
     public function getExtension()
     {
-        if (!$this->extension) {
+        if ( ! $this->extension) {
             $this->extension = $this->determineExtension();
         }
         return $this->extension;
@@ -110,7 +110,7 @@ 
      */
     protected function determineExtension()
     {
-        if (!$this->getTmpFile()) {
+        if ( ! $this->getTmpFile()) {
             return '';
         }
         return pathinfo($this->getTmpFile(), PATHINFO_EXTENSION);

Indentation +152 added lines, -152 removed lines

@@ -19,158 +19,158 @@
  */
 class FileSubmission implements FileSubmissionInterface
 {
-    /**
-     * @var string original name on the client machine
-     */
-    protected $name;
-
-    /**
-     * @var string mime type
-     */
-    protected $type;
-
-    /**
-     * @var string file extension
-     */
-    protected $extension;
-
-    /**
-     * @var int in bytes
-     */
-    protected $size;
-
-    /**
-     * @var string local filepath to the temporary file
-     */
-    protected $tmp_file;
-
-    /**
-     * @var int one of UPLOAD_ERR_OK, UPLOAD_ERR_NO_FILE, UPLOAD_ERR_INI_SIZE, UPLOAD_ERR_FORM_SIZE or other values
-     * although those aren't expected.
-     */
-    protected $error_code;
-
-    /**
-     * FileSubmission constructor.
-     * @param $name
-     * @param $tmp_file
-     * @param $size
-     * @param null $error_code
-     * @throws InvalidArgumentException
-     */
-    public function __construct($name, $tmp_file, $size, $error_code = null)
-    {
-        $this->name = basename($name);
-        if (parse_url($tmp_file, PHP_URL_SCHEME)) {
-            // Wait a minute- just local filepaths please, no URL schemes allowed!
-            throw new InvalidArgumentException(
-                sprintf(
-                    // @codingStandardsIgnoreStart
-                    esc_html__('The filepath of the temporary file ("%1$s") indicates is located elsewhere, that’s not ok!', 'event_espresso'),
-                    // @codingStandardsIgnoreEnd
-                    $tmp_file
-                )
-            );
-        }
-        $this->tmp_file = (string) $tmp_file;
-        $this->size = (int) $size;
-        $this->error_code = (int) $error_code;
-    }
-
-    /**
-     * @return string
-     */
-    public function getName()
-    {
-        return $this->name;
-    }
-
-    /**
-     * Gets the file's mime type
-     * @return string
-     */
-    public function getType()
-    {
-        if (!$this->type) {
-            $this->type = $this->determineType();
-        }
-        return $this->type;
-    }
-
-    /**
-     * @since $VID:$
-     * @return string
-     */
-    protected function determineType()
-    {
-        if (!$this->getTmpFile()) {
-            return '';
-        }
-        $finfo = new finfo(FILEINFO_MIME_TYPE);
-        return $finfo->file($this->getTmpFile());
-    }
-
-    /**
-     * Gets the file's extension.
-     * @since $VID:$
-     * @return string
-     */
-    public function getExtension()
-    {
-        if (!$this->extension) {
-            $this->extension = $this->determineExtension();
-        }
-        return $this->extension;
-    }
-
-    /**
-     * Determine's the file's extension given the temporary file.
-     * @since $VID:$
-     * @return string
-     */
-    protected function determineExtension()
-    {
-        if (!$this->getTmpFile()) {
-            return '';
-        }
-        return pathinfo($this->getTmpFile(), PATHINFO_EXTENSION);
-    }
-
-    /**
-     * Gets the size of the file
-     * @return int
-     */
-    public function getSize()
-    {
-        return $this->size;
-    }
-
-    /**
-     * Gets the path to the temporary file which was uploaded.
-     * @return string
-     */
-    public function getTmpFile()
-    {
-        return $this->tmp_file;
-    }
-
-    /**
-     * @since $VID:$
-     * @return string
-     */
-    public function __toString()
-    {
-        return $this->getTmpFile();
-    }
-
-    /**
-     * Gets the error code PHP reported for the file upload.
-     * @return string
-     */
-    public function getErrorCode()
-    {
-        return $this->error_code;
-    }
+	/**
+	 * @var string original name on the client machine
+	 */
+	protected $name;
+
+	/**
+	 * @var string mime type
+	 */
+	protected $type;
+
+	/**
+	 * @var string file extension
+	 */
+	protected $extension;
+
+	/**
+	 * @var int in bytes
+	 */
+	protected $size;
+
+	/**
+	 * @var string local filepath to the temporary file
+	 */
+	protected $tmp_file;
+
+	/**
+	 * @var int one of UPLOAD_ERR_OK, UPLOAD_ERR_NO_FILE, UPLOAD_ERR_INI_SIZE, UPLOAD_ERR_FORM_SIZE or other values
+	 * although those aren't expected.
+	 */
+	protected $error_code;
+
+	/**
+	 * FileSubmission constructor.
+	 * @param $name
+	 * @param $tmp_file
+	 * @param $size
+	 * @param null $error_code
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct($name, $tmp_file, $size, $error_code = null)
+	{
+		$this->name = basename($name);
+		if (parse_url($tmp_file, PHP_URL_SCHEME)) {
+			// Wait a minute- just local filepaths please, no URL schemes allowed!
+			throw new InvalidArgumentException(
+				sprintf(
+					// @codingStandardsIgnoreStart
+					esc_html__('The filepath of the temporary file ("%1$s") indicates is located elsewhere, that’s not ok!', 'event_espresso'),
+					// @codingStandardsIgnoreEnd
+					$tmp_file
+				)
+			);
+		}
+		$this->tmp_file = (string) $tmp_file;
+		$this->size = (int) $size;
+		$this->error_code = (int) $error_code;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getName()
+	{
+		return $this->name;
+	}
+
+	/**
+	 * Gets the file's mime type
+	 * @return string
+	 */
+	public function getType()
+	{
+		if (!$this->type) {
+			$this->type = $this->determineType();
+		}
+		return $this->type;
+	}
+
+	/**
+	 * @since $VID:$
+	 * @return string
+	 */
+	protected function determineType()
+	{
+		if (!$this->getTmpFile()) {
+			return '';
+		}
+		$finfo = new finfo(FILEINFO_MIME_TYPE);
+		return $finfo->file($this->getTmpFile());
+	}
+
+	/**
+	 * Gets the file's extension.
+	 * @since $VID:$
+	 * @return string
+	 */
+	public function getExtension()
+	{
+		if (!$this->extension) {
+			$this->extension = $this->determineExtension();
+		}
+		return $this->extension;
+	}
+
+	/**
+	 * Determine's the file's extension given the temporary file.
+	 * @since $VID:$
+	 * @return string
+	 */
+	protected function determineExtension()
+	{
+		if (!$this->getTmpFile()) {
+			return '';
+		}
+		return pathinfo($this->getTmpFile(), PATHINFO_EXTENSION);
+	}
+
+	/**
+	 * Gets the size of the file
+	 * @return int
+	 */
+	public function getSize()
+	{
+		return $this->size;
+	}
+
+	/**
+	 * Gets the path to the temporary file which was uploaded.
+	 * @return string
+	 */
+	public function getTmpFile()
+	{
+		return $this->tmp_file;
+	}
+
+	/**
+	 * @since $VID:$
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return $this->getTmpFile();
+	}
+
+	/**
+	 * Gets the error code PHP reported for the file upload.
+	 * @return string
+	 */
+	public function getErrorCode()
+	{
+		return $this->error_code;
+	}
 }
 // End of file FileSubmission.php
 // Location: EventEspresso\core\services\request\files/FileSubmission.php

core/services/request/files/FilesDataHandler.php

Spacing +8 added lines, -8 removed lines

@@ -76,7 +76,7 @@ 
      */
     public function getFileObjects()
     {
-        if (!$this->initialized) {
+        if ( ! $this->initialized) {
             $this->initialize();
         }
         return $this->file_objects;
@@ -111,7 +111,7 @@ 
      */
     protected function isStrangeFilesArray($files_data)
     {
-        if (!is_array($files_data)) {
+        if ( ! is_array($files_data)) {
             throw new UnexpectedValueException(
                 sprintf(
                     esc_html__(
@@ -123,7 +123,7 @@ 
             );
         }
         $first_value = reset($files_data);
-        if (!is_array($first_value)) {
+        if ( ! is_array($first_value)) {
             throw new UnexpectedValueException(
                 sprintf(
                     esc_html__(
@@ -185,9 +185,9 @@ 
         $organized_data = [];
         foreach ($data as $key => $val) {
             if (is_array($val)) {
-                $organized_data[ $key ] = $this->organizeFilesData($val, $type);
+                $organized_data[$key] = $this->organizeFilesData($val, $type);
             } else {
-                $organized_data[ $key ][ $type ] = $val;
+                $organized_data[$key][$type] = $val;
             }
         }
         return $organized_data;
@@ -204,7 +204,7 @@ 
      */
     protected function createFileObjects($organized_files)
     {
-        if (!is_array($organized_files)) {
+        if ( ! is_array($organized_files)) {
             throw new UnexpectedValueException(
                 sprintf(
                     esc_html__(
@@ -218,14 +218,14 @@ 
         $objs = [];
         foreach ($organized_files as $key => $value) {
             if (isset($value['name'], $value['tmp_name'], $value['size'])) {
-                $objs[ $key ] = new FileSubmission(
+                $objs[$key] = new FileSubmission(
                     $value['name'],
                     $value['tmp_name'],
                     $value['size'],
                     $value['error']
                 );
             } else {
-                $objs[ $key ] = $this->createFileObjects($value);
+                $objs[$key] = $this->createFileObjects($value);
             }
         }
         return $objs;

Unused Use Statements -5 removed lines

@@ -2,11 +2,6 @@
 
 namespace EventEspresso\core\services\request\files;
 
-use EventEspresso\core\services\collections\CollectionDetails;
-use EventEspresso\core\services\collections\CollectionDetailsException;
-use EventEspresso\core\services\collections\CollectionInterface;
-use EventEspresso\core\services\collections\CollectionLoader;
-use EventEspresso\core\services\collections\CollectionLoaderException;
 use EventEspresso\core\services\request\Request;
 use InvalidArgumentException;
 use UnexpectedValueException;

Indentation +180 added lines, -180 removed lines

@@ -43,195 +43,195 @@
  */
 class FilesDataHandler
 {
-    /**
-     * @var Request
-     */
-    protected $request;
+	/**
+	 * @var Request
+	 */
+	protected $request;
 
-    /**
-     * @var array
-     */
-    protected $file_objects;
+	/**
+	 * @var array
+	 */
+	protected $file_objects;
 
-    /**
-     * @var bool
-     */
-    protected $initialized = false;
+	/**
+	 * @var bool
+	 */
+	protected $initialized = false;
 
-    /**
-     * FilesDataHandler constructor.
-     * @param Request $request
-     */
-    public function __construct(Request $request)
-    {
-        $this->request = $request;
-    }
+	/**
+	 * FilesDataHandler constructor.
+	 * @param Request $request
+	 */
+	public function __construct(Request $request)
+	{
+		$this->request = $request;
+	}
 
-    /**
-     * @since $VID:$
-     * @return array with a similar structure to $_POST and $_GET (ie, it can be multi-dimensional) but the "leaf"
-     * nodes are all of type FileSubmissionInterface
-     * @throws UnexpectedValueException
-     * @throws InvalidArgumentException
-     */
-    public function getFileObjects()
-    {
-        if (!$this->initialized) {
-            $this->initialize();
-        }
-        return $this->file_objects;
-    }
+	/**
+	 * @since $VID:$
+	 * @return array with a similar structure to $_POST and $_GET (ie, it can be multi-dimensional) but the "leaf"
+	 * nodes are all of type FileSubmissionInterface
+	 * @throws UnexpectedValueException
+	 * @throws InvalidArgumentException
+	 */
+	public function getFileObjects()
+	{
+		if (!$this->initialized) {
+			$this->initialize();
+		}
+		return $this->file_objects;
+	}
 
-    /**
-     * Sets up the file objects from the request's $_FILES data.
-     * @since $VID:$
-     * @throws UnexpectedValueException
-     * @throws InvalidArgumentException
-     */
-    protected function initialize()
-    {
-        $files_raw_data = $this->request->filesParams();
-        if (empty($files_raw_data)) {
-            return;
-        }
-        if ($this->isStrangeFilesArray($files_raw_data)) {
-            $data = $this->fixFilesDataArray($files_raw_data);
-        } else {
-            $data = $files_raw_data;
-        }
-        $this->file_objects = $this->createFileObjects($data);
-        $this->initialized = true;
-    }
+	/**
+	 * Sets up the file objects from the request's $_FILES data.
+	 * @since $VID:$
+	 * @throws UnexpectedValueException
+	 * @throws InvalidArgumentException
+	 */
+	protected function initialize()
+	{
+		$files_raw_data = $this->request->filesParams();
+		if (empty($files_raw_data)) {
+			return;
+		}
+		if ($this->isStrangeFilesArray($files_raw_data)) {
+			$data = $this->fixFilesDataArray($files_raw_data);
+		} else {
+			$data = $files_raw_data;
+		}
+		$this->file_objects = $this->createFileObjects($data);
+		$this->initialized = true;
+	}
 
-    /**
-     * Detects if $_FILES is a weird multi-dimensional array that needs fixing or not.
-     * @since $VID:$
-     * @param $files_data
-     * @return bool
-     * @throws UnexpectedValueException
-     */
-    protected function isStrangeFilesArray($files_data)
-    {
-        if (!is_array($files_data)) {
-            throw new UnexpectedValueException(
-                sprintf(
-                    esc_html__(
-                        'Unexpected PHP $_FILES data format. "%1$s" was expected to be an array.',
-                        'event_espresso'
-                    ),
-                    (string) $files_data
-                )
-            );
-        }
-        $first_value = reset($files_data);
-        if (!is_array($first_value)) {
-            throw new UnexpectedValueException(
-                sprintf(
-                    esc_html__(
-                        'Unexpected PHP $_FILES data format. "%1$s" was expected to be an array.',
-                        'event_espresso'
-                    ),
-                    (string) $first_value
-                )
-            );
-        }
-        $first_sub_array_item = reset($first_value);
-        if (is_array($first_sub_array_item)) {
-            // not just a 2d array
-            return true;
-        }
-        // yep, just 2d array
-        return false;
-    }
+	/**
+	 * Detects if $_FILES is a weird multi-dimensional array that needs fixing or not.
+	 * @since $VID:$
+	 * @param $files_data
+	 * @return bool
+	 * @throws UnexpectedValueException
+	 */
+	protected function isStrangeFilesArray($files_data)
+	{
+		if (!is_array($files_data)) {
+			throw new UnexpectedValueException(
+				sprintf(
+					esc_html__(
+						'Unexpected PHP $_FILES data format. "%1$s" was expected to be an array.',
+						'event_espresso'
+					),
+					(string) $files_data
+				)
+			);
+		}
+		$first_value = reset($files_data);
+		if (!is_array($first_value)) {
+			throw new UnexpectedValueException(
+				sprintf(
+					esc_html__(
+						'Unexpected PHP $_FILES data format. "%1$s" was expected to be an array.',
+						'event_espresso'
+					),
+					(string) $first_value
+				)
+			);
+		}
+		$first_sub_array_item = reset($first_value);
+		if (is_array($first_sub_array_item)) {
+			// not just a 2d array
+			return true;
+		}
+		// yep, just 2d array
+		return false;
+	}
 
-    /**
-     * Takes into account that $_FILES does a weird thing when you have hierarchical form names (eg `<input type="file"
-     * name="my[hierarchical][form]">`): it leaves the top-level form part alone, but replaces the SECOND part with
-     * "name", "size", "tmp_name", etc. So that file's data is located at "my[name][hierarchical][form]",
-     * "my[size][hierarchical][form]", "my[tmp_name][hierarchical][form]", etc. It's really weird.
-     * @since $VID:$
-     * @param $files_data
-     * @return array
-     */
-    protected function fixFilesDataArray($files_data)
-    {
-        $sane_files_array = [];
-        foreach ($files_data as $top_key => $top_key_avlue) {
-            foreach ($top_key_avlue as $lower_key => $lower_key_value) {
-                foreach ($lower_key_value as $lowest_key => $lowest_key_value) {
-                    $next_data = [
-                        $top_key => [
-                            $lowest_key => $this->organizeFilesData($lowest_key_value, $lower_key, $lowest_key)
-                        ]
-                    ];
-                    $sane_files_array = array_merge_recursive(
-                        $sane_files_array,
-                        $next_data
-                    );
-                }
-            }
-        }
-        return $sane_files_array;
-    }
+	/**
+	 * Takes into account that $_FILES does a weird thing when you have hierarchical form names (eg `<input type="file"
+	 * name="my[hierarchical][form]">`): it leaves the top-level form part alone, but replaces the SECOND part with
+	 * "name", "size", "tmp_name", etc. So that file's data is located at "my[name][hierarchical][form]",
+	 * "my[size][hierarchical][form]", "my[tmp_name][hierarchical][form]", etc. It's really weird.
+	 * @since $VID:$
+	 * @param $files_data
+	 * @return array
+	 */
+	protected function fixFilesDataArray($files_data)
+	{
+		$sane_files_array = [];
+		foreach ($files_data as $top_key => $top_key_avlue) {
+			foreach ($top_key_avlue as $lower_key => $lower_key_value) {
+				foreach ($lower_key_value as $lowest_key => $lowest_key_value) {
+					$next_data = [
+						$top_key => [
+							$lowest_key => $this->organizeFilesData($lowest_key_value, $lower_key, $lowest_key)
+						]
+					];
+					$sane_files_array = array_merge_recursive(
+						$sane_files_array,
+						$next_data
+					);
+				}
+			}
+		}
+		return $sane_files_array;
+	}
 
-    /**
-     * Recursively explores the array until it finds a leaf node, and tacks `$type` as a final index in front of it.
-     * @since $VID:$
-     * @param $data either 'name', 'tmp_name', 'size', or 'error'
-     * @param $type
-     * @return array
-     */
-    protected function organizeFilesData($data, $type)
-    {
-        $organized_data = [];
-        foreach ($data as $key => $val) {
-            if (is_array($val)) {
-                $organized_data[ $key ] = $this->organizeFilesData($val, $type);
-            } else {
-                $organized_data[ $key ][ $type ] = $val;
-            }
-        }
-        return $organized_data;
-    }
+	/**
+	 * Recursively explores the array until it finds a leaf node, and tacks `$type` as a final index in front of it.
+	 * @since $VID:$
+	 * @param $data either 'name', 'tmp_name', 'size', or 'error'
+	 * @param $type
+	 * @return array
+	 */
+	protected function organizeFilesData($data, $type)
+	{
+		$organized_data = [];
+		foreach ($data as $key => $val) {
+			if (is_array($val)) {
+				$organized_data[ $key ] = $this->organizeFilesData($val, $type);
+			} else {
+				$organized_data[ $key ][ $type ] = $val;
+			}
+		}
+		return $organized_data;
+	}
 
-    /**
-     * Takes the organized $_FILES array (where all file info is located at the same spot as you'd expect an input
-     * to be in $_GET or $_POST, with all the file's data located side-by-side in an array) and creates a
-     * multi-dimensional array of FileSubmissionInterface objects.
-     * @since $VID:$
-     * @param $organized_files
-     * @return array
-     * @throws UnexpectedValueException
-     * @throws InvalidArgumentException
-     */
-    protected function createFileObjects($organized_files)
-    {
-        if (!is_array($organized_files)) {
-            throw new UnexpectedValueException(
-                sprintf(
-                    esc_html__(
-                        'Unexpected PHP $organized_files data format. "%1$s" was expected to be an array.',
-                        'event_espresso'
-                    ),
-                    (string) $organized_files
-                )
-            );
-        }
-        $objs = [];
-        foreach ($organized_files as $key => $value) {
-            if (isset($value['name'], $value['tmp_name'], $value['size'])) {
-                $objs[ $key ] = new FileSubmission(
-                    $value['name'],
-                    $value['tmp_name'],
-                    $value['size'],
-                    $value['error']
-                );
-            } else {
-                $objs[ $key ] = $this->createFileObjects($value);
-            }
-        }
-        return $objs;
-    }
+	/**
+	 * Takes the organized $_FILES array (where all file info is located at the same spot as you'd expect an input
+	 * to be in $_GET or $_POST, with all the file's data located side-by-side in an array) and creates a
+	 * multi-dimensional array of FileSubmissionInterface objects.
+	 * @since $VID:$
+	 * @param $organized_files
+	 * @return array
+	 * @throws UnexpectedValueException
+	 * @throws InvalidArgumentException
+	 */
+	protected function createFileObjects($organized_files)
+	{
+		if (!is_array($organized_files)) {
+			throw new UnexpectedValueException(
+				sprintf(
+					esc_html__(
+						'Unexpected PHP $organized_files data format. "%1$s" was expected to be an array.',
+						'event_espresso'
+					),
+					(string) $organized_files
+				)
+			);
+		}
+		$objs = [];
+		foreach ($organized_files as $key => $value) {
+			if (isset($value['name'], $value['tmp_name'], $value['size'])) {
+				$objs[ $key ] = new FileSubmission(
+					$value['name'],
+					$value['tmp_name'],
+					$value['size'],
+					$value['error']
+				);
+			} else {
+				$objs[ $key ] = $this->createFileObjects($value);
+			}
+		}
+		return $objs;
+	}
 }
 // End of file FilesDataHandler.php
 // Location: EventEspresso\core\services\request\files/FilesDataHandler.php

core/services/request/files/FileSubmissionInterface.php

Indentation +30 added lines, -30 removed lines

@@ -15,36 +15,36 @@
 interface FileSubmissionInterface
 {
 
-    /**
-     * @return string
-     */
-    public function getName();
-
-    /**
-     * @return string
-     */
-    public function getType();
-
-    /**
-     * @return int
-     */
-    public function getSize();
-
-    /**
-     * @return string
-     */
-    public function getTmpFile();
-
-    /**
-     * @since $VID:$
-     * @return string
-     */
-    public function __toString();
-
-    /**
-     * @return string
-     */
-    public function getErrorCode();
+	/**
+	 * @return string
+	 */
+	public function getName();
+
+	/**
+	 * @return string
+	 */
+	public function getType();
+
+	/**
+	 * @return int
+	 */
+	public function getSize();
+
+	/**
+	 * @return string
+	 */
+	public function getTmpFile();
+
+	/**
+	 * @since $VID:$
+	 * @return string
+	 */
+	public function __toString();
+
+	/**
+	 * @return string
+	 */
+	public function getErrorCode();
 }
 // End of file FileSubmissionInterface.php
 // Location: EventEspresso\core\services\request\files/FileSubmissionInterface.php