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);
+	}
 }

caffeinated/payment_methods/Paypal_Pro/EEG_Paypal_Pro.gateway.php

Indentation +602 added lines, -602 removed lines

@@ -11,606 +11,606 @@
 class EEG_Paypal_Pro extends EE_Onsite_Gateway
 {
 
-    /**
-     * @var $_paypal_api_username string
-     */
-    protected $_api_username = null;
-
-    /**
-     * @var $_api_password string
-     */
-    protected $_api_password = null;
-
-    /**
-     * @var $_api_signature string
-     */
-    protected $_api_signature = null;
-
-    /**
-     * @var $_credit_card_types array with the keys for credit card types accepted on this account
-     */
-    protected $_credit_card_types    = null;
-
-    protected $_currencies_supported = array(
-        'USD',
-        'GBP',
-        'CAD',
-        'AUD',
-        'BRL',
-        'CHF',
-        'CZK',
-        'DKK',
-        'EUR',
-        'HKD',
-        'HUF',
-        'ILS',
-        'JPY',
-        'MXN',
-        'MYR',
-        'NOK',
-        'NZD',
-        'PHP',
-        'PLN',
-        'SEK',
-        'SGD',
-        'THB',
-        'TRY',
-        'TWD',
-        'RUB',
-        'INR',
-    );
-
-
-
-    /**
-     * @param EEI_Payment $payment
-     * @param array       $billing_info {
-     * @type string $credit_card
-     * @type string $credit_card_type
-     * @type string $exp_month always 2 characters
-     * @type string $exp_year always 4 characters
-     * @type string $cvv
-     * }
-     * @see      parent::do_direct_payment for more info
-     * @return EE_Payment|EEI_Payment
-     * @throws EE_Error
-     */
-    public function do_direct_payment($payment, $billing_info = null)
-    {
-        $transaction = $payment->transaction();
-        if (! $transaction instanceof EEI_Transaction) {
-            throw new EE_Error(
-                esc_html__('No transaction for payment while paying with PayPal Pro.', 'event_espresso')
-            );
-        }
-        $primary_registrant = $transaction->primary_registration();
-        if (! $primary_registrant instanceof EEI_Registration) {
-            throw new EE_Error(
-                esc_html__(
-                    'No primary registration on transaction while paying with PayPal Pro.',
-                    'event_espresso'
-                )
-            );
-        }
-        $attendee = $primary_registrant->attendee();
-        if (! $attendee instanceof EEI_Attendee) {
-            throw new EE_Error(
-                esc_html__(
-                    'No attendee on primary registration while paying with PayPal Pro.',
-                    'event_espresso'
-                )
-            );
-        }
-        $gateway_formatter = $this->_get_gateway_formatter();
-        $order_description = substr($gateway_formatter->formatOrderDescription($payment), 0, 127);
-        // charge for the full amount. Show itemized list
-        if ($this->_money->compare_floats($payment->amount(), $transaction->total(), '==')) {
-            $item_num = 1;
-            $total_line_item = $transaction->total_line_item();
-            $order_items = array();
-            foreach ($total_line_item->get_items() as $line_item) {
-                // ignore line items with a quantity of 0
-                if ($line_item->quantity() == 0) {
-                    continue;
-                }
-                // For percent items, whose unit_price is 0, use the total instead.
-                if ($line_item->is_percent()) {
-                    $unit_price = $line_item->total();
-                    $line_item_quantity = 1;
-                } else {
-                    $unit_price = $line_item->unit_price();
-                    $line_item_quantity = $line_item->quantity();
-                }
-                $item = array(
-                    // Item Name.  127 char max.
-                    'l_name'                 => substr(
-                        $gateway_formatter->formatLineItemName($line_item, $payment),
-                        0,
-                        127
-                    ),
-                    // Item description.  127 char max.
-                    'l_desc'                 => substr(
-                        $gateway_formatter->formatLineItemDesc($line_item, $payment),
-                        0,
-                        127
-                    ),
-                    // Cost of individual item.
-                    'l_amt'                  => $unit_price,
-                    // Item Number.  127 char max.
-                    'l_number'               => $item_num++,
-                    // Item quantity.  Must be any positive integer.
-                    'l_qty'                  => $line_item_quantity,
-                    // Item's sales tax amount.
-                    'l_taxamt'               => '',
-                    // eBay auction number of item.
-                    'l_ebayitemnumber'       => '',
-                    // eBay transaction ID of purchased item.
-                    'l_ebayitemauctiontxnid' => '',
-                    // eBay order ID for the item.
-                    'l_ebayitemorderid'      => '',
-                );
-                // add to array of all items
-                array_push($order_items, $item);
-            }
-            $item_amount = $total_line_item->get_items_total();
-            $tax_amount = $total_line_item->get_total_tax();
-        } else {
-            $order_items = array();
-            $item_amount = $payment->amount();
-            $tax_amount = 0;
-            array_push($order_items, array(
-                // Item Name.  127 char max.
-                'l_name'   => substr(
-                    $gateway_formatter->formatPartialPaymentLineItemName($payment),
-                    0,
-                    127
-                ),
-                // Item description.  127 char max.
-                'l_desc'   => substr(
-                    $gateway_formatter->formatPartialPaymentLineItemDesc($payment),
-                    0,
-                    127
-                ),
-                // Cost of individual item.
-                'l_amt'    => $payment->amount(),
-                // Item Number.  127 char max.
-                'l_number' => 1,
-                // Item quantity.  Must be any positive integer.
-                'l_qty'    => 1,
-            ));
-        }
-        // Populate data arrays with order data.
-        $DPFields = array(
-            // How you want to obtain payment ?
-            // Authorization indicates the payment is a basic auth subject to settlement with Auth & Capture.
-            // Sale indicates that this is a final sale for which you are requesting payment.  Default is Sale.
-            'paymentaction'    => 'Sale',
-            // Required.  IP address of the payer's browser.
-            'ipaddress'        => $_SERVER['REMOTE_ADDR'],
-            // Flag to determine whether you want the results returned by FMF.  1 or 0.  Default is 0.
-            'returnfmfdetails' => '1',
-        );
-        $CCDetails = array(
-            // Required. Type of credit card.  Visa, MasterCard, Discover, Amex, Maestro, Solo.
-            // If Maestro or Solo, the currency code must be GBP.
-            //  In addition, either start date or issue number must be specified.
-            'creditcardtype' => $billing_info['credit_card_type'],
-            // Required.  Credit card number.  No spaces or punctuation.
-            'acct'           => $billing_info['credit_card'],
-            // Required.  Credit card expiration date.  Format is MMYYYY
-            'expdate'        => $billing_info['exp_month'] . $billing_info['exp_year'],
-            // Requirements determined by your PayPal account settings.  Security digits for credit card.
-            'cvv2'           => $billing_info['cvv'],
-        );
-        $PayerInfo = array(
-            // Email address of payer.
-            'email'       => $billing_info['email'],
-            // Unique PayPal customer ID for payer.
-            'payerid'     => '',
-            // Status of payer.  Values are verified or unverified
-            'payerstatus' => '',
-            // Payer's business name.
-            'business'    => '',
-        );
-        $PayerName = array(
-            // Payer's salutation.  20 char max.
-            'salutation' => '',
-            // Payer's first name.  25 char max.
-            'firstname'  => substr($billing_info['first_name'], 0, 25),
-            // Payer's middle name.  25 char max.
-            'middlename' => '',
-            // Payer's last name.  25 char max.
-            'lastname'   => substr($billing_info['last_name'], 0, 25),
-            // Payer's suffix.  12 char max.
-            'suffix'     => '',
-        );
-        $BillingAddress = array(
-            // Required.  First street address.
-            'street'      => $billing_info['address'],
-            // Second street address.
-            'street2'     => $billing_info['address2'],
-            // Required.  Name of City.
-            'city'        => $billing_info['city'],
-            // Required. Name of State or Province.
-            'state'       => substr($billing_info['state'], 0, 40),
-            // Required.  Country code.
-            'countrycode' => $billing_info['country'],
-            // Required.  Postal code of payer.
-            'zip'         => $billing_info['zip'],
-        );
-        // check if the registration info contains the needed fields for paypal pro
-        // (see https://developer.paypal.com/docs/classic/api/merchant/DoDirectPayment_API_Operation_NVP/)
-        if ($attendee->address() && $attendee->city() && $attendee->country_ID()) {
-            $use_registration_address_info = true;
-        } else {
-            $use_registration_address_info = false;
-        }
-        // so if the attendee has enough data to fill out PayPal Pro's shipping info, use it.
-        // If not, use the billing info again
-        $ShippingAddress = array(
-            'shiptoname'     => substr($use_registration_address_info
-                ? $attendee->full_name()
-                : $billing_info['first_name'] . ' ' . $billing_info['last_name'], 0, 32),
-            'shiptostreet'   => substr($use_registration_address_info
-                ? $attendee->address()
-                : $billing_info['address'], 0, 100),
-            'shiptostreet2'  => substr($use_registration_address_info
-                ? $attendee->address2() : $billing_info['address2'], 0, 100),
-            'shiptocity'     => substr($use_registration_address_info
-                ? $attendee->city()
-                : $billing_info['city'], 0, 40),
-            'state'          => substr($use_registration_address_info
-                ? $attendee->state_name()
-                : $billing_info['state'], 0, 40),
-            'shiptocountry'  => $use_registration_address_info
-                ? $attendee->country_ID()
-                : $billing_info['country'],
-            'shiptozip'      => substr($use_registration_address_info
-                ? $attendee->zip()
-                : $billing_info['zip'], 0, 20),
-            'shiptophonenum' => substr($use_registration_address_info
-                ? $attendee->phone()
-                : $billing_info['phone'], 0, 20),
-        );
-        $PaymentDetails = array(
-            // Required.  Total amount of order, including shipping, handling, and tax.
-            'amt'          => $gateway_formatter->formatCurrency($payment->amount()),
-            // Required.  Three-letter currency code.  Default is USD.
-            'currencycode' => $payment->currency_code(),
-            // Required if you include itemized cart details. (L_AMTn, etc.)
-            // Subtotal of items not including S&H, or tax.
-            'itemamt'      => $gateway_formatter->formatCurrency($item_amount),//
-            // Total shipping costs for the order.  If you specify shippingamt, you must also specify itemamt.
-            'shippingamt'  => '',
-            // Total handling costs for the order.  If you specify handlingamt, you must also specify itemamt.
-            'handlingamt'  => '',
-            // Required if you specify itemized cart tax details.
-            // Sum of tax for all items on the order.  Total sales tax.
-            'taxamt'       => $gateway_formatter->formatCurrency($tax_amount),
-            // Description of the order the customer is purchasing.  127 char max.
-            'desc'         => $order_description,
-            // Free-form field for your own use.  256 char max.
-            'custom'       => $primary_registrant ? $primary_registrant->ID() : '',
-            // Your own invoice or tracking number
-            'invnum'       => wp_generate_password(12, false),// $transaction->ID(),
-            // URL for receiving Instant Payment Notifications.  This overrides what your profile is set to use.
-            'notifyurl'    => '',
-            'buttonsource' => 'EventEspresso_SP',// EE will blow up if you change this
-        );
-        // Wrap all data arrays into a single, "master" array which will be passed into the class function.
-        $PayPalRequestData = array(
-            'DPFields'        => $DPFields,
-            'CCDetails'       => $CCDetails,
-            'PayerInfo'       => $PayerInfo,
-            'PayerName'       => $PayerName,
-            'BillingAddress'  => $BillingAddress,
-            'ShippingAddress' => $ShippingAddress,
-            'PaymentDetails'  => $PaymentDetails,
-            'OrderItems'      => $order_items,
-        );
-        $this->_log_clean_request($PayPalRequestData, $payment);
-        try {
-            $PayPalResult = $this->prep_and_curl_request($PayPalRequestData);
-            // remove PCI-sensitive data so it doesn't get stored
-            $PayPalResult = $this->_log_clean_response($PayPalResult, $payment);
-            if (isset($PayPalResult['L_ERRORCODE0']) && $PayPalResult['L_ERRORCODE0'] === '10002') {
-                $message = esc_html__('PayPal did not accept your API username, password, or signature. Please double-check these credentials and if debug mode is on.', 'event_espresso');
-            } elseif (isset($PayPalResult['L_LONGMESSAGE0'])) {
-                $message = $PayPalResult['L_LONGMESSAGE0'];
-            } else {
-                $message = $PayPalResult['ACK'];
-            }
-            if (empty($PayPalResult['RAWRESPONSE'])) {
-                $payment->set_status($this->_pay_model->failed_status());
-                $payment->set_gateway_response(__('No response received from Paypal Pro', 'event_espresso'));
-                $payment->set_details($PayPalResult);
-            } else {
-                if ($this->_APICallSuccessful($PayPalResult)) {
-                    $payment->set_status($this->_pay_model->approved_status());
-                } else {
-                    $payment->set_status($this->_pay_model->declined_status());
-                }
-                // make sure we interpret the AMT as a float, not an international string
-                // (where periods are thousand separators)
-                $payment->set_amount(isset($PayPalResult['AMT']) ? floatval($PayPalResult['AMT']) : 0);
-                $payment->set_gateway_response($message);
-                $payment->set_txn_id_chq_nmbr(isset($PayPalResult['TRANSACTIONID'])
-                    ? $PayPalResult['TRANSACTIONID']
-                    : null);
-                $primary_registration_code = $primary_registrant instanceof EE_Registration
-                    ? $primary_registrant->reg_code()
-                    : '';
-                $payment->set_extra_accntng($primary_registration_code);
-                $payment->set_details($PayPalResult);
-            }
-        } catch (Exception $e) {
-            $payment->set_status($this->_pay_model->failed_status());
-            $payment->set_gateway_response($e->getMessage());
-        }
-        // $payment->set_status( $this->_pay_model->declined_status() );
-        // $payment->set_gateway_response( '' );
-        return $payment;
-    }
-
-
-
-    /**
-     * CLeans out sensitive CC data and then logs it, and returns the cleaned request
-     *
-     * @param array       $request
-     * @param EEI_Payment $payment
-     * @return void
-     */
-    private function _log_clean_request($request, $payment)
-    {
-        $cleaned_request_data = $request;
-        unset($cleaned_request_data['CCDetails']['acct']);
-        unset($cleaned_request_data['CCDetails']['cvv2']);
-        unset($cleaned_request_data['CCDetails']['expdate']);
-        $this->log(array('Paypal Request' => $cleaned_request_data), $payment);
-    }
-
-
-
-    /**
-     * Cleans the response, logs it, and returns it
-     *
-     * @param array       $response
-     * @param EEI_Payment $payment
-     * @return array cleaned
-     */
-    private function _log_clean_response($response, $payment)
-    {
-        unset($response['REQUESTDATA']['CREDITCARDTYPE']);
-        unset($response['REQUESTDATA']['ACCT']);
-        unset($response['REQUESTDATA']['EXPDATE']);
-        unset($response['REQUESTDATA']['CVV2']);
-        unset($response['RAWREQUEST']);
-        $this->log(array('Paypal Response' => $response), $payment);
-        return $response;
-    }
-
-
-
-    /**
-     * @param $DataArray
-     * @return array
-     */
-    private function prep_and_curl_request($DataArray)
-    {
-        // Create empty holders for each portion of the NVP string
-        $DPFieldsNVP = '&METHOD=DoDirectPayment&BUTTONSOURCE=AngellEYE_PHP_Class_DDP';
-        $CCDetailsNVP = '';
-        $PayerInfoNVP = '';
-        $PayerNameNVP = '';
-        $BillingAddressNVP = '';
-        $ShippingAddressNVP = '';
-        $PaymentDetailsNVP = '';
-        $OrderItemsNVP = '';
-        $Secure3DNVP = '';
-        // DP Fields
-        $DPFields = isset($DataArray['DPFields']) ? $DataArray['DPFields'] : array();
-        foreach ($DPFields as $DPFieldsVar => $DPFieldsVal) {
-            $DPFieldsNVP .= '&' . strtoupper($DPFieldsVar) . '=' . urlencode($DPFieldsVal);
-        }
-        // CC Details Fields
-        $CCDetails = isset($DataArray['CCDetails']) ? $DataArray['CCDetails'] : array();
-        foreach ($CCDetails as $CCDetailsVar => $CCDetailsVal) {
-            $CCDetailsNVP .= '&' . strtoupper($CCDetailsVar) . '=' . urlencode($CCDetailsVal);
-        }
-        // PayerInfo Type Fields
-        $PayerInfo = isset($DataArray['PayerInfo']) ? $DataArray['PayerInfo'] : array();
-        foreach ($PayerInfo as $PayerInfoVar => $PayerInfoVal) {
-            $PayerInfoNVP .= '&' . strtoupper($PayerInfoVar) . '=' . urlencode($PayerInfoVal);
-        }
-        // Payer Name Fields
-        $PayerName = isset($DataArray['PayerName']) ? $DataArray['PayerName'] : array();
-        foreach ($PayerName as $PayerNameVar => $PayerNameVal) {
-            $PayerNameNVP .= '&' . strtoupper($PayerNameVar) . '=' . urlencode($PayerNameVal);
-        }
-        // Address Fields (Billing)
-        $BillingAddress = isset($DataArray['BillingAddress']) ? $DataArray['BillingAddress'] : array();
-        foreach ($BillingAddress as $BillingAddressVar => $BillingAddressVal) {
-            $BillingAddressNVP .= '&' . strtoupper($BillingAddressVar) . '=' . urlencode($BillingAddressVal);
-        }
-        // Payment Details Type Fields
-        $PaymentDetails = isset($DataArray['PaymentDetails']) ? $DataArray['PaymentDetails'] : array();
-        foreach ($PaymentDetails as $PaymentDetailsVar => $PaymentDetailsVal) {
-            $PaymentDetailsNVP .= '&' . strtoupper($PaymentDetailsVar) . '=' . urlencode($PaymentDetailsVal);
-        }
-        // Payment Details Item Type Fields
-        $OrderItems = isset($DataArray['OrderItems']) ? $DataArray['OrderItems'] : array();
-        $n = 0;
-        foreach ($OrderItems as $OrderItemsVar => $OrderItemsVal) {
-            $CurrentItem = $OrderItems[ $OrderItemsVar ];
-            foreach ($CurrentItem as $CurrentItemVar => $CurrentItemVal) {
-                $OrderItemsNVP .= '&' . strtoupper($CurrentItemVar) . $n . '=' . urlencode($CurrentItemVal);
-            }
-            $n++;
-        }
-        // Ship To Address Fields
-        $ShippingAddress = isset($DataArray['ShippingAddress']) ? $DataArray['ShippingAddress'] : array();
-        foreach ($ShippingAddress as $ShippingAddressVar => $ShippingAddressVal) {
-            $ShippingAddressNVP .= '&' . strtoupper($ShippingAddressVar) . '=' . urlencode($ShippingAddressVal);
-        }
-        // 3D Secure Fields
-        $Secure3D = isset($DataArray['Secure3D']) ? $DataArray['Secure3D'] : array();
-        foreach ($Secure3D as $Secure3DVar => $Secure3DVal) {
-            $Secure3DNVP .= '&' . strtoupper($Secure3DVar) . '=' . urlencode($Secure3DVal);
-        }
-        // Now that we have each chunk we need to go ahead and append them all together for our entire NVP string
-        $NVPRequest = 'USER='
-                      . $this->_api_username
-                      . '&PWD='
-                      . $this->_api_password
-                      . '&VERSION=64.0'
-                      . '&SIGNATURE='
-                      . $this->_api_signature
-                      . $DPFieldsNVP
-                      . $CCDetailsNVP
-                      . $PayerInfoNVP
-                      . $PayerNameNVP
-                      . $BillingAddressNVP
-                      . $PaymentDetailsNVP
-                      . $OrderItemsNVP
-                      . $ShippingAddressNVP
-                      . $Secure3DNVP;
-        $NVPResponse = $this->_CURLRequest($NVPRequest);
-        $NVPRequestArray = $this->_NVPToArray($NVPRequest);
-        $NVPResponseArray = $this->_NVPToArray($NVPResponse);
-        $Errors = $this->_GetErrors($NVPResponseArray);
-        $NVPResponseArray['ERRORS'] = $Errors;
-        $NVPResponseArray['REQUESTDATA'] = $NVPRequestArray;
-        $NVPResponseArray['RAWREQUEST'] = $NVPRequest;
-        $NVPResponseArray['RAWRESPONSE'] = $NVPResponse;
-        return $NVPResponseArray;
-    }
-
-
-
-    /**
-     * @param $Request
-     * @return mixed
-     */
-    private function _CURLRequest($Request)
-    {
-        $EndPointURL = $this->_debug_mode ? 'https://api-3t.sandbox.paypal.com/nvp' : 'https://api-3t.paypal.com/nvp';
-        $curl = curl_init();
-        curl_setopt($curl, CURLOPT_VERBOSE, apply_filters('FHEE__EEG_Paypal_Pro__CurlRequest__CURLOPT_VERBOSE', true));
-        curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
-        curl_setopt($curl, CURLOPT_TIMEOUT, 60);
-        curl_setopt($curl, CURLOPT_URL, $EndPointURL);
-        curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
-        curl_setopt($curl, CURLOPT_POSTFIELDS, $Request);
-        curl_setopt($curl, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1);
-        // execute the curl POST
-        $Response = curl_exec($curl);
-        curl_close($curl);
-        return $Response;
-    }
-
-
-
-    /**
-     * @param $NVPString
-     * @return array
-     */
-    private function _NVPToArray($NVPString)
-    {
-        // prepare responses into array
-        $proArray = array();
-        while (strlen($NVPString)) {
-            // name
-            $keypos = strpos($NVPString, '=');
-            $keyval = substr($NVPString, 0, $keypos);
-            // value
-            $valuepos = strpos($NVPString, '&') ? strpos($NVPString, '&') : strlen($NVPString);
-            $valval = substr($NVPString, $keypos + 1, $valuepos - $keypos - 1);
-            // decoding the response
-            $proArray[ $keyval ] = urldecode($valval);
-            $NVPString = substr($NVPString, $valuepos + 1, strlen($NVPString));
-        }
-        return $proArray;
-    }
-
-
-
-    /**
-     * @param array $PayPalResult
-     * @return bool
-     */
-    private function _APICallSuccessful($PayPalResult)
-    {
-        $approved = false;
-        // check main response message from PayPal
-        if (isset($PayPalResult['ACK']) && ! empty($PayPalResult['ACK'])) {
-            $ack = strtoupper($PayPalResult['ACK']);
-            $approved = ($ack == 'SUCCESS' || $ack == 'SUCCESSWITHWARNING' || $ack == 'PARTIALSUCCESS') ? true : false;
-        }
-        return $approved;
-    }
-
-
-
-    /**
-     * @param $DataArray
-     * @return array
-     */
-    private function _GetErrors($DataArray)
-    {
-        $Errors = array();
-        $n = 0;
-        while (isset($DataArray[ 'L_ERRORCODE' . $n . '' ])) {
-            $LErrorCode = isset($DataArray[ 'L_ERRORCODE' . $n . '' ]) ? $DataArray[ 'L_ERRORCODE' . $n . '' ] : '';
-            $LShortMessage = isset($DataArray[ 'L_SHORTMESSAGE' . $n . '' ])
-                ? $DataArray[ 'L_SHORTMESSAGE' . $n . '' ]
-                : '';
-            $LLongMessage = isset($DataArray[ 'L_LONGMESSAGE' . $n . '' ])
-                ? $DataArray[ 'L_LONGMESSAGE' . $n . '' ]
-                : '';
-            $LSeverityCode = isset($DataArray[ 'L_SEVERITYCODE' . $n . '' ])
-                ? $DataArray[ 'L_SEVERITYCODE' . $n . '' ]
-                : '';
-            $CurrentItem = array(
-                'L_ERRORCODE'    => $LErrorCode,
-                'L_SHORTMESSAGE' => $LShortMessage,
-                'L_LONGMESSAGE'  => $LLongMessage,
-                'L_SEVERITYCODE' => $LSeverityCode,
-            );
-            array_push($Errors, $CurrentItem);
-            $n++;
-        }
-        return $Errors;
-    }
-
-
-
-    /**
-     *        nothing to see here...  move along....
-     *
-     * @access protected
-     * @param $Errors
-     * @return string
-     */
-    private function _DisplayErrors($Errors)
-    {
-        $error = '';
-        foreach ($Errors as $ErrorVar => $ErrorVal) {
-            $CurrentError = $Errors[ $ErrorVar ];
-            foreach ($CurrentError as $CurrentErrorVar => $CurrentErrorVal) {
-                $CurrentVarName = '';
-                if ($CurrentErrorVar == 'L_ERRORCODE') {
-                    $CurrentVarName = 'Error Code';
-                } elseif ($CurrentErrorVar == 'L_SHORTMESSAGE') {
-                    $CurrentVarName = 'Short Message';
-                } elseif ($CurrentErrorVar == 'L_LONGMESSAGE') {
-                    $CurrentVarName = 'Long Message';
-                } elseif ($CurrentErrorVar == 'L_SEVERITYCODE') {
-                    $CurrentVarName = 'Severity Code';
-                }
-                $error .= '<br />' . $CurrentVarName . ': ' . $CurrentErrorVal;
-            }
-        }
-        return $error;
-    }
+	/**
+	 * @var $_paypal_api_username string
+	 */
+	protected $_api_username = null;
+
+	/**
+	 * @var $_api_password string
+	 */
+	protected $_api_password = null;
+
+	/**
+	 * @var $_api_signature string
+	 */
+	protected $_api_signature = null;
+
+	/**
+	 * @var $_credit_card_types array with the keys for credit card types accepted on this account
+	 */
+	protected $_credit_card_types    = null;
+
+	protected $_currencies_supported = array(
+		'USD',
+		'GBP',
+		'CAD',
+		'AUD',
+		'BRL',
+		'CHF',
+		'CZK',
+		'DKK',
+		'EUR',
+		'HKD',
+		'HUF',
+		'ILS',
+		'JPY',
+		'MXN',
+		'MYR',
+		'NOK',
+		'NZD',
+		'PHP',
+		'PLN',
+		'SEK',
+		'SGD',
+		'THB',
+		'TRY',
+		'TWD',
+		'RUB',
+		'INR',
+	);
+
+
+
+	/**
+	 * @param EEI_Payment $payment
+	 * @param array       $billing_info {
+	 * @type string $credit_card
+	 * @type string $credit_card_type
+	 * @type string $exp_month always 2 characters
+	 * @type string $exp_year always 4 characters
+	 * @type string $cvv
+	 * }
+	 * @see      parent::do_direct_payment for more info
+	 * @return EE_Payment|EEI_Payment
+	 * @throws EE_Error
+	 */
+	public function do_direct_payment($payment, $billing_info = null)
+	{
+		$transaction = $payment->transaction();
+		if (! $transaction instanceof EEI_Transaction) {
+			throw new EE_Error(
+				esc_html__('No transaction for payment while paying with PayPal Pro.', 'event_espresso')
+			);
+		}
+		$primary_registrant = $transaction->primary_registration();
+		if (! $primary_registrant instanceof EEI_Registration) {
+			throw new EE_Error(
+				esc_html__(
+					'No primary registration on transaction while paying with PayPal Pro.',
+					'event_espresso'
+				)
+			);
+		}
+		$attendee = $primary_registrant->attendee();
+		if (! $attendee instanceof EEI_Attendee) {
+			throw new EE_Error(
+				esc_html__(
+					'No attendee on primary registration while paying with PayPal Pro.',
+					'event_espresso'
+				)
+			);
+		}
+		$gateway_formatter = $this->_get_gateway_formatter();
+		$order_description = substr($gateway_formatter->formatOrderDescription($payment), 0, 127);
+		// charge for the full amount. Show itemized list
+		if ($this->_money->compare_floats($payment->amount(), $transaction->total(), '==')) {
+			$item_num = 1;
+			$total_line_item = $transaction->total_line_item();
+			$order_items = array();
+			foreach ($total_line_item->get_items() as $line_item) {
+				// ignore line items with a quantity of 0
+				if ($line_item->quantity() == 0) {
+					continue;
+				}
+				// For percent items, whose unit_price is 0, use the total instead.
+				if ($line_item->is_percent()) {
+					$unit_price = $line_item->total();
+					$line_item_quantity = 1;
+				} else {
+					$unit_price = $line_item->unit_price();
+					$line_item_quantity = $line_item->quantity();
+				}
+				$item = array(
+					// Item Name.  127 char max.
+					'l_name'                 => substr(
+						$gateway_formatter->formatLineItemName($line_item, $payment),
+						0,
+						127
+					),
+					// Item description.  127 char max.
+					'l_desc'                 => substr(
+						$gateway_formatter->formatLineItemDesc($line_item, $payment),
+						0,
+						127
+					),
+					// Cost of individual item.
+					'l_amt'                  => $unit_price,
+					// Item Number.  127 char max.
+					'l_number'               => $item_num++,
+					// Item quantity.  Must be any positive integer.
+					'l_qty'                  => $line_item_quantity,
+					// Item's sales tax amount.
+					'l_taxamt'               => '',
+					// eBay auction number of item.
+					'l_ebayitemnumber'       => '',
+					// eBay transaction ID of purchased item.
+					'l_ebayitemauctiontxnid' => '',
+					// eBay order ID for the item.
+					'l_ebayitemorderid'      => '',
+				);
+				// add to array of all items
+				array_push($order_items, $item);
+			}
+			$item_amount = $total_line_item->get_items_total();
+			$tax_amount = $total_line_item->get_total_tax();
+		} else {
+			$order_items = array();
+			$item_amount = $payment->amount();
+			$tax_amount = 0;
+			array_push($order_items, array(
+				// Item Name.  127 char max.
+				'l_name'   => substr(
+					$gateway_formatter->formatPartialPaymentLineItemName($payment),
+					0,
+					127
+				),
+				// Item description.  127 char max.
+				'l_desc'   => substr(
+					$gateway_formatter->formatPartialPaymentLineItemDesc($payment),
+					0,
+					127
+				),
+				// Cost of individual item.
+				'l_amt'    => $payment->amount(),
+				// Item Number.  127 char max.
+				'l_number' => 1,
+				// Item quantity.  Must be any positive integer.
+				'l_qty'    => 1,
+			));
+		}
+		// Populate data arrays with order data.
+		$DPFields = array(
+			// How you want to obtain payment ?
+			// Authorization indicates the payment is a basic auth subject to settlement with Auth & Capture.
+			// Sale indicates that this is a final sale for which you are requesting payment.  Default is Sale.
+			'paymentaction'    => 'Sale',
+			// Required.  IP address of the payer's browser.
+			'ipaddress'        => $_SERVER['REMOTE_ADDR'],
+			// Flag to determine whether you want the results returned by FMF.  1 or 0.  Default is 0.
+			'returnfmfdetails' => '1',
+		);
+		$CCDetails = array(
+			// Required. Type of credit card.  Visa, MasterCard, Discover, Amex, Maestro, Solo.
+			// If Maestro or Solo, the currency code must be GBP.
+			//  In addition, either start date or issue number must be specified.
+			'creditcardtype' => $billing_info['credit_card_type'],
+			// Required.  Credit card number.  No spaces or punctuation.
+			'acct'           => $billing_info['credit_card'],
+			// Required.  Credit card expiration date.  Format is MMYYYY
+			'expdate'        => $billing_info['exp_month'] . $billing_info['exp_year'],
+			// Requirements determined by your PayPal account settings.  Security digits for credit card.
+			'cvv2'           => $billing_info['cvv'],
+		);
+		$PayerInfo = array(
+			// Email address of payer.
+			'email'       => $billing_info['email'],
+			// Unique PayPal customer ID for payer.
+			'payerid'     => '',
+			// Status of payer.  Values are verified or unverified
+			'payerstatus' => '',
+			// Payer's business name.
+			'business'    => '',
+		);
+		$PayerName = array(
+			// Payer's salutation.  20 char max.
+			'salutation' => '',
+			// Payer's first name.  25 char max.
+			'firstname'  => substr($billing_info['first_name'], 0, 25),
+			// Payer's middle name.  25 char max.
+			'middlename' => '',
+			// Payer's last name.  25 char max.
+			'lastname'   => substr($billing_info['last_name'], 0, 25),
+			// Payer's suffix.  12 char max.
+			'suffix'     => '',
+		);
+		$BillingAddress = array(
+			// Required.  First street address.
+			'street'      => $billing_info['address'],
+			// Second street address.
+			'street2'     => $billing_info['address2'],
+			// Required.  Name of City.
+			'city'        => $billing_info['city'],
+			// Required. Name of State or Province.
+			'state'       => substr($billing_info['state'], 0, 40),
+			// Required.  Country code.
+			'countrycode' => $billing_info['country'],
+			// Required.  Postal code of payer.
+			'zip'         => $billing_info['zip'],
+		);
+		// check if the registration info contains the needed fields for paypal pro
+		// (see https://developer.paypal.com/docs/classic/api/merchant/DoDirectPayment_API_Operation_NVP/)
+		if ($attendee->address() && $attendee->city() && $attendee->country_ID()) {
+			$use_registration_address_info = true;
+		} else {
+			$use_registration_address_info = false;
+		}
+		// so if the attendee has enough data to fill out PayPal Pro's shipping info, use it.
+		// If not, use the billing info again
+		$ShippingAddress = array(
+			'shiptoname'     => substr($use_registration_address_info
+				? $attendee->full_name()
+				: $billing_info['first_name'] . ' ' . $billing_info['last_name'], 0, 32),
+			'shiptostreet'   => substr($use_registration_address_info
+				? $attendee->address()
+				: $billing_info['address'], 0, 100),
+			'shiptostreet2'  => substr($use_registration_address_info
+				? $attendee->address2() : $billing_info['address2'], 0, 100),
+			'shiptocity'     => substr($use_registration_address_info
+				? $attendee->city()
+				: $billing_info['city'], 0, 40),
+			'state'          => substr($use_registration_address_info
+				? $attendee->state_name()
+				: $billing_info['state'], 0, 40),
+			'shiptocountry'  => $use_registration_address_info
+				? $attendee->country_ID()
+				: $billing_info['country'],
+			'shiptozip'      => substr($use_registration_address_info
+				? $attendee->zip()
+				: $billing_info['zip'], 0, 20),
+			'shiptophonenum' => substr($use_registration_address_info
+				? $attendee->phone()
+				: $billing_info['phone'], 0, 20),
+		);
+		$PaymentDetails = array(
+			// Required.  Total amount of order, including shipping, handling, and tax.
+			'amt'          => $gateway_formatter->formatCurrency($payment->amount()),
+			// Required.  Three-letter currency code.  Default is USD.
+			'currencycode' => $payment->currency_code(),
+			// Required if you include itemized cart details. (L_AMTn, etc.)
+			// Subtotal of items not including S&H, or tax.
+			'itemamt'      => $gateway_formatter->formatCurrency($item_amount),//
+			// Total shipping costs for the order.  If you specify shippingamt, you must also specify itemamt.
+			'shippingamt'  => '',
+			// Total handling costs for the order.  If you specify handlingamt, you must also specify itemamt.
+			'handlingamt'  => '',
+			// Required if you specify itemized cart tax details.
+			// Sum of tax for all items on the order.  Total sales tax.
+			'taxamt'       => $gateway_formatter->formatCurrency($tax_amount),
+			// Description of the order the customer is purchasing.  127 char max.
+			'desc'         => $order_description,
+			// Free-form field for your own use.  256 char max.
+			'custom'       => $primary_registrant ? $primary_registrant->ID() : '',
+			// Your own invoice or tracking number
+			'invnum'       => wp_generate_password(12, false),// $transaction->ID(),
+			// URL for receiving Instant Payment Notifications.  This overrides what your profile is set to use.
+			'notifyurl'    => '',
+			'buttonsource' => 'EventEspresso_SP',// EE will blow up if you change this
+		);
+		// Wrap all data arrays into a single, "master" array which will be passed into the class function.
+		$PayPalRequestData = array(
+			'DPFields'        => $DPFields,
+			'CCDetails'       => $CCDetails,
+			'PayerInfo'       => $PayerInfo,
+			'PayerName'       => $PayerName,
+			'BillingAddress'  => $BillingAddress,
+			'ShippingAddress' => $ShippingAddress,
+			'PaymentDetails'  => $PaymentDetails,
+			'OrderItems'      => $order_items,
+		);
+		$this->_log_clean_request($PayPalRequestData, $payment);
+		try {
+			$PayPalResult = $this->prep_and_curl_request($PayPalRequestData);
+			// remove PCI-sensitive data so it doesn't get stored
+			$PayPalResult = $this->_log_clean_response($PayPalResult, $payment);
+			if (isset($PayPalResult['L_ERRORCODE0']) && $PayPalResult['L_ERRORCODE0'] === '10002') {
+				$message = esc_html__('PayPal did not accept your API username, password, or signature. Please double-check these credentials and if debug mode is on.', 'event_espresso');
+			} elseif (isset($PayPalResult['L_LONGMESSAGE0'])) {
+				$message = $PayPalResult['L_LONGMESSAGE0'];
+			} else {
+				$message = $PayPalResult['ACK'];
+			}
+			if (empty($PayPalResult['RAWRESPONSE'])) {
+				$payment->set_status($this->_pay_model->failed_status());
+				$payment->set_gateway_response(__('No response received from Paypal Pro', 'event_espresso'));
+				$payment->set_details($PayPalResult);
+			} else {
+				if ($this->_APICallSuccessful($PayPalResult)) {
+					$payment->set_status($this->_pay_model->approved_status());
+				} else {
+					$payment->set_status($this->_pay_model->declined_status());
+				}
+				// make sure we interpret the AMT as a float, not an international string
+				// (where periods are thousand separators)
+				$payment->set_amount(isset($PayPalResult['AMT']) ? floatval($PayPalResult['AMT']) : 0);
+				$payment->set_gateway_response($message);
+				$payment->set_txn_id_chq_nmbr(isset($PayPalResult['TRANSACTIONID'])
+					? $PayPalResult['TRANSACTIONID']
+					: null);
+				$primary_registration_code = $primary_registrant instanceof EE_Registration
+					? $primary_registrant->reg_code()
+					: '';
+				$payment->set_extra_accntng($primary_registration_code);
+				$payment->set_details($PayPalResult);
+			}
+		} catch (Exception $e) {
+			$payment->set_status($this->_pay_model->failed_status());
+			$payment->set_gateway_response($e->getMessage());
+		}
+		// $payment->set_status( $this->_pay_model->declined_status() );
+		// $payment->set_gateway_response( '' );
+		return $payment;
+	}
+
+
+
+	/**
+	 * CLeans out sensitive CC data and then logs it, and returns the cleaned request
+	 *
+	 * @param array       $request
+	 * @param EEI_Payment $payment
+	 * @return void
+	 */
+	private function _log_clean_request($request, $payment)
+	{
+		$cleaned_request_data = $request;
+		unset($cleaned_request_data['CCDetails']['acct']);
+		unset($cleaned_request_data['CCDetails']['cvv2']);
+		unset($cleaned_request_data['CCDetails']['expdate']);
+		$this->log(array('Paypal Request' => $cleaned_request_data), $payment);
+	}
+
+
+
+	/**
+	 * Cleans the response, logs it, and returns it
+	 *
+	 * @param array       $response
+	 * @param EEI_Payment $payment
+	 * @return array cleaned
+	 */
+	private function _log_clean_response($response, $payment)
+	{
+		unset($response['REQUESTDATA']['CREDITCARDTYPE']);
+		unset($response['REQUESTDATA']['ACCT']);
+		unset($response['REQUESTDATA']['EXPDATE']);
+		unset($response['REQUESTDATA']['CVV2']);
+		unset($response['RAWREQUEST']);
+		$this->log(array('Paypal Response' => $response), $payment);
+		return $response;
+	}
+
+
+
+	/**
+	 * @param $DataArray
+	 * @return array
+	 */
+	private function prep_and_curl_request($DataArray)
+	{
+		// Create empty holders for each portion of the NVP string
+		$DPFieldsNVP = '&METHOD=DoDirectPayment&BUTTONSOURCE=AngellEYE_PHP_Class_DDP';
+		$CCDetailsNVP = '';
+		$PayerInfoNVP = '';
+		$PayerNameNVP = '';
+		$BillingAddressNVP = '';
+		$ShippingAddressNVP = '';
+		$PaymentDetailsNVP = '';
+		$OrderItemsNVP = '';
+		$Secure3DNVP = '';
+		// DP Fields
+		$DPFields = isset($DataArray['DPFields']) ? $DataArray['DPFields'] : array();
+		foreach ($DPFields as $DPFieldsVar => $DPFieldsVal) {
+			$DPFieldsNVP .= '&' . strtoupper($DPFieldsVar) . '=' . urlencode($DPFieldsVal);
+		}
+		// CC Details Fields
+		$CCDetails = isset($DataArray['CCDetails']) ? $DataArray['CCDetails'] : array();
+		foreach ($CCDetails as $CCDetailsVar => $CCDetailsVal) {
+			$CCDetailsNVP .= '&' . strtoupper($CCDetailsVar) . '=' . urlencode($CCDetailsVal);
+		}
+		// PayerInfo Type Fields
+		$PayerInfo = isset($DataArray['PayerInfo']) ? $DataArray['PayerInfo'] : array();
+		foreach ($PayerInfo as $PayerInfoVar => $PayerInfoVal) {
+			$PayerInfoNVP .= '&' . strtoupper($PayerInfoVar) . '=' . urlencode($PayerInfoVal);
+		}
+		// Payer Name Fields
+		$PayerName = isset($DataArray['PayerName']) ? $DataArray['PayerName'] : array();
+		foreach ($PayerName as $PayerNameVar => $PayerNameVal) {
+			$PayerNameNVP .= '&' . strtoupper($PayerNameVar) . '=' . urlencode($PayerNameVal);
+		}
+		// Address Fields (Billing)
+		$BillingAddress = isset($DataArray['BillingAddress']) ? $DataArray['BillingAddress'] : array();
+		foreach ($BillingAddress as $BillingAddressVar => $BillingAddressVal) {
+			$BillingAddressNVP .= '&' . strtoupper($BillingAddressVar) . '=' . urlencode($BillingAddressVal);
+		}
+		// Payment Details Type Fields
+		$PaymentDetails = isset($DataArray['PaymentDetails']) ? $DataArray['PaymentDetails'] : array();
+		foreach ($PaymentDetails as $PaymentDetailsVar => $PaymentDetailsVal) {
+			$PaymentDetailsNVP .= '&' . strtoupper($PaymentDetailsVar) . '=' . urlencode($PaymentDetailsVal);
+		}
+		// Payment Details Item Type Fields
+		$OrderItems = isset($DataArray['OrderItems']) ? $DataArray['OrderItems'] : array();
+		$n = 0;
+		foreach ($OrderItems as $OrderItemsVar => $OrderItemsVal) {
+			$CurrentItem = $OrderItems[ $OrderItemsVar ];
+			foreach ($CurrentItem as $CurrentItemVar => $CurrentItemVal) {
+				$OrderItemsNVP .= '&' . strtoupper($CurrentItemVar) . $n . '=' . urlencode($CurrentItemVal);
+			}
+			$n++;
+		}
+		// Ship To Address Fields
+		$ShippingAddress = isset($DataArray['ShippingAddress']) ? $DataArray['ShippingAddress'] : array();
+		foreach ($ShippingAddress as $ShippingAddressVar => $ShippingAddressVal) {
+			$ShippingAddressNVP .= '&' . strtoupper($ShippingAddressVar) . '=' . urlencode($ShippingAddressVal);
+		}
+		// 3D Secure Fields
+		$Secure3D = isset($DataArray['Secure3D']) ? $DataArray['Secure3D'] : array();
+		foreach ($Secure3D as $Secure3DVar => $Secure3DVal) {
+			$Secure3DNVP .= '&' . strtoupper($Secure3DVar) . '=' . urlencode($Secure3DVal);
+		}
+		// Now that we have each chunk we need to go ahead and append them all together for our entire NVP string
+		$NVPRequest = 'USER='
+					  . $this->_api_username
+					  . '&PWD='
+					  . $this->_api_password
+					  . '&VERSION=64.0'
+					  . '&SIGNATURE='
+					  . $this->_api_signature
+					  . $DPFieldsNVP
+					  . $CCDetailsNVP
+					  . $PayerInfoNVP
+					  . $PayerNameNVP
+					  . $BillingAddressNVP
+					  . $PaymentDetailsNVP
+					  . $OrderItemsNVP
+					  . $ShippingAddressNVP
+					  . $Secure3DNVP;
+		$NVPResponse = $this->_CURLRequest($NVPRequest);
+		$NVPRequestArray = $this->_NVPToArray($NVPRequest);
+		$NVPResponseArray = $this->_NVPToArray($NVPResponse);
+		$Errors = $this->_GetErrors($NVPResponseArray);
+		$NVPResponseArray['ERRORS'] = $Errors;
+		$NVPResponseArray['REQUESTDATA'] = $NVPRequestArray;
+		$NVPResponseArray['RAWREQUEST'] = $NVPRequest;
+		$NVPResponseArray['RAWRESPONSE'] = $NVPResponse;
+		return $NVPResponseArray;
+	}
+
+
+
+	/**
+	 * @param $Request
+	 * @return mixed
+	 */
+	private function _CURLRequest($Request)
+	{
+		$EndPointURL = $this->_debug_mode ? 'https://api-3t.sandbox.paypal.com/nvp' : 'https://api-3t.paypal.com/nvp';
+		$curl = curl_init();
+		curl_setopt($curl, CURLOPT_VERBOSE, apply_filters('FHEE__EEG_Paypal_Pro__CurlRequest__CURLOPT_VERBOSE', true));
+		curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
+		curl_setopt($curl, CURLOPT_TIMEOUT, 60);
+		curl_setopt($curl, CURLOPT_URL, $EndPointURL);
+		curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
+		curl_setopt($curl, CURLOPT_POSTFIELDS, $Request);
+		curl_setopt($curl, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1);
+		// execute the curl POST
+		$Response = curl_exec($curl);
+		curl_close($curl);
+		return $Response;
+	}
+
+
+
+	/**
+	 * @param $NVPString
+	 * @return array
+	 */
+	private function _NVPToArray($NVPString)
+	{
+		// prepare responses into array
+		$proArray = array();
+		while (strlen($NVPString)) {
+			// name
+			$keypos = strpos($NVPString, '=');
+			$keyval = substr($NVPString, 0, $keypos);
+			// value
+			$valuepos = strpos($NVPString, '&') ? strpos($NVPString, '&') : strlen($NVPString);
+			$valval = substr($NVPString, $keypos + 1, $valuepos - $keypos - 1);
+			// decoding the response
+			$proArray[ $keyval ] = urldecode($valval);
+			$NVPString = substr($NVPString, $valuepos + 1, strlen($NVPString));
+		}
+		return $proArray;
+	}
+
+
+
+	/**
+	 * @param array $PayPalResult
+	 * @return bool
+	 */
+	private function _APICallSuccessful($PayPalResult)
+	{
+		$approved = false;
+		// check main response message from PayPal
+		if (isset($PayPalResult['ACK']) && ! empty($PayPalResult['ACK'])) {
+			$ack = strtoupper($PayPalResult['ACK']);
+			$approved = ($ack == 'SUCCESS' || $ack == 'SUCCESSWITHWARNING' || $ack == 'PARTIALSUCCESS') ? true : false;
+		}
+		return $approved;
+	}
+
+
+
+	/**
+	 * @param $DataArray
+	 * @return array
+	 */
+	private function _GetErrors($DataArray)
+	{
+		$Errors = array();
+		$n = 0;
+		while (isset($DataArray[ 'L_ERRORCODE' . $n . '' ])) {
+			$LErrorCode = isset($DataArray[ 'L_ERRORCODE' . $n . '' ]) ? $DataArray[ 'L_ERRORCODE' . $n . '' ] : '';
+			$LShortMessage = isset($DataArray[ 'L_SHORTMESSAGE' . $n . '' ])
+				? $DataArray[ 'L_SHORTMESSAGE' . $n . '' ]
+				: '';
+			$LLongMessage = isset($DataArray[ 'L_LONGMESSAGE' . $n . '' ])
+				? $DataArray[ 'L_LONGMESSAGE' . $n . '' ]
+				: '';
+			$LSeverityCode = isset($DataArray[ 'L_SEVERITYCODE' . $n . '' ])
+				? $DataArray[ 'L_SEVERITYCODE' . $n . '' ]
+				: '';
+			$CurrentItem = array(
+				'L_ERRORCODE'    => $LErrorCode,
+				'L_SHORTMESSAGE' => $LShortMessage,
+				'L_LONGMESSAGE'  => $LLongMessage,
+				'L_SEVERITYCODE' => $LSeverityCode,
+			);
+			array_push($Errors, $CurrentItem);
+			$n++;
+		}
+		return $Errors;
+	}
+
+
+
+	/**
+	 *        nothing to see here...  move along....
+	 *
+	 * @access protected
+	 * @param $Errors
+	 * @return string
+	 */
+	private function _DisplayErrors($Errors)
+	{
+		$error = '';
+		foreach ($Errors as $ErrorVar => $ErrorVal) {
+			$CurrentError = $Errors[ $ErrorVar ];
+			foreach ($CurrentError as $CurrentErrorVar => $CurrentErrorVal) {
+				$CurrentVarName = '';
+				if ($CurrentErrorVar == 'L_ERRORCODE') {
+					$CurrentVarName = 'Error Code';
+				} elseif ($CurrentErrorVar == 'L_SHORTMESSAGE') {
+					$CurrentVarName = 'Short Message';
+				} elseif ($CurrentErrorVar == 'L_LONGMESSAGE') {
+					$CurrentVarName = 'Long Message';
+				} elseif ($CurrentErrorVar == 'L_SEVERITYCODE') {
+					$CurrentVarName = 'Severity Code';
+				}
+				$error .= '<br />' . $CurrentVarName . ': ' . $CurrentErrorVal;
+			}
+		}
+		return $error;
+	}
 }

caffeinated/payment_methods/Paypal_Pro/EE_PMT_Paypal_Pro.pm.php

Spacing +9 added lines, -9 removed lines

@@ -63,22 +63,22 @@ 
             //              'html_id'=> 'ee-Paypal_Pro-billing-form',
                 'subsections'=>array(
                     'credit_card'=>new EE_Credit_Card_Input(
-                        array( 'required'=>true, 'html_class' => 'ee-billing-qstn', 'html_label_text' => __('Card Number', 'event_espresso'))
+                        array('required'=>true, 'html_class' => 'ee-billing-qstn', 'html_label_text' => __('Card Number', 'event_espresso'))
                     ),
                     'credit_card_type'=>new EE_Select_Input(
                         // the options are set dynamically
                         array_intersect_key(EE_PMT_Paypal_Pro::card_types_supported(), array_flip($allowed_types)),
-                        array( 'required'=>true, 'html_class' => 'ee-billing-qstn', 'html_label_text' => __('Card Type', 'event_espresso'))
+                        array('required'=>true, 'html_class' => 'ee-billing-qstn', 'html_label_text' => __('Card Type', 'event_espresso'))
                     ),
                     'exp_month'=>new EE_Credit_Card_Month_Input(
                         true,
-                        array( 'required'=>true, 'html_class' => 'ee-billing-qstn', 'html_label_text' =>  __('Expiry Month', 'event_espresso')  )
+                        array('required'=>true, 'html_class' => 'ee-billing-qstn', 'html_label_text' =>  __('Expiry Month', 'event_espresso'))
                     ),
                     'exp_year'=>new EE_Credit_Card_Year_Input(
-                        array( 'required'=>true, 'html_class' => 'ee-billing-qstn', 'html_label_text' => __('Expiry Year', 'event_espresso')  )
+                        array('required'=>true, 'html_class' => 'ee-billing-qstn', 'html_label_text' => __('Expiry Year', 'event_espresso'))
                     ),
                     'cvv'=>new EE_CVV_Input(
-                        array( 'required'=>true, 'html_class' => 'ee-billing-qstn', 'html_label_text' => __('CVV', 'event_espresso') )
+                        array('required'=>true, 'html_class' => 'ee-billing-qstn', 'html_label_text' => __('CVV', 'event_espresso'))
                     ),
                 )
             )
@@ -99,11 +99,11 @@ 
     {
         if ($this->_pm_instance->debug_mode()) {
             $billing_form->add_subsections(
-                array( 'fyi_about_autofill' => $billing_form->payment_fields_autofilled_notice_html() ),
+                array('fyi_about_autofill' => $billing_form->payment_fields_autofilled_notice_html()),
                 'credit_card'
             );
             $billing_form->add_subsections(
-                array( 'debug_content' => new EE_Form_Section_HTML_From_Template(dirname(__FILE__).DS.'templates'.DS.'paypal_pro_debug_info.template.php')),
+                array('debug_content' => new EE_Form_Section_HTML_From_Template(dirname(__FILE__).DS.'templates'.DS.'paypal_pro_debug_info.template.php')),
                 'first_name'
             );
             $billing_form->get_input('credit_card_type')->set_default('Visa');
@@ -184,9 +184,9 @@ 
             ]
         );
         // If they existed, set the new ones instead
-        if (!empty($old_extra_metas)) {
+        if ( ! empty($old_extra_metas)) {
             foreach ($old_extra_metas as $old_extra_meta) {
-                $old_extra_meta->set('EXM_key', 'api_' . $old_extra_meta->get('EXM_key'));
+                $old_extra_meta->set('EXM_key', 'api_'.$old_extra_meta->get('EXM_key'));
                 $old_extra_meta->save();
             }
         }

Indentation +178 added lines, -178 removed lines

@@ -14,182 +14,182 @@
 class EE_PMT_Paypal_Pro extends EE_PMT_Base
 {
 
-    /**
-     * @param EE_Payment_Method $pm_instance
-     * @return EE_PMT_Paypal_Pro
-     */
-    public function __construct($pm_instance = null)
-    {
-        require_once($this->file_folder().'EEG_Paypal_Pro.gateway.php');
-        $this->_gateway = new EEG_Paypal_Pro();
-        $this->_pretty_name = __("Paypal Pro", 'event_espresso');
-        $this->_default_description = __('Please provide the following billing information.', 'event_espresso');
-        $this->_requires_https = true;
-        parent::__construct($pm_instance);
-    }
-
-
-    /**
-     * Gets the form for all the settings related to this payment method type
-     * @return EE_Payment_Method_Form
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function generate_new_settings_form()
-    {
-        return new PayPalProSettingsForm(array(), $this->get_help_tab_link());
-    }
-
-
-    /**
-     * Creates the billing form for this payment method type
-     * @param \EE_Transaction $transaction
-     * @throws \EE_Error
-     * @return EE_Billing_Info_Form
-     */
-    public function generate_new_billing_form(EE_Transaction $transaction = null)
-    {
-        $allowed_types = $this->_pm_instance->get_extra_meta('credit_card_types', true);
-        // if allowed types is a string or empty array or null...
-        if (empty($allowed_types)) {
-            $allowed_types = array();
-        }
-
-        $billing_form = new EE_Billing_Attendee_Info_Form(
-            $this->_pm_instance,
-            array(
-                'name'=> 'Paypal_Pro_Billing_Form',
-            //              'html_id'=> 'ee-Paypal_Pro-billing-form',
-                'subsections'=>array(
-                    'credit_card'=>new EE_Credit_Card_Input(
-                        array( 'required'=>true, 'html_class' => 'ee-billing-qstn', 'html_label_text' => __('Card Number', 'event_espresso'))
-                    ),
-                    'credit_card_type'=>new EE_Select_Input(
-                        // the options are set dynamically
-                        array_intersect_key(EE_PMT_Paypal_Pro::card_types_supported(), array_flip($allowed_types)),
-                        array( 'required'=>true, 'html_class' => 'ee-billing-qstn', 'html_label_text' => __('Card Type', 'event_espresso'))
-                    ),
-                    'exp_month'=>new EE_Credit_Card_Month_Input(
-                        true,
-                        array( 'required'=>true, 'html_class' => 'ee-billing-qstn', 'html_label_text' =>  __('Expiry Month', 'event_espresso')  )
-                    ),
-                    'exp_year'=>new EE_Credit_Card_Year_Input(
-                        array( 'required'=>true, 'html_class' => 'ee-billing-qstn', 'html_label_text' => __('Expiry Year', 'event_espresso')  )
-                    ),
-                    'cvv'=>new EE_CVV_Input(
-                        array( 'required'=>true, 'html_class' => 'ee-billing-qstn', 'html_label_text' => __('CVV', 'event_espresso') )
-                    ),
-                )
-            )
-        );
-        return $this->apply_billing_form_debug_settings($billing_form);
-    }
-
-
-
-    /**
-     * apply_billing_form_debug_settings
-     * applies debug data to the form
-     *
-     * @param \EE_Billing_Info_Form $billing_form
-     * @return \EE_Billing_Info_Form
-     */
-    public function apply_billing_form_debug_settings(EE_Billing_Info_Form $billing_form)
-    {
-        if ($this->_pm_instance->debug_mode()) {
-            $billing_form->add_subsections(
-                array( 'fyi_about_autofill' => $billing_form->payment_fields_autofilled_notice_html() ),
-                'credit_card'
-            );
-            $billing_form->add_subsections(
-                array( 'debug_content' => new EE_Form_Section_HTML_From_Template(dirname(__FILE__).DS.'templates'.DS.'paypal_pro_debug_info.template.php')),
-                'first_name'
-            );
-            $billing_form->get_input('credit_card_type')->set_default('Visa');
-            $billing_form->get_input('exp_year')->set_default(2018);
-            $billing_form->get_input('cvv')->set_default('115');
-        }
-        return $billing_form;
-    }
-
-
-
-    /**
-     * Returns an array of all the payment cards possibly supported by paypal pro.
-     * Keys are their values, values are their pretty names.
-     * @return array
-     */
-    public static function card_types_supported()
-    {
-        return array(
-            'Visa'=>  __("Visa", 'event_espresso'),
-            'MasterCard'=>  __("MasterCard", 'event_espresso'),
-            'Amex'=>  __("American Express", 'event_espresso'),
-            'Discover'=>  __("Discover", 'event_espresso')
-            );
-    }
-
-
-
-    /**
-     * Adds the help tab
-     * @see EE_PMT_Base::help_tabs_config()
-     * @return array
-     */
-    public function help_tabs_config()
-    {
-        return array(
-            $this->get_help_tab_name() => array(
-                        'title' => __('PayPal Pro Settings', 'event_espresso'),
-                        'filename' => 'payment_methods_overview_paypalpro'
-                        ),
-        );
-    }
-
-    /**
-     * Overrides parent's _get_billing_values_from_form because we want to
-     * get the country's 2-character ISO code, not the name like most gateways
-     * @param EE_Billing_Info_Form $billing_form
-     * @return array
-     */
-    protected function _get_billing_values_from_form($billing_form)
-    {
-        $billing_values = parent::_get_billing_values_from_form($billing_form);
-        $billing_values['country'] = $billing_form->get_input_value('country');
-        $billing_values['credit_card_type'] = $billing_form->get_input_value('credit_card_type');
-        return $billing_values;
-    }
-
-    /**
-     * Override parent to account for a change in extra meta inputs in 4.9.75.p
-     * @since 4.9.79.p
-     * @param EE_Payment_Method $payment_method_instance
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function set_instance($payment_method_instance)
-    {
-        // Check for the old extra meta inputs
-        $old_extra_metas = EEM_Extra_Meta::instance()->get_all(
-            [
-                [
-                    'EXM_type' => 'Payment_Method',
-                    'OBJ_ID' => $payment_method_instance->ID(),
-                    'EXM_key' => ['IN', ['username', 'password', 'signature']],
-                ]
-            ]
-        );
-        // If they existed, set the new ones instead
-        if (!empty($old_extra_metas)) {
-            foreach ($old_extra_metas as $old_extra_meta) {
-                $old_extra_meta->set('EXM_key', 'api_' . $old_extra_meta->get('EXM_key'));
-                $old_extra_meta->save();
-            }
-        }
-        return parent::set_instance($payment_method_instance);
-    }
+	/**
+	 * @param EE_Payment_Method $pm_instance
+	 * @return EE_PMT_Paypal_Pro
+	 */
+	public function __construct($pm_instance = null)
+	{
+		require_once($this->file_folder().'EEG_Paypal_Pro.gateway.php');
+		$this->_gateway = new EEG_Paypal_Pro();
+		$this->_pretty_name = __("Paypal Pro", 'event_espresso');
+		$this->_default_description = __('Please provide the following billing information.', 'event_espresso');
+		$this->_requires_https = true;
+		parent::__construct($pm_instance);
+	}
+
+
+	/**
+	 * Gets the form for all the settings related to this payment method type
+	 * @return EE_Payment_Method_Form
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function generate_new_settings_form()
+	{
+		return new PayPalProSettingsForm(array(), $this->get_help_tab_link());
+	}
+
+
+	/**
+	 * Creates the billing form for this payment method type
+	 * @param \EE_Transaction $transaction
+	 * @throws \EE_Error
+	 * @return EE_Billing_Info_Form
+	 */
+	public function generate_new_billing_form(EE_Transaction $transaction = null)
+	{
+		$allowed_types = $this->_pm_instance->get_extra_meta('credit_card_types', true);
+		// if allowed types is a string or empty array or null...
+		if (empty($allowed_types)) {
+			$allowed_types = array();
+		}
+
+		$billing_form = new EE_Billing_Attendee_Info_Form(
+			$this->_pm_instance,
+			array(
+				'name'=> 'Paypal_Pro_Billing_Form',
+			//              'html_id'=> 'ee-Paypal_Pro-billing-form',
+				'subsections'=>array(
+					'credit_card'=>new EE_Credit_Card_Input(
+						array( 'required'=>true, 'html_class' => 'ee-billing-qstn', 'html_label_text' => __('Card Number', 'event_espresso'))
+					),
+					'credit_card_type'=>new EE_Select_Input(
+						// the options are set dynamically
+						array_intersect_key(EE_PMT_Paypal_Pro::card_types_supported(), array_flip($allowed_types)),
+						array( 'required'=>true, 'html_class' => 'ee-billing-qstn', 'html_label_text' => __('Card Type', 'event_espresso'))
+					),
+					'exp_month'=>new EE_Credit_Card_Month_Input(
+						true,
+						array( 'required'=>true, 'html_class' => 'ee-billing-qstn', 'html_label_text' =>  __('Expiry Month', 'event_espresso')  )
+					),
+					'exp_year'=>new EE_Credit_Card_Year_Input(
+						array( 'required'=>true, 'html_class' => 'ee-billing-qstn', 'html_label_text' => __('Expiry Year', 'event_espresso')  )
+					),
+					'cvv'=>new EE_CVV_Input(
+						array( 'required'=>true, 'html_class' => 'ee-billing-qstn', 'html_label_text' => __('CVV', 'event_espresso') )
+					),
+				)
+			)
+		);
+		return $this->apply_billing_form_debug_settings($billing_form);
+	}
+
+
+
+	/**
+	 * apply_billing_form_debug_settings
+	 * applies debug data to the form
+	 *
+	 * @param \EE_Billing_Info_Form $billing_form
+	 * @return \EE_Billing_Info_Form
+	 */
+	public function apply_billing_form_debug_settings(EE_Billing_Info_Form $billing_form)
+	{
+		if ($this->_pm_instance->debug_mode()) {
+			$billing_form->add_subsections(
+				array( 'fyi_about_autofill' => $billing_form->payment_fields_autofilled_notice_html() ),
+				'credit_card'
+			);
+			$billing_form->add_subsections(
+				array( 'debug_content' => new EE_Form_Section_HTML_From_Template(dirname(__FILE__).DS.'templates'.DS.'paypal_pro_debug_info.template.php')),
+				'first_name'
+			);
+			$billing_form->get_input('credit_card_type')->set_default('Visa');
+			$billing_form->get_input('exp_year')->set_default(2018);
+			$billing_form->get_input('cvv')->set_default('115');
+		}
+		return $billing_form;
+	}
+
+
+
+	/**
+	 * Returns an array of all the payment cards possibly supported by paypal pro.
+	 * Keys are their values, values are their pretty names.
+	 * @return array
+	 */
+	public static function card_types_supported()
+	{
+		return array(
+			'Visa'=>  __("Visa", 'event_espresso'),
+			'MasterCard'=>  __("MasterCard", 'event_espresso'),
+			'Amex'=>  __("American Express", 'event_espresso'),
+			'Discover'=>  __("Discover", 'event_espresso')
+			);
+	}
+
+
+
+	/**
+	 * Adds the help tab
+	 * @see EE_PMT_Base::help_tabs_config()
+	 * @return array
+	 */
+	public function help_tabs_config()
+	{
+		return array(
+			$this->get_help_tab_name() => array(
+						'title' => __('PayPal Pro Settings', 'event_espresso'),
+						'filename' => 'payment_methods_overview_paypalpro'
+						),
+		);
+	}
+
+	/**
+	 * Overrides parent's _get_billing_values_from_form because we want to
+	 * get the country's 2-character ISO code, not the name like most gateways
+	 * @param EE_Billing_Info_Form $billing_form
+	 * @return array
+	 */
+	protected function _get_billing_values_from_form($billing_form)
+	{
+		$billing_values = parent::_get_billing_values_from_form($billing_form);
+		$billing_values['country'] = $billing_form->get_input_value('country');
+		$billing_values['credit_card_type'] = $billing_form->get_input_value('credit_card_type');
+		return $billing_values;
+	}
+
+	/**
+	 * Override parent to account for a change in extra meta inputs in 4.9.75.p
+	 * @since 4.9.79.p
+	 * @param EE_Payment_Method $payment_method_instance
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function set_instance($payment_method_instance)
+	{
+		// Check for the old extra meta inputs
+		$old_extra_metas = EEM_Extra_Meta::instance()->get_all(
+			[
+				[
+					'EXM_type' => 'Payment_Method',
+					'OBJ_ID' => $payment_method_instance->ID(),
+					'EXM_key' => ['IN', ['username', 'password', 'signature']],
+				]
+			]
+		);
+		// If they existed, set the new ones instead
+		if (!empty($old_extra_metas)) {
+			foreach ($old_extra_metas as $old_extra_meta) {
+				$old_extra_meta->set('EXM_key', 'api_' . $old_extra_meta->get('EXM_key'));
+				$old_extra_meta->save();
+			}
+		}
+		return parent::set_instance($payment_method_instance);
+	}
 }

admin_pages/transactions/templates/txn_admin_details_side_meta_box_registrant.template.php

Indentation +19 added lines, -19 removed lines

@@ -10,19 +10,19 @@ 
 ?>
 <div id="admin-side-mbox-primary-registrant-dv" class="admin-side-mbox-dv">
     <?php
-    if (! empty($no_attendee_message)) : ?>
+	if (! empty($no_attendee_message)) : ?>
     <p class="clearfix">
         <?php echo $no_attendee_message; ?>
     </p>
 </div> <!-- end #admin-side-mbox-primary-registrant-dv -->
 <?php
-    else : ?>
+	else : ?>
     <p class="clearfix">
         <span class="admin-side-mbox-label-spn lt-grey-txt float-left">
             <?php esc_html_e(
-                'Name',
-                'event_espresso'
-            ); ?></span><?php echo $prime_reg_fname . ' ' . $prime_reg_lname; ?>
+				'Name',
+				'event_espresso'
+			); ?></span><?php echo $prime_reg_fname . ' ' . $prime_reg_lname; ?>
     </p>
     <p class="clearfix">
         <span class="admin-side-mbox-label-spn lt-grey-txt float-left"><?php esc_html_e('Email', 'event_espresso'); ?></span><a
@@ -31,9 +31,9 @@ 
     <p class="clearfix">
         <span class="admin-side-mbox-label-spn lt-grey-txt float-left">
             <?php esc_html_e(
-                'Phone #',
-                'event_espresso'
-            ); ?>
+				'Phone #',
+				'event_espresso'
+			); ?>
     </span>
     <?php if (! empty($prime_reg_phone)) : ?>
         <a href="tel:<?php echo $phone; ?>">
@@ -50,22 +50,22 @@ 
     </div> <!-- end #admin-side-mbox-primary-registrant-dv -->
 
     <?php
-    /** only show if logged in user has access */
-    if (EE_Registry::instance()->CAP->current_user_can(
-        'ee_edit_contact',
-        'view_or_edit_contact_button',
-        $ATT_ID
-    )
-    ) : ?>
+	/** only show if logged in user has access */
+	if (EE_Registry::instance()->CAP->current_user_can(
+		'ee_edit_contact',
+		'view_or_edit_contact_button',
+		$ATT_ID
+	)
+	) : ?>
         <p style="text-align:right;">
             <a class="button button-small" href="<?php echo $edit_attendee_url; ?>"
                title="<?php esc_attr_e('View details for this contact.', 'event_espresso'); ?>">
                 <span class="ee-icon ee-icon-user-edit"></span>
                 <?php _e(
-                    'View / Edit this Contact',
-                    'event_espresso'
-                ); ?>
+					'View / Edit this Contact',
+					'event_espresso'
+				); ?>
             </a>
         </p>
     <?php endif;
-    endif;
+	endif;

Spacing +3 added lines, -3 removed lines

@@ -10,7 +10,7 @@ 
 ?>
 <div id="admin-side-mbox-primary-registrant-dv" class="admin-side-mbox-dv">
     <?php
-    if (! empty($no_attendee_message)) : ?>
+    if ( ! empty($no_attendee_message)) : ?>
     <p class="clearfix">
         <?php echo $no_attendee_message; ?>
     </p>
@@ -22,7 +22,7 @@ 
             <?php esc_html_e(
                 'Name',
                 'event_espresso'
-            ); ?></span><?php echo $prime_reg_fname . ' ' . $prime_reg_lname; ?>
+            ); ?></span><?php echo $prime_reg_fname.' '.$prime_reg_lname; ?>
     </p>
     <p class="clearfix">
         <span class="admin-side-mbox-label-spn lt-grey-txt float-left"><?php esc_html_e('Email', 'event_espresso'); ?></span><a
@@ -35,7 +35,7 @@ 
                 'event_espresso'
             ); ?>
     </span>
-    <?php if (! empty($prime_reg_phone)) : ?>
+    <?php if ( ! empty($prime_reg_phone)) : ?>
         <a href="tel:<?php echo $phone; ?>">
             <?php echo $prime_reg_phone; ?>
         </a>

Braces +5 added lines, -2 removed lines

@@ -16,13 +16,16 @@
     </p>
 </div> <!-- end #admin-side-mbox-primary-registrant-dv -->
 <?php
-    else : ?>
+    else {
+    	: ?>
     <p class="clearfix">
         <span class="admin-side-mbox-label-spn lt-grey-txt float-left">
             <?php esc_html_e(
                 'Name',
                 'event_espresso'
-            ); ?></span><?php echo $prime_reg_fname . ' ' . $prime_reg_lname; ?>
+            );
+    }
+    ?></span><?php echo $prime_reg_fname . ' ' . $prime_reg_lname; ?>
     </p>
     <p class="clearfix">
         <span class="admin-side-mbox-label-spn lt-grey-txt float-left"><?php esc_html_e('Email', 'event_espresso'); ?></span><a

admin_pages/registrations/templates/reg_admin_details_side_meta_box_registrant.template.php

Spacing +3 added lines, -3 removed lines

@@ -2,7 +2,7 @@ 
     <p class="clearfix">
         <span class="admin-side-mbox-label-spn lt-grey-txt float-left">
             <?php esc_html_e('Name', 'event_espresso'); ?>
-        </span><?php echo $fname . ' ' . $lname; ?>
+        </span><?php echo $fname.' '.$lname; ?>
     </p>
     <p class="clearfix">
         <span class="admin-side-mbox-label-spn lt-grey-txt float-left">
@@ -16,7 +16,7 @@ 
         <span class="admin-side-mbox-label-spn lt-grey-txt float-left">
             <?php esc_html_e('Phone #', 'event_espresso'); ?>
         </span>
-        <?php if (! empty($phone)) : ?>
+        <?php if ( ! empty($phone)) : ?>
             <a href="tel:<?php echo $phone; ?>">
                 <?php echo $phone; ?>
             </a>
@@ -46,7 +46,7 @@ 
        title="<?php echo esc_attr($att_edit_label); ?>">
         <span class="ee-icon ee-icon-user-edit"></span><?php echo $att_edit_label; ?>
     </a>
-    <?php if (! empty($create_link)) : ?>
+    <?php if ( ! empty($create_link)) : ?>
         <a class="button button-small" href="<?php echo $create_link; ?>"
            title="<?php
                    esc_attr_e(

core/libraries/form_sections/inputs/EE_CVV_Input.input.php

Indentation +38 added lines, -38 removed lines

@@ -11,42 +11,42 @@
 class EE_CVV_Input extends EE_Text_Input
 {
 
-    /**
-     * @param array $input_settings {
-     *  @type boolean $include_whats_this_link defaults to true
-     * }
-     */
-    public function __construct($input_settings = array())
-    {
-        $this->set_sensitive_data_removal_strategy(new EE_CCV_Sensitive_Data_Removal());
-        $this->_add_validation_strategy(
-            new EE_Text_Validation_Strategy(
-                isset($input_settings['validation_error_message'])
-                    ?  $input_settings['validation_error_message']
-                    : esc_html__(
-                        'The CVV is either a 3 digit number on the back of your card, or 4 digit number on the front',
-                        'event_espresso'
-                    ),
-                '~^\d{3,4}$~'
-            )
-        );
-        parent::__construct($input_settings);
-        if (! isset($input_settings['include_whats_this_link'])
-            || (
-                isset($input_settings['include_whats_this_link'])
-                 && $input_settings['include_whats_this_link'] === true
-            )
-        ) {
-            $this->_html_label_text = sprintf(
-                esc_html_x(
-                    '%1$s %2$s(What\'s this?)%3$s',
-                    'CVV (What\'s this?)',
-                    'event_espresso'
-                ),
-                $this->_html_label_text,
-                '<a href="https://www.cvvnumber.com/" target="_blank" rel="noopener noreferrer">',
-                '</a>'
-            );
-        }
-    }
+	/**
+	 * @param array $input_settings {
+	 *  @type boolean $include_whats_this_link defaults to true
+	 * }
+	 */
+	public function __construct($input_settings = array())
+	{
+		$this->set_sensitive_data_removal_strategy(new EE_CCV_Sensitive_Data_Removal());
+		$this->_add_validation_strategy(
+			new EE_Text_Validation_Strategy(
+				isset($input_settings['validation_error_message'])
+					?  $input_settings['validation_error_message']
+					: esc_html__(
+						'The CVV is either a 3 digit number on the back of your card, or 4 digit number on the front',
+						'event_espresso'
+					),
+				'~^\d{3,4}$~'
+			)
+		);
+		parent::__construct($input_settings);
+		if (! isset($input_settings['include_whats_this_link'])
+			|| (
+				isset($input_settings['include_whats_this_link'])
+				 && $input_settings['include_whats_this_link'] === true
+			)
+		) {
+			$this->_html_label_text = sprintf(
+				esc_html_x(
+					'%1$s %2$s(What\'s this?)%3$s',
+					'CVV (What\'s this?)',
+					'event_espresso'
+				),
+				$this->_html_label_text,
+				'<a href="https://www.cvvnumber.com/" target="_blank" rel="noopener noreferrer">',
+				'</a>'
+			);
+		}
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -22,7 +22,7 @@ 
         $this->_add_validation_strategy(
             new EE_Text_Validation_Strategy(
                 isset($input_settings['validation_error_message'])
-                    ?  $input_settings['validation_error_message']
+                    ? $input_settings['validation_error_message']
                     : esc_html__(
                         'The CVV is either a 3 digit number on the back of your card, or 4 digit number on the front',
                         'event_espresso'
@@ -31,7 +31,7 @@ 
             )
         );
         parent::__construct($input_settings);
-        if (! isset($input_settings['include_whats_this_link'])
+        if ( ! isset($input_settings['include_whats_this_link'])
             || (
                 isset($input_settings['include_whats_this_link'])
                  && $input_settings['include_whats_this_link'] === true

core/helpers/EEH_Maps.helper.php

Indentation +169 added lines, -169 removed lines

@@ -12,173 +12,173 @@
 class EEH_Maps
 {
 
-    // array of map settings
-    public static $gmap_vars = array();
-
-
-    /**
-     * google_map - creates a Google Map Link
-     *
-     * @param  array $ee_gmaps_opts array of attributes required for the map link generation
-     * @return string (link to map!)
-     */
-    public static function google_map($ee_gmaps_opts)
-    {
-
-        $ee_map_width        = ! empty($ee_gmaps_opts['ee_map_width']) ? $ee_gmaps_opts['ee_map_width'] : '300';
-        $ee_map_height       = ! empty($ee_gmaps_opts['ee_map_height']) ? $ee_gmaps_opts['ee_map_height'] : '185';
-        $ee_map_zoom         = ! empty($ee_gmaps_opts['ee_map_zoom']) ? $ee_gmaps_opts['ee_map_zoom'] : '12';
-        $ee_map_nav_display  = ! empty($ee_gmaps_opts['ee_map_nav_display']) ? 'true' : 'false';
-        $ee_map_nav_size     = ! empty($ee_gmaps_opts['ee_map_nav_size'])
-            ? $ee_gmaps_opts['ee_map_nav_size']
-            : 'default';
-        $ee_map_type_control = ! empty($ee_gmaps_opts['ee_map_type_control'])
-            ? $ee_gmaps_opts['ee_map_type_control']
-            : 'default';
-        $static_url          = ! empty($ee_gmaps_opts['ee_static_url']) ? $ee_gmaps_opts['ee_static_url'] : false;
-
-        if (! empty($ee_gmaps_opts['ee_map_align'])) {
-            switch ($ee_gmaps_opts['ee_map_align']) {
-                case "left":
-                    $map_align = 'ee-gmap-align-left left';
-                    break;
-                case "right":
-                    $map_align = 'ee-gmap-align-right right';
-                    break;
-                case "center":
-                    $map_align = 'ee-gmap-align-center center';
-                    break;
-                case "none":
-                default:
-                    $map_align = 'ee-gmap-align-none';
-            }
-        } else {
-            $map_align = 'ee-gmap-align-none';
-        }
-
-
-        // Determine whether user has set a hardoded url to use and
-        // if so display a Google static iframe map else run V3 api
-        if ($static_url) {
-            $html = '<div class="ee-gmap-iframewrap ee-gmap-wrapper ' . $map_align . '">';
-            $html .= '<iframe src="' . $static_url . '&output=embed"'
-                . ' style="width: ' . $ee_map_width . 'px; height: ' . $ee_map_height . 'px;"'
-                . ' frameborder="0" scrolling="no">';
-            $html .= '</iframe>';
-            $html .= '<a href="' . $static_url . '">View Large map</a>';
-            $html .= '</div>';
-            return $html;
-        } else {
-            EEH_Maps::$gmap_vars[ $ee_gmaps_opts['map_ID'] ] = array(
-                'map_ID'              => $ee_gmaps_opts['map_ID'],
-                'ee_map_zoom'         => $ee_map_zoom,
-                'ee_map_nav_display'  => $ee_map_nav_display,
-                'ee_map_nav_size'     => $ee_map_nav_size,
-                'ee_map_type_control' => $ee_map_type_control,
-                'location'            => $ee_gmaps_opts['location'],
-            );
-
-            $style = 'width: ' . $ee_map_width . 'px; height: ' . $ee_map_height . 'px;';
-            $html = '<div class="ee-gmap-wrapper ' . $map_align . '">'
-                    . '<div class="ee-gmap" id="map_canvas_' . $ee_gmaps_opts['map_ID'] . '"'
-                    . ' style="' . $style . '"></div>'
-                    . '</div>';
-
-            wp_enqueue_script('gmap_api');
-            wp_enqueue_script('ee_gmap');
-            add_action('wp_footer', array('EEH_Maps', 'footer_enqueue_script'));
-
-            return $html;
-        } // end auto map or static url map check
-    }
-
-
-    /**
-     * enqueue_script
-     *
-     * @return void
-     */
-    public static function footer_enqueue_script()
-    {
-        wp_localize_script('ee_gmap', 'ee_gmap_vars', EEH_Maps::$gmap_vars);
-    }
-
-
-    /**
-     * registers scripts for maps
-     */
-    public static function espresso_google_map_js()
-    {
-        $api_url = sprintf(
-            "https://maps.googleapis.com/maps/api/js?key=%s",
-            apply_filters(
-                'FHEE__EEH_Maps__espresso_google_maps_js__api_key',
-                EE_Registry::instance()->CFG->map_settings->google_map_api_key
-            )
-        );
-        wp_register_script('gmap_api', $api_url, array('jquery'), null, true);
-        wp_register_script('ee_gmap', plugin_dir_url(__FILE__) . 'assets/ee_gmap.js', array('gmap_api'), '1.0', true);
-    }
-
-    /**
-     * creates a Google Map Link
-     *
-     * @param  array $atts array of attributes required for the map link generation
-     * @return string (link to map!)
-     */
-    public static function google_map_link($atts)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        extract($atts);
-        /** @var string $address */
-        /** @var string $city */
-        /** @var string $state */
-        /** @var string $zip */
-        /** @var string $country */
-        $address         = "{$address}";
-        $city            = "{$city}";
-        $state           = "{$state}";
-        $zip             = "{$zip}";
-        $country         = "{$country}";
-        $text            = isset($text) ? "{$text}" : "";
-        $type            = isset($type) ? "{$type}" : "";
-        $map_w           = isset($map_w) ? "{$map_w}" : 400;
-        $map_h           = isset($map_h) ? "{$map_h}" : 400;
-        $id              = isset($id) ? $id : 'not_set';
-        $map_image_class = isset($map_image_class) ? $map_image_class : 'ee_google_map_view';
-
-        $address_string = ($address != '' ? $address : '')
-                          . ($city != '' ? ',' . $city : '')
-                          . ($state != '' ? ',' . $state : '')
-                          . ($zip != '' ? ',' . $zip : '')
-                          . ($country != '' ? ',' . $country : '');
-
-        $google_map = htmlentities2('http://maps.google.com/maps?q=' . urlencode($address_string));
-
-        switch ($type) {
-            case 'text':
-            default:
-                $text = $text == '' ? esc_html__('Map and Directions', 'event_espresso') : $text;
-                break;
-
-            case 'url_only':
-            case 'url':
-                $text = $google_map;
-                break;
-
-            case 'map':
-                $scheme = is_ssl() ? 'https://' : 'http://';
-
-                $api_key = apply_filters(
-                    'FHEE__EEH_Maps__espresso_google_maps_link__api_key',
-                    EE_Registry::instance()->CFG->map_settings->google_map_api_key
-                );
-
-                return '<a class="a_map_image_link" href="' . $google_map . '" target="_blank" rel="noopener noreferrer">' . '<img class="map_image_link" id="venue_map_' . $id . '" ' . $map_image_class . ' src="' . htmlentities2($scheme . 'maps.googleapis.com/maps/api/staticmap?center=' . urlencode($address_string) . '&amp;zoom=14&amp;size=' . $map_w . 'x' . $map_h . '&amp;markers=color:green|label:|' . urlencode($address_string) . '&amp;sensor=false&amp;key=' . $api_key) . '" /></a>';
-        }
-
-        return $type === 'url_only'
-            ? $text
-            : '<a href="' . $google_map . '" target="_blank" rel="noopener noreferrer">' . $text . '</a>';
-    }
+	// array of map settings
+	public static $gmap_vars = array();
+
+
+	/**
+	 * google_map - creates a Google Map Link
+	 *
+	 * @param  array $ee_gmaps_opts array of attributes required for the map link generation
+	 * @return string (link to map!)
+	 */
+	public static function google_map($ee_gmaps_opts)
+	{
+
+		$ee_map_width        = ! empty($ee_gmaps_opts['ee_map_width']) ? $ee_gmaps_opts['ee_map_width'] : '300';
+		$ee_map_height       = ! empty($ee_gmaps_opts['ee_map_height']) ? $ee_gmaps_opts['ee_map_height'] : '185';
+		$ee_map_zoom         = ! empty($ee_gmaps_opts['ee_map_zoom']) ? $ee_gmaps_opts['ee_map_zoom'] : '12';
+		$ee_map_nav_display  = ! empty($ee_gmaps_opts['ee_map_nav_display']) ? 'true' : 'false';
+		$ee_map_nav_size     = ! empty($ee_gmaps_opts['ee_map_nav_size'])
+			? $ee_gmaps_opts['ee_map_nav_size']
+			: 'default';
+		$ee_map_type_control = ! empty($ee_gmaps_opts['ee_map_type_control'])
+			? $ee_gmaps_opts['ee_map_type_control']
+			: 'default';
+		$static_url          = ! empty($ee_gmaps_opts['ee_static_url']) ? $ee_gmaps_opts['ee_static_url'] : false;
+
+		if (! empty($ee_gmaps_opts['ee_map_align'])) {
+			switch ($ee_gmaps_opts['ee_map_align']) {
+				case "left":
+					$map_align = 'ee-gmap-align-left left';
+					break;
+				case "right":
+					$map_align = 'ee-gmap-align-right right';
+					break;
+				case "center":
+					$map_align = 'ee-gmap-align-center center';
+					break;
+				case "none":
+				default:
+					$map_align = 'ee-gmap-align-none';
+			}
+		} else {
+			$map_align = 'ee-gmap-align-none';
+		}
+
+
+		// Determine whether user has set a hardoded url to use and
+		// if so display a Google static iframe map else run V3 api
+		if ($static_url) {
+			$html = '<div class="ee-gmap-iframewrap ee-gmap-wrapper ' . $map_align . '">';
+			$html .= '<iframe src="' . $static_url . '&output=embed"'
+				. ' style="width: ' . $ee_map_width . 'px; height: ' . $ee_map_height . 'px;"'
+				. ' frameborder="0" scrolling="no">';
+			$html .= '</iframe>';
+			$html .= '<a href="' . $static_url . '">View Large map</a>';
+			$html .= '</div>';
+			return $html;
+		} else {
+			EEH_Maps::$gmap_vars[ $ee_gmaps_opts['map_ID'] ] = array(
+				'map_ID'              => $ee_gmaps_opts['map_ID'],
+				'ee_map_zoom'         => $ee_map_zoom,
+				'ee_map_nav_display'  => $ee_map_nav_display,
+				'ee_map_nav_size'     => $ee_map_nav_size,
+				'ee_map_type_control' => $ee_map_type_control,
+				'location'            => $ee_gmaps_opts['location'],
+			);
+
+			$style = 'width: ' . $ee_map_width . 'px; height: ' . $ee_map_height . 'px;';
+			$html = '<div class="ee-gmap-wrapper ' . $map_align . '">'
+					. '<div class="ee-gmap" id="map_canvas_' . $ee_gmaps_opts['map_ID'] . '"'
+					. ' style="' . $style . '"></div>'
+					. '</div>';
+
+			wp_enqueue_script('gmap_api');
+			wp_enqueue_script('ee_gmap');
+			add_action('wp_footer', array('EEH_Maps', 'footer_enqueue_script'));
+
+			return $html;
+		} // end auto map or static url map check
+	}
+
+
+	/**
+	 * enqueue_script
+	 *
+	 * @return void
+	 */
+	public static function footer_enqueue_script()
+	{
+		wp_localize_script('ee_gmap', 'ee_gmap_vars', EEH_Maps::$gmap_vars);
+	}
+
+
+	/**
+	 * registers scripts for maps
+	 */
+	public static function espresso_google_map_js()
+	{
+		$api_url = sprintf(
+			"https://maps.googleapis.com/maps/api/js?key=%s",
+			apply_filters(
+				'FHEE__EEH_Maps__espresso_google_maps_js__api_key',
+				EE_Registry::instance()->CFG->map_settings->google_map_api_key
+			)
+		);
+		wp_register_script('gmap_api', $api_url, array('jquery'), null, true);
+		wp_register_script('ee_gmap', plugin_dir_url(__FILE__) . 'assets/ee_gmap.js', array('gmap_api'), '1.0', true);
+	}
+
+	/**
+	 * creates a Google Map Link
+	 *
+	 * @param  array $atts array of attributes required for the map link generation
+	 * @return string (link to map!)
+	 */
+	public static function google_map_link($atts)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		extract($atts);
+		/** @var string $address */
+		/** @var string $city */
+		/** @var string $state */
+		/** @var string $zip */
+		/** @var string $country */
+		$address         = "{$address}";
+		$city            = "{$city}";
+		$state           = "{$state}";
+		$zip             = "{$zip}";
+		$country         = "{$country}";
+		$text            = isset($text) ? "{$text}" : "";
+		$type            = isset($type) ? "{$type}" : "";
+		$map_w           = isset($map_w) ? "{$map_w}" : 400;
+		$map_h           = isset($map_h) ? "{$map_h}" : 400;
+		$id              = isset($id) ? $id : 'not_set';
+		$map_image_class = isset($map_image_class) ? $map_image_class : 'ee_google_map_view';
+
+		$address_string = ($address != '' ? $address : '')
+						  . ($city != '' ? ',' . $city : '')
+						  . ($state != '' ? ',' . $state : '')
+						  . ($zip != '' ? ',' . $zip : '')
+						  . ($country != '' ? ',' . $country : '');
+
+		$google_map = htmlentities2('http://maps.google.com/maps?q=' . urlencode($address_string));
+
+		switch ($type) {
+			case 'text':
+			default:
+				$text = $text == '' ? esc_html__('Map and Directions', 'event_espresso') : $text;
+				break;
+
+			case 'url_only':
+			case 'url':
+				$text = $google_map;
+				break;
+
+			case 'map':
+				$scheme = is_ssl() ? 'https://' : 'http://';
+
+				$api_key = apply_filters(
+					'FHEE__EEH_Maps__espresso_google_maps_link__api_key',
+					EE_Registry::instance()->CFG->map_settings->google_map_api_key
+				);
+
+				return '<a class="a_map_image_link" href="' . $google_map . '" target="_blank" rel="noopener noreferrer">' . '<img class="map_image_link" id="venue_map_' . $id . '" ' . $map_image_class . ' src="' . htmlentities2($scheme . 'maps.googleapis.com/maps/api/staticmap?center=' . urlencode($address_string) . '&amp;zoom=14&amp;size=' . $map_w . 'x' . $map_h . '&amp;markers=color:green|label:|' . urlencode($address_string) . '&amp;sensor=false&amp;key=' . $api_key) . '" /></a>';
+		}
+
+		return $type === 'url_only'
+			? $text
+			: '<a href="' . $google_map . '" target="_blank" rel="noopener noreferrer">' . $text . '</a>';
+	}
 }

Spacing +18 added lines, -18 removed lines

@@ -37,7 +37,7 @@ 
             : 'default';
         $static_url          = ! empty($ee_gmaps_opts['ee_static_url']) ? $ee_gmaps_opts['ee_static_url'] : false;
 
-        if (! empty($ee_gmaps_opts['ee_map_align'])) {
+        if ( ! empty($ee_gmaps_opts['ee_map_align'])) {
             switch ($ee_gmaps_opts['ee_map_align']) {
                 case "left":
                     $map_align = 'ee-gmap-align-left left';
@@ -60,16 +60,16 @@ 
         // Determine whether user has set a hardoded url to use and
         // if so display a Google static iframe map else run V3 api
         if ($static_url) {
-            $html = '<div class="ee-gmap-iframewrap ee-gmap-wrapper ' . $map_align . '">';
-            $html .= '<iframe src="' . $static_url . '&output=embed"'
-                . ' style="width: ' . $ee_map_width . 'px; height: ' . $ee_map_height . 'px;"'
+            $html = '<div class="ee-gmap-iframewrap ee-gmap-wrapper '.$map_align.'">';
+            $html .= '<iframe src="'.$static_url.'&output=embed"'
+                . ' style="width: '.$ee_map_width.'px; height: '.$ee_map_height.'px;"'
                 . ' frameborder="0" scrolling="no">';
             $html .= '</iframe>';
-            $html .= '<a href="' . $static_url . '">View Large map</a>';
+            $html .= '<a href="'.$static_url.'">View Large map</a>';
             $html .= '</div>';
             return $html;
         } else {
-            EEH_Maps::$gmap_vars[ $ee_gmaps_opts['map_ID'] ] = array(
+            EEH_Maps::$gmap_vars[$ee_gmaps_opts['map_ID']] = array(
                 'map_ID'              => $ee_gmaps_opts['map_ID'],
                 'ee_map_zoom'         => $ee_map_zoom,
                 'ee_map_nav_display'  => $ee_map_nav_display,
@@ -78,10 +78,10 @@ 
                 'location'            => $ee_gmaps_opts['location'],
             );
 
-            $style = 'width: ' . $ee_map_width . 'px; height: ' . $ee_map_height . 'px;';
-            $html = '<div class="ee-gmap-wrapper ' . $map_align . '">'
-                    . '<div class="ee-gmap" id="map_canvas_' . $ee_gmaps_opts['map_ID'] . '"'
-                    . ' style="' . $style . '"></div>'
+            $style = 'width: '.$ee_map_width.'px; height: '.$ee_map_height.'px;';
+            $html = '<div class="ee-gmap-wrapper '.$map_align.'">'
+                    . '<div class="ee-gmap" id="map_canvas_'.$ee_gmaps_opts['map_ID'].'"'
+                    . ' style="'.$style.'"></div>'
                     . '</div>';
 
             wp_enqueue_script('gmap_api');
@@ -117,7 +117,7 @@ 
             )
         );
         wp_register_script('gmap_api', $api_url, array('jquery'), null, true);
-        wp_register_script('ee_gmap', plugin_dir_url(__FILE__) . 'assets/ee_gmap.js', array('gmap_api'), '1.0', true);
+        wp_register_script('ee_gmap', plugin_dir_url(__FILE__).'assets/ee_gmap.js', array('gmap_api'), '1.0', true);
     }
 
     /**
@@ -148,12 +148,12 @@ 
         $map_image_class = isset($map_image_class) ? $map_image_class : 'ee_google_map_view';
 
         $address_string = ($address != '' ? $address : '')
-                          . ($city != '' ? ',' . $city : '')
-                          . ($state != '' ? ',' . $state : '')
-                          . ($zip != '' ? ',' . $zip : '')
-                          . ($country != '' ? ',' . $country : '');
+                          . ($city != '' ? ','.$city : '')
+                          . ($state != '' ? ','.$state : '')
+                          . ($zip != '' ? ','.$zip : '')
+                          . ($country != '' ? ','.$country : '');
 
-        $google_map = htmlentities2('http://maps.google.com/maps?q=' . urlencode($address_string));
+        $google_map = htmlentities2('http://maps.google.com/maps?q='.urlencode($address_string));
 
         switch ($type) {
             case 'text':
@@ -174,11 +174,11 @@ 
                     EE_Registry::instance()->CFG->map_settings->google_map_api_key
                 );
 
-                return '<a class="a_map_image_link" href="' . $google_map . '" target="_blank" rel="noopener noreferrer">' . '<img class="map_image_link" id="venue_map_' . $id . '" ' . $map_image_class . ' src="' . htmlentities2($scheme . 'maps.googleapis.com/maps/api/staticmap?center=' . urlencode($address_string) . '&amp;zoom=14&amp;size=' . $map_w . 'x' . $map_h . '&amp;markers=color:green|label:|' . urlencode($address_string) . '&amp;sensor=false&amp;key=' . $api_key) . '" /></a>';
+                return '<a class="a_map_image_link" href="'.$google_map.'" target="_blank" rel="noopener noreferrer">'.'<img class="map_image_link" id="venue_map_'.$id.'" '.$map_image_class.' src="'.htmlentities2($scheme.'maps.googleapis.com/maps/api/staticmap?center='.urlencode($address_string).'&amp;zoom=14&amp;size='.$map_w.'x'.$map_h.'&amp;markers=color:green|label:|'.urlencode($address_string).'&amp;sensor=false&amp;key='.$api_key).'" /></a>';
         }
 
         return $type === 'url_only'
             ? $text
-            : '<a href="' . $google_map . '" target="_blank" rel="noopener noreferrer">' . $text . '</a>';
+            : '<a href="'.$google_map.'" target="_blank" rel="noopener noreferrer">'.$text.'</a>';
     }
 }