eventespresso / event-espresso-core

core/domain/values/FilePath.php

Indentation +36 added lines, -36 removed lines

@@ -20,42 +20,42 @@
 class FilePath
 {
 
-    /**
-     * @var string file_path
-     */
-    private $file_path;
-
-
-    /**
-     * FilePath constructor.
-     *
-     * @param string $file_path
-     * @throws InvalidDataTypeException
-     * @throws InvalidFilePathException
-     */
-    public function __construct($file_path)
-    {
-        if (! is_string($file_path)) {
-            throw new InvalidDataTypeException(
-                '$file_path',
-                $file_path,
-                'string'
-            );
-        }
-        if (! is_readable($file_path)) {
-            throw new InvalidFilePathException($file_path);
-        }
-        $this->file_path = $file_path;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function __toString()
-    {
-        return $this->file_path;
-    }
+	/**
+	 * @var string file_path
+	 */
+	private $file_path;
+
+
+	/**
+	 * FilePath constructor.
+	 *
+	 * @param string $file_path
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidFilePathException
+	 */
+	public function __construct($file_path)
+	{
+		if (! is_string($file_path)) {
+			throw new InvalidDataTypeException(
+				'$file_path',
+				$file_path,
+				'string'
+			);
+		}
+		if (! is_readable($file_path)) {
+			throw new InvalidFilePathException($file_path);
+		}
+		$this->file_path = $file_path;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return $this->file_path;
+	}
 
 
 }

Spacing +2 added lines, -2 removed lines

@@ -35,14 +35,14 @@
      */
     public function __construct($file_path)
     {
-        if (! is_string($file_path)) {
+        if ( ! is_string($file_path)) {
             throw new InvalidDataTypeException(
                 '$file_path',
                 $file_path,
                 'string'
             );
         }
-        if (! is_readable($file_path)) {
+        if ( ! is_readable($file_path)) {
             throw new InvalidFilePathException($file_path);
         }
         $this->file_path = $file_path;

core/domain/values/FullyQualifiedName.php

Spacing +2 added lines, -2 removed lines

@@ -37,14 +37,14 @@
      */
     public function __construct($fully_qualified_name)
     {
-        if (! is_string($fully_qualified_name)) {
+        if ( ! is_string($fully_qualified_name)) {
             throw new InvalidDataTypeException(
                 '$fully_qualified_name',
                 $fully_qualified_name,
                 'string'
             );
         }
-        if (! class_exists($fully_qualified_name) && ! interface_exists($fully_qualified_name)) {
+        if ( ! class_exists($fully_qualified_name) && ! interface_exists($fully_qualified_name)) {
             if (strpos($fully_qualified_name, 'Interface') !== false) {
                 throw new InvalidInterfaceException($fully_qualified_name);
             }

Indentation +43 added lines, -43 removed lines

@@ -21,54 +21,54 @@
 class FullyQualifiedName
 {
 
-    /**
-     * @var string $fully_qualified_name
-     */
-    private $fully_qualified_name;
+	/**
+	 * @var string $fully_qualified_name
+	 */
+	private $fully_qualified_name;
 
 
-    /**
-     * FullyQualifiedName constructor.
-     *
-     * @param string $fully_qualified_name
-     * @throws InvalidClassException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public function __construct($fully_qualified_name)
-    {
-        if (! is_string($fully_qualified_name)) {
-            throw new InvalidDataTypeException(
-                '$fully_qualified_name',
-                $fully_qualified_name,
-                'string'
-            );
-        }
-        if (! class_exists($fully_qualified_name) && ! interface_exists($fully_qualified_name)) {
-            if (strpos($fully_qualified_name, 'Interface') !== false) {
-                throw new InvalidInterfaceException($fully_qualified_name);
-            }
-            throw new InvalidClassException($fully_qualified_name);
-        }
-        $this->fully_qualified_name = $fully_qualified_name;
-    }
+	/**
+	 * FullyQualifiedName constructor.
+	 *
+	 * @param string $fully_qualified_name
+	 * @throws InvalidClassException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct($fully_qualified_name)
+	{
+		if (! is_string($fully_qualified_name)) {
+			throw new InvalidDataTypeException(
+				'$fully_qualified_name',
+				$fully_qualified_name,
+				'string'
+			);
+		}
+		if (! class_exists($fully_qualified_name) && ! interface_exists($fully_qualified_name)) {
+			if (strpos($fully_qualified_name, 'Interface') !== false) {
+				throw new InvalidInterfaceException($fully_qualified_name);
+			}
+			throw new InvalidClassException($fully_qualified_name);
+		}
+		$this->fully_qualified_name = $fully_qualified_name;
+	}
 
 
-    /**
-     * @return string
-     */
-    public function string()
-    {
-        return $this->fully_qualified_name;
-    }
+	/**
+	 * @return string
+	 */
+	public function string()
+	{
+		return $this->fully_qualified_name;
+	}
 
 
-    /**
-     * @return string
-     */
-    public function __toString()
-    {
-        return $this->fully_qualified_name;
-    }
+	/**
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return $this->fully_qualified_name;
+	}
 
 }

core/domain/DomainBase.php

Doc Comments +1 added lines, -1 removed lines

@@ -121,7 +121,7 @@
 
 
     /**
-     * @return Version
+     * @return string
      */
     public function versionValueObject()
     {

Spacing +2 added lines, -2 removed lines

@@ -136,7 +136,7 @@ 
      */
     public function distributionAssetsPath()
     {
-        return $this->pluginPath() . 'assets/dist/';
+        return $this->pluginPath().'assets/dist/';
     }
 
 
@@ -145,7 +145,7 @@ 
      */
     public function distributionAssetsUrl()
     {
-        return $this->pluginUrl() . 'assets/dist/';
+        return $this->pluginUrl().'assets/dist/';
     }
 
 

Unused Use Statements -1 removed lines

@@ -4,7 +4,6 @@
 
 use EventEspresso\core\domain\values\FilePath;
 use EventEspresso\core\domain\values\Version;
-use EventEspresso\core\services\assets\Registry;
 
 /**
  * DomainBase Class

Indentation +149 added lines, -149 removed lines

@@ -16,153 +16,153 @@
 abstract class DomainBase implements DomainInterface
 {
 
-    /**
-     * Equivalent to `__FILE__` for main plugin file.
-     *
-     * @var FilePath
-     */
-    private $plugin_file;
-
-    /**
-     * String indicating version for plugin
-     *
-     * @var string
-     */
-    private $version;
-
-    /**
-     * @var string $plugin_basename
-     */
-    private $plugin_basename;
-
-    /**
-     * @var string $plugin_path
-     */
-    private $plugin_path;
-
-    /**
-     * @var string $plugin_url
-     */
-    private $plugin_url;
-
-    /**
-     * @var string $asset_namespace
-     */
-    private $asset_namespace;
-
-
-
-    /**
-     * Initializes internal properties.
-     *
-     * @param FilePath $plugin_file
-     * @param Version  $version
-     */
-    public function __construct(FilePath $plugin_file, Version $version)
-    {
-        $this->plugin_file = $plugin_file;
-        $this->version = $version;
-        $this->plugin_basename = plugin_basename($this->pluginFile());
-        $this->plugin_path = plugin_dir_path($this->pluginFile());
-        $this->plugin_url = plugin_dir_url($this->pluginFile());
-        $this->setAssetNamespace();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function pluginFile()
-    {
-        return (string) $this->plugin_file;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function pluginBasename()
-    {
-        return $this->plugin_basename;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function pluginPath()
-    {
-        return $this->plugin_path;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function pluginUrl()
-    {
-        return $this->plugin_url;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function version()
-    {
-        return (string) $this->version;
-    }
-
-
-
-    /**
-     * @return Version
-     */
-    public function versionValueObject()
-    {
-        return $this->version;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function distributionAssetsPath()
-    {
-        return $this->pluginPath() . 'assets/dist/';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function distributionAssetsUrl()
-    {
-        return $this->pluginUrl() . 'assets/dist/';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function assetNamespace()
-    {
-        return $this->asset_namespace;
-    }
-
-
-    /**
-     * @return void
-     */
-    private function setAssetNamespace()
-    {
-        $this->asset_namespace = sanitize_key(
-            // convert directory separators to dashes and remove file extension
-            str_replace(array('/', '.php'), array('-', ''), $this->plugin_basename)
-        );
-    }
+	/**
+	 * Equivalent to `__FILE__` for main plugin file.
+	 *
+	 * @var FilePath
+	 */
+	private $plugin_file;
+
+	/**
+	 * String indicating version for plugin
+	 *
+	 * @var string
+	 */
+	private $version;
+
+	/**
+	 * @var string $plugin_basename
+	 */
+	private $plugin_basename;
+
+	/**
+	 * @var string $plugin_path
+	 */
+	private $plugin_path;
+
+	/**
+	 * @var string $plugin_url
+	 */
+	private $plugin_url;
+
+	/**
+	 * @var string $asset_namespace
+	 */
+	private $asset_namespace;
+
+
+
+	/**
+	 * Initializes internal properties.
+	 *
+	 * @param FilePath $plugin_file
+	 * @param Version  $version
+	 */
+	public function __construct(FilePath $plugin_file, Version $version)
+	{
+		$this->plugin_file = $plugin_file;
+		$this->version = $version;
+		$this->plugin_basename = plugin_basename($this->pluginFile());
+		$this->plugin_path = plugin_dir_path($this->pluginFile());
+		$this->plugin_url = plugin_dir_url($this->pluginFile());
+		$this->setAssetNamespace();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function pluginFile()
+	{
+		return (string) $this->plugin_file;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function pluginBasename()
+	{
+		return $this->plugin_basename;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function pluginPath()
+	{
+		return $this->plugin_path;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function pluginUrl()
+	{
+		return $this->plugin_url;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function version()
+	{
+		return (string) $this->version;
+	}
+
+
+
+	/**
+	 * @return Version
+	 */
+	public function versionValueObject()
+	{
+		return $this->version;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function distributionAssetsPath()
+	{
+		return $this->pluginPath() . 'assets/dist/';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function distributionAssetsUrl()
+	{
+		return $this->pluginUrl() . 'assets/dist/';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function assetNamespace()
+	{
+		return $this->asset_namespace;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function setAssetNamespace()
+	{
+		$this->asset_namespace = sanitize_key(
+			// convert directory separators to dashes and remove file extension
+			str_replace(array('/', '.php'), array('-', ''), $this->plugin_basename)
+		);
+	}
 }

core/domain/entities/contexts/RequestTypeContext.php

Spacing +1 added lines, -1 removed lines

@@ -91,7 +91,7 @@
     public function __construct($slug, $description)
     {
         parent::__construct($slug, $description);
-        if (! in_array($this->slug(), $this->validRequestTypes(), true)) {
+        if ( ! in_array($this->slug(), $this->validRequestTypes(), true)) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__(

Indentation +151 added lines, -151 removed lines

@@ -16,155 +16,155 @@
 class RequestTypeContext extends Context
 {
 
-    /**
-     * indicates that the current request involves some form of activation
-     */
-    const ACTIVATION = 'activation-request';
-
-    /**
-     * indicates that the current request is for the admin but is not being made via AJAX
-     */
-    const ADMIN = 'non-ajax-admin-request';
-
-    /**
-     * indicates that the current request is for the admin AND is being made via AJAX
-     */
-    const AJAX_ADMIN = 'admin-ajax-request';
-
-    /**
-     * indicates that the current request is for the frontend AND is being made via AJAX
-     */
-    const AJAX_FRONT = 'frontend-ajax-request';
-
-    /**
-     * indicates that the current request is for the WP Heartbeat
-     */
-    const AJAX_HEARTBEAT = 'admin-ajax-heartbeat';
-
-    /**
-     * indicates that the current request is being made via AJAX, but is NOT for EE
-     */
-    const AJAX_OTHER = 'other-ajax-request';
-
-    /**
-     * indicates that the current request is for the EE REST API
-     */
-    const API = 'rest-api';
-
-    /**
-     * indicates that the current request is from the command line
-     */
-    const CLI = 'command-line';
-
-    /**
-     * indicates that the current request is for a WP_Cron
-     */
-    const CRON = 'wp-cron';
-
-    /**
-     * indicates that the current request is for a feed (ie: RSS)
-     */
-    const FEED = 'feed-request';
-
-    /**
-     * indicates that the current request is for the frontend but is not being made via AJAX
-     */
-    const FRONTEND = 'non-ajax-frontend-request';
-
-    /**
-     * indicates that the current request is for content that is to be displayed within an iframe
-     */
-    const IFRAME = 'iframe-request';
-
-    /**
-     * indicates that the current request is for the WP REST API
-     */
-    const WP_API = 'wp-rest-api';
-
-    /**
-     * indicates that the current request is a loopback sent from WP core to test for errors
-     */
-    const WP_SCRAPE = 'wordpress-scrape';
-
-    /**
-     * @var boolean $is_activation
-     */
-    private $is_activation = false;
-
-    /**
-     * @var array $valid_request_types
-     */
-    private $valid_request_types = array();
-
-
-    /**
-     * RequestTypeContext constructor.
-     *
-     * @param string $slug
-     * @param string $description
-     * @throws InvalidArgumentException
-     */
-    public function __construct($slug, $description)
-    {
-        parent::__construct($slug, $description);
-        if (! in_array($this->slug(), $this->validRequestTypes(), true)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'The RequestTypeContext slug must be one of the following values: %1$s %2$s',
-                        'event_espresso'
-                    ),
-                    var_export($this->validRequestTypes(), true)
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return array
-     */
-    public function validRequestTypes()
-    {
-        if (empty($this->valid_request_types)) {
-            $this->valid_request_types = apply_filters(
-                'FHEE__EventEspresso_core_domain_entities_contexts_RequestTypeContext__validRequestTypes',
-                array(
-                    RequestTypeContext::ACTIVATION,
-                    RequestTypeContext::ADMIN,
-                    RequestTypeContext::AJAX_ADMIN,
-                    RequestTypeContext::AJAX_FRONT,
-                    RequestTypeContext::AJAX_HEARTBEAT,
-                    RequestTypeContext::AJAX_OTHER,
-                    RequestTypeContext::API,
-                    RequestTypeContext::CLI,
-                    RequestTypeContext::CRON,
-                    RequestTypeContext::FEED,
-                    RequestTypeContext::FRONTEND,
-                    RequestTypeContext::IFRAME,
-                    RequestTypeContext::WP_API,
-                    RequestTypeContext::WP_SCRAPE,
-                )
-            );
-        }
-        return $this->valid_request_types;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isActivation()
-    {
-        return $this->is_activation;
-    }
-
-
-    /**
-     * @param bool $is_activation
-     */
-    public function setIsActivation($is_activation)
-    {
-        $this->is_activation = filter_var($is_activation, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * indicates that the current request involves some form of activation
+	 */
+	const ACTIVATION = 'activation-request';
+
+	/**
+	 * indicates that the current request is for the admin but is not being made via AJAX
+	 */
+	const ADMIN = 'non-ajax-admin-request';
+
+	/**
+	 * indicates that the current request is for the admin AND is being made via AJAX
+	 */
+	const AJAX_ADMIN = 'admin-ajax-request';
+
+	/**
+	 * indicates that the current request is for the frontend AND is being made via AJAX
+	 */
+	const AJAX_FRONT = 'frontend-ajax-request';
+
+	/**
+	 * indicates that the current request is for the WP Heartbeat
+	 */
+	const AJAX_HEARTBEAT = 'admin-ajax-heartbeat';
+
+	/**
+	 * indicates that the current request is being made via AJAX, but is NOT for EE
+	 */
+	const AJAX_OTHER = 'other-ajax-request';
+
+	/**
+	 * indicates that the current request is for the EE REST API
+	 */
+	const API = 'rest-api';
+
+	/**
+	 * indicates that the current request is from the command line
+	 */
+	const CLI = 'command-line';
+
+	/**
+	 * indicates that the current request is for a WP_Cron
+	 */
+	const CRON = 'wp-cron';
+
+	/**
+	 * indicates that the current request is for a feed (ie: RSS)
+	 */
+	const FEED = 'feed-request';
+
+	/**
+	 * indicates that the current request is for the frontend but is not being made via AJAX
+	 */
+	const FRONTEND = 'non-ajax-frontend-request';
+
+	/**
+	 * indicates that the current request is for content that is to be displayed within an iframe
+	 */
+	const IFRAME = 'iframe-request';
+
+	/**
+	 * indicates that the current request is for the WP REST API
+	 */
+	const WP_API = 'wp-rest-api';
+
+	/**
+	 * indicates that the current request is a loopback sent from WP core to test for errors
+	 */
+	const WP_SCRAPE = 'wordpress-scrape';
+
+	/**
+	 * @var boolean $is_activation
+	 */
+	private $is_activation = false;
+
+	/**
+	 * @var array $valid_request_types
+	 */
+	private $valid_request_types = array();
+
+
+	/**
+	 * RequestTypeContext constructor.
+	 *
+	 * @param string $slug
+	 * @param string $description
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct($slug, $description)
+	{
+		parent::__construct($slug, $description);
+		if (! in_array($this->slug(), $this->validRequestTypes(), true)) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'The RequestTypeContext slug must be one of the following values: %1$s %2$s',
+						'event_espresso'
+					),
+					var_export($this->validRequestTypes(), true)
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function validRequestTypes()
+	{
+		if (empty($this->valid_request_types)) {
+			$this->valid_request_types = apply_filters(
+				'FHEE__EventEspresso_core_domain_entities_contexts_RequestTypeContext__validRequestTypes',
+				array(
+					RequestTypeContext::ACTIVATION,
+					RequestTypeContext::ADMIN,
+					RequestTypeContext::AJAX_ADMIN,
+					RequestTypeContext::AJAX_FRONT,
+					RequestTypeContext::AJAX_HEARTBEAT,
+					RequestTypeContext::AJAX_OTHER,
+					RequestTypeContext::API,
+					RequestTypeContext::CLI,
+					RequestTypeContext::CRON,
+					RequestTypeContext::FEED,
+					RequestTypeContext::FRONTEND,
+					RequestTypeContext::IFRAME,
+					RequestTypeContext::WP_API,
+					RequestTypeContext::WP_SCRAPE,
+				)
+			);
+		}
+		return $this->valid_request_types;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isActivation()
+	{
+		return $this->is_activation;
+	}
+
+
+	/**
+	 * @param bool $is_activation
+	 */
+	public function setIsActivation($is_activation)
+	{
+		$this->is_activation = filter_var($is_activation, FILTER_VALIDATE_BOOLEAN);
+	}
 }

core/helpers/EEH_URL.helper.php

Doc Comments +1 added lines, -1 removed lines

@@ -251,7 +251,7 @@
     /**
      * Identical in functionality to EEH_current_url except it removes any provided query_parameters from it.
      *
-     * @param array $query_parameters An array of query_parameters to remove from the current url.
+     * @param string[] $query_parameters An array of query_parameters to remove from the current url.
      * @since 4.9.46.rc.029
      * @return string
      */

Spacing +22 added lines, -22 removed lines

@@ -29,23 +29,23 @@ 
                 'An error occurred. A URL is a required parameter for the add_query_args_and_nonce method.',
                 'event_espresso'
             );
-            $dev_msg  = $user_msg . "\n"
+            $dev_msg = $user_msg."\n"
                 . sprintf(
                     esc_html__(
                         'In order to dynamically generate nonces for your actions, you need to supply a valid URL as a second parameter for the %s method.',
                         'event_espresso'
                     ),
-                    __CLASS__ . '::add_query_args_and_nonce'
+                    __CLASS__.'::add_query_args_and_nonce'
                 );
-            EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($user_msg.'||'.$dev_msg, __FILE__, __FUNCTION__, __LINE__);
         }
         // check that an action exists and add nonce
-        if (! $exclude_nonce) {
+        if ( ! $exclude_nonce) {
             if (isset($args['action']) && ! empty($args['action'])) {
                 $args = array_merge(
                     $args,
                     array(
-                        $args['action'] . '_nonce' => wp_create_nonce($args['action'] . '_nonce')
+                        $args['action'].'_nonce' => wp_create_nonce($args['action'].'_nonce')
                     )
                 );
             } else {
@@ -87,7 +87,7 @@ 
                 $args
             )
         );
-        if (! $results instanceof WP_Error &&
+        if ( ! $results instanceof WP_Error &&
             isset($results['response']) &&
             isset($results['response']['code']) &&
             $results['response']['code'] == '200') {
@@ -112,25 +112,25 @@ 
         // break apart incoming URL
         $url_bits = parse_url($url);
         // HTTP or HTTPS ?
-        $scheme = isset($url_bits['scheme']) ? $url_bits['scheme'] . '://' : 'http://';
+        $scheme = isset($url_bits['scheme']) ? $url_bits['scheme'].'://' : 'http://';
         // domain
         $host = isset($url_bits['host']) ? $url_bits['host'] : '';
         // if only the base URL is requested, then return that now
         if ($base_url_only) {
-            return $scheme . $host;
+            return $scheme.$host;
         }
-        $port = isset($url_bits['port']) ? ':' . $url_bits['port'] : '';
+        $port = isset($url_bits['port']) ? ':'.$url_bits['port'] : '';
         $user = isset($url_bits['user']) ? $url_bits['user'] : '';
-        $pass = isset($url_bits['pass']) ? ':' . $url_bits['pass'] : '';
-        $pass = ($user || $pass) ? $pass . '@' : '';
+        $pass = isset($url_bits['pass']) ? ':'.$url_bits['pass'] : '';
+        $pass = ($user || $pass) ? $pass.'@' : '';
         $path = isset($url_bits['path']) ? $url_bits['path'] : '';
         // if the query string is not required, then return what we have so far
         if ($remove_query) {
-            return $scheme . $user . $pass . $host . $port . $path;
+            return $scheme.$user.$pass.$host.$port.$path;
         }
-        $query    = isset($url_bits['query']) ? '?' . $url_bits['query'] : '';
-        $fragment = isset($url_bits['fragment']) ? '#' . $url_bits['fragment'] : '';
-        return $scheme . $user . $pass . $host . $port . $path . $query . $fragment;
+        $query    = isset($url_bits['query']) ? '?'.$url_bits['query'] : '';
+        $fragment = isset($url_bits['fragment']) ? '#'.$url_bits['fragment'] : '';
+        return $scheme.$user.$pass.$host.$port.$path.$query.$fragment;
     }
 
 
@@ -150,7 +150,7 @@ 
         // grab query string from URL
         $query = isset($url_bits['query']) ? $url_bits['query'] : '';
         // if we don't want the query string formatted into an array of key => value pairs, then just return it as is
-        if (! $as_array) {
+        if ( ! $as_array) {
             return $query;
         }
         // if no query string exists then just return an empty array now
@@ -166,7 +166,7 @@ 
             // break apart the key value pairs
             $query_args = explode('=', $query_args);
             // and add to our results array
-            $query_params[ $query_args[0] ] = $query_args[1];
+            $query_params[$query_args[0]] = $query_args[1];
         }
         return $query_params;
     }
@@ -195,8 +195,8 @@ 
      */
     public static function generate_unique_token($prefix = '')
     {
-        $token = md5(uniqid() . mt_rand());
-        return $prefix ? $prefix . '_' . $token : $token;
+        $token = md5(uniqid().mt_rand());
+        return $prefix ? $prefix.'_'.$token : $token;
     }
 
 
@@ -216,13 +216,13 @@ 
             'HTTP_HOST'   => 1,
             'PHP_SELF'    => 1,
         );
-        $server_variable  = strtoupper($server_variable);
+        $server_variable = strtoupper($server_variable);
         // whitelist INPUT_SERVER var
-        if (isset($server_variables[ $server_variable ])) {
+        if (isset($server_variables[$server_variable])) {
             $URL = filter_input(INPUT_SERVER, $server_variable, FILTER_SANITIZE_URL, FILTER_NULL_ON_FAILURE);
             if (empty($URL)) {
                 // fallback sanitization if the above fails
-                $URL = wp_sanitize_redirect($_SERVER[ $server_variable ]);
+                $URL = wp_sanitize_redirect($_SERVER[$server_variable]);
             }
         }
         return $URL;

Indentation +260 added lines, -260 removed lines

@@ -12,285 +12,285 @@
 class EEH_URL
 {
 
-    /**
-     * _add_query_arg
-     * adds nonce to array of arguments then calls WP add_query_arg function
-     *
-     * @access public
-     * @param array  $args
-     * @param string $url
-     * @param bool   $exclude_nonce If true then the nonce will be excluded from the generated url.
-     * @return string
-     */
-    public static function add_query_args_and_nonce($args = array(), $url = '', $exclude_nonce = false)
-    {
-        if (empty($url)) {
-            $user_msg = esc_html__(
-                'An error occurred. A URL is a required parameter for the add_query_args_and_nonce method.',
-                'event_espresso'
-            );
-            $dev_msg  = $user_msg . "\n"
-                . sprintf(
-                    esc_html__(
-                        'In order to dynamically generate nonces for your actions, you need to supply a valid URL as a second parameter for the %s method.',
-                        'event_espresso'
-                    ),
-                    __CLASS__ . '::add_query_args_and_nonce'
-                );
-            EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        // check that an action exists and add nonce
-        if (! $exclude_nonce) {
-            if (isset($args['action']) && ! empty($args['action'])) {
-                $args = array_merge(
-                    $args,
-                    array(
-                        $args['action'] . '_nonce' => wp_create_nonce($args['action'] . '_nonce')
-                    )
-                );
-            } else {
-                $args = array_merge(
-                    $args,
-                    array(
-                        'action' => 'default', 'default_nonce' => wp_create_nonce('default_nonce')
-                    )
-                );
-            }
-        }
+	/**
+	 * _add_query_arg
+	 * adds nonce to array of arguments then calls WP add_query_arg function
+	 *
+	 * @access public
+	 * @param array  $args
+	 * @param string $url
+	 * @param bool   $exclude_nonce If true then the nonce will be excluded from the generated url.
+	 * @return string
+	 */
+	public static function add_query_args_and_nonce($args = array(), $url = '', $exclude_nonce = false)
+	{
+		if (empty($url)) {
+			$user_msg = esc_html__(
+				'An error occurred. A URL is a required parameter for the add_query_args_and_nonce method.',
+				'event_espresso'
+			);
+			$dev_msg  = $user_msg . "\n"
+				. sprintf(
+					esc_html__(
+						'In order to dynamically generate nonces for your actions, you need to supply a valid URL as a second parameter for the %s method.',
+						'event_espresso'
+					),
+					__CLASS__ . '::add_query_args_and_nonce'
+				);
+			EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		// check that an action exists and add nonce
+		if (! $exclude_nonce) {
+			if (isset($args['action']) && ! empty($args['action'])) {
+				$args = array_merge(
+					$args,
+					array(
+						$args['action'] . '_nonce' => wp_create_nonce($args['action'] . '_nonce')
+					)
+				);
+			} else {
+				$args = array_merge(
+					$args,
+					array(
+						'action' => 'default', 'default_nonce' => wp_create_nonce('default_nonce')
+					)
+				);
+			}
+		}
 
-        // finally, let's always add a return address (if present) :)
-        $args = ! empty($_REQUEST['action']) && ! isset($_REQUEST['return'])
-            ? array_merge($args, array('return' => $_REQUEST['action']))
-            : $args;
+		// finally, let's always add a return address (if present) :)
+		$args = ! empty($_REQUEST['action']) && ! isset($_REQUEST['return'])
+			? array_merge($args, array('return' => $_REQUEST['action']))
+			: $args;
 
-        return add_query_arg($args, $url);
-    }
+		return add_query_arg($args, $url);
+	}
 
 
-    /**
-     * Returns whether not the remote file exists.
-     * Checking via GET because HEAD requests are blocked on some server configurations.
-     *
-     * @param string  $url
-     * @param array $args  the arguments that should be passed through to the wp_remote_request call.
-     * @return boolean
-     */
-    public static function remote_file_exists($url, $args = array())
-    {
-        $results = wp_remote_request(
-            $url,
-            array_merge(
-                array(
-                    'method'      => 'GET',
-                    'redirection' => 1,
-                ),
-                $args
-            )
-        );
-        if (! $results instanceof WP_Error &&
-            isset($results['response']) &&
-            isset($results['response']['code']) &&
-            $results['response']['code'] == '200') {
-            return true;
-        } else {
-            return false;
-        }
-    }
+	/**
+	 * Returns whether not the remote file exists.
+	 * Checking via GET because HEAD requests are blocked on some server configurations.
+	 *
+	 * @param string  $url
+	 * @param array $args  the arguments that should be passed through to the wp_remote_request call.
+	 * @return boolean
+	 */
+	public static function remote_file_exists($url, $args = array())
+	{
+		$results = wp_remote_request(
+			$url,
+			array_merge(
+				array(
+					'method'      => 'GET',
+					'redirection' => 1,
+				),
+				$args
+			)
+		);
+		if (! $results instanceof WP_Error &&
+			isset($results['response']) &&
+			isset($results['response']['code']) &&
+			$results['response']['code'] == '200') {
+			return true;
+		} else {
+			return false;
+		}
+	}
 
 
-    /**
-     * refactor_url
-     * primarily used for removing the query string from a URL
-     *
-     * @param string $url
-     * @param bool   $remove_query  - TRUE (default) will strip off any URL params, ie: ?this=1&that=2
-     * @param bool   $base_url_only - TRUE will only return the scheme and host with no other parameters
-     * @return string
-     */
-    public static function refactor_url($url = '', $remove_query = true, $base_url_only = false)
-    {
-        // break apart incoming URL
-        $url_bits = parse_url($url);
-        // HTTP or HTTPS ?
-        $scheme = isset($url_bits['scheme']) ? $url_bits['scheme'] . '://' : 'http://';
-        // domain
-        $host = isset($url_bits['host']) ? $url_bits['host'] : '';
-        // if only the base URL is requested, then return that now
-        if ($base_url_only) {
-            return $scheme . $host;
-        }
-        $port = isset($url_bits['port']) ? ':' . $url_bits['port'] : '';
-        $user = isset($url_bits['user']) ? $url_bits['user'] : '';
-        $pass = isset($url_bits['pass']) ? ':' . $url_bits['pass'] : '';
-        $pass = ($user || $pass) ? $pass . '@' : '';
-        $path = isset($url_bits['path']) ? $url_bits['path'] : '';
-        // if the query string is not required, then return what we have so far
-        if ($remove_query) {
-            return $scheme . $user . $pass . $host . $port . $path;
-        }
-        $query    = isset($url_bits['query']) ? '?' . $url_bits['query'] : '';
-        $fragment = isset($url_bits['fragment']) ? '#' . $url_bits['fragment'] : '';
-        return $scheme . $user . $pass . $host . $port . $path . $query . $fragment;
-    }
+	/**
+	 * refactor_url
+	 * primarily used for removing the query string from a URL
+	 *
+	 * @param string $url
+	 * @param bool   $remove_query  - TRUE (default) will strip off any URL params, ie: ?this=1&that=2
+	 * @param bool   $base_url_only - TRUE will only return the scheme and host with no other parameters
+	 * @return string
+	 */
+	public static function refactor_url($url = '', $remove_query = true, $base_url_only = false)
+	{
+		// break apart incoming URL
+		$url_bits = parse_url($url);
+		// HTTP or HTTPS ?
+		$scheme = isset($url_bits['scheme']) ? $url_bits['scheme'] . '://' : 'http://';
+		// domain
+		$host = isset($url_bits['host']) ? $url_bits['host'] : '';
+		// if only the base URL is requested, then return that now
+		if ($base_url_only) {
+			return $scheme . $host;
+		}
+		$port = isset($url_bits['port']) ? ':' . $url_bits['port'] : '';
+		$user = isset($url_bits['user']) ? $url_bits['user'] : '';
+		$pass = isset($url_bits['pass']) ? ':' . $url_bits['pass'] : '';
+		$pass = ($user || $pass) ? $pass . '@' : '';
+		$path = isset($url_bits['path']) ? $url_bits['path'] : '';
+		// if the query string is not required, then return what we have so far
+		if ($remove_query) {
+			return $scheme . $user . $pass . $host . $port . $path;
+		}
+		$query    = isset($url_bits['query']) ? '?' . $url_bits['query'] : '';
+		$fragment = isset($url_bits['fragment']) ? '#' . $url_bits['fragment'] : '';
+		return $scheme . $user . $pass . $host . $port . $path . $query . $fragment;
+	}
 
 
-    /**
-     * get_query_string
-     * returns just the query string from a URL, formatted by default into an array of key value pairs
-     *
-     * @param string $url
-     * @param bool   $as_array TRUE (default) will return query params as an array of key value pairs, FALSE will
-     *                         simply return the query string
-     * @return string|array
-     */
-    public static function get_query_string($url = '', $as_array = true)
-    {
-        // decode, then break apart incoming URL
-        $url_bits = parse_url(html_entity_decode($url));
-        // grab query string from URL
-        $query = isset($url_bits['query']) ? $url_bits['query'] : '';
-        // if we don't want the query string formatted into an array of key => value pairs, then just return it as is
-        if (! $as_array) {
-            return $query;
-        }
-        // if no query string exists then just return an empty array now
-        if (empty($query)) {
-            return array();
-        }
-        // empty array to hold results
-        $query_params = array();
-        // now break apart the query string into separate params
-        $query = explode('&', $query);
-        // loop thru our query params
-        foreach ($query as $query_args) {
-            // break apart the key value pairs
-            $query_args = explode('=', $query_args);
-            // and add to our results array
-            $query_params[ $query_args[0] ] = $query_args[1];
-        }
-        return $query_params;
-    }
+	/**
+	 * get_query_string
+	 * returns just the query string from a URL, formatted by default into an array of key value pairs
+	 *
+	 * @param string $url
+	 * @param bool   $as_array TRUE (default) will return query params as an array of key value pairs, FALSE will
+	 *                         simply return the query string
+	 * @return string|array
+	 */
+	public static function get_query_string($url = '', $as_array = true)
+	{
+		// decode, then break apart incoming URL
+		$url_bits = parse_url(html_entity_decode($url));
+		// grab query string from URL
+		$query = isset($url_bits['query']) ? $url_bits['query'] : '';
+		// if we don't want the query string formatted into an array of key => value pairs, then just return it as is
+		if (! $as_array) {
+			return $query;
+		}
+		// if no query string exists then just return an empty array now
+		if (empty($query)) {
+			return array();
+		}
+		// empty array to hold results
+		$query_params = array();
+		// now break apart the query string into separate params
+		$query = explode('&', $query);
+		// loop thru our query params
+		foreach ($query as $query_args) {
+			// break apart the key value pairs
+			$query_args = explode('=', $query_args);
+			// and add to our results array
+			$query_params[ $query_args[0] ] = $query_args[1];
+		}
+		return $query_params;
+	}
 
 
-    /**
-     * prevent_prefetching
-     *
-     * @return void
-     */
-    public static function prevent_prefetching()
-    {
-        // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes
-        // with the registration process
-        remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
-    }
+	/**
+	 * prevent_prefetching
+	 *
+	 * @return void
+	 */
+	public static function prevent_prefetching()
+	{
+		// prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes
+		// with the registration process
+		remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
+	}
 
 
-    /**
-     * This generates a unique site-specific string.
-     * An example usage for this string would be to save as a unique identifier for a record in the db for usage in
-     * urls.
-     *
-     * @param   string $prefix Use this to prefix the string with something.
-     * @return string
-     */
-    public static function generate_unique_token($prefix = '')
-    {
-        $token = md5(uniqid() . mt_rand());
-        return $prefix ? $prefix . '_' . $token : $token;
-    }
+	/**
+	 * This generates a unique site-specific string.
+	 * An example usage for this string would be to save as a unique identifier for a record in the db for usage in
+	 * urls.
+	 *
+	 * @param   string $prefix Use this to prefix the string with something.
+	 * @return string
+	 */
+	public static function generate_unique_token($prefix = '')
+	{
+		$token = md5(uniqid() . mt_rand());
+		return $prefix ? $prefix . '_' . $token : $token;
+	}
 
 
-    /**
-     * filter_input_server_url
-     * uses filter_input() to sanitize one of the INPUT_SERVER URL values
-     * but adds a backup in case filter_input() returns nothing, which can erringly happen on some servers
-     *
-     * @param string $server_variable
-     * @return string
-     */
-    public static function filter_input_server_url($server_variable = 'REQUEST_URI')
-    {
-        $URL              = '';
-        $server_variables = array(
-            'REQUEST_URI' => 1,
-            'HTTP_HOST'   => 1,
-            'PHP_SELF'    => 1,
-        );
-        $server_variable  = strtoupper($server_variable);
-        // whitelist INPUT_SERVER var
-        if (isset($server_variables[ $server_variable ])) {
-            $URL = filter_input(INPUT_SERVER, $server_variable, FILTER_SANITIZE_URL, FILTER_NULL_ON_FAILURE);
-            if (empty($URL)) {
-                // fallback sanitization if the above fails
-                $URL = wp_sanitize_redirect($_SERVER[ $server_variable ]);
-            }
-        }
-        return $URL;
-    }
+	/**
+	 * filter_input_server_url
+	 * uses filter_input() to sanitize one of the INPUT_SERVER URL values
+	 * but adds a backup in case filter_input() returns nothing, which can erringly happen on some servers
+	 *
+	 * @param string $server_variable
+	 * @return string
+	 */
+	public static function filter_input_server_url($server_variable = 'REQUEST_URI')
+	{
+		$URL              = '';
+		$server_variables = array(
+			'REQUEST_URI' => 1,
+			'HTTP_HOST'   => 1,
+			'PHP_SELF'    => 1,
+		);
+		$server_variable  = strtoupper($server_variable);
+		// whitelist INPUT_SERVER var
+		if (isset($server_variables[ $server_variable ])) {
+			$URL = filter_input(INPUT_SERVER, $server_variable, FILTER_SANITIZE_URL, FILTER_NULL_ON_FAILURE);
+			if (empty($URL)) {
+				// fallback sanitization if the above fails
+				$URL = wp_sanitize_redirect($_SERVER[ $server_variable ]);
+			}
+		}
+		return $URL;
+	}
 
 
-    /**
-     * Gets the current page's full URL.
-     *
-     * @return string
-     */
-    public static function current_url()
-    {
-        $url = '';
-        if (isset($_SERVER['HTTP_HOST'], $_SERVER['REQUEST_URI'])) {
-            $url = is_ssl() ? 'https://' : 'http://';
-            $url .= \EEH_URL::filter_input_server_url('HTTP_HOST');
-            $url .= \EEH_URL::filter_input_server_url('REQUEST_URI');
-        }
-        return $url;
-    }
+	/**
+	 * Gets the current page's full URL.
+	 *
+	 * @return string
+	 */
+	public static function current_url()
+	{
+		$url = '';
+		if (isset($_SERVER['HTTP_HOST'], $_SERVER['REQUEST_URI'])) {
+			$url = is_ssl() ? 'https://' : 'http://';
+			$url .= \EEH_URL::filter_input_server_url('HTTP_HOST');
+			$url .= \EEH_URL::filter_input_server_url('REQUEST_URI');
+		}
+		return $url;
+	}
 
 
-    /**
-     * Identical in functionality to EEH_current_url except it removes any provided query_parameters from it.
-     *
-     * @param array $query_parameters An array of query_parameters to remove from the current url.
-     * @since 4.9.46.rc.029
-     * @return string
-     */
-    public static function current_url_without_query_paramaters(array $query_parameters)
-    {
-        return remove_query_arg($query_parameters, EEH_URL::current_url());
-    }
+	/**
+	 * Identical in functionality to EEH_current_url except it removes any provided query_parameters from it.
+	 *
+	 * @param array $query_parameters An array of query_parameters to remove from the current url.
+	 * @since 4.9.46.rc.029
+	 * @return string
+	 */
+	public static function current_url_without_query_paramaters(array $query_parameters)
+	{
+		return remove_query_arg($query_parameters, EEH_URL::current_url());
+	}
 
 
-    /**
-     * @param string $location
-     * @param int    $status
-     * @param string $exit_notice
-     */
-    public static function safeRedirectAndExit($location, $status = 302, $exit_notice = '')
-    {
-        EE_Error::get_notices(false, true);
-        wp_safe_redirect($location, $status);
-        exit($exit_notice);
-    }
+	/**
+	 * @param string $location
+	 * @param int    $status
+	 * @param string $exit_notice
+	 */
+	public static function safeRedirectAndExit($location, $status = 302, $exit_notice = '')
+	{
+		EE_Error::get_notices(false, true);
+		wp_safe_redirect($location, $status);
+		exit($exit_notice);
+	}
 
-    /**
-     * Slugifies text for usage in a URL.
-     *
-     * Currently, this isn't just calling `sanitize_title()` on it, because that percent-encodes unicode characters,
-     * and WordPress chokes on them when used as CPT and custom taxonomy slugs.
-     *
-     * @since 4.9.66.p
-     * @param string $text
-     * @param string $fallback
-     * @return string which can be used in a URL
-     */
-    public static function slugify($text, $fallback)
-    {
-        // url decode after sanitizing title to restore unicode characters,
-        // see https://github.com/eventespresso/event-espresso-core/issues/575
-        return urldecode(
-            sanitize_title(
-                $text,
-                $fallback
-            )
-        );
-    }
+	/**
+	 * Slugifies text for usage in a URL.
+	 *
+	 * Currently, this isn't just calling `sanitize_title()` on it, because that percent-encodes unicode characters,
+	 * and WordPress chokes on them when used as CPT and custom taxonomy slugs.
+	 *
+	 * @since 4.9.66.p
+	 * @param string $text
+	 * @param string $fallback
+	 * @return string which can be used in a URL
+	 */
+	public static function slugify($text, $fallback)
+	{
+		// url decode after sanitizing title to restore unicode characters,
+		// see https://github.com/eventespresso/event-espresso-core/issues/575
+		return urldecode(
+			sanitize_title(
+				$text,
+				$fallback
+			)
+		);
+	}
 }

core/libraries/messages/validators/EE_Messages_Validator.core.php

Doc Comments +1 added lines, -1 removed lines

@@ -505,7 +505,7 @@
      *
      * @param  string $value            string to evaluate
      * @param  array  $valid_shortcodes array of shortcodes that are acceptable.
-     * @return mixed (bool|string)  return either a list of invalid shortcodes OR false if the shortcodes validate.
+     * @return false|string (bool|string)  return either a list of invalid shortcodes OR false if the shortcodes validate.
      */
     protected function _invalid_shortcodes($value, $valid_shortcodes)
     {

Indentation +622 added lines, -622 removed lines

@@ -18,626 +18,626 @@
 {
 
 
-    /**
-     * These properties just hold the name for the Messenger and Message Type (defined by child classes).
-     * These are used for retrieving objects etc.
-     *
-     * @var string
-     */
-    protected $_m_name;
-    protected $_mt_name;
-
-
-    /**
-     * This will hold any error messages from the validation process.
-     * The _errors property holds an associative array of error messages
-     * listing the field as the key and the message as the value.
-     *
-     * @var array()
-     */
-    private $_errors = array();
-
-
-    /**
-     * holds an array of fields being validated
-     *
-     * @var array
-     */
-    protected $_fields;
-
-
-    /**
-     * this will hold the incoming context
-     *
-     * @var string
-     */
-    protected $_context;
-
-
-    /**
-     * this holds an array of fields and the relevant validation information
-     * that the incoming fields data get validated against.
-     * This gets setup in the _set_props() method.
-     *
-     * @var array
-     */
-    protected $_validators;
-
-
-    /**
-     * holds the messenger object
-     *
-     * @var object
-     */
-    protected $_messenger;
-
-
-    /**
-     * holds the message type object
-     *
-     * @var object
-     */
-    protected $_message_type;
-
-
-    /**
-     * will hold any valid_shortcode modifications made by the _modify_validator() method.
-     *
-     * @var array
-     */
-    protected $_valid_shortcodes_modifier;
-
-
-    /**
-     * There may be times where a message type wants to include a shortcode group but exclude specific
-     * shortcodes.  If that's the case then it can set this property as an array of shortcodes to exclude and
-     * they will not be allowed.
-     * Array should be indexed by field and values are an array of specific shortcodes to exclude.
-     *
-     * @var array
-     */
-    protected $_specific_shortcode_excludes = array();
-
-
-    /**
-     * Runs the validator using the incoming fields array as the fields/values to check.
-     *
-     * @param array $fields The fields sent by the EEM object.
-     * @param       $context
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct($fields, $context)
-    {
-        // check that _m_name and _mt_name have been set by child class otherwise we get out.
-        if (empty($this->_m_name) || empty($this->_mt_name)) {
-            throw new EE_Error(
-                esc_html__(
-                    'EE_Messages_Validator child classes MUST set the $_m_name and $_mt_name property.  Check that the child class is doing this',
-                    'event_espresso'
-                )
-            );
-        }
-        $this->_fields  = $fields;
-        $this->_context = $context;
-
-        // load messenger and message_type objects and the related shortcode objects.
-        $this->_load_objects();
-
-
-        // modify any messenger/message_type specific validation instructions.  This is what child classes define.
-        $this->_modify_validator();
-
-
-        // let's set validators property
-        $this->_set_validators();
-    }
-
-
-    /**
-     * Child classes instantiate this and use it to modify the _validator_config array property
-     * for the messenger using messengers set_validate_config() method.
-     * This is so we can specify specific validation instructions for a messenger/message_type combo
-     * that aren't handled by the defaults setup in the messenger.
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _modify_validator();
-
-
-    /**
-     * loads all objects used by validator
-     *
-     * @access private
-     * @throws \EE_Error
-     */
-    private function _load_objects()
-    {
-        // load messenger
-        $messenger = ucwords(str_replace('_', ' ', $this->_m_name));
-        $messenger = str_replace(' ', '_', $messenger);
-        $messenger = 'EE_' . $messenger . '_messenger';
-
-        if (! class_exists($messenger)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('There is no messenger class for the given string (%s)', 'event_espresso'),
-                    $this->_m_name
-                )
-            );
-        }
-
-        $this->_messenger = new $messenger();
-
-        // load message type
-        $message_type = ucwords(str_replace('_', ' ', $this->_mt_name));
-        $message_type = str_replace(' ', '_', $message_type);
-        $message_type = 'EE_' . $message_type . '_message_type';
-
-        if (! class_exists($message_type)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('There is no message type class for the given string (%s)', 'event_espresso'),
-                    $this->_mt_name
-                )
-            );
-        }
-
-        $this->_message_type = new $message_type();
-    }
-
-
-    /**
-     * used to set the $_validators property
-     *
-     * @access private
-     * @return void
-     * @throws ReflectionException
-     */
-    private function _set_validators()
-    {
-        // let's get all valid shortcodes from mt and message type
-        // (messenger will have its set in the _validator_config property for the messenger)
-        $mt_codes = $this->_message_type->get_valid_shortcodes();
-
-
-        // get messenger validator_config
-        $msgr_validator = $this->_messenger->get_validator_config();
-
-
-        // we only want the valid shortcodes for the given context!
-        $context  = $this->_context;
-        $mt_codes = $mt_codes[ $context ];
-
-        // in this first loop we're just getting all shortcode group indexes from the msgr_validator
-        // into a single array (so we can get the appropriate shortcode objects for the groups)
-        $shortcode_groups = $mt_codes;
-        $groups_per_field = array();
-
-        foreach ($msgr_validator as $field => $config) {
-            if (empty($config) || ! isset($config['shortcodes'])) {
-                continue;
-            }  //Nothing to see here.
-            $groups_per_field[ $field ] = array_intersect($config['shortcodes'], $mt_codes);
-            $shortcode_groups         = array_merge($config['shortcodes'], $shortcode_groups);
-        }
-
-        $shortcode_groups = array_unique($shortcode_groups);
-
-        // okay now we've got our groups.
-        // Let's get the codes from the objects into an array indexed by group for easy retrieval later.
-        $codes_from_objs = array();
-
-        foreach ($shortcode_groups as $group) {
-            $ref       = ucwords(str_replace('_', ' ', $group));
-            $ref       = str_replace(' ', '_', $ref);
-            $classname = 'EE_' . $ref . '_Shortcodes';
-            if (class_exists($classname)) {
-                $a                       = new ReflectionClass($classname);
-                $obj                     = $a->newInstance();
-                $codes_from_objs[ $group ] = $obj->get_shortcodes();
-            }
-        }
-
-
-        // let's just replace the $mt shortcode group indexes with the actual shortcodes (unique)
-        $final_mt_codes = array();
-        foreach ($mt_codes as $group) {
-            $final_mt_codes = array_merge($final_mt_codes, $codes_from_objs[ $group ]);
-        }
-
-        $mt_codes = $final_mt_codes;
-
-
-        // k now in this next loop we're going to loop through $msgr_validator again
-        // and setup the _validators property from the data we've setup so far.
-        foreach ($msgr_validator as $field => $config) {
-            // if required shortcode is not in our list of codes for the given field, then we skip this field.
-            $required = isset($config['required'])
-                ? array_intersect($config['required'], array_keys($mt_codes))
-                : true;
-            if (empty($required)) {
-                continue;
-            }
-
-            // If we have an override then we use it to indicate the codes we want.
-            if (isset($this->_valid_shortcodes_modifier[ $context ][ $field ])) {
-                $this->_validators[ $field ]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group(
-                    $this->_valid_shortcodes_modifier[ $context ][ $field ],
-                    $codes_from_objs
-                );
-            } //if we have specific shortcodes for a field then we need to use them
-            elseif (isset($groups_per_field[ $field ])) {
-                $this->_validators[ $field ]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group(
-                    $groups_per_field[ $field ],
-                    $codes_from_objs
-                );
-            } //if empty config then we're assuming we're just going to use the shortcodes from the message type context
-            elseif (empty($config)) {
-                $this->_validators[ $field ]['shortcodes'] = $mt_codes;
-            } //if we have specific shortcodes then we need to use them
-            elseif (isset($config['specific_shortcodes'])) {
-                $this->_validators[ $field ]['shortcodes'] = $config['specific_shortcodes'];
-            } //otherwise the shortcodes are what is set by the messenger for that field
-            else {
-                foreach ($config['shortcodes'] as $group) {
-                    $this->_validators[ $field ]['shortcodes'] = isset($this->_validators[ $field ]['shortcodes'])
-                        ? array_merge($this->_validators[ $field ]['shortcodes'], $codes_from_objs[ $group ])
-                        : $codes_from_objs[ $group ];
-                }
-            }
-
-            // now let's just make sure that any excluded specific shortcodes are removed.
-            $specific_excludes = $this->get_specific_shortcode_excludes();
-            if (isset($specific_excludes[ $field ])) {
-                foreach ($specific_excludes[ $field ] as $sex) {
-                    if (isset($this->_validators[ $field ]['shortcodes'][ $sex ])) {
-                        unset($this->_validators[ $field ]['shortcodes'][ $sex ]);
-                    }
-                }
-            }
-
-            // hey! don't forget to include the type if present!
-            $this->_validators[ $field ]['type'] = isset($config['type']) ? $config['type'] : null;
-        }
-    }
-
-
-    /**
-     * This just returns the validators property that contains information
-     * about the various shortcodes and their availability with each field
-     *
-     * @return array
-     */
-    public function get_validators()
-    {
-        return $this->_validators;
-    }
-
-
-    /**
-     * This simply returns the specific shortcode_excludes property that is set.
-     *
-     * @since 4.5.0
-     * @return array
-     */
-    public function get_specific_shortcode_excludes()
-    {
-        // specific validator filter
-        $shortcode_excludes = apply_filters(
-            'FHEE__' . get_class($this) . '__get_specific_shortcode_excludes;',
-            $this->_specific_shortcode_excludes,
-            $this->_context
-        );
-        // global filter
-        return apply_filters(
-            'FHEE__EE_Messages_Validator__get_specific_shortcode_excludes',
-            $shortcode_excludes,
-            $this->_context,
-            $this
-        );
-    }
-
-
-    /**
-     * This is the main method that handles validation
-     * What it does is loop through the _fields (the ones that get validated)
-     * and checks them against the shortcodes array for the field and the 'type' indicated by the
-     *
-     * @access public
-     * @return mixed (bool|array)  if errors present we return the array otherwise true
-     */
-    public function validate()
-    {
-        // some defaults
-        $template_fields = $this->_messenger->get_template_fields();
-        // loop through the fields and check!
-        foreach ($this->_fields as $field => $value) {
-            $this->_errors[ $field ] = array();
-            $err_msg               = '';
-            $field_label           = '';
-            // if field is not present in the _validators array then we continue
-            if (! isset($this->_validators[ $field ])) {
-                unset($this->_errors[ $field ]);
-                continue;
-            }
-
-            // get the translated field label!
-            // first check if it's in the main fields list
-            if (isset($template_fields[ $field ])) {
-                if (empty($template_fields[ $field ])) {
-                    $field_label = $field;
-                } //most likely the field is found in the 'extra' array.
-                else {
-                    $field_label = $template_fields[ $field ]['label'];
-                }
-            }
-
-            // if field label is empty OR is equal to the current field
-            // then we need to loop through the 'extra' fields in the template_fields config (if present)
-            if (isset($template_fields['extra']) && (empty($field_label) || $field_label === $field)) {
-                foreach ($template_fields['extra'] as $main_field => $secondary_field) {
-                    foreach ($secondary_field as $name => $values) {
-                        if ($name === $field) {
-                            $field_label = $values['label'];
-                        }
-
-                        // if we've got a 'main' secondary field, let's see if that matches what field we're on
-                        // which means it contains the label for this field.
-                        if ($name === 'main' && $main_field === $field_label) {
-                            $field_label = $values['label'];
-                        }
-                    }
-                }
-            }
-
-            // field is present. Let's validate shortcodes first (but only if shortcodes present).
-            if (isset($this->_validators[ $field ]['shortcodes'])
-                && ! empty($this->_validators[ $field ]['shortcodes'])
-            ) {
-                $invalid_shortcodes = $this->_invalid_shortcodes($value, $this->_validators[ $field ]['shortcodes']);
-                // if true then that means there is a returned error message
-                // that we'll need to add to the _errors array for this field.
-                if ($invalid_shortcodes) {
-                    $v_s     = array_keys($this->_validators[ $field ]['shortcodes']);
-                    $err_msg = sprintf(
-                        esc_html__(
-                            '%3$sThe following shortcodes were found in the "%1$s" field that ARE not valid: %2$s%4$s',
-                            'event_espresso'
-                        ),
-                        '<strong>' . $field_label . '</strong>',
-                        $invalid_shortcodes,
-                        '<p>',
-                        '</p >'
-                    );
-                    $err_msg .= sprintf(
-                        esc_html__('%2$sValid shortcodes for this field are: %1$s%3$s', 'event_espresso'),
-                        implode(', ', $v_s),
-                        '<strong>',
-                        '</strong>'
-                    );
-                }
-            }
-
-            // if there's a "type" to be validated then let's do that too.
-            if (isset($this->_validators[ $field ]['type']) && ! empty($this->_validators[ $field ]['type'])) {
-                switch ($this->_validators[ $field ]['type']) {
-                    case 'number':
-                        if (! is_numeric($value)) {
-                            $err_msg .= sprintf(
-                                esc_html__(
-                                    '%3$sThe %1$s field is supposed to be a number. The value given (%2$s)  is not.  Please double-check and make sure the field contains a number%4$s',
-                                    'event_espresso'
-                                ),
-                                $field_label,
-                                $value,
-                                '<p>',
-                                '</p >'
-                            );
-                        }
-                        break;
-                    case 'email':
-                        $valid_email = $this->_validate_email($value);
-                        if (! $valid_email) {
-                            $err_msg .= htmlentities(
-                                sprintf(
-                                    esc_html__(
-                                        'The %1$s field has at least one string that is not a valid email address record.  Valid emails are in the format: "Name <email@something.com>" or "email@something.com" and multiple emails can be separated by a comma.',
-                                        'event_espresso'
-                                    ),
-                                    $field_label
-                                )
-                            );
-                        }
-                        break;
-                    default:
-                        break;
-                }
-            }
-
-            // if $err_msg isn't empty let's setup the _errors array for this field.
-            if (! empty($err_msg)) {
-                $this->_errors[ $field ]['msg'] = $err_msg;
-            } else {
-                unset($this->_errors[ $field ]);
-            }
-        }
-
-        // if we have ANY errors, then we want to make sure we return the values
-        // for ALL the fields so the user doesn't have to retype them all.
-        if (! empty($this->_errors)) {
-            foreach ($this->_fields as $field => $value) {
-                $this->_errors[ $field ]['value'] = stripslashes($value);
-            }
-        }
-
-        // return any errors or just TRUE if everything validates
-        return empty($this->_errors) ? true : $this->_errors;
-    }
-
-
-    /**
-     * Reassembles and returns an array of valid shortcodes
-     * given the array of groups and array of shortcodes indexed by group.
-     *
-     * @param  array $groups          array of shortcode groups that we want shortcodes for
-     * @param  array $codes_from_objs All the codes available.
-     * @return array                   an array of actual shortcodes (that will be used for validation).
-     */
-    private function _reassemble_valid_shortcodes_from_group($groups, $codes_from_objs)
-    {
-        $shortcodes = array();
-        foreach ($groups as $group) {
-            $shortcodes = array_merge($shortcodes, $codes_from_objs[ $group ]);
-        }
-        return $shortcodes;
-    }
-
-
-    /**
-     * Validates a string against a list of accepted shortcodes
-     * This function takes in an array of shortcodes
-     * and makes sure that the given string ONLY contains shortcodes in that array.
-     *
-     * @param  string $value            string to evaluate
-     * @param  array  $valid_shortcodes array of shortcodes that are acceptable.
-     * @return mixed (bool|string)  return either a list of invalid shortcodes OR false if the shortcodes validate.
-     */
-    protected function _invalid_shortcodes($value, $valid_shortcodes)
-    {
-        // first we need to go through the string and get the shortcodes in the string
-        preg_match_all('/(\[.+?\])/', $value, $matches);
-        $incoming_shortcodes = (array) $matches[0];
-
-        // get a diff of the shortcodes in the string vs the valid shortcodes
-        $diff = array_diff($incoming_shortcodes, array_keys($valid_shortcodes));
-
-        // we need to account for custom codes so let's loop through the diff and remove any of those type of codes
-        foreach ($diff as $ind => $code) {
-            if (preg_match('/(\[[A-Za-z0-9\_]+_\*)/', $code)) {
-                // strip the shortcode so we just have the BASE string (i.e. [ANSWER_*] )
-                $dynamic_sc = preg_replace('/(_\*+.+)/', '_*]', $code);
-                // does this exist in the $valid_shortcodes?  If so then unset.
-                if (isset($valid_shortcodes[ $dynamic_sc ])) {
-                    unset($diff[ $ind ]);
-                }
-            }
-        }
-
-        if (empty($diff)) {
-            return false;
-        } //there is no diff, we have no invalid shortcodes, so return
-
-        // made it here? then let's assemble the error message
-        $invalid_shortcodes = implode('</strong>,<strong>', $diff);
-        $invalid_shortcodes = '<strong>' . $invalid_shortcodes . '</strong>';
-        return $invalid_shortcodes;
-    }
-
-
-    /**
-     * Validates an incoming string and makes sure we have valid emails in the string.
-     *
-     * @param  string $value incoming value to validate
-     * @return bool        true if the string validates, false if it doesn't
-     */
-    protected function _validate_email($value)
-    {
-        $validate = true;
-        $or_val   = $value;
-
-        // empty strings will validate because this is how a message template
-        // for a particular context can be "turned off" (if there is no email then no message)
-        if (empty($value)) {
-            return $validate;
-        }
-
-        // first determine if there ARE any shortcodes.
-        // If there are shortcodes and then later we find that there were no other valid emails
-        // but the field isn't empty...
-        // that means we've got extra commas that were left after stripping out shortcodes so probably still valid.
-        $has_shortcodes = preg_match('/(\[.+?\])/', $value);
-
-        // first we need to strip out all the shortcodes!
-        $value = preg_replace('/(\[.+?\])/', '', $value);
-
-        // if original value is not empty and new value is, then we've parsed out a shortcode
-        // and we now have an empty string which DOES validate.
-        // We also validate complete empty field for email because
-        // its possible that this message is being "turned off" for a particular context
-
-
-        if (! empty($or_val) && empty($value)) {
-            return $validate;
-        }
-
-        // trim any commas from beginning and end of string ( after whitespace trimmed );
-        $value = trim(trim($value), ',');
-
-
-        // next we need to split up the string if its comma delimited.
-        $emails = explode(',', $value);
-        $empty  = false; // used to indicate that there is an empty comma.
-        // now let's loop through the emails and do our checks
-        foreach ($emails as $email) {
-            if (empty($email)) {
-                $empty = true;
-                continue;
-            }
-
-            // trim whitespace
-            $email = trim($email);
-            // either its of type "bob@whatever.com", or its of type "fname lname <few@few.few>"
-            if (is_email($email)) {
-                continue;
-            }
-            $matches  = array();
-            $validate = preg_match('/(.*)<(.+)>/', $email, $matches) ? true : false;
-            if ($validate && is_email($matches[2])) {
-                continue;
-            }
-            return false;
-        }
-
-        $validate = $empty && ! $has_shortcodes ? false : $validate;
-
-        return $validate;
-    }
-
-
-    /**
-     * Magic getter
-     * Using this to provide back compat with add-ons referencing deprecated properties.
-     *
-     * @param string $property Property being requested
-     * @throws Exception
-     * @return mixed
-     */
-    public function __get($property)
-    {
-        $expected_properties_map = array(
-            /**
-             * @deprecated 4.9.0
-             */
-            '_MSGR'   => '_messenger',
-            /**
-             * @deprecated 4.9.0
-             */
-            '_MSGTYP' => '_message_type',
-        );
-
-        if (isset($expected_properties_map[ $property ])) {
-            return $this->{$expected_properties_map[ $property ]};
-        }
-
-        throw new Exception(
-            sprintf(
-                esc_html__('The property %1$s being requested on %2$s does not exist', 'event_espresso'),
-                $property,
-                get_class($this)
-            )
-        );
-    }
+	/**
+	 * These properties just hold the name for the Messenger and Message Type (defined by child classes).
+	 * These are used for retrieving objects etc.
+	 *
+	 * @var string
+	 */
+	protected $_m_name;
+	protected $_mt_name;
+
+
+	/**
+	 * This will hold any error messages from the validation process.
+	 * The _errors property holds an associative array of error messages
+	 * listing the field as the key and the message as the value.
+	 *
+	 * @var array()
+	 */
+	private $_errors = array();
+
+
+	/**
+	 * holds an array of fields being validated
+	 *
+	 * @var array
+	 */
+	protected $_fields;
+
+
+	/**
+	 * this will hold the incoming context
+	 *
+	 * @var string
+	 */
+	protected $_context;
+
+
+	/**
+	 * this holds an array of fields and the relevant validation information
+	 * that the incoming fields data get validated against.
+	 * This gets setup in the _set_props() method.
+	 *
+	 * @var array
+	 */
+	protected $_validators;
+
+
+	/**
+	 * holds the messenger object
+	 *
+	 * @var object
+	 */
+	protected $_messenger;
+
+
+	/**
+	 * holds the message type object
+	 *
+	 * @var object
+	 */
+	protected $_message_type;
+
+
+	/**
+	 * will hold any valid_shortcode modifications made by the _modify_validator() method.
+	 *
+	 * @var array
+	 */
+	protected $_valid_shortcodes_modifier;
+
+
+	/**
+	 * There may be times where a message type wants to include a shortcode group but exclude specific
+	 * shortcodes.  If that's the case then it can set this property as an array of shortcodes to exclude and
+	 * they will not be allowed.
+	 * Array should be indexed by field and values are an array of specific shortcodes to exclude.
+	 *
+	 * @var array
+	 */
+	protected $_specific_shortcode_excludes = array();
+
+
+	/**
+	 * Runs the validator using the incoming fields array as the fields/values to check.
+	 *
+	 * @param array $fields The fields sent by the EEM object.
+	 * @param       $context
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct($fields, $context)
+	{
+		// check that _m_name and _mt_name have been set by child class otherwise we get out.
+		if (empty($this->_m_name) || empty($this->_mt_name)) {
+			throw new EE_Error(
+				esc_html__(
+					'EE_Messages_Validator child classes MUST set the $_m_name and $_mt_name property.  Check that the child class is doing this',
+					'event_espresso'
+				)
+			);
+		}
+		$this->_fields  = $fields;
+		$this->_context = $context;
+
+		// load messenger and message_type objects and the related shortcode objects.
+		$this->_load_objects();
+
+
+		// modify any messenger/message_type specific validation instructions.  This is what child classes define.
+		$this->_modify_validator();
+
+
+		// let's set validators property
+		$this->_set_validators();
+	}
+
+
+	/**
+	 * Child classes instantiate this and use it to modify the _validator_config array property
+	 * for the messenger using messengers set_validate_config() method.
+	 * This is so we can specify specific validation instructions for a messenger/message_type combo
+	 * that aren't handled by the defaults setup in the messenger.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _modify_validator();
+
+
+	/**
+	 * loads all objects used by validator
+	 *
+	 * @access private
+	 * @throws \EE_Error
+	 */
+	private function _load_objects()
+	{
+		// load messenger
+		$messenger = ucwords(str_replace('_', ' ', $this->_m_name));
+		$messenger = str_replace(' ', '_', $messenger);
+		$messenger = 'EE_' . $messenger . '_messenger';
+
+		if (! class_exists($messenger)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('There is no messenger class for the given string (%s)', 'event_espresso'),
+					$this->_m_name
+				)
+			);
+		}
+
+		$this->_messenger = new $messenger();
+
+		// load message type
+		$message_type = ucwords(str_replace('_', ' ', $this->_mt_name));
+		$message_type = str_replace(' ', '_', $message_type);
+		$message_type = 'EE_' . $message_type . '_message_type';
+
+		if (! class_exists($message_type)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('There is no message type class for the given string (%s)', 'event_espresso'),
+					$this->_mt_name
+				)
+			);
+		}
+
+		$this->_message_type = new $message_type();
+	}
+
+
+	/**
+	 * used to set the $_validators property
+	 *
+	 * @access private
+	 * @return void
+	 * @throws ReflectionException
+	 */
+	private function _set_validators()
+	{
+		// let's get all valid shortcodes from mt and message type
+		// (messenger will have its set in the _validator_config property for the messenger)
+		$mt_codes = $this->_message_type->get_valid_shortcodes();
+
+
+		// get messenger validator_config
+		$msgr_validator = $this->_messenger->get_validator_config();
+
+
+		// we only want the valid shortcodes for the given context!
+		$context  = $this->_context;
+		$mt_codes = $mt_codes[ $context ];
+
+		// in this first loop we're just getting all shortcode group indexes from the msgr_validator
+		// into a single array (so we can get the appropriate shortcode objects for the groups)
+		$shortcode_groups = $mt_codes;
+		$groups_per_field = array();
+
+		foreach ($msgr_validator as $field => $config) {
+			if (empty($config) || ! isset($config['shortcodes'])) {
+				continue;
+			}  //Nothing to see here.
+			$groups_per_field[ $field ] = array_intersect($config['shortcodes'], $mt_codes);
+			$shortcode_groups         = array_merge($config['shortcodes'], $shortcode_groups);
+		}
+
+		$shortcode_groups = array_unique($shortcode_groups);
+
+		// okay now we've got our groups.
+		// Let's get the codes from the objects into an array indexed by group for easy retrieval later.
+		$codes_from_objs = array();
+
+		foreach ($shortcode_groups as $group) {
+			$ref       = ucwords(str_replace('_', ' ', $group));
+			$ref       = str_replace(' ', '_', $ref);
+			$classname = 'EE_' . $ref . '_Shortcodes';
+			if (class_exists($classname)) {
+				$a                       = new ReflectionClass($classname);
+				$obj                     = $a->newInstance();
+				$codes_from_objs[ $group ] = $obj->get_shortcodes();
+			}
+		}
+
+
+		// let's just replace the $mt shortcode group indexes with the actual shortcodes (unique)
+		$final_mt_codes = array();
+		foreach ($mt_codes as $group) {
+			$final_mt_codes = array_merge($final_mt_codes, $codes_from_objs[ $group ]);
+		}
+
+		$mt_codes = $final_mt_codes;
+
+
+		// k now in this next loop we're going to loop through $msgr_validator again
+		// and setup the _validators property from the data we've setup so far.
+		foreach ($msgr_validator as $field => $config) {
+			// if required shortcode is not in our list of codes for the given field, then we skip this field.
+			$required = isset($config['required'])
+				? array_intersect($config['required'], array_keys($mt_codes))
+				: true;
+			if (empty($required)) {
+				continue;
+			}
+
+			// If we have an override then we use it to indicate the codes we want.
+			if (isset($this->_valid_shortcodes_modifier[ $context ][ $field ])) {
+				$this->_validators[ $field ]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group(
+					$this->_valid_shortcodes_modifier[ $context ][ $field ],
+					$codes_from_objs
+				);
+			} //if we have specific shortcodes for a field then we need to use them
+			elseif (isset($groups_per_field[ $field ])) {
+				$this->_validators[ $field ]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group(
+					$groups_per_field[ $field ],
+					$codes_from_objs
+				);
+			} //if empty config then we're assuming we're just going to use the shortcodes from the message type context
+			elseif (empty($config)) {
+				$this->_validators[ $field ]['shortcodes'] = $mt_codes;
+			} //if we have specific shortcodes then we need to use them
+			elseif (isset($config['specific_shortcodes'])) {
+				$this->_validators[ $field ]['shortcodes'] = $config['specific_shortcodes'];
+			} //otherwise the shortcodes are what is set by the messenger for that field
+			else {
+				foreach ($config['shortcodes'] as $group) {
+					$this->_validators[ $field ]['shortcodes'] = isset($this->_validators[ $field ]['shortcodes'])
+						? array_merge($this->_validators[ $field ]['shortcodes'], $codes_from_objs[ $group ])
+						: $codes_from_objs[ $group ];
+				}
+			}
+
+			// now let's just make sure that any excluded specific shortcodes are removed.
+			$specific_excludes = $this->get_specific_shortcode_excludes();
+			if (isset($specific_excludes[ $field ])) {
+				foreach ($specific_excludes[ $field ] as $sex) {
+					if (isset($this->_validators[ $field ]['shortcodes'][ $sex ])) {
+						unset($this->_validators[ $field ]['shortcodes'][ $sex ]);
+					}
+				}
+			}
+
+			// hey! don't forget to include the type if present!
+			$this->_validators[ $field ]['type'] = isset($config['type']) ? $config['type'] : null;
+		}
+	}
+
+
+	/**
+	 * This just returns the validators property that contains information
+	 * about the various shortcodes and their availability with each field
+	 *
+	 * @return array
+	 */
+	public function get_validators()
+	{
+		return $this->_validators;
+	}
+
+
+	/**
+	 * This simply returns the specific shortcode_excludes property that is set.
+	 *
+	 * @since 4.5.0
+	 * @return array
+	 */
+	public function get_specific_shortcode_excludes()
+	{
+		// specific validator filter
+		$shortcode_excludes = apply_filters(
+			'FHEE__' . get_class($this) . '__get_specific_shortcode_excludes;',
+			$this->_specific_shortcode_excludes,
+			$this->_context
+		);
+		// global filter
+		return apply_filters(
+			'FHEE__EE_Messages_Validator__get_specific_shortcode_excludes',
+			$shortcode_excludes,
+			$this->_context,
+			$this
+		);
+	}
+
+
+	/**
+	 * This is the main method that handles validation
+	 * What it does is loop through the _fields (the ones that get validated)
+	 * and checks them against the shortcodes array for the field and the 'type' indicated by the
+	 *
+	 * @access public
+	 * @return mixed (bool|array)  if errors present we return the array otherwise true
+	 */
+	public function validate()
+	{
+		// some defaults
+		$template_fields = $this->_messenger->get_template_fields();
+		// loop through the fields and check!
+		foreach ($this->_fields as $field => $value) {
+			$this->_errors[ $field ] = array();
+			$err_msg               = '';
+			$field_label           = '';
+			// if field is not present in the _validators array then we continue
+			if (! isset($this->_validators[ $field ])) {
+				unset($this->_errors[ $field ]);
+				continue;
+			}
+
+			// get the translated field label!
+			// first check if it's in the main fields list
+			if (isset($template_fields[ $field ])) {
+				if (empty($template_fields[ $field ])) {
+					$field_label = $field;
+				} //most likely the field is found in the 'extra' array.
+				else {
+					$field_label = $template_fields[ $field ]['label'];
+				}
+			}
+
+			// if field label is empty OR is equal to the current field
+			// then we need to loop through the 'extra' fields in the template_fields config (if present)
+			if (isset($template_fields['extra']) && (empty($field_label) || $field_label === $field)) {
+				foreach ($template_fields['extra'] as $main_field => $secondary_field) {
+					foreach ($secondary_field as $name => $values) {
+						if ($name === $field) {
+							$field_label = $values['label'];
+						}
+
+						// if we've got a 'main' secondary field, let's see if that matches what field we're on
+						// which means it contains the label for this field.
+						if ($name === 'main' && $main_field === $field_label) {
+							$field_label = $values['label'];
+						}
+					}
+				}
+			}
+
+			// field is present. Let's validate shortcodes first (but only if shortcodes present).
+			if (isset($this->_validators[ $field ]['shortcodes'])
+				&& ! empty($this->_validators[ $field ]['shortcodes'])
+			) {
+				$invalid_shortcodes = $this->_invalid_shortcodes($value, $this->_validators[ $field ]['shortcodes']);
+				// if true then that means there is a returned error message
+				// that we'll need to add to the _errors array for this field.
+				if ($invalid_shortcodes) {
+					$v_s     = array_keys($this->_validators[ $field ]['shortcodes']);
+					$err_msg = sprintf(
+						esc_html__(
+							'%3$sThe following shortcodes were found in the "%1$s" field that ARE not valid: %2$s%4$s',
+							'event_espresso'
+						),
+						'<strong>' . $field_label . '</strong>',
+						$invalid_shortcodes,
+						'<p>',
+						'</p >'
+					);
+					$err_msg .= sprintf(
+						esc_html__('%2$sValid shortcodes for this field are: %1$s%3$s', 'event_espresso'),
+						implode(', ', $v_s),
+						'<strong>',
+						'</strong>'
+					);
+				}
+			}
+
+			// if there's a "type" to be validated then let's do that too.
+			if (isset($this->_validators[ $field ]['type']) && ! empty($this->_validators[ $field ]['type'])) {
+				switch ($this->_validators[ $field ]['type']) {
+					case 'number':
+						if (! is_numeric($value)) {
+							$err_msg .= sprintf(
+								esc_html__(
+									'%3$sThe %1$s field is supposed to be a number. The value given (%2$s)  is not.  Please double-check and make sure the field contains a number%4$s',
+									'event_espresso'
+								),
+								$field_label,
+								$value,
+								'<p>',
+								'</p >'
+							);
+						}
+						break;
+					case 'email':
+						$valid_email = $this->_validate_email($value);
+						if (! $valid_email) {
+							$err_msg .= htmlentities(
+								sprintf(
+									esc_html__(
+										'The %1$s field has at least one string that is not a valid email address record.  Valid emails are in the format: "Name <email@something.com>" or "email@something.com" and multiple emails can be separated by a comma.',
+										'event_espresso'
+									),
+									$field_label
+								)
+							);
+						}
+						break;
+					default:
+						break;
+				}
+			}
+
+			// if $err_msg isn't empty let's setup the _errors array for this field.
+			if (! empty($err_msg)) {
+				$this->_errors[ $field ]['msg'] = $err_msg;
+			} else {
+				unset($this->_errors[ $field ]);
+			}
+		}
+
+		// if we have ANY errors, then we want to make sure we return the values
+		// for ALL the fields so the user doesn't have to retype them all.
+		if (! empty($this->_errors)) {
+			foreach ($this->_fields as $field => $value) {
+				$this->_errors[ $field ]['value'] = stripslashes($value);
+			}
+		}
+
+		// return any errors or just TRUE if everything validates
+		return empty($this->_errors) ? true : $this->_errors;
+	}
+
+
+	/**
+	 * Reassembles and returns an array of valid shortcodes
+	 * given the array of groups and array of shortcodes indexed by group.
+	 *
+	 * @param  array $groups          array of shortcode groups that we want shortcodes for
+	 * @param  array $codes_from_objs All the codes available.
+	 * @return array                   an array of actual shortcodes (that will be used for validation).
+	 */
+	private function _reassemble_valid_shortcodes_from_group($groups, $codes_from_objs)
+	{
+		$shortcodes = array();
+		foreach ($groups as $group) {
+			$shortcodes = array_merge($shortcodes, $codes_from_objs[ $group ]);
+		}
+		return $shortcodes;
+	}
+
+
+	/**
+	 * Validates a string against a list of accepted shortcodes
+	 * This function takes in an array of shortcodes
+	 * and makes sure that the given string ONLY contains shortcodes in that array.
+	 *
+	 * @param  string $value            string to evaluate
+	 * @param  array  $valid_shortcodes array of shortcodes that are acceptable.
+	 * @return mixed (bool|string)  return either a list of invalid shortcodes OR false if the shortcodes validate.
+	 */
+	protected function _invalid_shortcodes($value, $valid_shortcodes)
+	{
+		// first we need to go through the string and get the shortcodes in the string
+		preg_match_all('/(\[.+?\])/', $value, $matches);
+		$incoming_shortcodes = (array) $matches[0];
+
+		// get a diff of the shortcodes in the string vs the valid shortcodes
+		$diff = array_diff($incoming_shortcodes, array_keys($valid_shortcodes));
+
+		// we need to account for custom codes so let's loop through the diff and remove any of those type of codes
+		foreach ($diff as $ind => $code) {
+			if (preg_match('/(\[[A-Za-z0-9\_]+_\*)/', $code)) {
+				// strip the shortcode so we just have the BASE string (i.e. [ANSWER_*] )
+				$dynamic_sc = preg_replace('/(_\*+.+)/', '_*]', $code);
+				// does this exist in the $valid_shortcodes?  If so then unset.
+				if (isset($valid_shortcodes[ $dynamic_sc ])) {
+					unset($diff[ $ind ]);
+				}
+			}
+		}
+
+		if (empty($diff)) {
+			return false;
+		} //there is no diff, we have no invalid shortcodes, so return
+
+		// made it here? then let's assemble the error message
+		$invalid_shortcodes = implode('</strong>,<strong>', $diff);
+		$invalid_shortcodes = '<strong>' . $invalid_shortcodes . '</strong>';
+		return $invalid_shortcodes;
+	}
+
+
+	/**
+	 * Validates an incoming string and makes sure we have valid emails in the string.
+	 *
+	 * @param  string $value incoming value to validate
+	 * @return bool        true if the string validates, false if it doesn't
+	 */
+	protected function _validate_email($value)
+	{
+		$validate = true;
+		$or_val   = $value;
+
+		// empty strings will validate because this is how a message template
+		// for a particular context can be "turned off" (if there is no email then no message)
+		if (empty($value)) {
+			return $validate;
+		}
+
+		// first determine if there ARE any shortcodes.
+		// If there are shortcodes and then later we find that there were no other valid emails
+		// but the field isn't empty...
+		// that means we've got extra commas that were left after stripping out shortcodes so probably still valid.
+		$has_shortcodes = preg_match('/(\[.+?\])/', $value);
+
+		// first we need to strip out all the shortcodes!
+		$value = preg_replace('/(\[.+?\])/', '', $value);
+
+		// if original value is not empty and new value is, then we've parsed out a shortcode
+		// and we now have an empty string which DOES validate.
+		// We also validate complete empty field for email because
+		// its possible that this message is being "turned off" for a particular context
+
+
+		if (! empty($or_val) && empty($value)) {
+			return $validate;
+		}
+
+		// trim any commas from beginning and end of string ( after whitespace trimmed );
+		$value = trim(trim($value), ',');
+
+
+		// next we need to split up the string if its comma delimited.
+		$emails = explode(',', $value);
+		$empty  = false; // used to indicate that there is an empty comma.
+		// now let's loop through the emails and do our checks
+		foreach ($emails as $email) {
+			if (empty($email)) {
+				$empty = true;
+				continue;
+			}
+
+			// trim whitespace
+			$email = trim($email);
+			// either its of type "bob@whatever.com", or its of type "fname lname <few@few.few>"
+			if (is_email($email)) {
+				continue;
+			}
+			$matches  = array();
+			$validate = preg_match('/(.*)<(.+)>/', $email, $matches) ? true : false;
+			if ($validate && is_email($matches[2])) {
+				continue;
+			}
+			return false;
+		}
+
+		$validate = $empty && ! $has_shortcodes ? false : $validate;
+
+		return $validate;
+	}
+
+
+	/**
+	 * Magic getter
+	 * Using this to provide back compat with add-ons referencing deprecated properties.
+	 *
+	 * @param string $property Property being requested
+	 * @throws Exception
+	 * @return mixed
+	 */
+	public function __get($property)
+	{
+		$expected_properties_map = array(
+			/**
+			 * @deprecated 4.9.0
+			 */
+			'_MSGR'   => '_messenger',
+			/**
+			 * @deprecated 4.9.0
+			 */
+			'_MSGTYP' => '_message_type',
+		);
+
+		if (isset($expected_properties_map[ $property ])) {
+			return $this->{$expected_properties_map[ $property ]};
+		}
+
+		throw new Exception(
+			sprintf(
+				esc_html__('The property %1$s being requested on %2$s does not exist', 'event_espresso'),
+				$property,
+				get_class($this)
+			)
+		);
+	}
 }

Spacing +54 added lines, -54 removed lines

@@ -158,9 +158,9 @@ 
         // load messenger
         $messenger = ucwords(str_replace('_', ' ', $this->_m_name));
         $messenger = str_replace(' ', '_', $messenger);
-        $messenger = 'EE_' . $messenger . '_messenger';
+        $messenger = 'EE_'.$messenger.'_messenger';
 
-        if (! class_exists($messenger)) {
+        if ( ! class_exists($messenger)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('There is no messenger class for the given string (%s)', 'event_espresso'),
@@ -174,9 +174,9 @@ 
         // load message type
         $message_type = ucwords(str_replace('_', ' ', $this->_mt_name));
         $message_type = str_replace(' ', '_', $message_type);
-        $message_type = 'EE_' . $message_type . '_message_type';
+        $message_type = 'EE_'.$message_type.'_message_type';
 
-        if (! class_exists($message_type)) {
+        if ( ! class_exists($message_type)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('There is no message type class for the given string (%s)', 'event_espresso'),
@@ -209,7 +209,7 @@ 
 
         // we only want the valid shortcodes for the given context!
         $context  = $this->_context;
-        $mt_codes = $mt_codes[ $context ];
+        $mt_codes = $mt_codes[$context];
 
         // in this first loop we're just getting all shortcode group indexes from the msgr_validator
         // into a single array (so we can get the appropriate shortcode objects for the groups)
@@ -220,8 +220,8 @@ 
             if (empty($config) || ! isset($config['shortcodes'])) {
                 continue;
             }  //Nothing to see here.
-            $groups_per_field[ $field ] = array_intersect($config['shortcodes'], $mt_codes);
-            $shortcode_groups         = array_merge($config['shortcodes'], $shortcode_groups);
+            $groups_per_field[$field] = array_intersect($config['shortcodes'], $mt_codes);
+            $shortcode_groups = array_merge($config['shortcodes'], $shortcode_groups);
         }
 
         $shortcode_groups = array_unique($shortcode_groups);
@@ -233,11 +233,11 @@ 
         foreach ($shortcode_groups as $group) {
             $ref       = ucwords(str_replace('_', ' ', $group));
             $ref       = str_replace(' ', '_', $ref);
-            $classname = 'EE_' . $ref . '_Shortcodes';
+            $classname = 'EE_'.$ref.'_Shortcodes';
             if (class_exists($classname)) {
                 $a                       = new ReflectionClass($classname);
                 $obj                     = $a->newInstance();
-                $codes_from_objs[ $group ] = $obj->get_shortcodes();
+                $codes_from_objs[$group] = $obj->get_shortcodes();
             }
         }
 
@@ -245,7 +245,7 @@ 
         // let's just replace the $mt shortcode group indexes with the actual shortcodes (unique)
         $final_mt_codes = array();
         foreach ($mt_codes as $group) {
-            $final_mt_codes = array_merge($final_mt_codes, $codes_from_objs[ $group ]);
+            $final_mt_codes = array_merge($final_mt_codes, $codes_from_objs[$group]);
         }
 
         $mt_codes = $final_mt_codes;
@@ -263,44 +263,44 @@ 
             }
 
             // If we have an override then we use it to indicate the codes we want.
-            if (isset($this->_valid_shortcodes_modifier[ $context ][ $field ])) {
-                $this->_validators[ $field ]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group(
-                    $this->_valid_shortcodes_modifier[ $context ][ $field ],
+            if (isset($this->_valid_shortcodes_modifier[$context][$field])) {
+                $this->_validators[$field]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group(
+                    $this->_valid_shortcodes_modifier[$context][$field],
                     $codes_from_objs
                 );
             } //if we have specific shortcodes for a field then we need to use them
-            elseif (isset($groups_per_field[ $field ])) {
-                $this->_validators[ $field ]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group(
-                    $groups_per_field[ $field ],
+            elseif (isset($groups_per_field[$field])) {
+                $this->_validators[$field]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group(
+                    $groups_per_field[$field],
                     $codes_from_objs
                 );
             } //if empty config then we're assuming we're just going to use the shortcodes from the message type context
             elseif (empty($config)) {
-                $this->_validators[ $field ]['shortcodes'] = $mt_codes;
+                $this->_validators[$field]['shortcodes'] = $mt_codes;
             } //if we have specific shortcodes then we need to use them
             elseif (isset($config['specific_shortcodes'])) {
-                $this->_validators[ $field ]['shortcodes'] = $config['specific_shortcodes'];
+                $this->_validators[$field]['shortcodes'] = $config['specific_shortcodes'];
             } //otherwise the shortcodes are what is set by the messenger for that field
             else {
                 foreach ($config['shortcodes'] as $group) {
-                    $this->_validators[ $field ]['shortcodes'] = isset($this->_validators[ $field ]['shortcodes'])
-                        ? array_merge($this->_validators[ $field ]['shortcodes'], $codes_from_objs[ $group ])
-                        : $codes_from_objs[ $group ];
+                    $this->_validators[$field]['shortcodes'] = isset($this->_validators[$field]['shortcodes'])
+                        ? array_merge($this->_validators[$field]['shortcodes'], $codes_from_objs[$group])
+                        : $codes_from_objs[$group];
                 }
             }
 
             // now let's just make sure that any excluded specific shortcodes are removed.
             $specific_excludes = $this->get_specific_shortcode_excludes();
-            if (isset($specific_excludes[ $field ])) {
-                foreach ($specific_excludes[ $field ] as $sex) {
-                    if (isset($this->_validators[ $field ]['shortcodes'][ $sex ])) {
-                        unset($this->_validators[ $field ]['shortcodes'][ $sex ]);
+            if (isset($specific_excludes[$field])) {
+                foreach ($specific_excludes[$field] as $sex) {
+                    if (isset($this->_validators[$field]['shortcodes'][$sex])) {
+                        unset($this->_validators[$field]['shortcodes'][$sex]);
                     }
                 }
             }
 
             // hey! don't forget to include the type if present!
-            $this->_validators[ $field ]['type'] = isset($config['type']) ? $config['type'] : null;
+            $this->_validators[$field]['type'] = isset($config['type']) ? $config['type'] : null;
         }
     }
 
@@ -327,7 +327,7 @@ 
     {
         // specific validator filter
         $shortcode_excludes = apply_filters(
-            'FHEE__' . get_class($this) . '__get_specific_shortcode_excludes;',
+            'FHEE__'.get_class($this).'__get_specific_shortcode_excludes;',
             $this->_specific_shortcode_excludes,
             $this->_context
         );
@@ -355,23 +355,23 @@ 
         $template_fields = $this->_messenger->get_template_fields();
         // loop through the fields and check!
         foreach ($this->_fields as $field => $value) {
-            $this->_errors[ $field ] = array();
+            $this->_errors[$field] = array();
             $err_msg               = '';
             $field_label           = '';
             // if field is not present in the _validators array then we continue
-            if (! isset($this->_validators[ $field ])) {
-                unset($this->_errors[ $field ]);
+            if ( ! isset($this->_validators[$field])) {
+                unset($this->_errors[$field]);
                 continue;
             }
 
             // get the translated field label!
             // first check if it's in the main fields list
-            if (isset($template_fields[ $field ])) {
-                if (empty($template_fields[ $field ])) {
+            if (isset($template_fields[$field])) {
+                if (empty($template_fields[$field])) {
                     $field_label = $field;
                 } //most likely the field is found in the 'extra' array.
                 else {
-                    $field_label = $template_fields[ $field ]['label'];
+                    $field_label = $template_fields[$field]['label'];
                 }
             }
 
@@ -394,20 +394,20 @@ 
             }
 
             // field is present. Let's validate shortcodes first (but only if shortcodes present).
-            if (isset($this->_validators[ $field ]['shortcodes'])
-                && ! empty($this->_validators[ $field ]['shortcodes'])
+            if (isset($this->_validators[$field]['shortcodes'])
+                && ! empty($this->_validators[$field]['shortcodes'])
             ) {
-                $invalid_shortcodes = $this->_invalid_shortcodes($value, $this->_validators[ $field ]['shortcodes']);
+                $invalid_shortcodes = $this->_invalid_shortcodes($value, $this->_validators[$field]['shortcodes']);
                 // if true then that means there is a returned error message
                 // that we'll need to add to the _errors array for this field.
                 if ($invalid_shortcodes) {
-                    $v_s     = array_keys($this->_validators[ $field ]['shortcodes']);
+                    $v_s     = array_keys($this->_validators[$field]['shortcodes']);
                     $err_msg = sprintf(
                         esc_html__(
                             '%3$sThe following shortcodes were found in the "%1$s" field that ARE not valid: %2$s%4$s',
                             'event_espresso'
                         ),
-                        '<strong>' . $field_label . '</strong>',
+                        '<strong>'.$field_label.'</strong>',
                         $invalid_shortcodes,
                         '<p>',
                         '</p >'
@@ -422,10 +422,10 @@ 
             }
 
             // if there's a "type" to be validated then let's do that too.
-            if (isset($this->_validators[ $field ]['type']) && ! empty($this->_validators[ $field ]['type'])) {
-                switch ($this->_validators[ $field ]['type']) {
+            if (isset($this->_validators[$field]['type']) && ! empty($this->_validators[$field]['type'])) {
+                switch ($this->_validators[$field]['type']) {
                     case 'number':
-                        if (! is_numeric($value)) {
+                        if ( ! is_numeric($value)) {
                             $err_msg .= sprintf(
                                 esc_html__(
                                     '%3$sThe %1$s field is supposed to be a number. The value given (%2$s)  is not.  Please double-check and make sure the field contains a number%4$s',
@@ -440,7 +440,7 @@ 
                         break;
                     case 'email':
                         $valid_email = $this->_validate_email($value);
-                        if (! $valid_email) {
+                        if ( ! $valid_email) {
                             $err_msg .= htmlentities(
                                 sprintf(
                                     esc_html__(
@@ -458,18 +458,18 @@ 
             }
 
             // if $err_msg isn't empty let's setup the _errors array for this field.
-            if (! empty($err_msg)) {
-                $this->_errors[ $field ]['msg'] = $err_msg;
+            if ( ! empty($err_msg)) {
+                $this->_errors[$field]['msg'] = $err_msg;
             } else {
-                unset($this->_errors[ $field ]);
+                unset($this->_errors[$field]);
             }
         }
 
         // if we have ANY errors, then we want to make sure we return the values
         // for ALL the fields so the user doesn't have to retype them all.
-        if (! empty($this->_errors)) {
+        if ( ! empty($this->_errors)) {
             foreach ($this->_fields as $field => $value) {
-                $this->_errors[ $field ]['value'] = stripslashes($value);
+                $this->_errors[$field]['value'] = stripslashes($value);
             }
         }
 
@@ -490,7 +490,7 @@ 
     {
         $shortcodes = array();
         foreach ($groups as $group) {
-            $shortcodes = array_merge($shortcodes, $codes_from_objs[ $group ]);
+            $shortcodes = array_merge($shortcodes, $codes_from_objs[$group]);
         }
         return $shortcodes;
     }
@@ -520,8 +520,8 @@ 
                 // strip the shortcode so we just have the BASE string (i.e. [ANSWER_*] )
                 $dynamic_sc = preg_replace('/(_\*+.+)/', '_*]', $code);
                 // does this exist in the $valid_shortcodes?  If so then unset.
-                if (isset($valid_shortcodes[ $dynamic_sc ])) {
-                    unset($diff[ $ind ]);
+                if (isset($valid_shortcodes[$dynamic_sc])) {
+                    unset($diff[$ind]);
                 }
             }
         }
@@ -532,7 +532,7 @@ 
 
         // made it here? then let's assemble the error message
         $invalid_shortcodes = implode('</strong>,<strong>', $diff);
-        $invalid_shortcodes = '<strong>' . $invalid_shortcodes . '</strong>';
+        $invalid_shortcodes = '<strong>'.$invalid_shortcodes.'</strong>';
         return $invalid_shortcodes;
     }
 
@@ -569,7 +569,7 @@ 
         // its possible that this message is being "turned off" for a particular context
 
 
-        if (! empty($or_val) && empty($value)) {
+        if ( ! empty($or_val) && empty($value)) {
             return $validate;
         }
 
@@ -628,8 +628,8 @@ 
             '_MSGTYP' => '_message_type',
         );
 
-        if (isset($expected_properties_map[ $property ])) {
-            return $this->{$expected_properties_map[ $property ]};
+        if (isset($expected_properties_map[$property])) {
+            return $this->{$expected_properties_map[$property]};
         }
 
         throw new Exception(

core/db_models/fields/EE_Simple_HTML_Field.php

Indentation +10 added lines, -10 removed lines

@@ -11,14 +11,14 @@
 
 
 
-    /**
-     * removes all tags which a WP Post wouldn't allow in its content normally
-     *
-     * @param string $value
-     * @return string
-     */
-    public function prepare_for_set($value)
-    {
-        return parent::prepare_for_set(wp_kses("$value", EEH_HTML::get_simple_tags()));
-    }
+	/**
+	 * removes all tags which a WP Post wouldn't allow in its content normally
+	 *
+	 * @param string $value
+	 * @return string
+	 */
+	public function prepare_for_set($value)
+	{
+		return parent::prepare_for_set(wp_kses("$value", EEH_HTML::get_simple_tags()));
+	}
 }

core/db_classes/EE_Attendee.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -603,7 +603,7 @@ 
     /**
      * returns any events attached to this attendee ($_Event property);
      *
-     * @return array
+     * @return EE_Base_Class[]
      * @throws EE_Error
      */
     public function events()
@@ -618,7 +618,7 @@ 
      * used to save the billing info
      *
      * @param EE_Payment_Method $payment_method the _gateway_name property on the gateway class
-     * @return EE_Form_Section_Proper|null
+     * @return null|EE_Billing_Info_Form
      * @throws EE_Error
      */
     public function billing_info_for_payment_method($payment_method)

Indentation +742 added lines, -742 removed lines

@@ -25,746 +25,746 @@
 class EE_Attendee extends EE_CPT_Base implements EEI_Contact, EEI_Address, EEI_Admin_Links, EEI_Attendee
 {
 
-    /**
-     * Sets some dynamic defaults
-     *
-     * @param array  $fieldValues
-     * @param bool   $bydb
-     * @param string $timezone
-     * @param array  $date_formats
-     * @throws EE_Error
-     */
-    protected function __construct($fieldValues = null, $bydb = false, $timezone = null, $date_formats = array())
-    {
-        if (! isset($fieldValues['ATT_full_name'])) {
-            $fname = isset($fieldValues['ATT_fname']) ? $fieldValues['ATT_fname'] . ' ' : '';
-            $lname = isset($fieldValues['ATT_lname']) ? $fieldValues['ATT_lname'] : '';
-            $fieldValues['ATT_full_name'] = $fname . $lname;
-        }
-        if (! isset($fieldValues['ATT_slug'])) {
-            // $fieldValues['ATT_slug'] = sanitize_key(wp_generate_password(20));
-            $fieldValues['ATT_slug'] = sanitize_title($fieldValues['ATT_full_name']);
-        }
-        if (! isset($fieldValues['ATT_short_bio']) && isset($fieldValues['ATT_bio'])) {
-            $fieldValues['ATT_short_bio'] = substr($fieldValues['ATT_bio'], 0, 50);
-        }
-        parent::__construct($fieldValues, $bydb, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Attendee
-     * @throws EE_Error
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Attendee
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     *        Set Attendee First Name
-     *
-     * @access        public
-     * @param string $fname
-     * @throws EE_Error
-     */
-    public function set_fname($fname = '')
-    {
-        $this->set('ATT_fname', $fname);
-    }
-
-
-    /**
-     *        Set Attendee Last Name
-     *
-     * @access        public
-     * @param string $lname
-     * @throws EE_Error
-     */
-    public function set_lname($lname = '')
-    {
-        $this->set('ATT_lname', $lname);
-    }
-
-
-    /**
-     *        Set Attendee Address
-     *
-     * @access        public
-     * @param string $address
-     * @throws EE_Error
-     */
-    public function set_address($address = '')
-    {
-        $this->set('ATT_address', $address);
-    }
-
-
-    /**
-     *        Set Attendee Address2
-     *
-     * @access        public
-     * @param        string $address2
-     * @throws EE_Error
-     */
-    public function set_address2($address2 = '')
-    {
-        $this->set('ATT_address2', $address2);
-    }
-
-
-    /**
-     *        Set Attendee City
-     *
-     * @access        public
-     * @param        string $city
-     * @throws EE_Error
-     */
-    public function set_city($city = '')
-    {
-        $this->set('ATT_city', $city);
-    }
-
-
-    /**
-     *        Set Attendee State ID
-     *
-     * @access        public
-     * @param        int $STA_ID
-     * @throws EE_Error
-     */
-    public function set_state($STA_ID = 0)
-    {
-        $this->set('STA_ID', $STA_ID);
-    }
-
-
-    /**
-     *        Set Attendee Country ISO Code
-     *
-     * @access        public
-     * @param        string $CNT_ISO
-     * @throws EE_Error
-     */
-    public function set_country($CNT_ISO = '')
-    {
-        $this->set('CNT_ISO', $CNT_ISO);
-    }
-
-
-    /**
-     *        Set Attendee Zip/Postal Code
-     *
-     * @access        public
-     * @param        string $zip
-     * @throws EE_Error
-     */
-    public function set_zip($zip = '')
-    {
-        $this->set('ATT_zip', $zip);
-    }
-
-
-    /**
-     *        Set Attendee Email Address
-     *
-     * @access        public
-     * @param        string $email
-     * @throws EE_Error
-     */
-    public function set_email($email = '')
-    {
-        $this->set('ATT_email', $email);
-    }
-
-
-    /**
-     *        Set Attendee Phone
-     *
-     * @access        public
-     * @param        string $phone
-     * @throws EE_Error
-     */
-    public function set_phone($phone = '')
-    {
-        $this->set('ATT_phone', $phone);
-    }
-
-
-    /**
-     *        set deleted
-     *
-     * @access        public
-     * @param        bool $ATT_deleted
-     * @throws EE_Error
-     */
-    public function set_deleted($ATT_deleted = false)
-    {
-        $this->set('ATT_deleted', $ATT_deleted);
-    }
-
-
-    /**
-     * Returns the value for the post_author id saved with the cpt
-     *
-     * @since 4.5.0
-     * @return int
-     * @throws EE_Error
-     */
-    public function wp_user()
-    {
-        return $this->get('ATT_author');
-    }
-
-
-    /**
-     *        get Attendee First Name
-     *
-     * @access        public
-     * @return string
-     * @throws EE_Error
-     */
-    public function fname()
-    {
-        return $this->get('ATT_fname');
-    }
-
-
-    /**
-     * echoes out the attendee's first name
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function e_full_name()
-    {
-        echo $this->full_name();
-    }
-
-
-    /**
-     * Returns the first and last name concatenated together with a space.
-     *
-     * @param bool $apply_html_entities
-     * @return string
-     * @throws EE_Error
-     */
-    public function full_name($apply_html_entities = false)
-    {
-        $full_name = array(
-            $this->fname(),
-            $this->lname(),
-        );
-        $full_name = array_filter($full_name);
-        $full_name = implode(' ', $full_name);
-        return $apply_html_entities ? htmlentities($full_name, ENT_QUOTES, 'UTF-8') : $full_name;
-    }
-
-
-    /**
-     * This returns the value of the `ATT_full_name` field which is usually equivalent to calling `full_name()` unless
-     * the post_title field has been directly modified in the db for the post (espresso_attendees post type) for this
-     * attendee.
-     *
-     * @param bool $apply_html_entities
-     * @return string
-     * @throws EE_Error
-     */
-    public function ATT_full_name($apply_html_entities = false)
-    {
-        return $apply_html_entities
-            ? htmlentities($this->get('ATT_full_name'), ENT_QUOTES, 'UTF-8')
-            : $this->get('ATT_full_name');
-    }
-
-
-    /**
-     *        get Attendee Last Name
-     *
-     * @access        public
-     * @return string
-     * @throws EE_Error
-     */
-    public function lname()
-    {
-        return $this->get('ATT_lname');
-    }
-
-
-    /**
-     * Gets the attendee's full address as an array so client code can decide hwo to display it
-     *
-     * @return array numerically indexed, with each part of the address that is known.
-     * Eg, if the user only responded to state and country,
-     * it would be array(0=>'Alabama',1=>'USA')
-     * @return array
-     * @throws EE_Error
-     */
-    public function full_address_as_array()
-    {
-        $full_address_array = array();
-        $initial_address_fields = array('ATT_address', 'ATT_address2', 'ATT_city',);
-        foreach ($initial_address_fields as $address_field_name) {
-            $address_fields_value = $this->get($address_field_name);
-            if (! empty($address_fields_value)) {
-                $full_address_array[] = $address_fields_value;
-            }
-        }
-        // now handle state and country
-        $state_obj = $this->state_obj();
-        if ($state_obj instanceof EE_State) {
-            $full_address_array[] = $state_obj->name();
-        }
-        $country_obj = $this->country_obj();
-        if ($country_obj instanceof EE_Country) {
-            $full_address_array[] = $country_obj->name();
-        }
-        // lastly get the xip
-        $zip_value = $this->zip();
-        if (! empty($zip_value)) {
-            $full_address_array[] = $zip_value;
-        }
-        return $full_address_array;
-    }
-
-
-    /**
-     *        get Attendee Address
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function address()
-    {
-        return $this->get('ATT_address');
-    }
-
-
-    /**
-     *        get Attendee Address2
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function address2()
-    {
-        return $this->get('ATT_address2');
-    }
-
-
-    /**
-     *        get Attendee City
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function city()
-    {
-        return $this->get('ATT_city');
-    }
-
-
-    /**
-     *        get Attendee State ID
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function state_ID()
-    {
-        return $this->get('STA_ID');
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     */
-    public function state_abbrev()
-    {
-        return $this->state_obj() instanceof EE_State ? $this->state_obj()->abbrev() : '';
-    }
-
-
-    /**
-     * Gets the state set to this attendee
-     *
-     * @return EE_State
-     * @throws EE_Error
-     */
-    public function state_obj()
-    {
-        return $this->get_first_related('State');
-    }
-
-
-    /**
-     * Returns the state's name, otherwise 'Unknown'
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function state_name()
-    {
-        if ($this->state_obj()) {
-            return $this->state_obj()->name();
-        } else {
-            return '';
-        }
-    }
-
-
-    /**
-     * either displays the state abbreviation or the state name, as determined
-     * by the "FHEE__EEI_Address__state__use_abbreviation" filter.
-     * defaults to abbreviation
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function state()
-    {
-        if (apply_filters('FHEE__EEI_Address__state__use_abbreviation', true, $this->state_obj())) {
-            return $this->state_abbrev();
-        }
-        return $this->state_name();
-    }
-
-
-    /**
-     *    get Attendee Country ISO Code
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function country_ID()
-    {
-        return $this->get('CNT_ISO');
-    }
-
-
-    /**
-     * Gets country set for this attendee
-     *
-     * @return EE_Country
-     * @throws EE_Error
-     */
-    public function country_obj()
-    {
-        return $this->get_first_related('Country');
-    }
-
-
-    /**
-     * Returns the country's name if known, otherwise 'Unknown'
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function country_name()
-    {
-        if ($this->country_obj()) {
-            return $this->country_obj()->name();
-        }
-        return '';
-    }
-
-
-    /**
-     * either displays the country ISO2 code or the country name, as determined
-     * by the "FHEE__EEI_Address__country__use_abbreviation" filter.
-     * defaults to abbreviation
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function country()
-    {
-        if (apply_filters('FHEE__EEI_Address__country__use_abbreviation', true, $this->country_obj())) {
-            return $this->country_ID();
-        }
-        return $this->country_name();
-    }
-
-
-    /**
-     *        get Attendee Zip/Postal Code
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function zip()
-    {
-        return $this->get('ATT_zip');
-    }
-
-
-    /**
-     *        get Attendee Email Address
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function email()
-    {
-        return $this->get('ATT_email');
-    }
-
-
-    /**
-     *        get Attendee Phone #
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function phone()
-    {
-        return $this->get('ATT_phone');
-    }
-
-
-    /**
-     *    get deleted
-     *
-     * @return        bool
-     * @throws EE_Error
-     */
-    public function deleted()
-    {
-        return $this->get('ATT_deleted');
-    }
-
-
-    /**
-     * Gets registrations of this attendee
-     *
-     * @param array $query_params
-     * @return EE_Registration[]
-     * @throws EE_Error
-     */
-    public function get_registrations($query_params = array())
-    {
-        return $this->get_many_related('Registration', $query_params);
-    }
-
-
-    /**
-     * Gets the most recent registration of this attendee
-     *
-     * @return EE_Registration
-     * @throws EE_Error
-     */
-    public function get_most_recent_registration()
-    {
-        return $this->get_first_related(
-            'Registration',
-            array('order_by' => array('REG_date' => 'DESC'))
-        ); // null, 'REG_date', 'DESC', '=', 'OBJECT_K');
-    }
-
-
-    /**
-     * Gets the most recent registration for this attend at this event
-     *
-     * @param int $event_id
-     * @return EE_Registration
-     * @throws EE_Error
-     */
-    public function get_most_recent_registration_for_event($event_id)
-    {
-        return $this->get_first_related(
-            'Registration',
-            array(array('EVT_ID' => $event_id), 'order_by' => array('REG_date' => 'DESC'))
-        );
-    }
-
-
-    /**
-     * returns any events attached to this attendee ($_Event property);
-     *
-     * @return array
-     * @throws EE_Error
-     */
-    public function events()
-    {
-        return $this->get_many_related('Event');
-    }
-
-
-    /**
-     * Gets the billing info array where keys match espresso_reg_page_billing_inputs(),
-     * and keys are their cleaned values. @see EE_Attendee::save_and_clean_billing_info_for_payment_method() which was
-     * used to save the billing info
-     *
-     * @param EE_Payment_Method $payment_method the _gateway_name property on the gateway class
-     * @return EE_Form_Section_Proper|null
-     * @throws EE_Error
-     */
-    public function billing_info_for_payment_method($payment_method)
-    {
-        $pm_type = $payment_method->type_obj();
-        if (! $pm_type instanceof EE_PMT_Base) {
-            return null;
-        }
-        $billing_info = $this->get_post_meta($this->get_billing_info_postmeta_name($payment_method), true);
-        if (! $billing_info) {
-            return null;
-        }
-        $billing_form = $pm_type->billing_form();
-        // double-check the form isn't totally hidden, in which case pretend there is no form
-        $form_totally_hidden = true;
-        foreach ($billing_form->inputs_in_subsections() as $input) {
-            if (! $input->get_display_strategy() instanceof EE_Hidden_Display_Strategy) {
-                $form_totally_hidden = false;
-                break;
-            }
-        }
-        if ($form_totally_hidden) {
-            return null;
-        }
-        if ($billing_form instanceof EE_Form_Section_Proper) {
-            $billing_form->receive_form_submission(array($billing_form->name() => $billing_info), false);
-        }
-
-        return $billing_form;
-    }
-
-
-    /**
-     * Gets the postmeta key that holds this attendee's billing info for the
-     * specified payment method
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_billing_info_postmeta_name($payment_method)
-    {
-        if ($payment_method->type_obj() instanceof EE_PMT_Base) {
-            return 'billing_info_' . $payment_method->type_obj()->system_name();
-        }
-        return null;
-    }
-
-
-    /**
-     * Saves the billing info to the attendee. @see EE_Attendee::billing_info_for_payment_method() which is used to
-     * retrieve it
-     *
-     * @param EE_Billing_Attendee_Info_Form $billing_form
-     * @param EE_Payment_Method             $payment_method
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function save_and_clean_billing_info_for_payment_method($billing_form, $payment_method)
-    {
-        if (! $billing_form instanceof EE_Billing_Attendee_Info_Form) {
-            EE_Error::add_error(__('Cannot save billing info because there is none.', 'event_espresso'));
-            return false;
-        }
-        $billing_form->clean_sensitive_data();
-        return update_post_meta(
-            $this->ID(),
-            $this->get_billing_info_postmeta_name($payment_method),
-            $billing_form->input_values(true)
-        );
-    }
-
-
-    /**
-     * Return the link to the admin details for the object.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_admin_details_link()
-    {
-        return $this->get_admin_edit_link();
-    }
-
-
-    /**
-     * Returns the link to the editor for the object.  Sometimes this is the same as the details.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_admin_edit_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_registrations',
-                'action' => 'edit_attendee',
-                'post'   => $this->ID(),
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * Returns the link to a settings page for the object.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_admin_settings_link()
-    {
-        return $this->get_admin_edit_link();
-    }
-
-
-    /**
-     * Returns the link to the "overview" for the object (typically the "list table" view).
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_admin_overview_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_registrations',
-                'action' => 'contact_list',
-            ),
-            admin_url('admin.php')
-        );
-    }
+	/**
+	 * Sets some dynamic defaults
+	 *
+	 * @param array  $fieldValues
+	 * @param bool   $bydb
+	 * @param string $timezone
+	 * @param array  $date_formats
+	 * @throws EE_Error
+	 */
+	protected function __construct($fieldValues = null, $bydb = false, $timezone = null, $date_formats = array())
+	{
+		if (! isset($fieldValues['ATT_full_name'])) {
+			$fname = isset($fieldValues['ATT_fname']) ? $fieldValues['ATT_fname'] . ' ' : '';
+			$lname = isset($fieldValues['ATT_lname']) ? $fieldValues['ATT_lname'] : '';
+			$fieldValues['ATT_full_name'] = $fname . $lname;
+		}
+		if (! isset($fieldValues['ATT_slug'])) {
+			// $fieldValues['ATT_slug'] = sanitize_key(wp_generate_password(20));
+			$fieldValues['ATT_slug'] = sanitize_title($fieldValues['ATT_full_name']);
+		}
+		if (! isset($fieldValues['ATT_short_bio']) && isset($fieldValues['ATT_bio'])) {
+			$fieldValues['ATT_short_bio'] = substr($fieldValues['ATT_bio'], 0, 50);
+		}
+		parent::__construct($fieldValues, $bydb, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Attendee
+	 * @throws EE_Error
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Attendee
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 *        Set Attendee First Name
+	 *
+	 * @access        public
+	 * @param string $fname
+	 * @throws EE_Error
+	 */
+	public function set_fname($fname = '')
+	{
+		$this->set('ATT_fname', $fname);
+	}
+
+
+	/**
+	 *        Set Attendee Last Name
+	 *
+	 * @access        public
+	 * @param string $lname
+	 * @throws EE_Error
+	 */
+	public function set_lname($lname = '')
+	{
+		$this->set('ATT_lname', $lname);
+	}
+
+
+	/**
+	 *        Set Attendee Address
+	 *
+	 * @access        public
+	 * @param string $address
+	 * @throws EE_Error
+	 */
+	public function set_address($address = '')
+	{
+		$this->set('ATT_address', $address);
+	}
+
+
+	/**
+	 *        Set Attendee Address2
+	 *
+	 * @access        public
+	 * @param        string $address2
+	 * @throws EE_Error
+	 */
+	public function set_address2($address2 = '')
+	{
+		$this->set('ATT_address2', $address2);
+	}
+
+
+	/**
+	 *        Set Attendee City
+	 *
+	 * @access        public
+	 * @param        string $city
+	 * @throws EE_Error
+	 */
+	public function set_city($city = '')
+	{
+		$this->set('ATT_city', $city);
+	}
+
+
+	/**
+	 *        Set Attendee State ID
+	 *
+	 * @access        public
+	 * @param        int $STA_ID
+	 * @throws EE_Error
+	 */
+	public function set_state($STA_ID = 0)
+	{
+		$this->set('STA_ID', $STA_ID);
+	}
+
+
+	/**
+	 *        Set Attendee Country ISO Code
+	 *
+	 * @access        public
+	 * @param        string $CNT_ISO
+	 * @throws EE_Error
+	 */
+	public function set_country($CNT_ISO = '')
+	{
+		$this->set('CNT_ISO', $CNT_ISO);
+	}
+
+
+	/**
+	 *        Set Attendee Zip/Postal Code
+	 *
+	 * @access        public
+	 * @param        string $zip
+	 * @throws EE_Error
+	 */
+	public function set_zip($zip = '')
+	{
+		$this->set('ATT_zip', $zip);
+	}
+
+
+	/**
+	 *        Set Attendee Email Address
+	 *
+	 * @access        public
+	 * @param        string $email
+	 * @throws EE_Error
+	 */
+	public function set_email($email = '')
+	{
+		$this->set('ATT_email', $email);
+	}
+
+
+	/**
+	 *        Set Attendee Phone
+	 *
+	 * @access        public
+	 * @param        string $phone
+	 * @throws EE_Error
+	 */
+	public function set_phone($phone = '')
+	{
+		$this->set('ATT_phone', $phone);
+	}
+
+
+	/**
+	 *        set deleted
+	 *
+	 * @access        public
+	 * @param        bool $ATT_deleted
+	 * @throws EE_Error
+	 */
+	public function set_deleted($ATT_deleted = false)
+	{
+		$this->set('ATT_deleted', $ATT_deleted);
+	}
+
+
+	/**
+	 * Returns the value for the post_author id saved with the cpt
+	 *
+	 * @since 4.5.0
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function wp_user()
+	{
+		return $this->get('ATT_author');
+	}
+
+
+	/**
+	 *        get Attendee First Name
+	 *
+	 * @access        public
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function fname()
+	{
+		return $this->get('ATT_fname');
+	}
+
+
+	/**
+	 * echoes out the attendee's first name
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function e_full_name()
+	{
+		echo $this->full_name();
+	}
+
+
+	/**
+	 * Returns the first and last name concatenated together with a space.
+	 *
+	 * @param bool $apply_html_entities
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function full_name($apply_html_entities = false)
+	{
+		$full_name = array(
+			$this->fname(),
+			$this->lname(),
+		);
+		$full_name = array_filter($full_name);
+		$full_name = implode(' ', $full_name);
+		return $apply_html_entities ? htmlentities($full_name, ENT_QUOTES, 'UTF-8') : $full_name;
+	}
+
+
+	/**
+	 * This returns the value of the `ATT_full_name` field which is usually equivalent to calling `full_name()` unless
+	 * the post_title field has been directly modified in the db for the post (espresso_attendees post type) for this
+	 * attendee.
+	 *
+	 * @param bool $apply_html_entities
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function ATT_full_name($apply_html_entities = false)
+	{
+		return $apply_html_entities
+			? htmlentities($this->get('ATT_full_name'), ENT_QUOTES, 'UTF-8')
+			: $this->get('ATT_full_name');
+	}
+
+
+	/**
+	 *        get Attendee Last Name
+	 *
+	 * @access        public
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function lname()
+	{
+		return $this->get('ATT_lname');
+	}
+
+
+	/**
+	 * Gets the attendee's full address as an array so client code can decide hwo to display it
+	 *
+	 * @return array numerically indexed, with each part of the address that is known.
+	 * Eg, if the user only responded to state and country,
+	 * it would be array(0=>'Alabama',1=>'USA')
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function full_address_as_array()
+	{
+		$full_address_array = array();
+		$initial_address_fields = array('ATT_address', 'ATT_address2', 'ATT_city',);
+		foreach ($initial_address_fields as $address_field_name) {
+			$address_fields_value = $this->get($address_field_name);
+			if (! empty($address_fields_value)) {
+				$full_address_array[] = $address_fields_value;
+			}
+		}
+		// now handle state and country
+		$state_obj = $this->state_obj();
+		if ($state_obj instanceof EE_State) {
+			$full_address_array[] = $state_obj->name();
+		}
+		$country_obj = $this->country_obj();
+		if ($country_obj instanceof EE_Country) {
+			$full_address_array[] = $country_obj->name();
+		}
+		// lastly get the xip
+		$zip_value = $this->zip();
+		if (! empty($zip_value)) {
+			$full_address_array[] = $zip_value;
+		}
+		return $full_address_array;
+	}
+
+
+	/**
+	 *        get Attendee Address
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function address()
+	{
+		return $this->get('ATT_address');
+	}
+
+
+	/**
+	 *        get Attendee Address2
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function address2()
+	{
+		return $this->get('ATT_address2');
+	}
+
+
+	/**
+	 *        get Attendee City
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function city()
+	{
+		return $this->get('ATT_city');
+	}
+
+
+	/**
+	 *        get Attendee State ID
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function state_ID()
+	{
+		return $this->get('STA_ID');
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function state_abbrev()
+	{
+		return $this->state_obj() instanceof EE_State ? $this->state_obj()->abbrev() : '';
+	}
+
+
+	/**
+	 * Gets the state set to this attendee
+	 *
+	 * @return EE_State
+	 * @throws EE_Error
+	 */
+	public function state_obj()
+	{
+		return $this->get_first_related('State');
+	}
+
+
+	/**
+	 * Returns the state's name, otherwise 'Unknown'
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function state_name()
+	{
+		if ($this->state_obj()) {
+			return $this->state_obj()->name();
+		} else {
+			return '';
+		}
+	}
+
+
+	/**
+	 * either displays the state abbreviation or the state name, as determined
+	 * by the "FHEE__EEI_Address__state__use_abbreviation" filter.
+	 * defaults to abbreviation
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function state()
+	{
+		if (apply_filters('FHEE__EEI_Address__state__use_abbreviation', true, $this->state_obj())) {
+			return $this->state_abbrev();
+		}
+		return $this->state_name();
+	}
+
+
+	/**
+	 *    get Attendee Country ISO Code
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function country_ID()
+	{
+		return $this->get('CNT_ISO');
+	}
+
+
+	/**
+	 * Gets country set for this attendee
+	 *
+	 * @return EE_Country
+	 * @throws EE_Error
+	 */
+	public function country_obj()
+	{
+		return $this->get_first_related('Country');
+	}
+
+
+	/**
+	 * Returns the country's name if known, otherwise 'Unknown'
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function country_name()
+	{
+		if ($this->country_obj()) {
+			return $this->country_obj()->name();
+		}
+		return '';
+	}
+
+
+	/**
+	 * either displays the country ISO2 code or the country name, as determined
+	 * by the "FHEE__EEI_Address__country__use_abbreviation" filter.
+	 * defaults to abbreviation
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function country()
+	{
+		if (apply_filters('FHEE__EEI_Address__country__use_abbreviation', true, $this->country_obj())) {
+			return $this->country_ID();
+		}
+		return $this->country_name();
+	}
+
+
+	/**
+	 *        get Attendee Zip/Postal Code
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function zip()
+	{
+		return $this->get('ATT_zip');
+	}
+
+
+	/**
+	 *        get Attendee Email Address
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function email()
+	{
+		return $this->get('ATT_email');
+	}
+
+
+	/**
+	 *        get Attendee Phone #
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function phone()
+	{
+		return $this->get('ATT_phone');
+	}
+
+
+	/**
+	 *    get deleted
+	 *
+	 * @return        bool
+	 * @throws EE_Error
+	 */
+	public function deleted()
+	{
+		return $this->get('ATT_deleted');
+	}
+
+
+	/**
+	 * Gets registrations of this attendee
+	 *
+	 * @param array $query_params
+	 * @return EE_Registration[]
+	 * @throws EE_Error
+	 */
+	public function get_registrations($query_params = array())
+	{
+		return $this->get_many_related('Registration', $query_params);
+	}
+
+
+	/**
+	 * Gets the most recent registration of this attendee
+	 *
+	 * @return EE_Registration
+	 * @throws EE_Error
+	 */
+	public function get_most_recent_registration()
+	{
+		return $this->get_first_related(
+			'Registration',
+			array('order_by' => array('REG_date' => 'DESC'))
+		); // null, 'REG_date', 'DESC', '=', 'OBJECT_K');
+	}
+
+
+	/**
+	 * Gets the most recent registration for this attend at this event
+	 *
+	 * @param int $event_id
+	 * @return EE_Registration
+	 * @throws EE_Error
+	 */
+	public function get_most_recent_registration_for_event($event_id)
+	{
+		return $this->get_first_related(
+			'Registration',
+			array(array('EVT_ID' => $event_id), 'order_by' => array('REG_date' => 'DESC'))
+		);
+	}
+
+
+	/**
+	 * returns any events attached to this attendee ($_Event property);
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function events()
+	{
+		return $this->get_many_related('Event');
+	}
+
+
+	/**
+	 * Gets the billing info array where keys match espresso_reg_page_billing_inputs(),
+	 * and keys are their cleaned values. @see EE_Attendee::save_and_clean_billing_info_for_payment_method() which was
+	 * used to save the billing info
+	 *
+	 * @param EE_Payment_Method $payment_method the _gateway_name property on the gateway class
+	 * @return EE_Form_Section_Proper|null
+	 * @throws EE_Error
+	 */
+	public function billing_info_for_payment_method($payment_method)
+	{
+		$pm_type = $payment_method->type_obj();
+		if (! $pm_type instanceof EE_PMT_Base) {
+			return null;
+		}
+		$billing_info = $this->get_post_meta($this->get_billing_info_postmeta_name($payment_method), true);
+		if (! $billing_info) {
+			return null;
+		}
+		$billing_form = $pm_type->billing_form();
+		// double-check the form isn't totally hidden, in which case pretend there is no form
+		$form_totally_hidden = true;
+		foreach ($billing_form->inputs_in_subsections() as $input) {
+			if (! $input->get_display_strategy() instanceof EE_Hidden_Display_Strategy) {
+				$form_totally_hidden = false;
+				break;
+			}
+		}
+		if ($form_totally_hidden) {
+			return null;
+		}
+		if ($billing_form instanceof EE_Form_Section_Proper) {
+			$billing_form->receive_form_submission(array($billing_form->name() => $billing_info), false);
+		}
+
+		return $billing_form;
+	}
+
+
+	/**
+	 * Gets the postmeta key that holds this attendee's billing info for the
+	 * specified payment method
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_billing_info_postmeta_name($payment_method)
+	{
+		if ($payment_method->type_obj() instanceof EE_PMT_Base) {
+			return 'billing_info_' . $payment_method->type_obj()->system_name();
+		}
+		return null;
+	}
+
+
+	/**
+	 * Saves the billing info to the attendee. @see EE_Attendee::billing_info_for_payment_method() which is used to
+	 * retrieve it
+	 *
+	 * @param EE_Billing_Attendee_Info_Form $billing_form
+	 * @param EE_Payment_Method             $payment_method
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function save_and_clean_billing_info_for_payment_method($billing_form, $payment_method)
+	{
+		if (! $billing_form instanceof EE_Billing_Attendee_Info_Form) {
+			EE_Error::add_error(__('Cannot save billing info because there is none.', 'event_espresso'));
+			return false;
+		}
+		$billing_form->clean_sensitive_data();
+		return update_post_meta(
+			$this->ID(),
+			$this->get_billing_info_postmeta_name($payment_method),
+			$billing_form->input_values(true)
+		);
+	}
+
+
+	/**
+	 * Return the link to the admin details for the object.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_admin_details_link()
+	{
+		return $this->get_admin_edit_link();
+	}
+
+
+	/**
+	 * Returns the link to the editor for the object.  Sometimes this is the same as the details.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_admin_edit_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_registrations',
+				'action' => 'edit_attendee',
+				'post'   => $this->ID(),
+			),
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * Returns the link to a settings page for the object.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_admin_settings_link()
+	{
+		return $this->get_admin_edit_link();
+	}
+
+
+	/**
+	 * Returns the link to the "overview" for the object (typically the "list table" view).
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_admin_overview_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_registrations',
+				'action' => 'contact_list',
+			),
+			admin_url('admin.php')
+		);
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -36,16 +36,16 @@ 
      */
     protected function __construct($fieldValues = null, $bydb = false, $timezone = null, $date_formats = array())
     {
-        if (! isset($fieldValues['ATT_full_name'])) {
-            $fname = isset($fieldValues['ATT_fname']) ? $fieldValues['ATT_fname'] . ' ' : '';
+        if ( ! isset($fieldValues['ATT_full_name'])) {
+            $fname = isset($fieldValues['ATT_fname']) ? $fieldValues['ATT_fname'].' ' : '';
             $lname = isset($fieldValues['ATT_lname']) ? $fieldValues['ATT_lname'] : '';
-            $fieldValues['ATT_full_name'] = $fname . $lname;
+            $fieldValues['ATT_full_name'] = $fname.$lname;
         }
-        if (! isset($fieldValues['ATT_slug'])) {
+        if ( ! isset($fieldValues['ATT_slug'])) {
             // $fieldValues['ATT_slug'] = sanitize_key(wp_generate_password(20));
             $fieldValues['ATT_slug'] = sanitize_title($fieldValues['ATT_full_name']);
         }
-        if (! isset($fieldValues['ATT_short_bio']) && isset($fieldValues['ATT_bio'])) {
+        if ( ! isset($fieldValues['ATT_short_bio']) && isset($fieldValues['ATT_bio'])) {
             $fieldValues['ATT_short_bio'] = substr($fieldValues['ATT_bio'], 0, 50);
         }
         parent::__construct($fieldValues, $bydb, $timezone, $date_formats);
@@ -325,7 +325,7 @@ 
         $initial_address_fields = array('ATT_address', 'ATT_address2', 'ATT_city',);
         foreach ($initial_address_fields as $address_field_name) {
             $address_fields_value = $this->get($address_field_name);
-            if (! empty($address_fields_value)) {
+            if ( ! empty($address_fields_value)) {
                 $full_address_array[] = $address_fields_value;
             }
         }
@@ -340,7 +340,7 @@ 
         }
         // lastly get the xip
         $zip_value = $this->zip();
-        if (! empty($zip_value)) {
+        if ( ! empty($zip_value)) {
             $full_address_array[] = $zip_value;
         }
         return $full_address_array;
@@ -622,18 +622,18 @@ 
     public function billing_info_for_payment_method($payment_method)
     {
         $pm_type = $payment_method->type_obj();
-        if (! $pm_type instanceof EE_PMT_Base) {
+        if ( ! $pm_type instanceof EE_PMT_Base) {
             return null;
         }
         $billing_info = $this->get_post_meta($this->get_billing_info_postmeta_name($payment_method), true);
-        if (! $billing_info) {
+        if ( ! $billing_info) {
             return null;
         }
         $billing_form = $pm_type->billing_form();
         // double-check the form isn't totally hidden, in which case pretend there is no form
         $form_totally_hidden = true;
         foreach ($billing_form->inputs_in_subsections() as $input) {
-            if (! $input->get_display_strategy() instanceof EE_Hidden_Display_Strategy) {
+            if ( ! $input->get_display_strategy() instanceof EE_Hidden_Display_Strategy) {
                 $form_totally_hidden = false;
                 break;
             }
@@ -660,7 +660,7 @@ 
     public function get_billing_info_postmeta_name($payment_method)
     {
         if ($payment_method->type_obj() instanceof EE_PMT_Base) {
-            return 'billing_info_' . $payment_method->type_obj()->system_name();
+            return 'billing_info_'.$payment_method->type_obj()->system_name();
         }
         return null;
     }
@@ -677,7 +677,7 @@ 
      */
     public function save_and_clean_billing_info_for_payment_method($billing_form, $payment_method)
     {
-        if (! $billing_form instanceof EE_Billing_Attendee_Info_Form) {
+        if ( ! $billing_form instanceof EE_Billing_Attendee_Info_Form) {
             EE_Error::add_error(__('Cannot save billing info because there is none.', 'event_espresso'));
             return false;
         }

core/db_classes/EE_WP_User.class.php

Spacing +1 added lines, -1 removed lines

@@ -51,7 +51,7 @@
      */
     public function wp_user_obj()
     {
-        if (! $this->_wp_user_obj) {
+        if ( ! $this->_wp_user_obj) {
             $this->_wp_user_obj = get_user_by('ID', $this->ID());
         }
         return $this->_wp_user_obj;

Indentation +79 added lines, -79 removed lines

@@ -11,91 +11,91 @@
 class EE_WP_User extends EE_Base_Class implements EEI_Admin_Links
 {
 
-    /**
-     * @var WP_User
-     */
-    protected $_wp_user_obj;
+	/**
+	 * @var WP_User
+	 */
+	protected $_wp_user_obj;
 
-    /**
-     * @param array $props_n_values
-     * @return EE_WP_User|mixed
-     */
-    public static function new_instance($props_n_values = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ? $has_object : new self($props_n_values);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_WP_User|mixed
+	 */
+	public static function new_instance($props_n_values = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ? $has_object : new self($props_n_values);
+	}
 
 
-    /**
-     * @param array $props_n_values
-     * @return EE_WP_User
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_WP_User
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
 
-    /**
-     * Return a normal WP_User object (caches the object for future calls)
-     *
-     * @return WP_User
-     */
-    public function wp_user_obj()
-    {
-        if (! $this->_wp_user_obj) {
-            $this->_wp_user_obj = get_user_by('ID', $this->ID());
-        }
-        return $this->_wp_user_obj;
-    }
+	/**
+	 * Return a normal WP_User object (caches the object for future calls)
+	 *
+	 * @return WP_User
+	 */
+	public function wp_user_obj()
+	{
+		if (! $this->_wp_user_obj) {
+			$this->_wp_user_obj = get_user_by('ID', $this->ID());
+		}
+		return $this->_wp_user_obj;
+	}
 
-    /**
-     * Return the link to the admin details for the object.
-     *
-     * @return string
-     */
-    public function get_admin_details_link()
-    {
-        return $this->get_admin_edit_link();
-    }
+	/**
+	 * Return the link to the admin details for the object.
+	 *
+	 * @return string
+	 */
+	public function get_admin_details_link()
+	{
+		return $this->get_admin_edit_link();
+	}
 
-    /**
-     * Returns the link to the editor for the object.  Sometimes this is the same as the details.
-     *
-     * @return string
-     */
-    public function get_admin_edit_link()
-    {
-        return esc_url(
-            add_query_arg(
-                'wp_http_referer',
-                urlencode(
-                    wp_unslash(
-                        $_SERVER['REQUEST_URI']
-                    )
-                ),
-                get_edit_user_link($this->ID())
-            )
-        );
-    }
+	/**
+	 * Returns the link to the editor for the object.  Sometimes this is the same as the details.
+	 *
+	 * @return string
+	 */
+	public function get_admin_edit_link()
+	{
+		return esc_url(
+			add_query_arg(
+				'wp_http_referer',
+				urlencode(
+					wp_unslash(
+						$_SERVER['REQUEST_URI']
+					)
+				),
+				get_edit_user_link($this->ID())
+			)
+		);
+	}
 
-    /**
-     * Returns the link to a settings page for the object.
-     *
-     * @return string
-     */
-    public function get_admin_settings_link()
-    {
-        return $this->get_admin_edit_link();
-    }
+	/**
+	 * Returns the link to a settings page for the object.
+	 *
+	 * @return string
+	 */
+	public function get_admin_settings_link()
+	{
+		return $this->get_admin_edit_link();
+	}
 
-    /**
-     * Returns the link to the "overview" for the object (typically the "list table" view).
-     *
-     * @return string
-     */
-    public function get_admin_overview_link()
-    {
-        return admin_url('users.php');
-    }
+	/**
+	 * Returns the link to the "overview" for the object (typically the "list table" view).
+	 *
+	 * @return string
+	 */
+	public function get_admin_overview_link()
+	{
+		return admin_url('users.php');
+	}
 }