eventespresso / event-espresso-core

core/services/request/RequestParams.php

Spacing +16 added lines, -16 removed lines

@@ -17,13 +17,13 @@ 
      * Used for matches() and parameterDrillDown()
      * 'bool' will return true or false if match is found or not
      */
-    const RETURN_BOOL  = 'bool';
+    const RETURN_BOOL = 'bool';
 
     /**
      * Used for matches() and parameterDrillDown()
      * 'key' will return the first key found that matches the supplied pattern
      */
-    const RETURN_KEY   = 'key';
+    const RETURN_KEY = 'key';
 
     /**
      * Used for matches() and parameterDrillDown()
@@ -113,7 +113,7 @@ 
     {
         // don't allow "ee" to be overwritten unless explicitly instructed to do so
         if ($override_ee || $key !== 'ee' || empty($this->request['ee'])) {
-            $this->request[ $key ] = $value;
+            $this->request[$key] = $value;
         }
     }
 
@@ -237,7 +237,7 @@ 
             preg_quote($pattern, '/')
         );
         foreach ($request_params as $key => $request_param) {
-            if (preg_match('/^' . $pattern . '$/is', $key)) {
+            if (preg_match('/^'.$pattern.'$/is', $key)) {
                 // return value for request param
                 if ($return === self::RETURN_VALUE) {
                     return $request_param;
@@ -299,30 +299,30 @@ 
                 $key      = $real_key ?: $key;
             }
             // check if top level key exists
-            if (isset($request_params[ $key ])) {
+            if (isset($request_params[$key])) {
                 // build a new key to pass along like: 'second[third]'
                 // or just 'second' depending on depth of keys
                 $key_string = array_shift($keys);
-                if (! empty($keys)) {
-                    $key_string .= '[' . implode('][', $keys) . ']';
+                if ( ! empty($keys)) {
+                    $key_string .= '['.implode('][', $keys).']';
                 }
                 return $this->parameterDrillDown(
                     $key_string,
                     $default,
                     $callback,
                     $return,
-                    $request_params[ $key ]
+                    $request_params[$key]
                 );
             }
         }
         if ($callback === 'is_set') {
-            return isset($request_params[ $key ]);
+            return isset($request_params[$key]);
         }
         if ($callback === 'match') {
             return $this->match($key, $request_params, $default, $return);
         }
-        return isset($request_params[ $key ])
-            ? $request_params[ $key ]
+        return isset($request_params[$key])
+            ? $request_params[$key]
             : $default;
     }
 
@@ -336,12 +336,12 @@ 
     public function unSetRequestParam($key, $unset_from_global_too = false)
     {
         // because unset may not actually remove var
-        $this->get[ $key ]     = null;
-        $this->post[ $key ]    = null;
-        $this->request[ $key ] = null;
-        unset($this->get[ $key ], $this->post[ $key ], $this->request[ $key ]);
+        $this->get[$key]     = null;
+        $this->post[$key]    = null;
+        $this->request[$key] = null;
+        unset($this->get[$key], $this->post[$key], $this->request[$key]);
         if ($unset_from_global_too) {
-            unset($_GET[ $key ], $_POST[ $key ], $_REQUEST[ $key ]);
+            unset($_GET[$key], $_POST[$key], $_REQUEST[$key]);
         }
     }
 

Indentation +353 added lines, -353 removed lines

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

admin_pages/messages/templates/shortcode_selector_skeleton.template.php

Indentation +5 added lines, -5 removed lines

@@ -28,14 +28,14 @@
         </h6>
         <h4>
             <?php
-            printf(
-                esc_html__('"%1$s" field', 'event_espresso'),
-                esc_attr($fieldname)
-            ); ?>
+			printf(
+				esc_html__('"%1$s" field', 'event_espresso'),
+				esc_attr($fieldname)
+			); ?>
         </h4>
         <ul>
         <?php
-        foreach (array_keys($shortcodes) as $shortcode) : ?>
+		foreach (array_keys($shortcodes) as $shortcode) : ?>
             <li>
                 <span class="js-shortcode-selection"
                       data-linked-input-id="<?php echo esc_attr($linked_input_id); ?>"

Spacing +1 added lines, -1 removed lines

@@ -10,7 +10,7 @@
  * @type    string $linked_input_id The name of the input that the shortcode gets inserted to.
  */
 
-if (! empty($shortcodes)) : ?>
+if ( ! empty($shortcodes)) : ?>
 <div class="ee-messages-shortcodes-chooser-wrap">
     <button class="button button--secondary button--icon-only ee-messages-shortcodes-chooser js-open-list-trigger"
             aria-label="<?php echo esc_html__('open shortcode selector', 'event_espresso'); ?>"

admin_pages/venues/Venues_Admin_Page.core.php

Spacing +34 added lines, -34 removed lines

@@ -45,10 +45,10 @@ 
      */
     protected function _init_page_props()
     {
-        require_once(EE_MODELS . 'EEM_Venue.model.php');
+        require_once(EE_MODELS.'EEM_Venue.model.php');
         $this->page_slug        = EE_VENUES_PG_SLUG;
         $this->_admin_base_url  = EE_VENUES_ADMIN_URL;
-        $this->_admin_base_path = EE_ADMIN_PAGES . 'venues';
+        $this->_admin_base_path = EE_ADMIN_PAGES.'venues';
         $this->page_label       = esc_html__('Event Venues', 'event_espresso');
         $this->_cpt_model_names = [
             'create_new' => 'EEM_Venue',
@@ -466,7 +466,7 @@ 
 
     public function load_scripts_styles()
     {
-        wp_register_style('ee-cat-admin', EVENTS_ASSETS_URL . 'ee-cat-admin.css', [], EVENT_ESPRESSO_VERSION);
+        wp_register_style('ee-cat-admin', EVENTS_ASSETS_URL.'ee-cat-admin.css', [], EVENT_ESPRESSO_VERSION);
         wp_enqueue_style('ee-cat-admin');
     }
 
@@ -488,7 +488,7 @@ 
         wp_enqueue_style('espresso-ui-theme');
         wp_register_style(
             'espresso_venues',
-            EE_VENUES_ASSETS_URL . 'ee-venues-admin.css',
+            EE_VENUES_ASSETS_URL.'ee-venues-admin.css',
             [],
             EVENT_ESPRESSO_VERSION
         );
@@ -551,14 +551,14 @@ 
             'button'
         );
 
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+        $this->_admin_page_title .= ' '.$this->get_action_link_or_button(
             'create_new',
             'add',
             [],
             'add-new-h2'
         );
 
-        $this->_search_btn_label  = esc_html__('Venues', 'event_espresso');
+        $this->_search_btn_label = esc_html__('Venues', 'event_espresso');
         $this->display_admin_list_table_page_with_sidebar();
     }
 
@@ -574,7 +574,7 @@ 
             'vnu_url'      => $this->_cpt_model_obj->get_f('VNU_url'),
             'vnu_phone'    => $this->_cpt_model_obj->get_f('VNU_phone'),
         ];
-        $template   = EE_VENUES_TEMPLATE_PATH . 'venue_publish_box_extras.template.php';
+        $template = EE_VENUES_TEMPLATE_PATH.'venue_publish_box_extras.template.php';
         EEH_Template::display_template($template, $extra_rows);
     }
 
@@ -638,7 +638,7 @@ 
         $this->_set_add_edit_form_tags('update_google_map_settings');
         $this->_set_publish_post_box_vars(null, false, false, null, false);
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EE_VENUES_TEMPLATE_PATH . 'google_map.template.php',
+            EE_VENUES_TEMPLATE_PATH.'google_map.template.php',
             $this->_template_args,
             true
         );
@@ -734,7 +734,7 @@ 
             ),
             'vnu_google_map_link' => $this->_cpt_model_obj->google_map_link(),
         ];
-        $template      = EE_VENUES_TEMPLATE_PATH . 'venue_gmap_metabox_content.template.php';
+        $template = EE_VENUES_TEMPLATE_PATH.'venue_gmap_metabox_content.template.php';
         EEH_Template::display_template($template, $template_args);
     }
 
@@ -747,7 +747,7 @@ 
     {
         $template_args['_venue'] = $this->_cpt_model_obj;
 
-        $template_args['states_dropdown']    = EEH_Form_Fields::generate_form_input(
+        $template_args['states_dropdown'] = EEH_Form_Fields::generate_form_input(
             new EE_Question_Form_Input(
                 EE_Question::new_instance(
                     ['QST_display_text' => esc_html__('State', 'event_espresso'), 'QST_system' => 'state']
@@ -790,7 +790,7 @@ 
             )
         );
 
-        $template = EE_VENUES_TEMPLATE_PATH . 'venue_address_metabox_content.template.php';
+        $template = EE_VENUES_TEMPLATE_PATH.'venue_address_metabox_content.template.php';
         EEH_Template::display_template($template, $template_args);
     }
 
@@ -800,7 +800,7 @@ 
         $template_args = [
             '_venue' => $this->_cpt_model_obj,
         ];
-        $template      = EE_VENUES_TEMPLATE_PATH . 'venue_virtual_location_metabox_content.template.php';
+        $template      = EE_VENUES_TEMPLATE_PATH.'venue_virtual_location_metabox_content.template.php';
         EEH_Template::display_template($template, $template_args);
     }
 
@@ -825,7 +825,7 @@ 
     {
 
         if ($post instanceof WP_Post && $post->post_type !== 'espresso_venues') {
-            return;// get out we're not processing the saving of venues.
+            return; // get out we're not processing the saving of venues.
         }
 
         $wheres = [$this->_venue_model->primary_key_name() => $post_id];
@@ -860,7 +860,7 @@ 
             'FHEE__Venues_Admin_Page___insert_update_cpt_item__venue_update_callbacks',
             []
         );
-        $att_success            = true;
+        $att_success = true;
         foreach ($venue_update_callbacks as $v_callback) {
             // if ANY of these updates fail then we want the appropriate global error message
             $att_success = call_user_func_array($v_callback, [$venue, $this->request->requestParams()])
@@ -945,7 +945,7 @@ 
             // clean status
             $venue_status = sanitize_key($venue_status);
             // grab status
-            if (! empty($venue_status)) {
+            if ( ! empty($venue_status)) {
                 $success = $this->_change_venue_status($VNU_ID, $venue_status);
             } else {
                 $success = false;
@@ -980,7 +980,7 @@ 
         // clean status
         $venue_status = sanitize_key($venue_status);
         // grab status
-        if (! empty($venue_status)) {
+        if ( ! empty($venue_status)) {
             $success = true;
             // determine the event id and set to array.
             $VNU_IDs = $this->request->getRequestParam('venue_id', [], 'int', true);
@@ -1033,7 +1033,7 @@ 
     private function _change_venue_status($VNU_ID = 0, $venue_status = '')
     {
         // grab venue id
-        if (! $VNU_ID) {
+        if ( ! $VNU_ID) {
             $msg = esc_html__('An error occurred. No Venue ID or an invalid Venue ID was received.', 'event_espresso');
             EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
@@ -1044,7 +1044,7 @@ 
         // clean status
         $venue_status = sanitize_key($venue_status);
         // grab status
-        if (! $venue_status) {
+        if ( ! $venue_status) {
             $msg = esc_html__(
                 'An error occurred. No Venue Status or an invalid Venue Status was received.',
                 'event_espresso'
@@ -1156,7 +1156,7 @@ 
     private function _delete_or_trash_venue($VNU_ID = false)
     {
         // grab event id
-        if (! $VNU_ID = absint($VNU_ID)) {
+        if ( ! $VNU_ID = absint($VNU_ID)) {
             $msg = esc_html__('An error occurred. No Venue ID or an invalid Venue ID was received.', 'event_espresso');
             EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
@@ -1244,10 +1244,10 @@ 
         }
 
 
-        if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_venues', 'get_venues')) {
+        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_venues', 'get_venues')) {
             $where['VNU_wp_user'] = get_current_user_id();
         } else {
-            if (! EE_Registry::instance()->CAP->current_user_can('ee_read_private_venues', 'get_venues')) {
+            if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_private_venues', 'get_venues')) {
                 $where['OR'] = [
                     'status*restrict_private' => ['!=', 'private'],
                     'AND'                     => [
@@ -1260,7 +1260,7 @@ 
 
         $search_term = $this->request->getRequestParam('s');
         if ($search_term) {
-            $search_term = '%' . $search_term . '%';
+            $search_term = '%'.$search_term.'%';
             $where['OR'] = [
                 'VNU_name'               => ['LIKE', $search_term],
                 'VNU_desc'               => ['LIKE', $search_term],
@@ -1311,14 +1311,14 @@ 
 
         // only set if we've got an id
         $category_ID = $this->request->getRequestParam('VEN_CAT_ID', 0, 'int');
-        if (! $category_ID) {
+        if ( ! $category_ID) {
             return;
         }
 
         $term = get_term($category_ID, 'espresso_venue_categories');
 
 
-        if (! empty($term)) {
+        if ( ! empty($term)) {
             $this->_category->category_name       = $term->name;
             $this->_category->category_identifier = $term->slug;
             $this->_category->category_desc       = $term->description;
@@ -1342,7 +1342,7 @@ 
     protected function _category_list_table()
     {
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+        $this->_admin_page_title .= ' '.$this->get_action_link_or_button(
             'add_category',
             'add_category',
             [],
@@ -1388,7 +1388,7 @@ 
             'class'         => 'my_editor_custom',
             'wpeditor_args' => ['media_buttons' => false],
         ];
-        $_wp_editor                   = $this->_generate_admin_form_fields($editor_args, 'array');
+        $_wp_editor = $this->_generate_admin_form_fields($editor_args, 'array');
 
         $all_terms = get_terms(
             ['espresso_venue_categories'],
@@ -1412,7 +1412,7 @@ 
             $category_select_values,
             $this->_category->parent
         );
-        $template_args   = [
+        $template_args = [
             'category'                 => $this->_category,
             'category_select'          => $category_select,
             'unique_id_info_help_link' => $this->_get_help_tab_link('unique_id_info'),
@@ -1420,7 +1420,7 @@ 
             'disable'                  => '',
             'disabled_message'         => false,
         ];
-        $template        = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php';
+        $template = EVENTS_TEMPLATE_PATH.'event_category_details.template.php';
         return EEH_Template::display_template($template, $template_args, true);
     }
 
@@ -1500,7 +1500,7 @@ 
                 $term_args
             );
 
-        if (! is_array($insert_ids)) {
+        if ( ! is_array($insert_ids)) {
             EE_Error::add_error(
                 esc_html__('An error occurred and the category has not been saved to the database.', 'event_espresso'),
                 __FILE__,
@@ -1537,8 +1537,8 @@ 
             ]
         );
 
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-            require_once(EE_CLASSES . 'EE_Export.class.php');
+        if (is_readable(EE_CLASSES.'EE_Export.class.php')) {
+            require_once(EE_CLASSES.'EE_Export.class.php');
             $EE_Export = EE_Export::instance($this->request->requestParams());
             $EE_Export->export();
         }
@@ -1548,7 +1548,7 @@ 
     protected function _import_categories()
     {
 
-        require_once(EE_CLASSES . 'EE_Import.class.php');
+        require_once(EE_CLASSES.'EE_Import.class.php');
         EE_Import::instance()->import();
     }
 
@@ -1566,7 +1566,7 @@ 
         $where       = ['taxonomy' => 'espresso_venue_categories'];
         $search_term = $this->request->getRequestParam('s');
         if ($search_term) {
-            $search_term = '%' . $search_term . '%';
+            $search_term = '%'.$search_term.'%';
             $where['OR'] = [
                 'Term.name'   => ['LIKE', $search_term],
                 'description' => ['LIKE', $search_term],
@@ -1576,7 +1576,7 @@ 
         $query_params = [
             $where,
             'order_by'   => [$orderby => $order],
-            'limit'      => $limit . ',' . $per_page,
+            'limit'      => $limit.','.$per_page,
             'force_join' => ['Term'],
         ];
 

Indentation +1563 added lines, -1563 removed lines

@@ -13,1573 +13,1573 @@
  */
 class Venues_Admin_Page extends EE_Admin_Page_CPT
 {
-    /**
-     * _venue
-     * This will hold the venue object for venue_details screen.
-     *
-     * @access protected
-     * @var object
-     */
-    protected $_venue;
-
-
-    /**
-     * This will hold the category object for category_details screen.
-     *
-     * @var object
-     */
-    protected $_category;
-
-
-    /**
-     * This property will hold the venue model instance
-     *
-     * @var object
-     */
-    protected $_venue_model;
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _init_page_props()
-    {
-        require_once(EE_MODELS . 'EEM_Venue.model.php');
-        $this->page_slug        = EE_VENUES_PG_SLUG;
-        $this->_admin_base_url  = EE_VENUES_ADMIN_URL;
-        $this->_admin_base_path = EE_ADMIN_PAGES . 'venues';
-        $this->page_label       = esc_html__('Event Venues', 'event_espresso');
-        $this->_cpt_model_names = [
-            'create_new' => 'EEM_Venue',
-            'edit'       => 'EEM_Venue',
-        ];
-        $this->_cpt_edit_routes = [
-            'espresso_venues' => 'edit',
-        ];
-        $this->_venue_model     = EEM_Venue::instance();
-    }
-
-
-    protected function _ajax_hooks()
-    {
-        // todo: all hooks for ee_venues ajax goes in here.
-    }
-
-
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = $this->page_label;
-        $this->_labels           = [
-            'buttons'      => [
-                'add'             => esc_html__('Add New Venue', 'event_espresso'),
-                'edit'            => esc_html__('Edit Venue', 'event_espresso'),
-                'delete'          => esc_html__('Delete Venue', 'event_espresso'),
-                'add_category'    => esc_html__('Add New Category', 'event_espresso'),
-                'edit_category'   => esc_html__('Edit Category', 'event_espresso'),
-                'delete_category' => esc_html__('Delete Category', 'event_espresso'),
-            ],
-            'editor_title' => [
-                'espresso_venues' => esc_html__('Enter Venue name here', 'event_espresso'),
-            ],
-            'publishbox'   => [
-                'create_new'          => esc_html__('Save New Venue', 'event_espresso'),
-                'edit'                => esc_html__('Update Venue', 'event_espresso'),
-                'add_category'        => esc_html__('Save New Category', 'event_espresso'),
-                'edit_category'       => esc_html__('Update Category', 'event_espresso'),
-                'google_map_settings' => esc_html__('Update Settings', 'event_espresso'),
-            ],
-        ];
-    }
-
-
-    protected function _set_page_routes()
-    {
-
-        // load formatter helper
-        // load field generator helper
-
-        // is there a vnu_id in the request?
-        $VNU_ID = $this->request->getRequestParam('VNU_ID', 0, 'int');
-        $VNU_ID = $this->request->getRequestParam('post', $VNU_ID, 'int');
-
-        $this->_page_routes = [
-            'default'                    => [
-                'func'       => '_overview_list_table',
-                'capability' => 'ee_read_venues',
-            ],
-            'create_new'                 => [
-                'func'       => '_create_new_cpt_item',
-                'capability' => 'ee_edit_venues',
-            ],
-            'edit'                       => [
-                'func'       => '_edit_cpt_item',
-                'capability' => 'ee_edit_venue',
-                'obj_id'     => $VNU_ID,
-            ],
-            'trash_venue'                => [
-                'func'       => '_trash_or_restore_venue',
-                'args'       => ['venue_status' => 'trash'],
-                'noheader'   => true,
-                'capability' => 'ee_delete_venue',
-                'obj_id'     => $VNU_ID,
-            ],
-            'trash_venues'               => [
-                'func'       => '_trash_or_restore_venues',
-                'args'       => ['venue_status' => 'trash'],
-                'noheader'   => true,
-                'capability' => 'ee_delete_venues',
-            ],
-            'restore_venue'              => [
-                'func'       => '_trash_or_restore_venue',
-                'args'       => ['venue_status' => 'draft'],
-                'noheader'   => true,
-                'capability' => 'ee_delete_venue',
-                'obj_id'     => $VNU_ID,
-            ],
-            'restore_venues'             => [
-                'func'       => '_trash_or_restore_venues',
-                'args'       => ['venue_status' => 'draft'],
-                'noheader'   => true,
-                'capability' => 'ee_delete_venues',
-            ],
-            'delete_venues'              => [
-                'func'       => '_delete_venues',
-                'noheader'   => true,
-                'capability' => 'ee_delete_venues',
-            ],
-            'delete_venue'               => [
-                'func'       => '_delete_venue',
-                'noheader'   => true,
-                'capability' => 'ee_delete_venue',
-                'obj_id'     => $VNU_ID,
-            ],
-            // settings related
-            'google_map_settings'        => [
-                'func'       => '_google_map_settings',
-                'capability' => 'manage_options',
-            ],
-            'update_google_map_settings' => [
-                'func'       => '_update_google_map_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-            // venue category tab related
-            'add_category'               => [
-                'func'       => '_category_details',
-                'args'       => ['add'],
-                'capability' => 'ee_edit_venue_category',
-            ],
-            'edit_category'              => [
-                'func'       => '_category_details',
-                'args'       => ['edit'],
-                'capability' => 'ee_edit_venue_category',
-            ],
-            'delete_categories'          => [
-                'func'       => '_delete_categories',
-                'noheader'   => true,
-                'capability' => 'ee_delete_venue_category',
-            ],
-
-            'delete_category' => [
-                'func'       => '_delete_categories',
-                'noheader'   => true,
-                'capability' => 'ee_delete_venue_category',
-            ],
-
-            'insert_category' => [
-                'func'       => '_insert_or_update_category',
-                'args'       => ['new_category' => true],
-                'noheader'   => true,
-                'capability' => 'ee_edit_venue_category',
-            ],
-
-            'update_category'   => [
-                'func'       => '_insert_or_update_category',
-                'args'       => ['new_category' => false],
-                'noheader'   => true,
-                'capability' => 'ee_edit_venue_category',
-            ],
-            'export_categories' => [
-                'func'       => '_categories_export',
-                'noheader'   => true,
-                'capability' => 'export',
-            ],
-            'import_categories' => [
-                'func'       => '_import_categories',
-                'capability' => 'import',
-            ],
-            'category_list'     => [
-                'func'       => '_category_list_table',
-                'capability' => 'ee_manage_venue_categories',
-            ],
-        ];
-    }
-
-
-    protected function _set_page_config()
-    {
-        $VNU_ID     = $this->request->getRequestParam('post', 0, 'int');
-        $EVT_CAT_ID = $this->request->getRequestParam('EVT_CAT_ID', 0, 'int');
-
-        $this->_page_config = [
-            'default'             => [
-                'nav'           => [
-                    'label' => esc_html__('Overview', 'event_espresso'),
-                    'icon' => 'dashicons-list-view',
-                    'order' => 10,
-                ],
-                'list_table'    => 'Venues_Admin_List_Table',
-                'help_tabs'     => [
-                    'venues_overview_help_tab'                           => [
-                        'title'    => esc_html__('Venues Overview', 'event_espresso'),
-                        'filename' => 'venues_overview',
-                    ],
-                    'venues_overview_table_column_headings_help_tab'     => [
-                        'title'    => esc_html__('Venues Overview Table Column Headings', 'event_espresso'),
-                        'filename' => 'venues_overview_table_column_headings',
-                    ],
-                    'venues_overview_views_bulk_actions_search_help_tab' => [
-                        'title'    => esc_html__('Venues Overview Views & Bulk Actions & Search', 'event_espresso'),
-                        'filename' => 'venues_overview_views_bulk_actions_search',
-                    ],
-                ],
-                'metaboxes'     => ['_espresso_news_post_box', '_espresso_links_post_box'],
-                'require_nonce' => false,
-            ],
-            'create_new'          => [
-                'nav'           => [
-                    'label'      => esc_html__('Add Venue', 'event_espresso'),
-                    'icon' => 'dashicons-plus-alt',
-                    'order'      => 15,
-                    'persistent' => false,
-                ],
-                'help_tabs'     => [
-                    'venues_editor_help_tab'                                               => [
-                        'title'    => esc_html__('Venue Editor', 'event_espresso'),
-                        'filename' => 'venues_editor',
-                    ],
-                    'venues_editor_title_richtexteditor_help_tab'                          => [
-                        'title'    => esc_html__('Venue Title & Rich Text Editor', 'event_espresso'),
-                        'filename' => 'venues_editor_title_richtexteditor',
-                    ],
-                    'venues_editor_tags_categories_help_tab'                               => [
-                        'title'    => esc_html__('Venue Tags & Categories', 'event_espresso'),
-                        'filename' => 'venues_editor_tags_categories',
-                    ],
-                    'venues_editor_physical_location_google_map_virtual_location_help_tab' => [
-                        'title'    => esc_html__(
-                            'Venue Editor Physical Location & Google Map & Virtual Location',
-                            'event_espresso'
-                        ),
-                        'filename' => 'venues_editor_physical_location_google_map_virtual_location',
-                    ],
-                    'venues_editor_save_new_venue_help_tab'                                => [
-                        'title'    => esc_html__('Save New Venue', 'event_espresso'),
-                        'filename' => 'venues_editor_save_new_venue',
-                    ],
-                    'venues_editor_other_help_tab'                                         => [
-                        'title'    => esc_html__('Venue Editor Other', 'event_espresso'),
-                        'filename' => 'venues_editor_other',
-                    ],
-                ],
-                'metaboxes'     => ['_venue_editor_metaboxes'],
-                'require_nonce' => false,
-            ],
-            'edit'                => [
-                'nav'           => [
-                    'label'      => esc_html__('Edit Venue', 'event_espresso'),
-                    'icon' => 'dashicons-edit-large',
-                    'order'      => 15,
-                    'persistent' => false,
-                    'url'        => $VNU_ID
-                        ? add_query_arg(['post' => $VNU_ID], $this->_current_page_view_url)
-                        : $this->_admin_base_url,
-                ],
-                'help_tabs'     => [
-                    'venues_editor_help_tab'                                               => [
-                        'title'    => esc_html__('Venue Editor', 'event_espresso'),
-                        'filename' => 'venues_editor',
-                    ],
-                    'venues_editor_title_richtexteditor_help_tab'                          => [
-                        'title'    => esc_html__('Venue Title & Rich Text Editor', 'event_espresso'),
-                        'filename' => 'venues_editor_title_richtexteditor',
-                    ],
-                    'venues_editor_tags_categories_help_tab'                               => [
-                        'title'    => esc_html__('Venue Tags & Categories', 'event_espresso'),
-                        'filename' => 'venues_editor_tags_categories',
-                    ],
-                    'venues_editor_physical_location_google_map_virtual_location_help_tab' => [
-                        'title'    => esc_html__(
-                            'Venue Editor Physical Location & Google Map & Virtual Location',
-                            'event_espresso'
-                        ),
-                        'filename' => 'venues_editor_physical_location_google_map_virtual_location',
-                    ],
-                    'venues_editor_save_new_venue_help_tab'                                => [
-                        'title'    => esc_html__('Save New Venue', 'event_espresso'),
-                        'filename' => 'venues_editor_save_new_venue',
-                    ],
-                    'venues_editor_other_help_tab'                                         => [
-                        'title'    => esc_html__('Venue Editor Other', 'event_espresso'),
-                        'filename' => 'venues_editor_other',
-                    ],
-                ],
-                'metaboxes'     => ['_venue_editor_metaboxes'],
-                'require_nonce' => false,
-            ],
-            'google_map_settings' => [
-                'nav'           => [
-                    'label' => esc_html__('Google Maps', 'event_espresso'),
-                    'icon' => 'dashicons-location-alt',
-                    'order' => 40,
-                ],
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
-                'help_tabs'     => [
-                    'general_settings_google_maps_help_tab' => [
-                        'title'    => esc_html__('Google Maps', 'event_espresso'),
-                        'filename' => 'general_settings_google_maps',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            // venue category stuff
-            'add_category'        => [
-                'nav'           => [
-                    'label'      => esc_html__('Add Category', 'event_espresso'),
-                    'icon' => 'dashicons-plus-alt',
-                    'order'      => 25,
-                    'persistent' => false,
-                ],
-                'metaboxes'     => ['_publish_post_box'],
-                'help_tabs'     => [
-                    'venues_add_category_help_tab' => [
-                        'title'    => esc_html__('Add New Venue Category', 'event_espresso'),
-                        'filename' => 'venues_add_category',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'edit_category'       => [
-                'nav'           => [
-                    'label'      => esc_html__('Edit Category', 'event_espresso'),
-                    'icon' => 'dashicons-edit-large',
-                    'order'      => 25,
-                    'persistent' => false,
-                    'url'        => $EVT_CAT_ID
-                        ? add_query_arg(['EVT_CAT_ID' => $EVT_CAT_ID], $this->_current_page_view_url)
-                        : $this->_admin_base_url,
-                ],
-                'metaboxes'     => ['_publish_post_box'],
-                'help_tabs'     => [
-                    'venues_edit_category_help_tab' => [
-                        'title'    => esc_html__('Edit Venue Category', 'event_espresso'),
-                        'filename' => 'venues_edit_category',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'category_list'       => [
-                'nav'           => [
-                    'label' => esc_html__('Categories', 'event_espresso'),
-                    'icon' => 'dashicons-networking',
-                    'order' => 20,
-                ],
-                'list_table'    => 'Venue_Categories_Admin_List_Table',
-                'help_tabs'     => [
-                    'venues_categories_help_tab'                       => [
-                        'title'    => esc_html__('Venue Categories', 'event_espresso'),
-                        'filename' => 'venues_categories',
-                    ],
-                    'venues_categories_table_column_headings_help_tab' => [
-                        'title'    => esc_html__('Venue Categories Table Column Headings', 'event_espresso'),
-                        'filename' => 'venues_categories_table_column_headings',
-                    ],
-                    'venues_categories_views_help_tab'                 => [
-                        'title'    => esc_html__('Venue Categories Views', 'event_espresso'),
-                        'filename' => 'venues_categories_views',
-                    ],
-                    'venues_categories_other_help_tab'                 => [
-                        'title'    => esc_html__('Venue Categories Other', 'event_espresso'),
-                        'filename' => 'venues_categories_other',
-                    ],
-                ],
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'require_nonce' => false,
-            ],
-        ];
-    }
-
-
-    protected function _add_screen_options()
-    {
-        // todo
-    }
-
-
-    protected function _add_screen_options_default()
-    {
-        $this->_per_page_screen_option();
-    }
-
-
-    protected function _add_screen_options_category_list()
-    {
-        $page_title              = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__('Venue Categories', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-    // none of the below group are currently used for Event Venues
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    public function admin_init()
-    {
-    }
-
-
-    public function admin_notices()
-    {
-    }
-
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    public function load_scripts_styles_create_new()
-    {
-        $this->load_scripts_styles_edit();
-    }
-
-
-    public function load_scripts_styles()
-    {
-        wp_register_style('ee-cat-admin', EVENTS_ASSETS_URL . 'ee-cat-admin.css', [], EVENT_ESPRESSO_VERSION);
-        wp_enqueue_style('ee-cat-admin');
-    }
-
-
-    public function load_scripts_styles_add_category()
-    {
-        $this->load_scripts_styles_edit_category();
-    }
-
-
-    public function load_scripts_styles_edit_category()
-    {
-    }
-
-
-    public function load_scripts_styles_edit()
-    {
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-        wp_register_style(
-            'espresso_venues',
-            EE_VENUES_ASSETS_URL . 'ee-venues-admin.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_venues');
-    }
-
-
-    protected function _set_list_table_views_default()
-    {
-        $this->_views = [
-            'all' => [
-                'slug'        => 'all',
-                'label'       => esc_html__('View All Venues', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [],
-            ],
-        ];
-
-        if (EE_Registry::instance()->CAP->current_user_can('ee_delete_venues', 'espresso_venues_trash_venues')) {
-            $this->_views['all']['bulk_action'] = [
-                'trash_venues' => esc_html__('Move to Trash', 'event_espresso'),
-            ];
-            $this->_views['trash']              = [
-                'slug'        => 'trash',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'restore_venues' => esc_html__('Restore from Trash', 'event_espresso'),
-                    'delete_venues'  => esc_html__('Delete', 'event_espresso'),
-                ],
-            ];
-        }
-    }
-
-
-    protected function _set_list_table_views_category_list()
-    {
-        $this->_views = [
-            'all' => [
-                'slug'        => 'all',
-                'label'       => esc_html__('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'delete_categories' => esc_html__('Delete Permanently', 'event_espresso'),
-                ],
-            ],
-        ];
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _overview_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_template_args['after_list_table'] = EEH_Template::get_button_or_link(
-            get_post_type_archive_link('espresso_venues'),
-            esc_html__("View Venue Archive Page", "event_espresso"),
-            'button'
-        );
-
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-            'create_new',
-            'add',
-            [],
-            'add-new-h2'
-        );
-
-        $this->_search_btn_label  = esc_html__('Venues', 'event_espresso');
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function extra_misc_actions_publish_box()
-    {
-        $extra_rows = [
-            'vnu_capacity' => $this->_cpt_model_obj->get_f('VNU_capacity'),
-            'vnu_url'      => $this->_cpt_model_obj->get_f('VNU_url'),
-            'vnu_phone'    => $this->_cpt_model_obj->get_f('VNU_phone'),
-        ];
-        $template   = EE_VENUES_TEMPLATE_PATH . 'venue_publish_box_extras.template.php';
-        EEH_Template::display_template($template, $extra_rows);
-    }
-
-
-    /*************        Google Maps        *************
+	/**
+	 * _venue
+	 * This will hold the venue object for venue_details screen.
+	 *
+	 * @access protected
+	 * @var object
+	 */
+	protected $_venue;
+
+
+	/**
+	 * This will hold the category object for category_details screen.
+	 *
+	 * @var object
+	 */
+	protected $_category;
+
+
+	/**
+	 * This property will hold the venue model instance
+	 *
+	 * @var object
+	 */
+	protected $_venue_model;
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _init_page_props()
+	{
+		require_once(EE_MODELS . 'EEM_Venue.model.php');
+		$this->page_slug        = EE_VENUES_PG_SLUG;
+		$this->_admin_base_url  = EE_VENUES_ADMIN_URL;
+		$this->_admin_base_path = EE_ADMIN_PAGES . 'venues';
+		$this->page_label       = esc_html__('Event Venues', 'event_espresso');
+		$this->_cpt_model_names = [
+			'create_new' => 'EEM_Venue',
+			'edit'       => 'EEM_Venue',
+		];
+		$this->_cpt_edit_routes = [
+			'espresso_venues' => 'edit',
+		];
+		$this->_venue_model     = EEM_Venue::instance();
+	}
+
+
+	protected function _ajax_hooks()
+	{
+		// todo: all hooks for ee_venues ajax goes in here.
+	}
+
+
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = $this->page_label;
+		$this->_labels           = [
+			'buttons'      => [
+				'add'             => esc_html__('Add New Venue', 'event_espresso'),
+				'edit'            => esc_html__('Edit Venue', 'event_espresso'),
+				'delete'          => esc_html__('Delete Venue', 'event_espresso'),
+				'add_category'    => esc_html__('Add New Category', 'event_espresso'),
+				'edit_category'   => esc_html__('Edit Category', 'event_espresso'),
+				'delete_category' => esc_html__('Delete Category', 'event_espresso'),
+			],
+			'editor_title' => [
+				'espresso_venues' => esc_html__('Enter Venue name here', 'event_espresso'),
+			],
+			'publishbox'   => [
+				'create_new'          => esc_html__('Save New Venue', 'event_espresso'),
+				'edit'                => esc_html__('Update Venue', 'event_espresso'),
+				'add_category'        => esc_html__('Save New Category', 'event_espresso'),
+				'edit_category'       => esc_html__('Update Category', 'event_espresso'),
+				'google_map_settings' => esc_html__('Update Settings', 'event_espresso'),
+			],
+		];
+	}
+
+
+	protected function _set_page_routes()
+	{
+
+		// load formatter helper
+		// load field generator helper
+
+		// is there a vnu_id in the request?
+		$VNU_ID = $this->request->getRequestParam('VNU_ID', 0, 'int');
+		$VNU_ID = $this->request->getRequestParam('post', $VNU_ID, 'int');
+
+		$this->_page_routes = [
+			'default'                    => [
+				'func'       => '_overview_list_table',
+				'capability' => 'ee_read_venues',
+			],
+			'create_new'                 => [
+				'func'       => '_create_new_cpt_item',
+				'capability' => 'ee_edit_venues',
+			],
+			'edit'                       => [
+				'func'       => '_edit_cpt_item',
+				'capability' => 'ee_edit_venue',
+				'obj_id'     => $VNU_ID,
+			],
+			'trash_venue'                => [
+				'func'       => '_trash_or_restore_venue',
+				'args'       => ['venue_status' => 'trash'],
+				'noheader'   => true,
+				'capability' => 'ee_delete_venue',
+				'obj_id'     => $VNU_ID,
+			],
+			'trash_venues'               => [
+				'func'       => '_trash_or_restore_venues',
+				'args'       => ['venue_status' => 'trash'],
+				'noheader'   => true,
+				'capability' => 'ee_delete_venues',
+			],
+			'restore_venue'              => [
+				'func'       => '_trash_or_restore_venue',
+				'args'       => ['venue_status' => 'draft'],
+				'noheader'   => true,
+				'capability' => 'ee_delete_venue',
+				'obj_id'     => $VNU_ID,
+			],
+			'restore_venues'             => [
+				'func'       => '_trash_or_restore_venues',
+				'args'       => ['venue_status' => 'draft'],
+				'noheader'   => true,
+				'capability' => 'ee_delete_venues',
+			],
+			'delete_venues'              => [
+				'func'       => '_delete_venues',
+				'noheader'   => true,
+				'capability' => 'ee_delete_venues',
+			],
+			'delete_venue'               => [
+				'func'       => '_delete_venue',
+				'noheader'   => true,
+				'capability' => 'ee_delete_venue',
+				'obj_id'     => $VNU_ID,
+			],
+			// settings related
+			'google_map_settings'        => [
+				'func'       => '_google_map_settings',
+				'capability' => 'manage_options',
+			],
+			'update_google_map_settings' => [
+				'func'       => '_update_google_map_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+			// venue category tab related
+			'add_category'               => [
+				'func'       => '_category_details',
+				'args'       => ['add'],
+				'capability' => 'ee_edit_venue_category',
+			],
+			'edit_category'              => [
+				'func'       => '_category_details',
+				'args'       => ['edit'],
+				'capability' => 'ee_edit_venue_category',
+			],
+			'delete_categories'          => [
+				'func'       => '_delete_categories',
+				'noheader'   => true,
+				'capability' => 'ee_delete_venue_category',
+			],
+
+			'delete_category' => [
+				'func'       => '_delete_categories',
+				'noheader'   => true,
+				'capability' => 'ee_delete_venue_category',
+			],
+
+			'insert_category' => [
+				'func'       => '_insert_or_update_category',
+				'args'       => ['new_category' => true],
+				'noheader'   => true,
+				'capability' => 'ee_edit_venue_category',
+			],
+
+			'update_category'   => [
+				'func'       => '_insert_or_update_category',
+				'args'       => ['new_category' => false],
+				'noheader'   => true,
+				'capability' => 'ee_edit_venue_category',
+			],
+			'export_categories' => [
+				'func'       => '_categories_export',
+				'noheader'   => true,
+				'capability' => 'export',
+			],
+			'import_categories' => [
+				'func'       => '_import_categories',
+				'capability' => 'import',
+			],
+			'category_list'     => [
+				'func'       => '_category_list_table',
+				'capability' => 'ee_manage_venue_categories',
+			],
+		];
+	}
+
+
+	protected function _set_page_config()
+	{
+		$VNU_ID     = $this->request->getRequestParam('post', 0, 'int');
+		$EVT_CAT_ID = $this->request->getRequestParam('EVT_CAT_ID', 0, 'int');
+
+		$this->_page_config = [
+			'default'             => [
+				'nav'           => [
+					'label' => esc_html__('Overview', 'event_espresso'),
+					'icon' => 'dashicons-list-view',
+					'order' => 10,
+				],
+				'list_table'    => 'Venues_Admin_List_Table',
+				'help_tabs'     => [
+					'venues_overview_help_tab'                           => [
+						'title'    => esc_html__('Venues Overview', 'event_espresso'),
+						'filename' => 'venues_overview',
+					],
+					'venues_overview_table_column_headings_help_tab'     => [
+						'title'    => esc_html__('Venues Overview Table Column Headings', 'event_espresso'),
+						'filename' => 'venues_overview_table_column_headings',
+					],
+					'venues_overview_views_bulk_actions_search_help_tab' => [
+						'title'    => esc_html__('Venues Overview Views & Bulk Actions & Search', 'event_espresso'),
+						'filename' => 'venues_overview_views_bulk_actions_search',
+					],
+				],
+				'metaboxes'     => ['_espresso_news_post_box', '_espresso_links_post_box'],
+				'require_nonce' => false,
+			],
+			'create_new'          => [
+				'nav'           => [
+					'label'      => esc_html__('Add Venue', 'event_espresso'),
+					'icon' => 'dashicons-plus-alt',
+					'order'      => 15,
+					'persistent' => false,
+				],
+				'help_tabs'     => [
+					'venues_editor_help_tab'                                               => [
+						'title'    => esc_html__('Venue Editor', 'event_espresso'),
+						'filename' => 'venues_editor',
+					],
+					'venues_editor_title_richtexteditor_help_tab'                          => [
+						'title'    => esc_html__('Venue Title & Rich Text Editor', 'event_espresso'),
+						'filename' => 'venues_editor_title_richtexteditor',
+					],
+					'venues_editor_tags_categories_help_tab'                               => [
+						'title'    => esc_html__('Venue Tags & Categories', 'event_espresso'),
+						'filename' => 'venues_editor_tags_categories',
+					],
+					'venues_editor_physical_location_google_map_virtual_location_help_tab' => [
+						'title'    => esc_html__(
+							'Venue Editor Physical Location & Google Map & Virtual Location',
+							'event_espresso'
+						),
+						'filename' => 'venues_editor_physical_location_google_map_virtual_location',
+					],
+					'venues_editor_save_new_venue_help_tab'                                => [
+						'title'    => esc_html__('Save New Venue', 'event_espresso'),
+						'filename' => 'venues_editor_save_new_venue',
+					],
+					'venues_editor_other_help_tab'                                         => [
+						'title'    => esc_html__('Venue Editor Other', 'event_espresso'),
+						'filename' => 'venues_editor_other',
+					],
+				],
+				'metaboxes'     => ['_venue_editor_metaboxes'],
+				'require_nonce' => false,
+			],
+			'edit'                => [
+				'nav'           => [
+					'label'      => esc_html__('Edit Venue', 'event_espresso'),
+					'icon' => 'dashicons-edit-large',
+					'order'      => 15,
+					'persistent' => false,
+					'url'        => $VNU_ID
+						? add_query_arg(['post' => $VNU_ID], $this->_current_page_view_url)
+						: $this->_admin_base_url,
+				],
+				'help_tabs'     => [
+					'venues_editor_help_tab'                                               => [
+						'title'    => esc_html__('Venue Editor', 'event_espresso'),
+						'filename' => 'venues_editor',
+					],
+					'venues_editor_title_richtexteditor_help_tab'                          => [
+						'title'    => esc_html__('Venue Title & Rich Text Editor', 'event_espresso'),
+						'filename' => 'venues_editor_title_richtexteditor',
+					],
+					'venues_editor_tags_categories_help_tab'                               => [
+						'title'    => esc_html__('Venue Tags & Categories', 'event_espresso'),
+						'filename' => 'venues_editor_tags_categories',
+					],
+					'venues_editor_physical_location_google_map_virtual_location_help_tab' => [
+						'title'    => esc_html__(
+							'Venue Editor Physical Location & Google Map & Virtual Location',
+							'event_espresso'
+						),
+						'filename' => 'venues_editor_physical_location_google_map_virtual_location',
+					],
+					'venues_editor_save_new_venue_help_tab'                                => [
+						'title'    => esc_html__('Save New Venue', 'event_espresso'),
+						'filename' => 'venues_editor_save_new_venue',
+					],
+					'venues_editor_other_help_tab'                                         => [
+						'title'    => esc_html__('Venue Editor Other', 'event_espresso'),
+						'filename' => 'venues_editor_other',
+					],
+				],
+				'metaboxes'     => ['_venue_editor_metaboxes'],
+				'require_nonce' => false,
+			],
+			'google_map_settings' => [
+				'nav'           => [
+					'label' => esc_html__('Google Maps', 'event_espresso'),
+					'icon' => 'dashicons-location-alt',
+					'order' => 40,
+				],
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
+				'help_tabs'     => [
+					'general_settings_google_maps_help_tab' => [
+						'title'    => esc_html__('Google Maps', 'event_espresso'),
+						'filename' => 'general_settings_google_maps',
+					],
+				],
+				'require_nonce' => false,
+			],
+			// venue category stuff
+			'add_category'        => [
+				'nav'           => [
+					'label'      => esc_html__('Add Category', 'event_espresso'),
+					'icon' => 'dashicons-plus-alt',
+					'order'      => 25,
+					'persistent' => false,
+				],
+				'metaboxes'     => ['_publish_post_box'],
+				'help_tabs'     => [
+					'venues_add_category_help_tab' => [
+						'title'    => esc_html__('Add New Venue Category', 'event_espresso'),
+						'filename' => 'venues_add_category',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'edit_category'       => [
+				'nav'           => [
+					'label'      => esc_html__('Edit Category', 'event_espresso'),
+					'icon' => 'dashicons-edit-large',
+					'order'      => 25,
+					'persistent' => false,
+					'url'        => $EVT_CAT_ID
+						? add_query_arg(['EVT_CAT_ID' => $EVT_CAT_ID], $this->_current_page_view_url)
+						: $this->_admin_base_url,
+				],
+				'metaboxes'     => ['_publish_post_box'],
+				'help_tabs'     => [
+					'venues_edit_category_help_tab' => [
+						'title'    => esc_html__('Edit Venue Category', 'event_espresso'),
+						'filename' => 'venues_edit_category',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'category_list'       => [
+				'nav'           => [
+					'label' => esc_html__('Categories', 'event_espresso'),
+					'icon' => 'dashicons-networking',
+					'order' => 20,
+				],
+				'list_table'    => 'Venue_Categories_Admin_List_Table',
+				'help_tabs'     => [
+					'venues_categories_help_tab'                       => [
+						'title'    => esc_html__('Venue Categories', 'event_espresso'),
+						'filename' => 'venues_categories',
+					],
+					'venues_categories_table_column_headings_help_tab' => [
+						'title'    => esc_html__('Venue Categories Table Column Headings', 'event_espresso'),
+						'filename' => 'venues_categories_table_column_headings',
+					],
+					'venues_categories_views_help_tab'                 => [
+						'title'    => esc_html__('Venue Categories Views', 'event_espresso'),
+						'filename' => 'venues_categories_views',
+					],
+					'venues_categories_other_help_tab'                 => [
+						'title'    => esc_html__('Venue Categories Other', 'event_espresso'),
+						'filename' => 'venues_categories_other',
+					],
+				],
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'require_nonce' => false,
+			],
+		];
+	}
+
+
+	protected function _add_screen_options()
+	{
+		// todo
+	}
+
+
+	protected function _add_screen_options_default()
+	{
+		$this->_per_page_screen_option();
+	}
+
+
+	protected function _add_screen_options_category_list()
+	{
+		$page_title              = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__('Venue Categories', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+	// none of the below group are currently used for Event Venues
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	public function admin_init()
+	{
+	}
+
+
+	public function admin_notices()
+	{
+	}
+
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	public function load_scripts_styles_create_new()
+	{
+		$this->load_scripts_styles_edit();
+	}
+
+
+	public function load_scripts_styles()
+	{
+		wp_register_style('ee-cat-admin', EVENTS_ASSETS_URL . 'ee-cat-admin.css', [], EVENT_ESPRESSO_VERSION);
+		wp_enqueue_style('ee-cat-admin');
+	}
+
+
+	public function load_scripts_styles_add_category()
+	{
+		$this->load_scripts_styles_edit_category();
+	}
+
+
+	public function load_scripts_styles_edit_category()
+	{
+	}
+
+
+	public function load_scripts_styles_edit()
+	{
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+		wp_register_style(
+			'espresso_venues',
+			EE_VENUES_ASSETS_URL . 'ee-venues-admin.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_venues');
+	}
+
+
+	protected function _set_list_table_views_default()
+	{
+		$this->_views = [
+			'all' => [
+				'slug'        => 'all',
+				'label'       => esc_html__('View All Venues', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [],
+			],
+		];
+
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_venues', 'espresso_venues_trash_venues')) {
+			$this->_views['all']['bulk_action'] = [
+				'trash_venues' => esc_html__('Move to Trash', 'event_espresso'),
+			];
+			$this->_views['trash']              = [
+				'slug'        => 'trash',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'restore_venues' => esc_html__('Restore from Trash', 'event_espresso'),
+					'delete_venues'  => esc_html__('Delete', 'event_espresso'),
+				],
+			];
+		}
+	}
+
+
+	protected function _set_list_table_views_category_list()
+	{
+		$this->_views = [
+			'all' => [
+				'slug'        => 'all',
+				'label'       => esc_html__('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'delete_categories' => esc_html__('Delete Permanently', 'event_espresso'),
+				],
+			],
+		];
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _overview_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_template_args['after_list_table'] = EEH_Template::get_button_or_link(
+			get_post_type_archive_link('espresso_venues'),
+			esc_html__("View Venue Archive Page", "event_espresso"),
+			'button'
+		);
+
+		$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+			'create_new',
+			'add',
+			[],
+			'add-new-h2'
+		);
+
+		$this->_search_btn_label  = esc_html__('Venues', 'event_espresso');
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function extra_misc_actions_publish_box()
+	{
+		$extra_rows = [
+			'vnu_capacity' => $this->_cpt_model_obj->get_f('VNU_capacity'),
+			'vnu_url'      => $this->_cpt_model_obj->get_f('VNU_url'),
+			'vnu_phone'    => $this->_cpt_model_obj->get_f('VNU_phone'),
+		];
+		$template   = EE_VENUES_TEMPLATE_PATH . 'venue_publish_box_extras.template.php';
+		EEH_Template::display_template($template, $extra_rows);
+	}
+
+
+	/*************        Google Maps        *************
      *
      * @throws EE_Error
      * @throws EE_Error
      */
 
 
-    protected function _google_map_settings()
-    {
-
-
-        $this->_template_args['values']           = $this->_yes_no_values;
-        $default_map_settings                     = new stdClass();
-        $default_map_settings->use_google_maps    = true;
-        $default_map_settings->google_map_api_key = '';
-        // for event details pages (reg page)
-        $default_map_settings->event_details_map_width    = 585;
-        // ee_map_width_single
-        $default_map_settings->event_details_map_height   = 362;
-        // ee_map_height_single
-        $default_map_settings->event_details_map_zoom     = 14;
-        // ee_map_zoom_single
-        $default_map_settings->event_details_display_nav  = true;
-        // ee_map_nav_display_single
-        $default_map_settings->event_details_nav_size     = false;
-        // ee_map_nav_size_single
-        $default_map_settings->event_details_control_type = 'default';
-        // ee_map_type_control_single
-        $default_map_settings->event_details_map_align    = 'center';
-        // ee_map_align_single
-
-        // for event list pages
-        $default_map_settings->event_list_map_width    = 300;
-        // ee_map_width
-        $default_map_settings->event_list_map_height   = 185;
-        // ee_map_height
-        $default_map_settings->event_list_map_zoom     = 12;
-        // ee_map_zoom
-        $default_map_settings->event_list_display_nav  = false;
-        // ee_map_nav_display
-        $default_map_settings->event_list_nav_size     = true;
-        // ee_map_nav_size
-        $default_map_settings->event_list_control_type = 'dropdown';
-        // ee_map_type_control
-        $default_map_settings->event_list_map_align    = 'center';
-        // ee_map_align
-
-        $this->_template_args['map_settings'] =
-            isset(EE_Registry::instance()->CFG->map_settings)
-            && ! empty(EE_Registry::instance()->CFG->map_settings)
-                ? (object) array_merge(
-                    (array) $default_map_settings,
-                    (array) EE_Registry::instance()->CFG->map_settings
-                )
-                : $default_map_settings;
-
-        $this->_set_add_edit_form_tags('update_google_map_settings');
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EE_VENUES_TEMPLATE_PATH . 'google_map.template.php',
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _update_google_map_settings()
-    {
-        $map_settings = EE_Registry::instance()->CFG->map_settings;
-
-        $settings = [
-            'use_google_maps'            => 'int',
-            'google_map_api_key'         => 'string',
-            'event_details_map_width'    => 'int',
-            'event_details_map_zoom'     => 'int',
-            'event_details_display_nav'  => 'int',
-            'event_details_nav_size'     => 'int',
-            'event_details_control_type' => 'string',
-            'event_details_map_align'    => 'string',
-            'event_list_map_width'       => 'int',
-            'event_list_map_height'      => 'int',
-            'event_list_map_zoom'        => 'int',
-            'event_list_display_nav'     => 'int',
-            'event_list_nav_size'        => 'int',
-            'event_list_control_type'    => 'string',
-            'event_list_map_align'       => 'string',
-        ];
-
-        foreach ($settings as $setting => $type) {
-            $map_settings->{$setting} = $this->request->getRequestParam($setting, $map_settings->{$setting}, $type);
-        }
-
-        EE_Registry::instance()->CFG->map_settings = apply_filters(
-            'FHEE__Extend_General_Settings_Admin_Page___update_google_map_settings__CFG_map_settings',
-            $map_settings
-        );
-
-        $what    = 'Google Map Settings';
-        $success = $this->_update_espresso_configuration(
-            $what,
-            EE_Registry::instance()->CFG->map_settings,
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        $this->_redirect_after_action($success, $what, 'updated', ['action' => 'google_map_settings']);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _venue_editor_metaboxes()
-    {
-        $this->verify_cpt_object();
-
-        $this->addMetaBox(
-            'espresso_venue_address_options',
-            esc_html__('Physical Location', 'event_espresso'),
-            [$this, 'venue_address_metabox'],
-            $this->page_slug,
-            'side'
-        );
-        $this->addMetaBox(
-            'espresso_venue_gmap_options',
-            esc_html__('Google Map', 'event_espresso'),
-            [$this, 'venue_gmap_metabox'],
-            $this->page_slug,
-            'side'
-        );
-        $this->addMetaBox(
-            'espresso_venue_virtual_loc_options',
-            esc_html__('Virtual Location', 'event_espresso'),
-            [$this, 'venue_virtual_loc_metabox'],
-            $this->page_slug,
-            'side'
-        );
-    }
-
-
-    public function venue_gmap_metabox()
-    {
-        $template_args = [
-            'vnu_enable_for_gmap' => EEH_Form_Fields::select_input(
-                'vnu_enable_for_gmap',
-                $this->get_yes_no_values(),
-                $this->_cpt_model_obj instanceof EE_Venue ? $this->_cpt_model_obj->enable_for_gmap() : false
-            ),
-            'vnu_google_map_link' => $this->_cpt_model_obj->google_map_link(),
-        ];
-        $template      = EE_VENUES_TEMPLATE_PATH . 'venue_gmap_metabox_content.template.php';
-        EEH_Template::display_template($template, $template_args);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function venue_address_metabox()
-    {
-        $template_args['_venue'] = $this->_cpt_model_obj;
-
-        $template_args['states_dropdown']    = EEH_Form_Fields::generate_form_input(
-            new EE_Question_Form_Input(
-                EE_Question::new_instance(
-                    ['QST_display_text' => esc_html__('State', 'event_espresso'), 'QST_system' => 'state']
-                ),
-                EE_Answer::new_instance(
-                    [
-                        'ANS_value' => $this->_cpt_model_obj instanceof EE_Venue
-                            ? $this->_cpt_model_obj->state_ID()
-                            : 0,
-                    ]
-                ),
-                [
-                    'input_name'     => 'sta_id',
-                    'input_id'       => 'sta_id',
-                    'input_class'    => '',
-                    'input_prefix'   => '',
-                    'append_qstn_id' => false,
-                ]
-            )
-        );
-        $template_args['countries_dropdown'] = EEH_Form_Fields::generate_form_input(
-            new EE_Question_Form_Input(
-                EE_Question::new_instance(
-                    ['QST_display_text' => esc_html__('Country', 'event_espresso'), 'QST_system' => 'country']
-                ),
-                EE_Answer::new_instance(
-                    [
-                        'ANS_value' => $this->_cpt_model_obj instanceof EE_Venue
-                            ? $this->_cpt_model_obj->country_ID()
-                            : 0,
-                    ]
-                ),
-                [
-                    'input_name'     => 'cnt_iso',
-                    'input_id'       => 'cnt_iso',
-                    'input_class'    => '',
-                    'input_prefix'   => '',
-                    'append_qstn_id' => false,
-                ]
-            )
-        );
-
-        $template = EE_VENUES_TEMPLATE_PATH . 'venue_address_metabox_content.template.php';
-        EEH_Template::display_template($template, $template_args);
-    }
-
-
-    public function venue_virtual_loc_metabox()
-    {
-        $template_args = [
-            '_venue' => $this->_cpt_model_obj,
-        ];
-        $template      = EE_VENUES_TEMPLATE_PATH . 'venue_virtual_location_metabox_content.template.php';
-        EEH_Template::display_template($template, $template_args);
-    }
-
-
-    protected function _restore_cpt_item($post_id, $revision_id)
-    {
-        $venue_obj = $this->_venue_model->get_one_by_ID($post_id);
-
-        // meta revision restore
-        $venue_obj->restore_revision($revision_id);
-    }
-
-
-    /**
-     * Handles updates for venue cpts
-     *
-     * @param int    $post_id ID of Venue CPT
-     * @param WP_Post $post    Post object (with "blessed" WP properties)
-     * @return void
-     */
-    protected function _insert_update_cpt_item($post_id, $post)
-    {
-
-        if ($post instanceof WP_Post && $post->post_type !== 'espresso_venues') {
-            return;// get out we're not processing the saving of venues.
-        }
-
-        $wheres = [$this->_venue_model->primary_key_name() => $post_id];
-
-        $venue_values = [
-            'VNU_address'         => $this->request->getRequestParam('vnu_address'),
-            'VNU_address2'        => $this->request->getRequestParam('vnu_address2'),
-            'VNU_city'            => $this->request->getRequestParam('vnu_city'),
-            'STA_ID'              => $this->request->getRequestParam('sta_id'),
-            'CNT_ISO'             => $this->request->getRequestParam('cnt_iso'),
-            'VNU_zip'             => $this->request->getRequestParam('vnu_zip'),
-            'VNU_phone'           => $this->request->getRequestParam('vnu_phone'),
-            'VNU_capacity'        => $this->request->requestParamIsSet('vnu_capacity')
-                ? str_replace(',', '', $this->request->getRequestParam('vnu_capacity'))
-                : EE_INF,
-            'VNU_url'             => $this->request->getRequestParam('vnu_url'),
-            'VNU_virtual_phone'   => $this->request->getRequestParam('vnu_virtual_phone'),
-            'VNU_virtual_url'     => $this->request->getRequestParam('vnu_virtual_url'),
-            'VNU_enable_for_gmap' => $this->request->getRequestParam('vnu_enable_for_gmap', false, 'bool'),
-            'VNU_google_map_link' => $this->request->getRequestParam('vnu_google_map_link'),
-        ];
-
-        // update venue
-        $success = $this->_venue_model->update($venue_values, [$wheres]);
-
-        // get venue_object for other metaboxes that might be added via the filter... though it would seem to make sense to just use $this->_venue_model->get_one_by_ID( $post_id ).. i have to setup where conditions to override the filters in the model that filter out autodraft and inherit statuses so we GET the inherit id!
-        $get_one_where = [$this->_venue_model->primary_key_name() => $post_id, 'status' => $post->post_status];
-        $venue         = $this->_venue_model->get_one([$get_one_where]);
-
-        // notice we've applied a filter for venue metabox callbacks but we don't actually have any default venue metaboxes in use.  So this is just here for addons to more easily hook into venue saves.
-        $venue_update_callbacks = apply_filters(
-            'FHEE__Venues_Admin_Page___insert_update_cpt_item__venue_update_callbacks',
-            []
-        );
-        $att_success            = true;
-        foreach ($venue_update_callbacks as $v_callback) {
-            // if ANY of these updates fail then we want the appropriate global error message
-            $att_success = call_user_func_array($v_callback, [$venue, $this->request->requestParams()])
-                ? $att_success
-                : false;
-        }
-
-        // any errors?
-        if ($success && ! $att_success) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Venue Details saved successfully but something went wrong with saving attachments.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } elseif ($success === false) {
-            EE_Error::add_error(
-                esc_html__('Venue Details did not save successfully.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * @param int $post_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function trash_cpt_item($post_id)
-    {
-        $this->request->setRequestParam('VNU_ID', $post_id);
-        $this->_trash_or_restore_venue('trash', false);
-    }
-
-
-    /**
-     * @param int $post_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function restore_cpt_item($post_id)
-    {
-        $this->request->setRequestParam('VNU_ID', $post_id);
-        $this->_trash_or_restore_venue('draft', false);
-    }
-
-
-    /**
-     * @param int $post_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_cpt_item($post_id)
-    {
-        $this->request->setRequestParam('VNU_ID', $post_id);
-        $this->_delete_venue(false);
-    }
-
-
-    public function get_venue_object()
-    {
-        return $this->_cpt_model_obj;
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _trash_or_restore_venue($venue_status = 'trash', $redirect_after = true)
-    {
-        $VNU_ID = $this->request->getRequestParam('VNU_ID', 0, 'int');
-
-        // loop thru venues
-        if ($VNU_ID) {
-            // clean status
-            $venue_status = sanitize_key($venue_status);
-            // grab status
-            if (! empty($venue_status)) {
-                $success = $this->_change_venue_status($VNU_ID, $venue_status);
-            } else {
-                $success = false;
-                $msg     = esc_html__(
-                    'An error occurred. The venue could not be moved to the trash because a valid venue status was not not supplied.',
-                    'event_espresso'
-                );
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        } else {
-            $success = false;
-            $msg     = esc_html__(
-                'An error occurred. The venue could not be moved to the trash because a valid venue ID was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        $action = $venue_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
-
-        if ($redirect_after) {
-            $this->_redirect_after_action($success, 'Venue', $action, ['action' => 'default']);
-        }
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _trash_or_restore_venues($venue_status = 'trash')
-    {
-        // clean status
-        $venue_status = sanitize_key($venue_status);
-        // grab status
-        if (! empty($venue_status)) {
-            $success = true;
-            // determine the event id and set to array.
-            $VNU_IDs = $this->request->getRequestParam('venue_id', [], 'int', true);
-            // loop thru events
-            foreach ($VNU_IDs as $VNU_ID) {
-                if ($VNU_ID = absint($VNU_ID)) {
-                    $results = $this->_change_venue_status($VNU_ID, $venue_status);
-                    $success = $results !== false ? $success : false;
-                } else {
-                    $msg = sprintf(
-                        esc_html__(
-                            'An error occurred. Venue #%d could not be moved to the trash because a valid venue ID was not not supplied.',
-                            'event_espresso'
-                        ),
-                        $VNU_ID
-                    );
-                    EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                    $success = false;
-                }
-            }
-        } else {
-            $success = false;
-            $msg     = esc_html__(
-                'An error occurred. The venue could not be moved to the trash because a valid venue status was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        // in order to force a pluralized result message we need to send back a success status greater than 1
-        $success = $success ? 2 : false;
-        $action  = $venue_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
-        $this->_redirect_after_action($success, 'Venues', $action, ['action' => 'default']);
-    }
-
-
-    /**
-     * _trash_or_restore_venues
-     *
-     * //todo this is pretty much the same as the corresponding change_event_status method in Events_Admin_Page.  We
-     * should probably abstract this up to the EE_Admin_Page_CPT (or even EE_Admin_Page) and make this a common method
-     * accepting a certain number of params.
-     *
-     * @access  private
-     * @param int    $VNU_ID
-     * @param string $venue_status
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _change_venue_status($VNU_ID = 0, $venue_status = '')
-    {
-        // grab venue id
-        if (! $VNU_ID) {
-            $msg = esc_html__('An error occurred. No Venue ID or an invalid Venue ID was received.', 'event_espresso');
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-
-        $this->_cpt_model_obj = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
-
-        // clean status
-        $venue_status = sanitize_key($venue_status);
-        // grab status
-        if (! $venue_status) {
-            $msg = esc_html__(
-                'An error occurred. No Venue Status or an invalid Venue Status was received.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-
-        // was event trashed or restored ?
-        switch ($venue_status) {
-            case 'draft':
-                $action = 'restored from the trash';
-                $hook   = 'AHEE_venue_restored_from_trash';
-                break;
-            case 'trash':
-                $action = 'moved to the trash';
-                $hook   = 'AHEE_venue_moved_to_trash';
-                break;
-            default:
-                $action = 'updated';
-                $hook   = false;
-        }
-        // use class to change status
-        $this->_cpt_model_obj->set_status($venue_status);
-        $success = $this->_cpt_model_obj->save();
-
-        if ($success === false) {
-            $msg = sprintf(esc_html__('An error occurred. The venue could not be %s.', 'event_espresso'), $action);
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if ($hook) {
-            do_action($hook);
-        }
-        return true;
-    }
-
-
-    /**
-     * @param bool $redirect_after
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _delete_venue($redirect_after = true)
-    {
-        // determine the venue id and set to array.
-        $VNU_ID = $this->request->getRequestParam('VNU_ID', 0, 'int');
-        $VNU_ID = $this->request->getRequestParam('post', $VNU_ID, 'int');
-
-        // loop thru venues
-        if ($VNU_ID) {
-            $success = $this->_delete_or_trash_venue($VNU_ID);
-        } else {
-            $success = false;
-            $msg     = esc_html__(
-                'An error occurred. An venue could not be deleted because a valid venue ID was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        if ($redirect_after) {
-            $this->_redirect_after_action($success, 'Venue', 'deleted', ['action' => 'default']);
-        }
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _delete_venues()
-    {
-        $success = true;
-        // determine the event id and set to array.
-        $VNU_IDs = $this->request->getRequestParam('venue_id', [], 'int', true);
-        // loop thru events
-        foreach ($VNU_IDs as $VNU_ID) {
-            if ($VNU_ID = absint($VNU_ID)) {
-                $results = $this->_delete_or_trash_venue($VNU_ID);
-                $success = $results !== false ? $success : false;
-            } else {
-                $success = false;
-                $msg     = esc_html__(
-                    'An error occurred. An venue could not be deleted because a valid venue ID was not not supplied.',
-                    'event_espresso'
-                );
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        }
-        // in order to force a pluralized result message we need to send back a success status greater than 1
-        $success = $success ? 2 : false;
-        $this->_redirect_after_action(
-            $success,
-            esc_html__('Venues', 'event_espresso'),
-            esc_html__('deleted', 'event_espresso'),
-            ['action' => 'default']
-        );
-    }
-
-
-    // todo: put in parent
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _delete_or_trash_venue($VNU_ID = false)
-    {
-        // grab event id
-        if (! $VNU_ID = absint($VNU_ID)) {
-            $msg = esc_html__('An error occurred. No Venue ID or an invalid Venue ID was received.', 'event_espresso');
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-
-
-        $venue = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
-        // first need to remove all term relationships
-        $venue->_remove_relations('Term_Taxonomy');
-        $success = $venue->delete_permanently();
-        // did it all go as planned ?
-        if ($success) {
-            $msg = sprintf(esc_html__('Venue ID # %d has been deleted.', 'event_espresso'), $VNU_ID);
-            EE_Error::add_success($msg);
-        } else {
-            $msg =
-                sprintf(
-                    esc_html__('An error occurred. Venue ID # %d could not be deleted.', 'event_espresso'),
-                    $VNU_ID
-                );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        do_action('AHEE__Venues_Admin_Page___delete_or_trash_venue__after_venue_deleted');
-        return true;
-    }
-
-
-
-
-    /***********/
-    /* QUERIES */
-
-
-    public function get_venues($per_page = 10, $count = false)
-    {
-
-        $orderby = $this->request->getRequestParam('orderby', '');
-
-        switch ($orderby) {
-            case 'id':
-                $orderby = 'VNU_ID';
-                break;
-
-            case 'capacity':
-                $orderby = 'VNU_capacity';
-                break;
-
-            case 'city':
-                $orderby = 'VNU_city';
-                break;
-
-            default:
-                $orderby = 'VNU_name';
-        }
-
-        $sort         = $this->request->getRequestParam('order', 'ASC');
-        $current_page = $this->request->getRequestParam('paged', 1, 'int');
-        $per_page     = ! empty($per_page) ? $per_page : 10;
-        $per_page     = $this->request->getRequestParam('perpage', $per_page, 'int');
-
-        $offset = ($current_page - 1) * $per_page;
-        $limit  = [$offset, $per_page];
-
-        $category = $this->request->getRequestParam('category');
-        $category = $category > 0 ? $category : null;
-
-        $where = [];
-
-        // only set initial status if it is in the incoming request.  Otherwise the "all" view display's all statuses.
-        $status = $this->request->getRequestParam('status');
-        if ($status && $status !== 'all') {
-            $where['status'] = $status;
-        }
-
-        $venue_status = $this->request->getRequestParam('venue_status');
-        if ($venue_status) {
-            $where['status'] = $venue_status;
-        }
-
-
-        if ($category) {
-            $where['Term_Taxonomy.taxonomy'] = 'espresso_venue_categories';
-            $where['Term_Taxonomy.term_id']  = $category;
-        }
-
-
-        if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_venues', 'get_venues')) {
-            $where['VNU_wp_user'] = get_current_user_id();
-        } else {
-            if (! EE_Registry::instance()->CAP->current_user_can('ee_read_private_venues', 'get_venues')) {
-                $where['OR'] = [
-                    'status*restrict_private' => ['!=', 'private'],
-                    'AND'                     => [
-                        'status*inclusive' => ['=', 'private'],
-                        'VNU_wp_user'      => get_current_user_id(),
-                    ],
-                ];
-            }
-        }
-
-        $search_term = $this->request->getRequestParam('s');
-        if ($search_term) {
-            $search_term = '%' . $search_term . '%';
-            $where['OR'] = [
-                'VNU_name'               => ['LIKE', $search_term],
-                'VNU_desc'               => ['LIKE', $search_term],
-                'VNU_short_desc'         => ['LIKE', $search_term],
-                'VNU_address'            => ['LIKE', $search_term],
-                'VNU_address2'           => ['LIKE', $search_term],
-                'VNU_city'               => ['LIKE', $search_term],
-                'VNU_zip'                => ['LIKE', $search_term],
-                'VNU_phone'              => ['LIKE', $search_term],
-                'VNU_url'                => ['LIKE', $search_term],
-                'VNU_virtual_phone'      => ['LIKE', $search_term],
-                'VNU_virtual_url'        => ['LIKE', $search_term],
-                'VNU_google_map_link'    => ['LIKE', $search_term],
-                'Event.EVT_name'         => ['LIKE', $search_term],
-                'Event.EVT_desc'         => ['LIKE', $search_term],
-                'Event.EVT_phone'        => ['LIKE', $search_term],
-                'Event.EVT_external_URL' => ['LIKE', $search_term],
-            ];
-        }
-
-
-        return $count
-            ? $this->_venue_model->count([$where], 'VNU_ID')
-            : $this->_venue_model->get_all(
-                [$where, 'limit' => $limit, 'order_by' => $orderby, 'order' => $sort]
-            );
-    }
-
-
-
-
-    /** Venue Category Stuff **/
-
-    /**
-     * set the _category property with the category object for the loaded page.
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_category_object()
-    {
-        if (isset($this->_category->id) && ! empty($this->_category->id)) {
-            return;
-        } // already have the category object so get out.
-
-        // set default category object
-        $this->_set_empty_category_object();
-
-        // only set if we've got an id
-        $category_ID = $this->request->getRequestParam('VEN_CAT_ID', 0, 'int');
-        if (! $category_ID) {
-            return;
-        }
-
-        $term = get_term($category_ID, 'espresso_venue_categories');
-
-
-        if (! empty($term)) {
-            $this->_category->category_name       = $term->name;
-            $this->_category->category_identifier = $term->slug;
-            $this->_category->category_desc       = $term->description;
-            $this->_category->id                  = $term->term_id;
-            $this->_category->parent              = $term->parent;
-        }
-    }
-
-
-    private function _set_empty_category_object()
-    {
-        $this->_category                = new stdClass();
-        $this->_category->category_name = $this->_category->category_identifier = $this->_category->category_desc = '';
-        $this->_category->id            = $this->_category->parent = 0;
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _category_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-            'add_category',
-            'add_category',
-            [],
-            'add-new-h2'
-        );
-        $this->_search_btn_label = esc_html__('Venue Categories', 'event_espresso');
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _category_details($view)
-    {
-
-        // load formatter helper
-        // load field generator helper
-
-        $route = $view == 'edit' ? 'update_category' : 'insert_category';
-        $this->_set_add_edit_form_tags($route);
-
-        $this->_set_category_object();
-        $id = ! empty($this->_category->id) ? $this->_category->id : '';
-
-        $delete_action = 'delete_category';
-
-        $redirect = EE_Admin_Page::add_query_args_and_nonce(['action' => 'category_list'], $this->_admin_base_url);
-
-        $this->_set_publish_post_box_vars('VEN_CAT_ID', $id, $delete_action, $redirect);
-
-        // take care of contents
-        $this->_template_args['admin_page_content'] = $this->_category_details_content();
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    protected function _category_details_content()
-    {
-        $editor_args['category_desc'] = [
-            'type'          => 'wp_editor',
-            'value'         => EEH_Formatter::admin_format_content($this->_category->category_desc),
-            'class'         => 'my_editor_custom',
-            'wpeditor_args' => ['media_buttons' => false],
-        ];
-        $_wp_editor                   = $this->_generate_admin_form_fields($editor_args, 'array');
-
-        $all_terms = get_terms(
-            ['espresso_venue_categories'],
-            ['hide_empty' => 0, 'exclude' => [$this->_category->id]]
-        );
-
-        // setup category select for term parents.
-        $category_select_values[] = [
-            'text' => esc_html__('No Parent', 'event_espresso'),
-            'id'   => 0,
-        ];
-        foreach ($all_terms as $term) {
-            $category_select_values[] = [
-                'text' => $term->name,
-                'id'   => $term->term_id,
-            ];
-        }
-
-        $category_select = EEH_Form_Fields::select_input(
-            'category_parent',
-            $category_select_values,
-            $this->_category->parent
-        );
-        $template_args   = [
-            'category'                 => $this->_category,
-            'category_select'          => $category_select,
-            'unique_id_info_help_link' => $this->_get_help_tab_link('unique_id_info'),
-            'category_desc_editor'     => $_wp_editor['category_desc']['field'],
-            'disable'                  => '',
-            'disabled_message'         => false,
-        ];
-        $template        = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php';
-        return EEH_Template::display_template($template, $template_args, true);
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _delete_categories()
-    {
-        $category_ID  = $this->request->getRequestParam('category_id', 0, 'int');
-        $category_IDs = $this->request->getRequestParam('VEN_CAT_ID', [$category_ID], 'int', true);
-
-        foreach ($category_IDs as $cat_id) {
-            $this->_delete_category($cat_id);
-        }
-
-        // doesn't matter what page we're coming from... we're going to the same place after delete.
-        $query_args = [
-            'action' => 'category_list',
-        ];
-        $this->_redirect_after_action(0, '', '', $query_args);
-    }
-
-
-    protected function _delete_category($cat_id)
-    {
-        $cat_id = absint($cat_id);
-        wp_delete_term($cat_id, 'espresso_venue_categories');
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _insert_or_update_category($new_category)
-    {
-
-        $cat_id  = $new_category ? $this->_insert_category() : $this->_insert_category(true);
-        $success = 0; // we already have a success message so lets not send another.
-        if ($cat_id) {
-            $query_args = [
-                'action'     => 'edit_category',
-                'VEN_CAT_ID' => $cat_id,
-            ];
-        } else {
-            $query_args = ['action' => 'add_category'];
-        }
-        $this->_redirect_after_action($success, '', '', $query_args, true);
-    }
-
-
-    private function _insert_category($update = false)
-    {
-        $category_ID     = $update ? $this->request->getRequestParam('VEN_CAT_ID', '', 'int') : '';
-        $category_name   = $this->request->getRequestParam('category_name', '');
-        $category_desc   = $this->request->getRequestParam('category_desc', '', 'html');
-        $category_parent = $this->request->getRequestParam('category_parent', 0, 'int');
-
-        if (empty($category_name)) {
-            $msg = esc_html__('You must add a name for the category.', 'event_espresso');
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-
-
-        $term_args = [
-            'name'        => $category_name,
-            'description' => $category_desc,
-            'parent'      => $category_parent,
-        ];
-
-        $insert_ids = $update
-            ? wp_update_term($category_ID, 'espresso_venue_categories', $term_args)
-            : wp_insert_term(
-                $category_name,
-                'espresso_venue_categories',
-                $term_args
-            );
-
-        if (! is_array($insert_ids)) {
-            EE_Error::add_error(
-                esc_html__('An error occurred and the category has not been saved to the database.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } else {
-            $category_ID = $insert_ids['term_id'];
-            EE_Error::add_success(
-                sprintf(
-                    esc_html__('The category %s was successfully created', 'event_espresso'),
-                    $category_name
-                )
-            );
-        }
-
-        return $category_ID;
-    }
-
-
-    /**
-     * TODO handle category exports()
-     *
-     * @return void
-     */
-    protected function _categories_export()
-    {
-        // todo: I don't like doing this but it'll do until we modify EE_Export Class.
-        $this->request->mergeRequestParams(
-            [
-                'export'       => 'report',
-                'action'       => 'categories',
-                'category_ids' => $this->request->getRequestParam('VEN_CAT_ID', 0, 'int'),
-            ]
-        );
-
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-            require_once(EE_CLASSES . 'EE_Export.class.php');
-            $EE_Export = EE_Export::instance($this->request->requestParams());
-            $EE_Export->export();
-        }
-    }
-
-
-    protected function _import_categories()
-    {
-
-        require_once(EE_CLASSES . 'EE_Import.class.php');
-        EE_Import::instance()->import();
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    public function get_categories($per_page = 10, $current_page = 1, $count = false)
-    {
-
-        // testing term stuff
-        $orderby     = $this->request->getRequestParam('orderby', 'Term.term_id');
-        $order       = $this->request->getRequestParam('order', 'DESC');
-        $limit       = ($current_page - 1) * $per_page;
-        $where       = ['taxonomy' => 'espresso_venue_categories'];
-        $search_term = $this->request->getRequestParam('s');
-        if ($search_term) {
-            $search_term = '%' . $search_term . '%';
-            $where['OR'] = [
-                'Term.name'   => ['LIKE', $search_term],
-                'description' => ['LIKE', $search_term],
-            ];
-        }
-
-        $query_params = [
-            $where,
-            'order_by'   => [$orderby => $order],
-            'limit'      => $limit . ',' . $per_page,
-            'force_join' => ['Term'],
-        ];
-
-        return $count
-            ? EEM_Term_Taxonomy::instance()->count($query_params, 'term_id')
-            : EEM_Term_Taxonomy::instance()->get_all($query_params);
-    }
-
-
-    /* end category stuff */
-    /**************/
+	protected function _google_map_settings()
+	{
+
+
+		$this->_template_args['values']           = $this->_yes_no_values;
+		$default_map_settings                     = new stdClass();
+		$default_map_settings->use_google_maps    = true;
+		$default_map_settings->google_map_api_key = '';
+		// for event details pages (reg page)
+		$default_map_settings->event_details_map_width    = 585;
+		// ee_map_width_single
+		$default_map_settings->event_details_map_height   = 362;
+		// ee_map_height_single
+		$default_map_settings->event_details_map_zoom     = 14;
+		// ee_map_zoom_single
+		$default_map_settings->event_details_display_nav  = true;
+		// ee_map_nav_display_single
+		$default_map_settings->event_details_nav_size     = false;
+		// ee_map_nav_size_single
+		$default_map_settings->event_details_control_type = 'default';
+		// ee_map_type_control_single
+		$default_map_settings->event_details_map_align    = 'center';
+		// ee_map_align_single
+
+		// for event list pages
+		$default_map_settings->event_list_map_width    = 300;
+		// ee_map_width
+		$default_map_settings->event_list_map_height   = 185;
+		// ee_map_height
+		$default_map_settings->event_list_map_zoom     = 12;
+		// ee_map_zoom
+		$default_map_settings->event_list_display_nav  = false;
+		// ee_map_nav_display
+		$default_map_settings->event_list_nav_size     = true;
+		// ee_map_nav_size
+		$default_map_settings->event_list_control_type = 'dropdown';
+		// ee_map_type_control
+		$default_map_settings->event_list_map_align    = 'center';
+		// ee_map_align
+
+		$this->_template_args['map_settings'] =
+			isset(EE_Registry::instance()->CFG->map_settings)
+			&& ! empty(EE_Registry::instance()->CFG->map_settings)
+				? (object) array_merge(
+					(array) $default_map_settings,
+					(array) EE_Registry::instance()->CFG->map_settings
+				)
+				: $default_map_settings;
+
+		$this->_set_add_edit_form_tags('update_google_map_settings');
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			EE_VENUES_TEMPLATE_PATH . 'google_map.template.php',
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _update_google_map_settings()
+	{
+		$map_settings = EE_Registry::instance()->CFG->map_settings;
+
+		$settings = [
+			'use_google_maps'            => 'int',
+			'google_map_api_key'         => 'string',
+			'event_details_map_width'    => 'int',
+			'event_details_map_zoom'     => 'int',
+			'event_details_display_nav'  => 'int',
+			'event_details_nav_size'     => 'int',
+			'event_details_control_type' => 'string',
+			'event_details_map_align'    => 'string',
+			'event_list_map_width'       => 'int',
+			'event_list_map_height'      => 'int',
+			'event_list_map_zoom'        => 'int',
+			'event_list_display_nav'     => 'int',
+			'event_list_nav_size'        => 'int',
+			'event_list_control_type'    => 'string',
+			'event_list_map_align'       => 'string',
+		];
+
+		foreach ($settings as $setting => $type) {
+			$map_settings->{$setting} = $this->request->getRequestParam($setting, $map_settings->{$setting}, $type);
+		}
+
+		EE_Registry::instance()->CFG->map_settings = apply_filters(
+			'FHEE__Extend_General_Settings_Admin_Page___update_google_map_settings__CFG_map_settings',
+			$map_settings
+		);
+
+		$what    = 'Google Map Settings';
+		$success = $this->_update_espresso_configuration(
+			$what,
+			EE_Registry::instance()->CFG->map_settings,
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		$this->_redirect_after_action($success, $what, 'updated', ['action' => 'google_map_settings']);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _venue_editor_metaboxes()
+	{
+		$this->verify_cpt_object();
+
+		$this->addMetaBox(
+			'espresso_venue_address_options',
+			esc_html__('Physical Location', 'event_espresso'),
+			[$this, 'venue_address_metabox'],
+			$this->page_slug,
+			'side'
+		);
+		$this->addMetaBox(
+			'espresso_venue_gmap_options',
+			esc_html__('Google Map', 'event_espresso'),
+			[$this, 'venue_gmap_metabox'],
+			$this->page_slug,
+			'side'
+		);
+		$this->addMetaBox(
+			'espresso_venue_virtual_loc_options',
+			esc_html__('Virtual Location', 'event_espresso'),
+			[$this, 'venue_virtual_loc_metabox'],
+			$this->page_slug,
+			'side'
+		);
+	}
+
+
+	public function venue_gmap_metabox()
+	{
+		$template_args = [
+			'vnu_enable_for_gmap' => EEH_Form_Fields::select_input(
+				'vnu_enable_for_gmap',
+				$this->get_yes_no_values(),
+				$this->_cpt_model_obj instanceof EE_Venue ? $this->_cpt_model_obj->enable_for_gmap() : false
+			),
+			'vnu_google_map_link' => $this->_cpt_model_obj->google_map_link(),
+		];
+		$template      = EE_VENUES_TEMPLATE_PATH . 'venue_gmap_metabox_content.template.php';
+		EEH_Template::display_template($template, $template_args);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function venue_address_metabox()
+	{
+		$template_args['_venue'] = $this->_cpt_model_obj;
+
+		$template_args['states_dropdown']    = EEH_Form_Fields::generate_form_input(
+			new EE_Question_Form_Input(
+				EE_Question::new_instance(
+					['QST_display_text' => esc_html__('State', 'event_espresso'), 'QST_system' => 'state']
+				),
+				EE_Answer::new_instance(
+					[
+						'ANS_value' => $this->_cpt_model_obj instanceof EE_Venue
+							? $this->_cpt_model_obj->state_ID()
+							: 0,
+					]
+				),
+				[
+					'input_name'     => 'sta_id',
+					'input_id'       => 'sta_id',
+					'input_class'    => '',
+					'input_prefix'   => '',
+					'append_qstn_id' => false,
+				]
+			)
+		);
+		$template_args['countries_dropdown'] = EEH_Form_Fields::generate_form_input(
+			new EE_Question_Form_Input(
+				EE_Question::new_instance(
+					['QST_display_text' => esc_html__('Country', 'event_espresso'), 'QST_system' => 'country']
+				),
+				EE_Answer::new_instance(
+					[
+						'ANS_value' => $this->_cpt_model_obj instanceof EE_Venue
+							? $this->_cpt_model_obj->country_ID()
+							: 0,
+					]
+				),
+				[
+					'input_name'     => 'cnt_iso',
+					'input_id'       => 'cnt_iso',
+					'input_class'    => '',
+					'input_prefix'   => '',
+					'append_qstn_id' => false,
+				]
+			)
+		);
+
+		$template = EE_VENUES_TEMPLATE_PATH . 'venue_address_metabox_content.template.php';
+		EEH_Template::display_template($template, $template_args);
+	}
+
+
+	public function venue_virtual_loc_metabox()
+	{
+		$template_args = [
+			'_venue' => $this->_cpt_model_obj,
+		];
+		$template      = EE_VENUES_TEMPLATE_PATH . 'venue_virtual_location_metabox_content.template.php';
+		EEH_Template::display_template($template, $template_args);
+	}
+
+
+	protected function _restore_cpt_item($post_id, $revision_id)
+	{
+		$venue_obj = $this->_venue_model->get_one_by_ID($post_id);
+
+		// meta revision restore
+		$venue_obj->restore_revision($revision_id);
+	}
+
+
+	/**
+	 * Handles updates for venue cpts
+	 *
+	 * @param int    $post_id ID of Venue CPT
+	 * @param WP_Post $post    Post object (with "blessed" WP properties)
+	 * @return void
+	 */
+	protected function _insert_update_cpt_item($post_id, $post)
+	{
+
+		if ($post instanceof WP_Post && $post->post_type !== 'espresso_venues') {
+			return;// get out we're not processing the saving of venues.
+		}
+
+		$wheres = [$this->_venue_model->primary_key_name() => $post_id];
+
+		$venue_values = [
+			'VNU_address'         => $this->request->getRequestParam('vnu_address'),
+			'VNU_address2'        => $this->request->getRequestParam('vnu_address2'),
+			'VNU_city'            => $this->request->getRequestParam('vnu_city'),
+			'STA_ID'              => $this->request->getRequestParam('sta_id'),
+			'CNT_ISO'             => $this->request->getRequestParam('cnt_iso'),
+			'VNU_zip'             => $this->request->getRequestParam('vnu_zip'),
+			'VNU_phone'           => $this->request->getRequestParam('vnu_phone'),
+			'VNU_capacity'        => $this->request->requestParamIsSet('vnu_capacity')
+				? str_replace(',', '', $this->request->getRequestParam('vnu_capacity'))
+				: EE_INF,
+			'VNU_url'             => $this->request->getRequestParam('vnu_url'),
+			'VNU_virtual_phone'   => $this->request->getRequestParam('vnu_virtual_phone'),
+			'VNU_virtual_url'     => $this->request->getRequestParam('vnu_virtual_url'),
+			'VNU_enable_for_gmap' => $this->request->getRequestParam('vnu_enable_for_gmap', false, 'bool'),
+			'VNU_google_map_link' => $this->request->getRequestParam('vnu_google_map_link'),
+		];
+
+		// update venue
+		$success = $this->_venue_model->update($venue_values, [$wheres]);
+
+		// get venue_object for other metaboxes that might be added via the filter... though it would seem to make sense to just use $this->_venue_model->get_one_by_ID( $post_id ).. i have to setup where conditions to override the filters in the model that filter out autodraft and inherit statuses so we GET the inherit id!
+		$get_one_where = [$this->_venue_model->primary_key_name() => $post_id, 'status' => $post->post_status];
+		$venue         = $this->_venue_model->get_one([$get_one_where]);
+
+		// notice we've applied a filter for venue metabox callbacks but we don't actually have any default venue metaboxes in use.  So this is just here for addons to more easily hook into venue saves.
+		$venue_update_callbacks = apply_filters(
+			'FHEE__Venues_Admin_Page___insert_update_cpt_item__venue_update_callbacks',
+			[]
+		);
+		$att_success            = true;
+		foreach ($venue_update_callbacks as $v_callback) {
+			// if ANY of these updates fail then we want the appropriate global error message
+			$att_success = call_user_func_array($v_callback, [$venue, $this->request->requestParams()])
+				? $att_success
+				: false;
+		}
+
+		// any errors?
+		if ($success && ! $att_success) {
+			EE_Error::add_error(
+				esc_html__(
+					'Venue Details saved successfully but something went wrong with saving attachments.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} elseif ($success === false) {
+			EE_Error::add_error(
+				esc_html__('Venue Details did not save successfully.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * @param int $post_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function trash_cpt_item($post_id)
+	{
+		$this->request->setRequestParam('VNU_ID', $post_id);
+		$this->_trash_or_restore_venue('trash', false);
+	}
+
+
+	/**
+	 * @param int $post_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function restore_cpt_item($post_id)
+	{
+		$this->request->setRequestParam('VNU_ID', $post_id);
+		$this->_trash_or_restore_venue('draft', false);
+	}
+
+
+	/**
+	 * @param int $post_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_cpt_item($post_id)
+	{
+		$this->request->setRequestParam('VNU_ID', $post_id);
+		$this->_delete_venue(false);
+	}
+
+
+	public function get_venue_object()
+	{
+		return $this->_cpt_model_obj;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _trash_or_restore_venue($venue_status = 'trash', $redirect_after = true)
+	{
+		$VNU_ID = $this->request->getRequestParam('VNU_ID', 0, 'int');
+
+		// loop thru venues
+		if ($VNU_ID) {
+			// clean status
+			$venue_status = sanitize_key($venue_status);
+			// grab status
+			if (! empty($venue_status)) {
+				$success = $this->_change_venue_status($VNU_ID, $venue_status);
+			} else {
+				$success = false;
+				$msg     = esc_html__(
+					'An error occurred. The venue could not be moved to the trash because a valid venue status was not not supplied.',
+					'event_espresso'
+				);
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		} else {
+			$success = false;
+			$msg     = esc_html__(
+				'An error occurred. The venue could not be moved to the trash because a valid venue ID was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		$action = $venue_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
+
+		if ($redirect_after) {
+			$this->_redirect_after_action($success, 'Venue', $action, ['action' => 'default']);
+		}
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _trash_or_restore_venues($venue_status = 'trash')
+	{
+		// clean status
+		$venue_status = sanitize_key($venue_status);
+		// grab status
+		if (! empty($venue_status)) {
+			$success = true;
+			// determine the event id and set to array.
+			$VNU_IDs = $this->request->getRequestParam('venue_id', [], 'int', true);
+			// loop thru events
+			foreach ($VNU_IDs as $VNU_ID) {
+				if ($VNU_ID = absint($VNU_ID)) {
+					$results = $this->_change_venue_status($VNU_ID, $venue_status);
+					$success = $results !== false ? $success : false;
+				} else {
+					$msg = sprintf(
+						esc_html__(
+							'An error occurred. Venue #%d could not be moved to the trash because a valid venue ID was not not supplied.',
+							'event_espresso'
+						),
+						$VNU_ID
+					);
+					EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+					$success = false;
+				}
+			}
+		} else {
+			$success = false;
+			$msg     = esc_html__(
+				'An error occurred. The venue could not be moved to the trash because a valid venue status was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		// in order to force a pluralized result message we need to send back a success status greater than 1
+		$success = $success ? 2 : false;
+		$action  = $venue_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
+		$this->_redirect_after_action($success, 'Venues', $action, ['action' => 'default']);
+	}
+
+
+	/**
+	 * _trash_or_restore_venues
+	 *
+	 * //todo this is pretty much the same as the corresponding change_event_status method in Events_Admin_Page.  We
+	 * should probably abstract this up to the EE_Admin_Page_CPT (or even EE_Admin_Page) and make this a common method
+	 * accepting a certain number of params.
+	 *
+	 * @access  private
+	 * @param int    $VNU_ID
+	 * @param string $venue_status
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _change_venue_status($VNU_ID = 0, $venue_status = '')
+	{
+		// grab venue id
+		if (! $VNU_ID) {
+			$msg = esc_html__('An error occurred. No Venue ID or an invalid Venue ID was received.', 'event_espresso');
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+
+		$this->_cpt_model_obj = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
+
+		// clean status
+		$venue_status = sanitize_key($venue_status);
+		// grab status
+		if (! $venue_status) {
+			$msg = esc_html__(
+				'An error occurred. No Venue Status or an invalid Venue Status was received.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+
+		// was event trashed or restored ?
+		switch ($venue_status) {
+			case 'draft':
+				$action = 'restored from the trash';
+				$hook   = 'AHEE_venue_restored_from_trash';
+				break;
+			case 'trash':
+				$action = 'moved to the trash';
+				$hook   = 'AHEE_venue_moved_to_trash';
+				break;
+			default:
+				$action = 'updated';
+				$hook   = false;
+		}
+		// use class to change status
+		$this->_cpt_model_obj->set_status($venue_status);
+		$success = $this->_cpt_model_obj->save();
+
+		if ($success === false) {
+			$msg = sprintf(esc_html__('An error occurred. The venue could not be %s.', 'event_espresso'), $action);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if ($hook) {
+			do_action($hook);
+		}
+		return true;
+	}
+
+
+	/**
+	 * @param bool $redirect_after
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _delete_venue($redirect_after = true)
+	{
+		// determine the venue id and set to array.
+		$VNU_ID = $this->request->getRequestParam('VNU_ID', 0, 'int');
+		$VNU_ID = $this->request->getRequestParam('post', $VNU_ID, 'int');
+
+		// loop thru venues
+		if ($VNU_ID) {
+			$success = $this->_delete_or_trash_venue($VNU_ID);
+		} else {
+			$success = false;
+			$msg     = esc_html__(
+				'An error occurred. An venue could not be deleted because a valid venue ID was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		if ($redirect_after) {
+			$this->_redirect_after_action($success, 'Venue', 'deleted', ['action' => 'default']);
+		}
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _delete_venues()
+	{
+		$success = true;
+		// determine the event id and set to array.
+		$VNU_IDs = $this->request->getRequestParam('venue_id', [], 'int', true);
+		// loop thru events
+		foreach ($VNU_IDs as $VNU_ID) {
+			if ($VNU_ID = absint($VNU_ID)) {
+				$results = $this->_delete_or_trash_venue($VNU_ID);
+				$success = $results !== false ? $success : false;
+			} else {
+				$success = false;
+				$msg     = esc_html__(
+					'An error occurred. An venue could not be deleted because a valid venue ID was not not supplied.',
+					'event_espresso'
+				);
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		}
+		// in order to force a pluralized result message we need to send back a success status greater than 1
+		$success = $success ? 2 : false;
+		$this->_redirect_after_action(
+			$success,
+			esc_html__('Venues', 'event_espresso'),
+			esc_html__('deleted', 'event_espresso'),
+			['action' => 'default']
+		);
+	}
+
+
+	// todo: put in parent
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _delete_or_trash_venue($VNU_ID = false)
+	{
+		// grab event id
+		if (! $VNU_ID = absint($VNU_ID)) {
+			$msg = esc_html__('An error occurred. No Venue ID or an invalid Venue ID was received.', 'event_espresso');
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+
+
+		$venue = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
+		// first need to remove all term relationships
+		$venue->_remove_relations('Term_Taxonomy');
+		$success = $venue->delete_permanently();
+		// did it all go as planned ?
+		if ($success) {
+			$msg = sprintf(esc_html__('Venue ID # %d has been deleted.', 'event_espresso'), $VNU_ID);
+			EE_Error::add_success($msg);
+		} else {
+			$msg =
+				sprintf(
+					esc_html__('An error occurred. Venue ID # %d could not be deleted.', 'event_espresso'),
+					$VNU_ID
+				);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		do_action('AHEE__Venues_Admin_Page___delete_or_trash_venue__after_venue_deleted');
+		return true;
+	}
+
+
+
+
+	/***********/
+	/* QUERIES */
+
+
+	public function get_venues($per_page = 10, $count = false)
+	{
+
+		$orderby = $this->request->getRequestParam('orderby', '');
+
+		switch ($orderby) {
+			case 'id':
+				$orderby = 'VNU_ID';
+				break;
+
+			case 'capacity':
+				$orderby = 'VNU_capacity';
+				break;
+
+			case 'city':
+				$orderby = 'VNU_city';
+				break;
+
+			default:
+				$orderby = 'VNU_name';
+		}
+
+		$sort         = $this->request->getRequestParam('order', 'ASC');
+		$current_page = $this->request->getRequestParam('paged', 1, 'int');
+		$per_page     = ! empty($per_page) ? $per_page : 10;
+		$per_page     = $this->request->getRequestParam('perpage', $per_page, 'int');
+
+		$offset = ($current_page - 1) * $per_page;
+		$limit  = [$offset, $per_page];
+
+		$category = $this->request->getRequestParam('category');
+		$category = $category > 0 ? $category : null;
+
+		$where = [];
+
+		// only set initial status if it is in the incoming request.  Otherwise the "all" view display's all statuses.
+		$status = $this->request->getRequestParam('status');
+		if ($status && $status !== 'all') {
+			$where['status'] = $status;
+		}
+
+		$venue_status = $this->request->getRequestParam('venue_status');
+		if ($venue_status) {
+			$where['status'] = $venue_status;
+		}
+
+
+		if ($category) {
+			$where['Term_Taxonomy.taxonomy'] = 'espresso_venue_categories';
+			$where['Term_Taxonomy.term_id']  = $category;
+		}
+
+
+		if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_venues', 'get_venues')) {
+			$where['VNU_wp_user'] = get_current_user_id();
+		} else {
+			if (! EE_Registry::instance()->CAP->current_user_can('ee_read_private_venues', 'get_venues')) {
+				$where['OR'] = [
+					'status*restrict_private' => ['!=', 'private'],
+					'AND'                     => [
+						'status*inclusive' => ['=', 'private'],
+						'VNU_wp_user'      => get_current_user_id(),
+					],
+				];
+			}
+		}
+
+		$search_term = $this->request->getRequestParam('s');
+		if ($search_term) {
+			$search_term = '%' . $search_term . '%';
+			$where['OR'] = [
+				'VNU_name'               => ['LIKE', $search_term],
+				'VNU_desc'               => ['LIKE', $search_term],
+				'VNU_short_desc'         => ['LIKE', $search_term],
+				'VNU_address'            => ['LIKE', $search_term],
+				'VNU_address2'           => ['LIKE', $search_term],
+				'VNU_city'               => ['LIKE', $search_term],
+				'VNU_zip'                => ['LIKE', $search_term],
+				'VNU_phone'              => ['LIKE', $search_term],
+				'VNU_url'                => ['LIKE', $search_term],
+				'VNU_virtual_phone'      => ['LIKE', $search_term],
+				'VNU_virtual_url'        => ['LIKE', $search_term],
+				'VNU_google_map_link'    => ['LIKE', $search_term],
+				'Event.EVT_name'         => ['LIKE', $search_term],
+				'Event.EVT_desc'         => ['LIKE', $search_term],
+				'Event.EVT_phone'        => ['LIKE', $search_term],
+				'Event.EVT_external_URL' => ['LIKE', $search_term],
+			];
+		}
+
+
+		return $count
+			? $this->_venue_model->count([$where], 'VNU_ID')
+			: $this->_venue_model->get_all(
+				[$where, 'limit' => $limit, 'order_by' => $orderby, 'order' => $sort]
+			);
+	}
+
+
+
+
+	/** Venue Category Stuff **/
+
+	/**
+	 * set the _category property with the category object for the loaded page.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_category_object()
+	{
+		if (isset($this->_category->id) && ! empty($this->_category->id)) {
+			return;
+		} // already have the category object so get out.
+
+		// set default category object
+		$this->_set_empty_category_object();
+
+		// only set if we've got an id
+		$category_ID = $this->request->getRequestParam('VEN_CAT_ID', 0, 'int');
+		if (! $category_ID) {
+			return;
+		}
+
+		$term = get_term($category_ID, 'espresso_venue_categories');
+
+
+		if (! empty($term)) {
+			$this->_category->category_name       = $term->name;
+			$this->_category->category_identifier = $term->slug;
+			$this->_category->category_desc       = $term->description;
+			$this->_category->id                  = $term->term_id;
+			$this->_category->parent              = $term->parent;
+		}
+	}
+
+
+	private function _set_empty_category_object()
+	{
+		$this->_category                = new stdClass();
+		$this->_category->category_name = $this->_category->category_identifier = $this->_category->category_desc = '';
+		$this->_category->id            = $this->_category->parent = 0;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _category_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+			'add_category',
+			'add_category',
+			[],
+			'add-new-h2'
+		);
+		$this->_search_btn_label = esc_html__('Venue Categories', 'event_espresso');
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _category_details($view)
+	{
+
+		// load formatter helper
+		// load field generator helper
+
+		$route = $view == 'edit' ? 'update_category' : 'insert_category';
+		$this->_set_add_edit_form_tags($route);
+
+		$this->_set_category_object();
+		$id = ! empty($this->_category->id) ? $this->_category->id : '';
+
+		$delete_action = 'delete_category';
+
+		$redirect = EE_Admin_Page::add_query_args_and_nonce(['action' => 'category_list'], $this->_admin_base_url);
+
+		$this->_set_publish_post_box_vars('VEN_CAT_ID', $id, $delete_action, $redirect);
+
+		// take care of contents
+		$this->_template_args['admin_page_content'] = $this->_category_details_content();
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	protected function _category_details_content()
+	{
+		$editor_args['category_desc'] = [
+			'type'          => 'wp_editor',
+			'value'         => EEH_Formatter::admin_format_content($this->_category->category_desc),
+			'class'         => 'my_editor_custom',
+			'wpeditor_args' => ['media_buttons' => false],
+		];
+		$_wp_editor                   = $this->_generate_admin_form_fields($editor_args, 'array');
+
+		$all_terms = get_terms(
+			['espresso_venue_categories'],
+			['hide_empty' => 0, 'exclude' => [$this->_category->id]]
+		);
+
+		// setup category select for term parents.
+		$category_select_values[] = [
+			'text' => esc_html__('No Parent', 'event_espresso'),
+			'id'   => 0,
+		];
+		foreach ($all_terms as $term) {
+			$category_select_values[] = [
+				'text' => $term->name,
+				'id'   => $term->term_id,
+			];
+		}
+
+		$category_select = EEH_Form_Fields::select_input(
+			'category_parent',
+			$category_select_values,
+			$this->_category->parent
+		);
+		$template_args   = [
+			'category'                 => $this->_category,
+			'category_select'          => $category_select,
+			'unique_id_info_help_link' => $this->_get_help_tab_link('unique_id_info'),
+			'category_desc_editor'     => $_wp_editor['category_desc']['field'],
+			'disable'                  => '',
+			'disabled_message'         => false,
+		];
+		$template        = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php';
+		return EEH_Template::display_template($template, $template_args, true);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _delete_categories()
+	{
+		$category_ID  = $this->request->getRequestParam('category_id', 0, 'int');
+		$category_IDs = $this->request->getRequestParam('VEN_CAT_ID', [$category_ID], 'int', true);
+
+		foreach ($category_IDs as $cat_id) {
+			$this->_delete_category($cat_id);
+		}
+
+		// doesn't matter what page we're coming from... we're going to the same place after delete.
+		$query_args = [
+			'action' => 'category_list',
+		];
+		$this->_redirect_after_action(0, '', '', $query_args);
+	}
+
+
+	protected function _delete_category($cat_id)
+	{
+		$cat_id = absint($cat_id);
+		wp_delete_term($cat_id, 'espresso_venue_categories');
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _insert_or_update_category($new_category)
+	{
+
+		$cat_id  = $new_category ? $this->_insert_category() : $this->_insert_category(true);
+		$success = 0; // we already have a success message so lets not send another.
+		if ($cat_id) {
+			$query_args = [
+				'action'     => 'edit_category',
+				'VEN_CAT_ID' => $cat_id,
+			];
+		} else {
+			$query_args = ['action' => 'add_category'];
+		}
+		$this->_redirect_after_action($success, '', '', $query_args, true);
+	}
+
+
+	private function _insert_category($update = false)
+	{
+		$category_ID     = $update ? $this->request->getRequestParam('VEN_CAT_ID', '', 'int') : '';
+		$category_name   = $this->request->getRequestParam('category_name', '');
+		$category_desc   = $this->request->getRequestParam('category_desc', '', 'html');
+		$category_parent = $this->request->getRequestParam('category_parent', 0, 'int');
+
+		if (empty($category_name)) {
+			$msg = esc_html__('You must add a name for the category.', 'event_espresso');
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+
+
+		$term_args = [
+			'name'        => $category_name,
+			'description' => $category_desc,
+			'parent'      => $category_parent,
+		];
+
+		$insert_ids = $update
+			? wp_update_term($category_ID, 'espresso_venue_categories', $term_args)
+			: wp_insert_term(
+				$category_name,
+				'espresso_venue_categories',
+				$term_args
+			);
+
+		if (! is_array($insert_ids)) {
+			EE_Error::add_error(
+				esc_html__('An error occurred and the category has not been saved to the database.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} else {
+			$category_ID = $insert_ids['term_id'];
+			EE_Error::add_success(
+				sprintf(
+					esc_html__('The category %s was successfully created', 'event_espresso'),
+					$category_name
+				)
+			);
+		}
+
+		return $category_ID;
+	}
+
+
+	/**
+	 * TODO handle category exports()
+	 *
+	 * @return void
+	 */
+	protected function _categories_export()
+	{
+		// todo: I don't like doing this but it'll do until we modify EE_Export Class.
+		$this->request->mergeRequestParams(
+			[
+				'export'       => 'report',
+				'action'       => 'categories',
+				'category_ids' => $this->request->getRequestParam('VEN_CAT_ID', 0, 'int'),
+			]
+		);
+
+		if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
+			require_once(EE_CLASSES . 'EE_Export.class.php');
+			$EE_Export = EE_Export::instance($this->request->requestParams());
+			$EE_Export->export();
+		}
+	}
+
+
+	protected function _import_categories()
+	{
+
+		require_once(EE_CLASSES . 'EE_Import.class.php');
+		EE_Import::instance()->import();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	public function get_categories($per_page = 10, $current_page = 1, $count = false)
+	{
+
+		// testing term stuff
+		$orderby     = $this->request->getRequestParam('orderby', 'Term.term_id');
+		$order       = $this->request->getRequestParam('order', 'DESC');
+		$limit       = ($current_page - 1) * $per_page;
+		$where       = ['taxonomy' => 'espresso_venue_categories'];
+		$search_term = $this->request->getRequestParam('s');
+		if ($search_term) {
+			$search_term = '%' . $search_term . '%';
+			$where['OR'] = [
+				'Term.name'   => ['LIKE', $search_term],
+				'description' => ['LIKE', $search_term],
+			];
+		}
+
+		$query_params = [
+			$where,
+			'order_by'   => [$orderby => $order],
+			'limit'      => $limit . ',' . $per_page,
+			'force_join' => ['Term'],
+		];
+
+		return $count
+			? EEM_Term_Taxonomy::instance()->count($query_params, 'term_id')
+			: EEM_Term_Taxonomy::instance()->get_all($query_params);
+	}
+
+
+	/* end category stuff */
+	/**************/
 }

core/libraries/messages/data_class/EE_Messages_Preview_incoming_data.class.php

Spacing +65 added lines, -65 removed lines

@@ -106,70 +106,70 @@ 
         // we'll actually use the generated line_item identifiers for our loop
         $dtts = $tkts = [];
         foreach ($events as $id => $event) {
-            if (! $event instanceof EE_Event) {
+            if ( ! $event instanceof EE_Event) {
                 continue;
             }
-            $this->_events[ $id ]['ID']       = $id;
-            $this->_events[ $id ]['name']     = $event->get('EVT_name');
+            $this->_events[$id]['ID']       = $id;
+            $this->_events[$id]['name']     = $event->get('EVT_name');
             $datetime                         = $event->get_first_related('Datetime');
             $tickets                          = $datetime instanceof EE_Datetime ? $datetime->get_many_related(
                 'Ticket',
                 ['default_where_conditions' => 'none']
             ) : [];
-            $this->_events[ $id ]['event']    = $event;
-            $this->_events[ $id ]['reg_objs'] = [];
-            $this->_events[ $id ]['tkt_objs'] = $tickets;
-            $this->_events[ $id ]['dtt_objs'] = [];
+            $this->_events[$id]['event']    = $event;
+            $this->_events[$id]['reg_objs'] = [];
+            $this->_events[$id]['tkt_objs'] = $tickets;
+            $this->_events[$id]['dtt_objs'] = [];
 
-            $tkts     = [];
+            $tkts = [];
             foreach ($tickets as $ticket) {
-                if (! $ticket instanceof EE_Ticket) {
+                if ( ! $ticket instanceof EE_Ticket) {
                     continue;
                 }
                 $reldatetime                       = $ticket->datetimes();
-                $tkts[ $ticket->ID() ]             = [];
-                $tkts[ $ticket->ID() ]['ticket']   = $ticket;
-                $tkts[ $ticket->ID() ]['dtt_objs'] = $reldatetime;
-                $tkts[ $ticket->ID() ]['att_objs'] = $attendees;
-                $tkts[ $ticket->ID() ]['count']    = count($attendees);
-                $tkts[ $ticket->ID() ]['EE_Event'] = $event;
+                $tkts[$ticket->ID()]             = [];
+                $tkts[$ticket->ID()]['ticket']   = $ticket;
+                $tkts[$ticket->ID()]['dtt_objs'] = $reldatetime;
+                $tkts[$ticket->ID()]['att_objs'] = $attendees;
+                $tkts[$ticket->ID()]['count']    = count($attendees);
+                $tkts[$ticket->ID()]['EE_Event'] = $event;
                 foreach ($reldatetime as $datetime) {
-                    if ($datetime instanceof EE_Datetime && ! isset($dtts[ $datetime->ID() ])) {
-                        $this->_events[ $id ]['dtt_objs'][ $datetime->ID() ] = $datetime;
-                        $dtts[ $datetime->ID() ]['datetime']                 = $datetime;
-                        $dtts[ $datetime->ID() ]['tkt_objs'][]               = $ticket;
-                        $dtts[ $datetime->ID() ]['evt_objs'][]               = $event;
+                    if ($datetime instanceof EE_Datetime && ! isset($dtts[$datetime->ID()])) {
+                        $this->_events[$id]['dtt_objs'][$datetime->ID()] = $datetime;
+                        $dtts[$datetime->ID()]['datetime']                 = $datetime;
+                        $dtts[$datetime->ID()]['tkt_objs'][]               = $ticket;
+                        $dtts[$datetime->ID()]['evt_objs'][]               = $event;
                     }
                 }
             }
 
-            $this->_events[ $id ]['total_attendees'] = count($attendees);
-            $this->_events[ $id ]['att_objs']        = $attendees;
+            $this->_events[$id]['total_attendees'] = count($attendees);
+            $this->_events[$id]['att_objs']        = $attendees;
 
             // let's also setup the dummy attendees property!
             foreach ($attendees as $att_key => $attendee) {
-                if (! $attendee instanceof EE_Attendee) {
+                if ( ! $attendee instanceof EE_Attendee) {
                     continue;
                 }
-                $this->_attendees[ $att_key ]['line_ref'][] =
-                    $id;  // so later it can be determined what events this attendee registered for!
-                $this->_attendees[ $att_key ]['evt_objs'][] = $event;
-                $this->_attendees[ $att_key ]['att_obj']    = $attendee;
+                $this->_attendees[$att_key]['line_ref'][] =
+                    $id; // so later it can be determined what events this attendee registered for!
+                $this->_attendees[$att_key]['evt_objs'][] = $event;
+                $this->_attendees[$att_key]['att_obj']    = $attendee;
                 // $this->_attendees[$att_key]['registration_id'] = 0;
-                $this->_attendees[ $att_key ]['attendee_email'] = $attendee->email();
-                $this->_attendees[ $att_key ]['tkt_objs']       = $tickets;
+                $this->_attendees[$att_key]['attendee_email'] = $attendee->email();
+                $this->_attendees[$att_key]['tkt_objs']       = $tickets;
                 if ($att_key == 999999991) {
-                    $this->_attendees[ $att_key ]['ans_objs'][999]  = $answers_n_questions['answers'][999];
-                    $this->_attendees[ $att_key ]['ans_objs'][1002] = $answers_n_questions['answers'][1002];
-                    $this->_attendees[ $att_key ]['ans_objs'][1005] = $answers_n_questions['answers'][1005];
+                    $this->_attendees[$att_key]['ans_objs'][999]  = $answers_n_questions['answers'][999];
+                    $this->_attendees[$att_key]['ans_objs'][1002] = $answers_n_questions['answers'][1002];
+                    $this->_attendees[$att_key]['ans_objs'][1005] = $answers_n_questions['answers'][1005];
                 } elseif ($att_key == 999999992) {
-                    $this->_attendees[ $att_key ]['ans_objs'][1000] = $answers_n_questions['answers'][1000];
-                    $this->_attendees[ $att_key ]['ans_objs'][1003] = $answers_n_questions['answers'][1003];
-                    $this->_attendees[ $att_key ]['ans_objs'][1006] = $answers_n_questions['answers'][1006];
+                    $this->_attendees[$att_key]['ans_objs'][1000] = $answers_n_questions['answers'][1000];
+                    $this->_attendees[$att_key]['ans_objs'][1003] = $answers_n_questions['answers'][1003];
+                    $this->_attendees[$att_key]['ans_objs'][1006] = $answers_n_questions['answers'][1006];
                 } elseif ($att_key == 999999993) {
-                    $this->_attendees[ $att_key ]['ans_objs'][1001] = $answers_n_questions['answers'][1001];
-                    $this->_attendees[ $att_key ]['ans_objs'][1004] = $answers_n_questions['answers'][1004];
-                    $this->_attendees[ $att_key ]['ans_objs'][1007] = $answers_n_questions['answers'][1007];
+                    $this->_attendees[$att_key]['ans_objs'][1001] = $answers_n_questions['answers'][1001];
+                    $this->_attendees[$att_key]['ans_objs'][1004] = $answers_n_questions['answers'][1004];
+                    $this->_attendees[$att_key]['ans_objs'][1007] = $answers_n_questions['answers'][1007];
                 }
             }
         }
@@ -270,7 +270,7 @@ 
             /** @var $email string */
             /** @var $phone string */
             /** @var $attid string */
-            $attendees[ $attid ] = EE_Attendee::new_instance(
+            $attendees[$attid] = EE_Attendee::new_instance(
                 [
                     'ATT_fname'    => $fname,
                     'ATT_lname'    => $lname,
@@ -377,7 +377,7 @@ 
         // first the questions
         foreach ($quests_array as $qst) {
             $qstobj                    = array_combine($qst_columns, $qst);
-            $qsts[ $qstobj['QST_ID'] ] = EE_Question::new_instance($qstobj);
+            $qsts[$qstobj['QST_ID']] = EE_Question::new_instance($qstobj);
         }
 
         // now the answers (and we'll setup our arrays)
@@ -385,8 +385,8 @@ 
         foreach ($ans_array as $ans) {
             $ansobj                               = array_combine($ans_columns, $ans);
             $ansobj                               = EE_Answer::new_instance($ansobj);
-            $q_n_as['answers'][ $ansobj->ID() ]   = $ansobj;
-            $q_n_as['questions'][ $ansobj->ID() ] = $qsts[ $ansobj->get('QST_ID') ];
+            $q_n_as['answers'][$ansobj->ID()]   = $ansobj;
+            $q_n_as['questions'][$ansobj->ID()] = $qsts[$ansobj->get('QST_ID')];
         }
 
         return $q_n_as;
@@ -471,11 +471,11 @@ 
             $regtxn = $this->txn->ID();
             $regcnt = 1;
             foreach ($attendee['line_ref'] as $evtid) {
-                foreach ($this->_events[ $evtid ]['tkt_objs'] as $ticket) {
-                    if (! $ticket instanceof EE_Ticket) {
+                foreach ($this->_events[$evtid]['tkt_objs'] as $ticket) {
+                    if ( ! $ticket instanceof EE_Ticket) {
                         continue;
                     }
-                    $reg_array                                            = [
+                    $reg_array = [
                         'EVT_ID'           => $evtid,
                         'ATT_ID'           => $regatt,
                         'TXN_ID'           => $regtxn,
@@ -484,18 +484,18 @@ 
                         'REG_date'         => time(),
                         'REG_final_price'  => $ticket->get('TKT_price'),
                         'REG_session'      => 'dummy_session_id',
-                        'REG_code'         => $regid . '-dummy-generated-code',
-                        'REG_url_link'     => $regcnt . '-daafpapasdlfakasdfpqasdfasdf',
+                        'REG_code'         => $regid.'-dummy-generated-code',
+                        'REG_url_link'     => $regcnt.'-daafpapasdlfakasdfpqasdfasdf',
                         'REG_count'        => $regcnt,
-                        'REG_group_size'   => $this->_events[ $evtid ]['total_attendees'],
+                        'REG_group_size'   => $this->_events[$evtid]['total_attendees'],
                         'REG_att_is_going' => true,
                         'REG_ID'           => $regid,
                     ];
                     $REG_OBJ                                              = EE_Registration::new_instance($reg_array);
-                    $this->_attendees[ $key ]['reg_objs'][ $regid ]       = $REG_OBJ;
-                    $this->_events[ $evtid ]['reg_objs'][]                = $REG_OBJ;
+                    $this->_attendees[$key]['reg_objs'][$regid]       = $REG_OBJ;
+                    $this->_events[$evtid]['reg_objs'][]                = $REG_OBJ;
                     $this->reg_objs[]                                     = $REG_OBJ;
-                    $this->tickets[ $ticket->ID() ]['reg_objs'][ $regid ] = $REG_OBJ;
+                    $this->tickets[$ticket->ID()]['reg_objs'][$regid] = $REG_OBJ;
 
                     $regcnt++;
                     $regid++;
@@ -541,19 +541,19 @@ 
         $event_line_items = EEH_Line_Item::get_pre_tax_subtotal($line_item_total)->children();
         $line_items       = [];
         foreach ($event_line_items as $line_item) {
-            if (! $line_item instanceof EE_Line_Item || $line_item->OBJ_type() !== 'Event') {
+            if ( ! $line_item instanceof EE_Line_Item || $line_item->OBJ_type() !== 'Event') {
                 continue;
             }
             $ticket_line_items = EEH_Line_Item::get_ticket_line_items($line_item);
             foreach ($ticket_line_items as $ticket_line_item) {
-                if (! $ticket_line_item instanceof EE_Line_Item) {
+                if ( ! $ticket_line_item instanceof EE_Line_Item) {
                     continue;
                 }
-                $this->tickets[ $ticket_line_item->OBJ_ID() ]['line_item']      = $ticket_line_item;
-                $this->tickets[ $ticket_line_item->OBJ_ID() ]['sub_line_items'] = $ticket_line_item->children();
-                $line_items[ $ticket_line_item->ID() ]['children']              = $ticket_line_item->children();
-                $line_items[ $ticket_line_item->ID() ]['EE_Ticket']             =
-                    $this->tickets[ $ticket_line_item->OBJ_ID() ]['ticket'];
+                $this->tickets[$ticket_line_item->OBJ_ID()]['line_item']      = $ticket_line_item;
+                $this->tickets[$ticket_line_item->OBJ_ID()]['sub_line_items'] = $ticket_line_item->children();
+                $line_items[$ticket_line_item->ID()]['children']              = $ticket_line_item->children();
+                $line_items[$ticket_line_item->ID()]['EE_Ticket']             =
+                    $this->tickets[$ticket_line_item->OBJ_ID()]['ticket'];
             }
         }
 
@@ -568,15 +568,15 @@ 
 
         // add additional details for each registration
         foreach ($this->reg_objs as $reg) {
-            if (! $reg instanceof EE_Registration) {
+            if ( ! $reg instanceof EE_Registration) {
                 continue;
             }
-            $this->_registrations[ $reg->ID() ]['tkt_obj']  = $this->tickets[ $reg->get('TKT_ID') ]['ticket'];
-            $this->_registrations[ $reg->ID() ]['evt_obj']  = $this->_events[ $reg->get('EVT_ID') ]['event'];
-            $this->_registrations[ $reg->ID() ]['reg_obj']  = $reg;
-            $this->_registrations[ $reg->ID() ]['ans_objs'] = $this->_attendees[ $reg->get('ATT_ID') ]['ans_objs'];
-            $this->_registrations[ $reg->ID() ]['att_obj']  = $this->_attendees[ $reg->get('ATT_ID') ]['att_obj'];
-            $this->_registrations[ $reg->ID() ]['dtt_objs'] = $this->tickets[ $reg->get('TKT_ID') ]['dtt_objs'];
+            $this->_registrations[$reg->ID()]['tkt_obj']  = $this->tickets[$reg->get('TKT_ID')]['ticket'];
+            $this->_registrations[$reg->ID()]['evt_obj']  = $this->_events[$reg->get('EVT_ID')]['event'];
+            $this->_registrations[$reg->ID()]['reg_obj']  = $reg;
+            $this->_registrations[$reg->ID()]['ans_objs'] = $this->_attendees[$reg->get('ATT_ID')]['ans_objs'];
+            $this->_registrations[$reg->ID()]['att_obj']  = $this->_attendees[$reg->get('ATT_ID')]['att_obj'];
+            $this->_registrations[$reg->ID()]['dtt_objs'] = $this->tickets[$reg->get('TKT_ID')]['dtt_objs'];
         }
 
 

Indentation +599 added lines, -599 removed lines

@@ -20,603 +20,603 @@
  */
 class EE_Messages_Preview_incoming_data extends EE_Messages_incoming_data
 {
-    // some specific properties we need for this class
-    private $_events        = [];
-
-    private $_attendees     = [];
-
-    private $_registrations = [];
-
-
-    /**
-     * For the constructor of this special preview class.  We're either looking for an event id or empty data.  If we
-     * have an event id (or ids) then we'll use that as the source for the "dummy" data.  If the data is empty then
-     * we'll get the first three published events from the users database and use that as a source.
-     *
-     * @param array $data
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct($data = [])
-    {
-        $this->_data = isset($data['event_ids']) ? $data['event_ids'] : [];
-        $this->_setup_attendees_events();
-        parent::__construct($data);
-    }
-
-
-    /**
-     * Returns database safe representation of the data later used to when instantiating this object.
-     *
-     * @param array $data The incoming data to be prepped.
-     *
-     * @return array   The prepped data for db
-     */
-    public static function convert_data_for_persistent_storage($data)
-    {
-        return $data;
-    }
-
-
-    /**
-     * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage
-     * can be sent into this method and converted back into the format used for instantiating with this data handler.
-     *
-     * @param array $data
-     *
-     * @return array
-     */
-    public static function convert_data_from_persistent_storage($data)
-    {
-        return $data;
-    }
-
-
-    /**
-     * This will just setup the _events property in the expected format.
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _setup_attendees_events()
-    {
-
-        // setup some attendee objects
-        $attendees = $this->_get_some_attendees();
-
-        // if empty $data we'll do a query to get some events from the server.
-        // otherwise we'll retrieve the event data for the given ids.
-        $events = $this->_get_some_events($this->_data);
-
-        $answers_n_questions = $this->_get_some_q_and_as();
-
-        if (count($events) < 1) {
-            throw new EE_Error(
-                esc_html__(
-                    'We can\'t generate a preview for you because there are no active events in your database',
-                    'event_espresso'
-                )
-            );
-        }
-
-
-        // now let's loop and set up the _events property.  At the same time we'll set up attendee properties.
-        // we'll actually use the generated line_item identifiers for our loop
-        $dtts = $tkts = [];
-        foreach ($events as $id => $event) {
-            if (! $event instanceof EE_Event) {
-                continue;
-            }
-            $this->_events[ $id ]['ID']       = $id;
-            $this->_events[ $id ]['name']     = $event->get('EVT_name');
-            $datetime                         = $event->get_first_related('Datetime');
-            $tickets                          = $datetime instanceof EE_Datetime ? $datetime->get_many_related(
-                'Ticket',
-                ['default_where_conditions' => 'none']
-            ) : [];
-            $this->_events[ $id ]['event']    = $event;
-            $this->_events[ $id ]['reg_objs'] = [];
-            $this->_events[ $id ]['tkt_objs'] = $tickets;
-            $this->_events[ $id ]['dtt_objs'] = [];
-
-            $tkts     = [];
-            foreach ($tickets as $ticket) {
-                if (! $ticket instanceof EE_Ticket) {
-                    continue;
-                }
-                $reldatetime                       = $ticket->datetimes();
-                $tkts[ $ticket->ID() ]             = [];
-                $tkts[ $ticket->ID() ]['ticket']   = $ticket;
-                $tkts[ $ticket->ID() ]['dtt_objs'] = $reldatetime;
-                $tkts[ $ticket->ID() ]['att_objs'] = $attendees;
-                $tkts[ $ticket->ID() ]['count']    = count($attendees);
-                $tkts[ $ticket->ID() ]['EE_Event'] = $event;
-                foreach ($reldatetime as $datetime) {
-                    if ($datetime instanceof EE_Datetime && ! isset($dtts[ $datetime->ID() ])) {
-                        $this->_events[ $id ]['dtt_objs'][ $datetime->ID() ] = $datetime;
-                        $dtts[ $datetime->ID() ]['datetime']                 = $datetime;
-                        $dtts[ $datetime->ID() ]['tkt_objs'][]               = $ticket;
-                        $dtts[ $datetime->ID() ]['evt_objs'][]               = $event;
-                    }
-                }
-            }
-
-            $this->_events[ $id ]['total_attendees'] = count($attendees);
-            $this->_events[ $id ]['att_objs']        = $attendees;
-
-            // let's also setup the dummy attendees property!
-            foreach ($attendees as $att_key => $attendee) {
-                if (! $attendee instanceof EE_Attendee) {
-                    continue;
-                }
-                $this->_attendees[ $att_key ]['line_ref'][] =
-                    $id;  // so later it can be determined what events this attendee registered for!
-                $this->_attendees[ $att_key ]['evt_objs'][] = $event;
-                $this->_attendees[ $att_key ]['att_obj']    = $attendee;
-                // $this->_attendees[$att_key]['registration_id'] = 0;
-                $this->_attendees[ $att_key ]['attendee_email'] = $attendee->email();
-                $this->_attendees[ $att_key ]['tkt_objs']       = $tickets;
-                if ($att_key == 999999991) {
-                    $this->_attendees[ $att_key ]['ans_objs'][999]  = $answers_n_questions['answers'][999];
-                    $this->_attendees[ $att_key ]['ans_objs'][1002] = $answers_n_questions['answers'][1002];
-                    $this->_attendees[ $att_key ]['ans_objs'][1005] = $answers_n_questions['answers'][1005];
-                } elseif ($att_key == 999999992) {
-                    $this->_attendees[ $att_key ]['ans_objs'][1000] = $answers_n_questions['answers'][1000];
-                    $this->_attendees[ $att_key ]['ans_objs'][1003] = $answers_n_questions['answers'][1003];
-                    $this->_attendees[ $att_key ]['ans_objs'][1006] = $answers_n_questions['answers'][1006];
-                } elseif ($att_key == 999999993) {
-                    $this->_attendees[ $att_key ]['ans_objs'][1001] = $answers_n_questions['answers'][1001];
-                    $this->_attendees[ $att_key ]['ans_objs'][1004] = $answers_n_questions['answers'][1004];
-                    $this->_attendees[ $att_key ]['ans_objs'][1007] = $answers_n_questions['answers'][1007];
-                }
-            }
-        }
-
-        $this->tickets            = $tkts;
-        $this->datetimes          = $dtts;
-        $this->answers            = $answers_n_questions['answers'];
-        $this->questions          = $answers_n_questions['questions'];
-        $this->total_ticket_count = count($tkts) * count($this->_attendees);
-    }
-
-
-    /**
-     * This just returns an array of dummy attendee objects that we'll use to attach to events for our preview data
-     *
-     * @access private
-     * @return array an array of attendee objects
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    private function _get_some_attendees()
-    {
-        // let's just setup a dummy array of various attendee details
-        $dummy_attendees = [
-            0 => [
-                'Luke',
-                'Skywalker',
-                'farfaraway@galaxy.sp',
-                '804 Bantha Dr.',
-                'Complex 8',
-                'Mos Eisley',
-                32,
-                'US',
-                'f0r3e',
-                '222-333-4763',
-                false,
-                '999999991',
-            ],
-            1 => [
-                'Princess',
-                'Leia',
-                'buns@fcn.al',
-                '1456 Valley Way Boulevard',
-                'Suite 9',
-                'Alderaan',
-                15,
-                'US',
-                'c1h2c',
-                '78-123-111-1111',
-                false,
-                '999999992',
-            ],
-            2 => [
-                'Yoda',
-                'I Am',
-                'arrivenot@emailbad.fr',
-                '4th Tree',
-                '5th Knot',
-                'Marsh',
-                22,
-                'US',
-                'l18n',
-                '999-999-9999',
-                false,
-                '999999993',
-            ],
-        ];
-
-        // let's generate the attendee objects
-        $attendees = [];
-        $var_array = [
-            'fname',
-            'lname',
-            'email',
-            'address',
-            'address2',
-            'city',
-            'staid',
-            'cntry',
-            'zip',
-            'phone',
-            'deleted',
-            'attid',
-        ];
-
-        // EE_Registry::instance()->load_class( 'Attendee', array(), FALSE, false, TRUE );
-        foreach ($dummy_attendees as $dummy) {
-            $att = array_combine($var_array, $dummy);
-            extract($att);
-            /** @var $fname string */
-            /** @var $lname string */
-            /** @var $address string */
-            /** @var $address2 string */
-            /** @var $city string */
-            /** @var $staid string */
-            /** @var $cntry string */
-            /** @var $zip string */
-            /** @var $email string */
-            /** @var $phone string */
-            /** @var $attid string */
-            $attendees[ $attid ] = EE_Attendee::new_instance(
-                [
-                    'ATT_fname'    => $fname,
-                    'ATT_lname'    => $lname,
-                    'ATT_address'  => $address,
-                    'ATT_address2' => $address2,
-                    'ATT_city'     => $city,
-                    'STA_ID'       => $staid,
-                    'CNT_ISO'      => $cntry,
-                    'ATT_zip'      => $zip,
-                    'ATT_email'    => $email,
-                    'ATT_phone'    => $phone,
-                    'ATT_ID'       => $attid,
-                ]
-            );
-        }
-
-        return $attendees;
-    }
-
-
-    /**
-     * Return an array of dummy question objects indexed by answer id and dummy answer objects indexed by answer id.
-     * This will be used in our dummy data setup
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_some_q_and_as()
-    {
-        $quests_array = [
-            0 => [
-                555,
-                esc_html__('What is your favorite planet?', 'event_espresso'),
-                0,
-            ],
-            1 => [
-                556,
-                esc_html__('What is your favorite food?', 'event_espresso'),
-                0,
-            ],
-            2 => [
-                557,
-                esc_html__('How many lightyears have you travelled', 'event_espresso'),
-                0,
-            ],
-        ];
-
-        $ans_array = [
-            0 => [
-                999,
-                555,
-                'Tattoine',
-            ],
-            1 => [
-                1000,
-                555,
-                'Alderaan',
-            ],
-            2 => [
-                1001,
-                555,
-                'Dantooine',
-            ],
-            3 => [
-                1002,
-                556,
-                'Fish Fingers',
-            ],
-            4 => [
-                1003,
-                556,
-                'Sushi',
-            ],
-            5 => [
-                1004,
-                556,
-                'Water',
-            ],
-            6 => [
-                1005,
-                557,
-                'A lot',
-            ],
-            7 => [
-                1006,
-                557,
-                "That's none of your business.",
-            ],
-            8 => [
-                1007,
-                557,
-                "People less travel me then.",
-            ],
-        ];
-
-        $qst_columns = ['QST_ID', 'QST_display_text', 'QST_system'];
-        $ans_columns = ['ANS_ID', 'QST_ID', 'ANS_value'];
-
-        // EE_Registry::instance()->load_class( 'Question', array(), FALSE, TRUE, TRUE );
-        // EE_Registry::instance()->load_class( 'Answer', array(), FALSE, TRUE, TRUE );
-
-        $qsts = [];
-        // first the questions
-        foreach ($quests_array as $qst) {
-            $qstobj                    = array_combine($qst_columns, $qst);
-            $qsts[ $qstobj['QST_ID'] ] = EE_Question::new_instance($qstobj);
-        }
-
-        // now the answers (and we'll setup our arrays)
-        $q_n_as = [];
-        foreach ($ans_array as $ans) {
-            $ansobj                               = array_combine($ans_columns, $ans);
-            $ansobj                               = EE_Answer::new_instance($ansobj);
-            $q_n_as['answers'][ $ansobj->ID() ]   = $ansobj;
-            $q_n_as['questions'][ $ansobj->ID() ] = $qsts[ $ansobj->get('QST_ID') ];
-        }
-
-        return $q_n_as;
-    }
-
-
-    /**
-     * Return an array of event objects from the database
-     *
-     * If event ids are not included then we'll just retrieve the first published event from the database.
-     *
-     * @param array $event_ids if set, this will be an array of event ids to obtain events for.
-     *
-     * @return array    An array of event objects from the db.
-     * @throws EE_Error
-     */
-    private function _get_some_events(array $event_ids = [])
-    {
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        // if we have an evt_id then we want to make sure we use that for the preview
-        // (because a specific event template is being viewed);
-        $event_ids = $request->getRequestParam('evt_id', $event_ids, 'int', true);
-        // clear out any invalid IDs, like 0
-        $event_ids = array_filter($event_ids);
-        $limit     = ! empty($event_ids)
-            ? null
-            : apply_filters('FHEE__EE_Messages_Preview_incoming_data___get_some_events__limit', '0,1');
-
-        $where = ! empty($event_ids)
-            ? [
-                'EVT_ID'                 => ['IN', $event_ids],
-                'Datetime.Ticket.TKT_ID' => ['>', 1],
-            ]
-            : ['Datetime.Ticket.TKT_ID' => ['>', 1]];
-
-        return EEM_Event::instance()->get_all([$where, 'limit' => $limit]);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _setup_data()
-    {
-        // need to figure out the running total for test purposes so... we're going to create a temp cart and add the tickets to it!
-        if (EE_Registry::instance()->SSN instanceof EE_Session) {
-            EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-            $session = EE_Registry::instance()->SSN;
-        } else {
-            $session = EE_Registry::instance()->load_core('Session');
-        }
-        $cart = EE_Cart::instance(null, $session);
-
-        // add tickets to cart
-        foreach ($this->tickets as $ticket) {
-            $cart->add_ticket_to_cart($ticket['ticket']);
-        }
-
-        // setup txn property
-        $this->txn = EE_Transaction::new_instance(
-            [
-                'TXN_timestamp'    => time(), // unix timestamp
-                'TXN_total'        => 0, // txn_total
-                'TXN_paid'         => 0, // txn_paid
-                'STS_ID'           => EEM_Transaction::incomplete_status_code, // sts_id
-                'TXN_session_data' => null, // dump of txn session object (we're just going to leave blank here)
-                'TXN_hash_salt'    => null, // hash salt blank as well
-                'TXN_ID'           => 999999,
-            ]
-        );
-
-
-        // setup reg_objects
-        // note we're setting up a reg object for each attendee in each event but ALSO adding to the reg_object array.
-        $this->reg_objs = [];
-        $regid          = 9999990;
-        foreach ($this->_attendees as $key => $attendee) {
-            // note we need to setup reg_objects for each event this attendee belongs to
-            $regatt = $attendee['att_obj'] instanceof EE_Attendee ? $attendee['att_obj']->ID() : null;
-            $regtxn = $this->txn->ID();
-            $regcnt = 1;
-            foreach ($attendee['line_ref'] as $evtid) {
-                foreach ($this->_events[ $evtid ]['tkt_objs'] as $ticket) {
-                    if (! $ticket instanceof EE_Ticket) {
-                        continue;
-                    }
-                    $reg_array                                            = [
-                        'EVT_ID'           => $evtid,
-                        'ATT_ID'           => $regatt,
-                        'TXN_ID'           => $regtxn,
-                        'TKT_ID'           => $ticket->ID(),
-                        'STS_ID'           => EEM_Registration::status_id_pending_payment,
-                        'REG_date'         => time(),
-                        'REG_final_price'  => $ticket->get('TKT_price'),
-                        'REG_session'      => 'dummy_session_id',
-                        'REG_code'         => $regid . '-dummy-generated-code',
-                        'REG_url_link'     => $regcnt . '-daafpapasdlfakasdfpqasdfasdf',
-                        'REG_count'        => $regcnt,
-                        'REG_group_size'   => $this->_events[ $evtid ]['total_attendees'],
-                        'REG_att_is_going' => true,
-                        'REG_ID'           => $regid,
-                    ];
-                    $REG_OBJ                                              = EE_Registration::new_instance($reg_array);
-                    $this->_attendees[ $key ]['reg_objs'][ $regid ]       = $REG_OBJ;
-                    $this->_events[ $evtid ]['reg_objs'][]                = $REG_OBJ;
-                    $this->reg_objs[]                                     = $REG_OBJ;
-                    $this->tickets[ $ticket->ID() ]['reg_objs'][ $regid ] = $REG_OBJ;
-
-                    $regcnt++;
-                    $regid++;
-                }
-            }
-        }
-
-
-        // setup line items!
-        $line_item_total = EEH_Line_Item::create_total_line_item($this->txn);
-
-        // add tickets
-        foreach ($this->tickets as $item) {
-            $qty    = $item['count'];
-            $ticket = $item['ticket'];
-            EEH_Line_Item::add_ticket_purchase($line_item_total, $ticket, $qty);
-        }
-
-        $shipping_line_item = EE_Line_Item::new_instance(
-            [
-                'LIN_name'       => esc_html__(
-                    'Shipping Surcharge',
-                    'event_espresso'
-                ),
-                'LIN_desc'       => esc_html__(
-                    'Sent via Millenium Falcon',
-                    'event_espresso'
-                ),
-                'LIN_unit_price' => 20,
-                'LIN_quantity'   => 1,
-                'LIN_is_taxable' => true,
-                'LIN_total'      => 20,
-                'LIN_type'       => EEM_Line_Item::type_line_item,
-            ]
-        );
-        EEH_Line_Item::add_item($line_item_total, $shipping_line_item);
-        $this->additional_line_items = [$shipping_line_item];
-
-        // now let's add taxes
-        EEH_Line_Item::apply_taxes($line_item_total);
-
-        // now we should be able to get the items we need from this object
-        $event_line_items = EEH_Line_Item::get_pre_tax_subtotal($line_item_total)->children();
-        $line_items       = [];
-        foreach ($event_line_items as $line_item) {
-            if (! $line_item instanceof EE_Line_Item || $line_item->OBJ_type() !== 'Event') {
-                continue;
-            }
-            $ticket_line_items = EEH_Line_Item::get_ticket_line_items($line_item);
-            foreach ($ticket_line_items as $ticket_line_item) {
-                if (! $ticket_line_item instanceof EE_Line_Item) {
-                    continue;
-                }
-                $this->tickets[ $ticket_line_item->OBJ_ID() ]['line_item']      = $ticket_line_item;
-                $this->tickets[ $ticket_line_item->OBJ_ID() ]['sub_line_items'] = $ticket_line_item->children();
-                $line_items[ $ticket_line_item->ID() ]['children']              = $ticket_line_item->children();
-                $line_items[ $ticket_line_item->ID() ]['EE_Ticket']             =
-                    $this->tickets[ $ticket_line_item->OBJ_ID() ]['ticket'];
-            }
-        }
-
-        $this->line_items_with_children = $line_items;
-        $this->tax_line_items           = $line_item_total->tax_descendants();
-
-        // add proper total to transaction object.
-        $grand_total                 = $line_item_total->recalculate_total_including_taxes();
-        $this->grand_total_line_item = $line_item_total;
-        $this->txn->set_total($grand_total);
-
-
-        // add additional details for each registration
-        foreach ($this->reg_objs as $reg) {
-            if (! $reg instanceof EE_Registration) {
-                continue;
-            }
-            $this->_registrations[ $reg->ID() ]['tkt_obj']  = $this->tickets[ $reg->get('TKT_ID') ]['ticket'];
-            $this->_registrations[ $reg->ID() ]['evt_obj']  = $this->_events[ $reg->get('EVT_ID') ]['event'];
-            $this->_registrations[ $reg->ID() ]['reg_obj']  = $reg;
-            $this->_registrations[ $reg->ID() ]['ans_objs'] = $this->_attendees[ $reg->get('ATT_ID') ]['ans_objs'];
-            $this->_registrations[ $reg->ID() ]['att_obj']  = $this->_attendees[ $reg->get('ATT_ID') ]['att_obj'];
-            $this->_registrations[ $reg->ID() ]['dtt_objs'] = $this->tickets[ $reg->get('TKT_ID') ]['dtt_objs'];
-        }
-
-
-        // events and attendees
-        $this->events        = $this->_events;
-        $this->attendees     = $this->_attendees;
-        $this->registrations = $this->_registrations;
-
-        $attendees_to_shift = $this->_attendees;
-
-        // setup primary attendee property
-        $this->primary_attendee_data = [
-            'fname' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
-                ? $this->_attendees[999999991]['att_obj']->fname()
-                : '',
-
-            'lname' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
-                ? $this->_attendees[999999991]['att_obj']->lname()
-                : '',
-
-            'email' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
-                ? $this->_attendees[999999991]['att_obj']->email()
-                : '',
-
-            'att_obj' => $this->_attendees[999999991]['att_obj'],
-
-            'reg_obj' => array_shift($attendees_to_shift[999999991]['reg_objs']),
-        ];
-
-        // reg_info property
-        // note this isn't referenced by any shortcode parsers so we'll ignore for now.
-        $this->reg_info = [];
-
-        // let's set a reg_obj for messengers expecting one.
-        $this->reg_obj = array_shift($this->_attendees[999999991]['reg_objs']);
-
-        // the below are just dummy items.
-        $this->user_id     = 1;
-        $this->ip_address  = '192.0.2.1';
-        $this->user_agent  = '';
-        $this->init_access = time();
-        $this->last_access = time();
-    }
+	// some specific properties we need for this class
+	private $_events        = [];
+
+	private $_attendees     = [];
+
+	private $_registrations = [];
+
+
+	/**
+	 * For the constructor of this special preview class.  We're either looking for an event id or empty data.  If we
+	 * have an event id (or ids) then we'll use that as the source for the "dummy" data.  If the data is empty then
+	 * we'll get the first three published events from the users database and use that as a source.
+	 *
+	 * @param array $data
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct($data = [])
+	{
+		$this->_data = isset($data['event_ids']) ? $data['event_ids'] : [];
+		$this->_setup_attendees_events();
+		parent::__construct($data);
+	}
+
+
+	/**
+	 * Returns database safe representation of the data later used to when instantiating this object.
+	 *
+	 * @param array $data The incoming data to be prepped.
+	 *
+	 * @return array   The prepped data for db
+	 */
+	public static function convert_data_for_persistent_storage($data)
+	{
+		return $data;
+	}
+
+
+	/**
+	 * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage
+	 * can be sent into this method and converted back into the format used for instantiating with this data handler.
+	 *
+	 * @param array $data
+	 *
+	 * @return array
+	 */
+	public static function convert_data_from_persistent_storage($data)
+	{
+		return $data;
+	}
+
+
+	/**
+	 * This will just setup the _events property in the expected format.
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _setup_attendees_events()
+	{
+
+		// setup some attendee objects
+		$attendees = $this->_get_some_attendees();
+
+		// if empty $data we'll do a query to get some events from the server.
+		// otherwise we'll retrieve the event data for the given ids.
+		$events = $this->_get_some_events($this->_data);
+
+		$answers_n_questions = $this->_get_some_q_and_as();
+
+		if (count($events) < 1) {
+			throw new EE_Error(
+				esc_html__(
+					'We can\'t generate a preview for you because there are no active events in your database',
+					'event_espresso'
+				)
+			);
+		}
+
+
+		// now let's loop and set up the _events property.  At the same time we'll set up attendee properties.
+		// we'll actually use the generated line_item identifiers for our loop
+		$dtts = $tkts = [];
+		foreach ($events as $id => $event) {
+			if (! $event instanceof EE_Event) {
+				continue;
+			}
+			$this->_events[ $id ]['ID']       = $id;
+			$this->_events[ $id ]['name']     = $event->get('EVT_name');
+			$datetime                         = $event->get_first_related('Datetime');
+			$tickets                          = $datetime instanceof EE_Datetime ? $datetime->get_many_related(
+				'Ticket',
+				['default_where_conditions' => 'none']
+			) : [];
+			$this->_events[ $id ]['event']    = $event;
+			$this->_events[ $id ]['reg_objs'] = [];
+			$this->_events[ $id ]['tkt_objs'] = $tickets;
+			$this->_events[ $id ]['dtt_objs'] = [];
+
+			$tkts     = [];
+			foreach ($tickets as $ticket) {
+				if (! $ticket instanceof EE_Ticket) {
+					continue;
+				}
+				$reldatetime                       = $ticket->datetimes();
+				$tkts[ $ticket->ID() ]             = [];
+				$tkts[ $ticket->ID() ]['ticket']   = $ticket;
+				$tkts[ $ticket->ID() ]['dtt_objs'] = $reldatetime;
+				$tkts[ $ticket->ID() ]['att_objs'] = $attendees;
+				$tkts[ $ticket->ID() ]['count']    = count($attendees);
+				$tkts[ $ticket->ID() ]['EE_Event'] = $event;
+				foreach ($reldatetime as $datetime) {
+					if ($datetime instanceof EE_Datetime && ! isset($dtts[ $datetime->ID() ])) {
+						$this->_events[ $id ]['dtt_objs'][ $datetime->ID() ] = $datetime;
+						$dtts[ $datetime->ID() ]['datetime']                 = $datetime;
+						$dtts[ $datetime->ID() ]['tkt_objs'][]               = $ticket;
+						$dtts[ $datetime->ID() ]['evt_objs'][]               = $event;
+					}
+				}
+			}
+
+			$this->_events[ $id ]['total_attendees'] = count($attendees);
+			$this->_events[ $id ]['att_objs']        = $attendees;
+
+			// let's also setup the dummy attendees property!
+			foreach ($attendees as $att_key => $attendee) {
+				if (! $attendee instanceof EE_Attendee) {
+					continue;
+				}
+				$this->_attendees[ $att_key ]['line_ref'][] =
+					$id;  // so later it can be determined what events this attendee registered for!
+				$this->_attendees[ $att_key ]['evt_objs'][] = $event;
+				$this->_attendees[ $att_key ]['att_obj']    = $attendee;
+				// $this->_attendees[$att_key]['registration_id'] = 0;
+				$this->_attendees[ $att_key ]['attendee_email'] = $attendee->email();
+				$this->_attendees[ $att_key ]['tkt_objs']       = $tickets;
+				if ($att_key == 999999991) {
+					$this->_attendees[ $att_key ]['ans_objs'][999]  = $answers_n_questions['answers'][999];
+					$this->_attendees[ $att_key ]['ans_objs'][1002] = $answers_n_questions['answers'][1002];
+					$this->_attendees[ $att_key ]['ans_objs'][1005] = $answers_n_questions['answers'][1005];
+				} elseif ($att_key == 999999992) {
+					$this->_attendees[ $att_key ]['ans_objs'][1000] = $answers_n_questions['answers'][1000];
+					$this->_attendees[ $att_key ]['ans_objs'][1003] = $answers_n_questions['answers'][1003];
+					$this->_attendees[ $att_key ]['ans_objs'][1006] = $answers_n_questions['answers'][1006];
+				} elseif ($att_key == 999999993) {
+					$this->_attendees[ $att_key ]['ans_objs'][1001] = $answers_n_questions['answers'][1001];
+					$this->_attendees[ $att_key ]['ans_objs'][1004] = $answers_n_questions['answers'][1004];
+					$this->_attendees[ $att_key ]['ans_objs'][1007] = $answers_n_questions['answers'][1007];
+				}
+			}
+		}
+
+		$this->tickets            = $tkts;
+		$this->datetimes          = $dtts;
+		$this->answers            = $answers_n_questions['answers'];
+		$this->questions          = $answers_n_questions['questions'];
+		$this->total_ticket_count = count($tkts) * count($this->_attendees);
+	}
+
+
+	/**
+	 * This just returns an array of dummy attendee objects that we'll use to attach to events for our preview data
+	 *
+	 * @access private
+	 * @return array an array of attendee objects
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	private function _get_some_attendees()
+	{
+		// let's just setup a dummy array of various attendee details
+		$dummy_attendees = [
+			0 => [
+				'Luke',
+				'Skywalker',
+				'farfaraway@galaxy.sp',
+				'804 Bantha Dr.',
+				'Complex 8',
+				'Mos Eisley',
+				32,
+				'US',
+				'f0r3e',
+				'222-333-4763',
+				false,
+				'999999991',
+			],
+			1 => [
+				'Princess',
+				'Leia',
+				'buns@fcn.al',
+				'1456 Valley Way Boulevard',
+				'Suite 9',
+				'Alderaan',
+				15,
+				'US',
+				'c1h2c',
+				'78-123-111-1111',
+				false,
+				'999999992',
+			],
+			2 => [
+				'Yoda',
+				'I Am',
+				'arrivenot@emailbad.fr',
+				'4th Tree',
+				'5th Knot',
+				'Marsh',
+				22,
+				'US',
+				'l18n',
+				'999-999-9999',
+				false,
+				'999999993',
+			],
+		];
+
+		// let's generate the attendee objects
+		$attendees = [];
+		$var_array = [
+			'fname',
+			'lname',
+			'email',
+			'address',
+			'address2',
+			'city',
+			'staid',
+			'cntry',
+			'zip',
+			'phone',
+			'deleted',
+			'attid',
+		];
+
+		// EE_Registry::instance()->load_class( 'Attendee', array(), FALSE, false, TRUE );
+		foreach ($dummy_attendees as $dummy) {
+			$att = array_combine($var_array, $dummy);
+			extract($att);
+			/** @var $fname string */
+			/** @var $lname string */
+			/** @var $address string */
+			/** @var $address2 string */
+			/** @var $city string */
+			/** @var $staid string */
+			/** @var $cntry string */
+			/** @var $zip string */
+			/** @var $email string */
+			/** @var $phone string */
+			/** @var $attid string */
+			$attendees[ $attid ] = EE_Attendee::new_instance(
+				[
+					'ATT_fname'    => $fname,
+					'ATT_lname'    => $lname,
+					'ATT_address'  => $address,
+					'ATT_address2' => $address2,
+					'ATT_city'     => $city,
+					'STA_ID'       => $staid,
+					'CNT_ISO'      => $cntry,
+					'ATT_zip'      => $zip,
+					'ATT_email'    => $email,
+					'ATT_phone'    => $phone,
+					'ATT_ID'       => $attid,
+				]
+			);
+		}
+
+		return $attendees;
+	}
+
+
+	/**
+	 * Return an array of dummy question objects indexed by answer id and dummy answer objects indexed by answer id.
+	 * This will be used in our dummy data setup
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_some_q_and_as()
+	{
+		$quests_array = [
+			0 => [
+				555,
+				esc_html__('What is your favorite planet?', 'event_espresso'),
+				0,
+			],
+			1 => [
+				556,
+				esc_html__('What is your favorite food?', 'event_espresso'),
+				0,
+			],
+			2 => [
+				557,
+				esc_html__('How many lightyears have you travelled', 'event_espresso'),
+				0,
+			],
+		];
+
+		$ans_array = [
+			0 => [
+				999,
+				555,
+				'Tattoine',
+			],
+			1 => [
+				1000,
+				555,
+				'Alderaan',
+			],
+			2 => [
+				1001,
+				555,
+				'Dantooine',
+			],
+			3 => [
+				1002,
+				556,
+				'Fish Fingers',
+			],
+			4 => [
+				1003,
+				556,
+				'Sushi',
+			],
+			5 => [
+				1004,
+				556,
+				'Water',
+			],
+			6 => [
+				1005,
+				557,
+				'A lot',
+			],
+			7 => [
+				1006,
+				557,
+				"That's none of your business.",
+			],
+			8 => [
+				1007,
+				557,
+				"People less travel me then.",
+			],
+		];
+
+		$qst_columns = ['QST_ID', 'QST_display_text', 'QST_system'];
+		$ans_columns = ['ANS_ID', 'QST_ID', 'ANS_value'];
+
+		// EE_Registry::instance()->load_class( 'Question', array(), FALSE, TRUE, TRUE );
+		// EE_Registry::instance()->load_class( 'Answer', array(), FALSE, TRUE, TRUE );
+
+		$qsts = [];
+		// first the questions
+		foreach ($quests_array as $qst) {
+			$qstobj                    = array_combine($qst_columns, $qst);
+			$qsts[ $qstobj['QST_ID'] ] = EE_Question::new_instance($qstobj);
+		}
+
+		// now the answers (and we'll setup our arrays)
+		$q_n_as = [];
+		foreach ($ans_array as $ans) {
+			$ansobj                               = array_combine($ans_columns, $ans);
+			$ansobj                               = EE_Answer::new_instance($ansobj);
+			$q_n_as['answers'][ $ansobj->ID() ]   = $ansobj;
+			$q_n_as['questions'][ $ansobj->ID() ] = $qsts[ $ansobj->get('QST_ID') ];
+		}
+
+		return $q_n_as;
+	}
+
+
+	/**
+	 * Return an array of event objects from the database
+	 *
+	 * If event ids are not included then we'll just retrieve the first published event from the database.
+	 *
+	 * @param array $event_ids if set, this will be an array of event ids to obtain events for.
+	 *
+	 * @return array    An array of event objects from the db.
+	 * @throws EE_Error
+	 */
+	private function _get_some_events(array $event_ids = [])
+	{
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		// if we have an evt_id then we want to make sure we use that for the preview
+		// (because a specific event template is being viewed);
+		$event_ids = $request->getRequestParam('evt_id', $event_ids, 'int', true);
+		// clear out any invalid IDs, like 0
+		$event_ids = array_filter($event_ids);
+		$limit     = ! empty($event_ids)
+			? null
+			: apply_filters('FHEE__EE_Messages_Preview_incoming_data___get_some_events__limit', '0,1');
+
+		$where = ! empty($event_ids)
+			? [
+				'EVT_ID'                 => ['IN', $event_ids],
+				'Datetime.Ticket.TKT_ID' => ['>', 1],
+			]
+			: ['Datetime.Ticket.TKT_ID' => ['>', 1]];
+
+		return EEM_Event::instance()->get_all([$where, 'limit' => $limit]);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _setup_data()
+	{
+		// need to figure out the running total for test purposes so... we're going to create a temp cart and add the tickets to it!
+		if (EE_Registry::instance()->SSN instanceof EE_Session) {
+			EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+			$session = EE_Registry::instance()->SSN;
+		} else {
+			$session = EE_Registry::instance()->load_core('Session');
+		}
+		$cart = EE_Cart::instance(null, $session);
+
+		// add tickets to cart
+		foreach ($this->tickets as $ticket) {
+			$cart->add_ticket_to_cart($ticket['ticket']);
+		}
+
+		// setup txn property
+		$this->txn = EE_Transaction::new_instance(
+			[
+				'TXN_timestamp'    => time(), // unix timestamp
+				'TXN_total'        => 0, // txn_total
+				'TXN_paid'         => 0, // txn_paid
+				'STS_ID'           => EEM_Transaction::incomplete_status_code, // sts_id
+				'TXN_session_data' => null, // dump of txn session object (we're just going to leave blank here)
+				'TXN_hash_salt'    => null, // hash salt blank as well
+				'TXN_ID'           => 999999,
+			]
+		);
+
+
+		// setup reg_objects
+		// note we're setting up a reg object for each attendee in each event but ALSO adding to the reg_object array.
+		$this->reg_objs = [];
+		$regid          = 9999990;
+		foreach ($this->_attendees as $key => $attendee) {
+			// note we need to setup reg_objects for each event this attendee belongs to
+			$regatt = $attendee['att_obj'] instanceof EE_Attendee ? $attendee['att_obj']->ID() : null;
+			$regtxn = $this->txn->ID();
+			$regcnt = 1;
+			foreach ($attendee['line_ref'] as $evtid) {
+				foreach ($this->_events[ $evtid ]['tkt_objs'] as $ticket) {
+					if (! $ticket instanceof EE_Ticket) {
+						continue;
+					}
+					$reg_array                                            = [
+						'EVT_ID'           => $evtid,
+						'ATT_ID'           => $regatt,
+						'TXN_ID'           => $regtxn,
+						'TKT_ID'           => $ticket->ID(),
+						'STS_ID'           => EEM_Registration::status_id_pending_payment,
+						'REG_date'         => time(),
+						'REG_final_price'  => $ticket->get('TKT_price'),
+						'REG_session'      => 'dummy_session_id',
+						'REG_code'         => $regid . '-dummy-generated-code',
+						'REG_url_link'     => $regcnt . '-daafpapasdlfakasdfpqasdfasdf',
+						'REG_count'        => $regcnt,
+						'REG_group_size'   => $this->_events[ $evtid ]['total_attendees'],
+						'REG_att_is_going' => true,
+						'REG_ID'           => $regid,
+					];
+					$REG_OBJ                                              = EE_Registration::new_instance($reg_array);
+					$this->_attendees[ $key ]['reg_objs'][ $regid ]       = $REG_OBJ;
+					$this->_events[ $evtid ]['reg_objs'][]                = $REG_OBJ;
+					$this->reg_objs[]                                     = $REG_OBJ;
+					$this->tickets[ $ticket->ID() ]['reg_objs'][ $regid ] = $REG_OBJ;
+
+					$regcnt++;
+					$regid++;
+				}
+			}
+		}
+
+
+		// setup line items!
+		$line_item_total = EEH_Line_Item::create_total_line_item($this->txn);
+
+		// add tickets
+		foreach ($this->tickets as $item) {
+			$qty    = $item['count'];
+			$ticket = $item['ticket'];
+			EEH_Line_Item::add_ticket_purchase($line_item_total, $ticket, $qty);
+		}
+
+		$shipping_line_item = EE_Line_Item::new_instance(
+			[
+				'LIN_name'       => esc_html__(
+					'Shipping Surcharge',
+					'event_espresso'
+				),
+				'LIN_desc'       => esc_html__(
+					'Sent via Millenium Falcon',
+					'event_espresso'
+				),
+				'LIN_unit_price' => 20,
+				'LIN_quantity'   => 1,
+				'LIN_is_taxable' => true,
+				'LIN_total'      => 20,
+				'LIN_type'       => EEM_Line_Item::type_line_item,
+			]
+		);
+		EEH_Line_Item::add_item($line_item_total, $shipping_line_item);
+		$this->additional_line_items = [$shipping_line_item];
+
+		// now let's add taxes
+		EEH_Line_Item::apply_taxes($line_item_total);
+
+		// now we should be able to get the items we need from this object
+		$event_line_items = EEH_Line_Item::get_pre_tax_subtotal($line_item_total)->children();
+		$line_items       = [];
+		foreach ($event_line_items as $line_item) {
+			if (! $line_item instanceof EE_Line_Item || $line_item->OBJ_type() !== 'Event') {
+				continue;
+			}
+			$ticket_line_items = EEH_Line_Item::get_ticket_line_items($line_item);
+			foreach ($ticket_line_items as $ticket_line_item) {
+				if (! $ticket_line_item instanceof EE_Line_Item) {
+					continue;
+				}
+				$this->tickets[ $ticket_line_item->OBJ_ID() ]['line_item']      = $ticket_line_item;
+				$this->tickets[ $ticket_line_item->OBJ_ID() ]['sub_line_items'] = $ticket_line_item->children();
+				$line_items[ $ticket_line_item->ID() ]['children']              = $ticket_line_item->children();
+				$line_items[ $ticket_line_item->ID() ]['EE_Ticket']             =
+					$this->tickets[ $ticket_line_item->OBJ_ID() ]['ticket'];
+			}
+		}
+
+		$this->line_items_with_children = $line_items;
+		$this->tax_line_items           = $line_item_total->tax_descendants();
+
+		// add proper total to transaction object.
+		$grand_total                 = $line_item_total->recalculate_total_including_taxes();
+		$this->grand_total_line_item = $line_item_total;
+		$this->txn->set_total($grand_total);
+
+
+		// add additional details for each registration
+		foreach ($this->reg_objs as $reg) {
+			if (! $reg instanceof EE_Registration) {
+				continue;
+			}
+			$this->_registrations[ $reg->ID() ]['tkt_obj']  = $this->tickets[ $reg->get('TKT_ID') ]['ticket'];
+			$this->_registrations[ $reg->ID() ]['evt_obj']  = $this->_events[ $reg->get('EVT_ID') ]['event'];
+			$this->_registrations[ $reg->ID() ]['reg_obj']  = $reg;
+			$this->_registrations[ $reg->ID() ]['ans_objs'] = $this->_attendees[ $reg->get('ATT_ID') ]['ans_objs'];
+			$this->_registrations[ $reg->ID() ]['att_obj']  = $this->_attendees[ $reg->get('ATT_ID') ]['att_obj'];
+			$this->_registrations[ $reg->ID() ]['dtt_objs'] = $this->tickets[ $reg->get('TKT_ID') ]['dtt_objs'];
+		}
+
+
+		// events and attendees
+		$this->events        = $this->_events;
+		$this->attendees     = $this->_attendees;
+		$this->registrations = $this->_registrations;
+
+		$attendees_to_shift = $this->_attendees;
+
+		// setup primary attendee property
+		$this->primary_attendee_data = [
+			'fname' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
+				? $this->_attendees[999999991]['att_obj']->fname()
+				: '',
+
+			'lname' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
+				? $this->_attendees[999999991]['att_obj']->lname()
+				: '',
+
+			'email' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
+				? $this->_attendees[999999991]['att_obj']->email()
+				: '',
+
+			'att_obj' => $this->_attendees[999999991]['att_obj'],
+
+			'reg_obj' => array_shift($attendees_to_shift[999999991]['reg_objs']),
+		];
+
+		// reg_info property
+		// note this isn't referenced by any shortcode parsers so we'll ignore for now.
+		$this->reg_info = [];
+
+		// let's set a reg_obj for messengers expecting one.
+		$this->reg_obj = array_shift($this->_attendees[999999991]['reg_objs']);
+
+		// the below are just dummy items.
+		$this->user_id     = 1;
+		$this->ip_address  = '192.0.2.1';
+		$this->user_agent  = '';
+		$this->init_access = time();
+		$this->last_access = time();
+	}
 }

core/libraries/messages/EE_Messages_Queue.lib.php

Indentation +705 added lines, -705 removed lines

@@ -13,709 +13,709 @@
  */
 class EE_Messages_Queue
 {
-    /**
-     * @type    string  reference for sending action
-     */
-    const action_sending = 'sending';
-
-    /**
-     * @type    string  reference for generation action
-     */
-    const action_generating = 'generation';
-
-
-    /**
-     * @type EE_Message_Repository $_message_repository
-     */
-    protected $_message_repository;
-
-    /**
-     * Sets the limit of how many messages are generated per process.
-     *
-     * @type int
-     */
-    protected $_batch_count;
-
-
-    /**
-     * This is an array of cached queue items being stored in this object.
-     * The array keys will be the ID of the EE_Message in the db if saved.  If the EE_Message
-     * is not saved to the db then its key will be an increment of "UNS" (i.e. UNS1, UNS2 etc.)
-     *
-     * @type EE_Message[]
-     */
-    protected $_cached_queue_items;
-
-    /**
-     * Tracks the number of unsaved queue items.
-     *
-     * @type int
-     */
-    protected $_unsaved_count = 0;
-
-    /**
-     * used to record if a do_messenger_hooks has already been called for a message type.  This prevents multiple
-     * hooks getting fired if users have setup their action/filter hooks to prevent duplicate calls.
-     *
-     * @type array
-     */
-    protected $_did_hook = [];
-
-
-    /**
-     * Constructor.
-     * Setup all the initial properties and load a EE_Message_Repository.
-     *
-     * @param EE_Message_Repository $message_repository
-     */
-    public function __construct(EE_Message_Repository $message_repository)
-    {
-        $this->_batch_count        = apply_filters('FHEE__EE_Messages_Queue___batch_count', 50);
-        $this->_message_repository = $message_repository;
-    }
-
-
-    /**
-     * Add a EE_Message object to the queue
-     *
-     * @param EE_Message $message
-     * @param array      $data         This will be an array of data to attach to the object in the repository.  If the
-     *                                 object is persisted, this data will be saved on an extra_meta object related to
-     *                                 EE_Message.
-     * @param bool       $preview      Whether this EE_Message represents a preview or not.
-     * @param bool       $test_send    This indicates whether to do a test send instead of actual send. A test send will
-     *                                 use the messenger send method but typically is based on preview data.
-     * @return bool          Whether the message was successfully added to the repository or not.
-     */
-    public function add(EE_Message $message, $data = [], $preview = false, $test_send = false)
-    {
-        $data['preview']   = $preview;
-        $data['test_send'] = $test_send;
-        return $this->_message_repository->add($message, $data);
-    }
-
-
-    /**
-     * Removes EE_Message from _queue that matches the given EE_Message if the pointer is on a matching EE_Message
-     *
-     * @param EE_Message $message The message to detach from the queue
-     * @param bool       $persist This flag indicates whether to attempt to delete the object from the db as well.
-     * @return bool
-     */
-    public function remove(EE_Message $message, $persist = false)
-    {
-        if ($persist && $this->_message_repository->current() !== $message) {
-            // get pointer on right message
-            if ($this->_message_repository->has($message)) {
-                $this->_message_repository->rewind();
-                while ($this->_message_repository->valid()) {
-                    if ($this->_message_repository->current() === $message) {
-                        break;
-                    }
-                    $this->_message_repository->next();
-                }
-            } else {
-                return false;
-            }
-        }
-        return $persist ? $this->_message_repository->delete() : $this->_message_repository->remove($message);
-    }
-
-
-    /**
-     * Persists all queued EE_Message objects to the db.
-     *
-     * @param bool $do_hooks_only @see EE_Message_Repository::saveAll
-     * @return array @see EE_Messages_Repository::saveAll() for return values.
-     */
-    public function save($do_hooks_only = false)
-    {
-        return $this->_message_repository->saveAll($do_hooks_only);
-    }
-
-
-    /**
-     * @return EE_Message_Repository
-     */
-    public function get_message_repository()
-    {
-        return $this->_message_repository;
-    }
-
-
-    /**
-     * This does the following things:
-     * 1. Checks if there is a lock on generation (prevents race conditions).  If there is a lock then exits (return
-     * false).
-     * 2. If no lock, sets lock, then retrieves a batch of non-generated EE_Message objects and adds to queue
-     * 3. Returns bool.  True = batch ready.  False = no batch ready (or nothing available for generation).
-     * Note: Callers should make sure they release the lock otherwise batch generation will be prevented from
-     * continuing. The lock is on a transient that is set to expire after one hour as a fallback in case locks are not
-     * removed.
-     *
-     * @return bool  true if successfully retrieved batch, false no batch ready.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_batch_to_generate()
-    {
-        if ($this->is_locked()) {
-            return false;
-        }
-
-        // lock batch generation to prevent race conditions.
-        $this->lock_queue();
-
-        $query_args = [
-            // key 0 = where conditions
-            0          => ['STS_ID' => EEM_Message::status_incomplete],
-            'order_by' => $this->_get_priority_orderby(),
-            'limit'    => $this->_batch_count,
-        ];
-        $messages   = EEM_Message::instance()->get_all($query_args);
-
-        if (! $messages) {
-            return false; // nothing to generate
-        }
-
-        foreach ($messages as $message) {
-            if ($message instanceof EE_Message) {
-                $data = $message->all_extra_meta_array();
-                $this->add($message, $data);
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * This does the following things:
-     * 1. Checks if there is a lock on sending (prevents race conditions).  If there is a lock then exits (return
-     * false).
-     * 2. Grabs the allowed number of messages to send for the rate_limit.  If cannot send any more messages, then
-     * return false.
-     * 2. If no lock, sets lock, then retrieves a batch of EE_Message objects, adds to queue and triggers execution.
-     * 3. On success or unsuccessful send, sets status appropriately.
-     * 4. Saves messages via the queue
-     * 5. Releases lock.
-     *
-     * @return bool  true on success, false if something preventing sending (i.e. lock set).  Note: true does not
-     *               necessarily mean that all messages were successfully sent.  It just means that this method
-     *               successfully completed. On true, client may want to call $this->count_STS_in_queue(
-     *               EEM_Message::status_failed ) to see if any failed EE_Message objects.  Each failed message object
-     *               will also have a saved error message on it to assist with notifying user.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_to_send_batch_and_send()
-    {
-        $rate_limit = $this->get_rate_limit();
-        if (
-            $rate_limit < 1
-            || $this->is_locked(EE_Messages_Queue::action_sending)
-        ) {
-            return false;
-        }
-
-        $this->lock_queue(EE_Messages_Queue::action_sending);
-
-        $batch = $this->_batch_count < $rate_limit ? $this->_batch_count : $rate_limit;
-
-        $query_args = [
-            // key 0 = where conditions
-            0          => ['STS_ID' => ['IN', EEM_Message::instance()->stati_indicating_to_send()]],
-            'order_by' => $this->_get_priority_orderby(),
-            'limit'    => $batch,
-        ];
-
-        $messages_to_send = EEM_Message::instance()->get_all($query_args);
-
-
-        // any to send?
-        if (! $messages_to_send) {
-            $this->unlock_queue(EE_Messages_Queue::action_sending);
-            return false;
-        }
-
-        $queue_count = 0;
-
-        // add to queue.
-        foreach ($messages_to_send as $message) {
-            if ($message instanceof EE_Message) {
-                $queue_count++;
-                $this->add($message);
-            }
-        }
-
-        // send messages  (this also updates the rate limit)
-        $this->execute();
-
-        // release lock
-        $this->unlock_queue(EE_Messages_Queue::action_sending);
-        // update rate limit
-        $this->set_rate_limit($queue_count);
-        return true;
-    }
-
-
-    /**
-     * Locks the queue so that no other queues can call the "batch" methods.
-     *
-     * @param string $type The type of queue being locked.
-     */
-    public function lock_queue($type = EE_Messages_Queue::action_generating)
-    {
-        update_option($this->_get_lock_key($type), $this->_get_lock_expiry($type));
-    }
-
-
-    /**
-     * Unlocks the queue so that batch methods can be used.
-     *
-     * @param string $type The type of queue being unlocked.
-     */
-    public function unlock_queue($type = EE_Messages_Queue::action_generating)
-    {
-        delete_option($this->_get_lock_key($type));
-    }
-
-
-    /**
-     * Retrieve the key used for the lock transient.
-     *
-     * @param string $type The type of lock.
-     * @return string
-     */
-    protected function _get_lock_key($type = EE_Messages_Queue::action_generating)
-    {
-        return '_ee_lock_' . $type;
-    }
-
-
-    /**
-     * Retrieve the expiry time for the lock transient.
-     *
-     * @param string $type The type of lock
-     * @return int   time to expiry in seconds.
-     */
-    protected function _get_lock_expiry($type = EE_Messages_Queue::action_generating)
-    {
-        return time() + (int) apply_filters('FHEE__EE_Messages_Queue__lock_expiry', HOUR_IN_SECONDS, $type);
-    }
-
-
-    /**
-     * Returns the key used for rate limit transient.
-     *
-     * @return string
-     */
-    protected function _get_rate_limit_key()
-    {
-        return '_ee_rate_limit';
-    }
-
-
-    /**
-     * Returns the rate limit expiry time.
-     *
-     * @return int
-     */
-    protected function _get_rate_limit_expiry()
-    {
-        return time() + (int) apply_filters('FHEE__EE_Messages_Queue__rate_limit_expiry', HOUR_IN_SECONDS);
-    }
-
-
-    /**
-     * Returns the default rate limit for sending messages.
-     *
-     * @return int
-     */
-    protected function _default_rate_limit()
-    {
-        return (int) apply_filters('FHEE__EE_Messages_Queue___rate_limit', 200);
-    }
-
-
-    /**
-     * Return the orderby array for priority.
-     *
-     * @return array
-     */
-    protected function _get_priority_orderby()
-    {
-        return [
-            'MSG_priority' => 'ASC',
-            'MSG_modified' => 'DESC',
-        ];
-    }
-
-
-    /**
-     * Returns whether batch methods are "locked" or not, and if models an currently be used to query the database.
-     * Return true when batch methods should not be used; returns false when they can be.
-     *
-     * @param string $type The type of lock being checked for.
-     * @return bool
-     */
-    public function is_locked($type = EE_Messages_Queue::action_generating)
-    {
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
-            return true;
-        }
-        $lock = (int) get_option($this->_get_lock_key($type), 0);
-        /**
-         * This filters the default is_locked behaviour.
-         */
-        $is_locked = filter_var(
-            apply_filters(
-                'FHEE__EE_Messages_Queue__is_locked',
-                $lock > time(),
-                $this
-            ),
-            FILTER_VALIDATE_BOOLEAN
-        );
-
-        /**
-         * @see usage of this filter in EE_Messages_Queue::initiate_request_by_priority() method.
-         *            Also implemented here because messages processed on the same request should not have any locks applied.
-         */
-        if (
-            apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
-            || EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
-        ) {
-            $is_locked = false;
-        }
-
-
-        return $is_locked;
-    }
-
-
-    /**
-     * Retrieves the rate limit that may be cached as a transient.
-     * If the rate limit is not set, then this sets the default rate limit and expiry and returns it.
-     *
-     * @param bool $return_expiry If true then return the expiry time not the rate_limit.
-     * @return int
-     */
-    protected function get_rate_limit($return_expiry = false)
-    {
-        $stored_rate_info = get_option($this->_get_rate_limit_key(), []);
-        $rate_limit       = isset($stored_rate_info[0])
-            ? (int) $stored_rate_info[0]
-            : 0;
-        $expiry           = isset($stored_rate_info[1])
-            ? (int) $stored_rate_info[1]
-            : 0;
-        // set the default for tracking?
-        if (empty($stored_rate_info) || time() > $expiry) {
-            $expiry     = $this->_get_rate_limit_expiry();
-            $rate_limit = $this->_default_rate_limit();
-            update_option($this->_get_rate_limit_key(), [$rate_limit, $expiry]);
-        }
-        return $return_expiry ? $expiry : $rate_limit;
-    }
-
-
-    /**
-     * This updates existing rate limit with the new limit which is the old minus the batch.
-     *
-     * @param int $batch_completed This sets the new rate limit based on the given batch that was completed.
-     */
-    protected function set_rate_limit($batch_completed)
-    {
-        // first get the most up to date rate limit (in case its expired and reset)
-        $rate_limit = $this->get_rate_limit();
-        $expiry     = $this->get_rate_limit(true);
-        $new_limit  = $rate_limit - $batch_completed;
-        // updating the transient option directly to avoid resetting the expiry.
-
-        update_option($this->_get_rate_limit_key(), [$new_limit, $expiry]);
-    }
-
-
-    /**
-     * This method checks the queue for ANY EE_Message objects with a priority matching the given priority passed in.
-     * If that exists, then we immediately initiate a non-blocking request to do the requested action type.
-     * Note: Keep in mind that there is the possibility that the request will not execute if there is already another
-     * request running on a queue for the given task.
-     *
-     * @param string $task     This indicates what type of request is going to be initiated.
-     * @param int    $priority This indicates the priority that triggers initiating the request.
-     * @return bool|EE_Messages_Queue|void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function initiate_request_by_priority($task = 'generate', $priority = EEM_Message::priority_high)
-    {
-        // determine what status is matched with the priority as part of the trigger conditions.
-        $status = $task == 'generate'
-            ? EEM_Message::status_incomplete
-            : EEM_Message::instance()->stati_indicating_to_send();
-        // always make sure we save because either this will get executed immediately on a separate request
-        // or remains in the queue for the regularly scheduled queue batch.
-        $this->save();
-        /**
-         * This filter/option allows users to override processing of messages on separate requests and instead have everything
-         * happen on the same request.  If this is utilized remember:
-         * - message priorities don't matter
-         * - existing unprocessed messages in the queue will not get processed unless manually triggered.
-         * - things will be perceived to take longer to happen for end users (i.e. registrations) because of the additional
-         *   processing happening on the same request.
-         * - any race condition protection (locks) are removed because they don't apply when things are processed on
-         *   the same request.
-         */
-        if (
-            apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
-            || EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
-        ) {
-            $messages_processor = EE_Registry::instance()->load_lib('Messages_Processor');
-            if ($messages_processor instanceof EE_Messages_Processor) {
-                return $messages_processor->process_immediately_from_queue($this);
-            }
-            // if we get here then that means the messages processor couldn't be loaded so messages will just remain
-            // queued for manual triggering by end user.
-        }
-
-        if ($this->_message_repository->count_by_priority_and_status($priority, $status)) {
-            EE_Messages_Scheduler::initiate_scheduled_non_blocking_request($task);
-        }
-    }
-
-
-    /**
-     *  Loops through the EE_Message objects in the _queue and calls the messenger send methods for each message.
-     *
-     * @param bool     $save                      Used to indicate whether to save the message queue after sending
-     *                                            (default will save).
-     * @param mixed    $sending_messenger         (optional) When the sending messenger is different than
-     *                                            what is on the EE_Message object in the queue.
-     *                                            For instance, showing the browser view of an email message,
-     *                                            or giving a pdf generated view of an html document.
-     *                                            This should be an instance of EE_messenger but if you call this
-     *                                            method
-     *                                            intending it to be a sending messenger but a valid one could not be
-     *                                            retrieved then send in an instance of EE_Error that contains the
-     *                                            related error message.
-     * @param bool|int $by_priority               When set, this indicates that only messages
-     *                                            matching the given priority should be executed.
-     * @return int        Number of messages sent.  Note, 0 does not mean that no messages were processed.
-     *                                            Also, if the messenger is an request type messenger (or a preview),
-     *                                            its entirely possible that the messenger will exit before
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function execute($save = true, $sending_messenger = null, $by_priority = false)
-    {
-        $messages_sent   = 0;
-        $this->_did_hook = [];
-        $this->_message_repository->rewind();
-
-        while ($this->_message_repository->valid()) {
-            $error_messages = [];
-            $message        = $this->_message_repository->current();
-
-            // only process things that are queued for sending
-            if (! in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_to_send())) {
-                $this->_message_repository->next();
-                continue;
-            }
-            // if $by_priority is set and does not match then continue;
-            if ($by_priority && $by_priority != $message->priority()) {
-                $this->_message_repository->next();
-                continue;
-            }
-            // error checking
-            if (! $message->valid_messenger()) {
-                $error_messages[] = sprintf(
-                    esc_html__('The %s messenger is not active at time of sending.', 'event_espresso'),
-                    $message->messenger()
-                );
-            }
-            if (! $message->valid_message_type()) {
-                $error_messages[] = sprintf(
-                    esc_html__('The %s message type is not active at the time of sending.', 'event_espresso'),
-                    $message->message_type()
-                );
-            }
-            // if there was supposed to be a sending messenger for this message, but it was invalid/inactive,
-            // then it will instead be an EE_Error object, so let's check for that
-            if ($sending_messenger instanceof EE_Error) {
-                $error_messages[] = $sending_messenger->getMessage();
-            }
-            // if there are no errors, then let's process the message
-            if (empty($error_messages)) {
-                if ($save) {
-                    $message->set_messenger_is_executing();
-                }
-                if ($this->_process_message($message, $sending_messenger)) {
-                    $messages_sent++;
-                }
-            }
-            $this->_set_error_message($message, $error_messages);
-            // add modified time
-            $message->set_modified(time());
-            // we save each message after its processed to make sure its status persists in case PHP times-out or runs
-            // out of memory. @see https://events.codebasehq.com/projects/event-espresso/tickets/10281
-            if ($save) {
-                $message->save();
-            }
-
-            $this->_message_repository->next();
-        }
-        if ($save) {
-            $this->save(true);
-        }
-        return $messages_sent;
-    }
-
-
-    /**
-     * _process_message
-     *
-     * @param EE_Message $message
-     * @param mixed      $sending_messenger (optional)
-     * @return bool
-     */
-    protected function _process_message(EE_Message $message, $sending_messenger = null)
-    {
-        // these *should* have been validated in the execute() method above
-        $messenger    = $message->messenger_object();
-        $message_type = $message->message_type_object();
-        // do actions for sending messenger if it differs from generating messenger and swap values.
-        if (
-            $sending_messenger instanceof EE_messenger
-            && $messenger instanceof EE_messenger
-            && $sending_messenger->name != $messenger->name
-        ) {
-            $messenger->do_secondary_messenger_hooks($sending_messenger->name);
-            $messenger = $sending_messenger;
-        }
-        // send using messenger, but double check objects
-        if ($messenger instanceof EE_messenger && $message_type instanceof EE_message_type) {
-            // set hook for message type (but only if not using another messenger to send).
-            if (! isset($this->_did_hook[ $message_type->name ])) {
-                $message_type->do_messenger_hooks($messenger);
-                $this->_did_hook[ $message_type->name ] = 1;
-            }
-            // if preview then use preview method
-            return $this->_message_repository->is_preview()
-                ? $this->_do_preview($message, $messenger, $message_type, $this->_message_repository->is_test_send())
-                : $this->_do_send($message, $messenger, $message_type);
-        }
-        return false;
-    }
-
-
-    /**
-     * The intention of this method is to count how many EE_Message objects
-     * are in the queue with a given status.
-     * Example usage:
-     * After a caller calls the "EE_Message_Queue::execute()" method, the caller can check if there were any failed
-     * sends by calling $queue->count_STS_in_queue( EEM_Message_Queue::status_failed ).
-     *
-     * @param array|string $status Stati to check for in queue
-     * @return int  Count of EE_Message's matching the given status.
-     */
-    public function count_STS_in_queue($status)
-    {
-        $count  = 0;
-        $status = is_array($status) ? $status : [$status];
-        $this->_message_repository->rewind();
-        foreach ($this->_message_repository as $message) {
-            if (in_array($message->STS_ID(), $status)) {
-                $count++;
-            }
-        }
-        return $count;
-    }
-
-
-    /**
-     * Executes the get_preview method on the provided messenger.
-     *
-     * @param EE_Message      $message
-     * @param EE_messenger    $messenger
-     * @param EE_message_type $message_type
-     * @param                 $test_send
-     * @return bool   true means all went well, false means, not so much.
-     */
-    protected function _do_preview(
-        EE_Message $message,
-        EE_messenger $messenger,
-        EE_message_type $message_type,
-        $test_send
-    ) {
-        if ($preview = $messenger->get_preview($message, $message_type, $test_send)) {
-            if (! $test_send) {
-                $message->set_content($preview);
-            }
-            $message->set_STS_ID(EEM_Message::status_sent);
-            return true;
-        } else {
-            $message->set_STS_ID(EEM_Message::status_failed);
-            return false;
-        }
-    }
-
-
-    /**
-     * Executes the send method on the provided messenger
-     * EE_Messengers are expected to:
-     * - return true if the send was successful.
-     * - return false if the send was unsuccessful but can be tried again.
-     * - throw an Exception if the send was unsuccessful and cannot be tried again.
-     *
-     * @param EE_Message      $message
-     * @param EE_messenger    $messenger
-     * @param EE_message_type $message_type
-     * @return bool true means all went well, false means, not so much.
-     */
-    protected function _do_send(EE_Message $message, EE_messenger $messenger, EE_message_type $message_type)
-    {
-        try {
-            if ($messenger->send_message($message, $message_type)) {
-                $message->set_STS_ID(EEM_Message::status_sent);
-                return true;
-            } else {
-                $message->set_STS_ID(EEM_Message::status_retry);
-                return false;
-            }
-        } catch (SendMessageException $e) {
-            $message->set_STS_ID(EEM_Message::status_failed);
-            $message->set_error_message($e->getMessage());
-            return false;
-        }
-    }
-
-
-    /**
-     * This sets any necessary error messages on the message object and its status to failed.
-     *
-     * @param EE_Message $message
-     * @param array      $error_messages the response from the messenger.
-     * @throws EE_Error
-     */
-    protected function _set_error_message(EE_Message $message, $error_messages)
-    {
-        $error_messages = (array) $error_messages;
-        if (in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_failed_sending())) {
-            $notices          = EE_Error::has_notices();
-            $error_messages[] = esc_html__(
-                'Messenger and Message Type were valid and active, but the messenger send method failed.',
-                'event_espresso'
-            );
-            if ($notices === 1) {
-                $notices           = EE_Error::get_vanilla_notices();
-                $notices['errors'] = isset($notices['errors']) ? $notices['errors'] : [];
-                $error_messages[]  = implode("\n", $notices['errors']);
-            }
-        }
-        if (count($error_messages) > 0) {
-            $msg = esc_html__('Message was not executed successfully.', 'event_espresso');
-            $msg = $msg . "\n" . implode("\n", $error_messages);
-            $message->set_error_message($msg);
-        }
-    }
+	/**
+	 * @type    string  reference for sending action
+	 */
+	const action_sending = 'sending';
+
+	/**
+	 * @type    string  reference for generation action
+	 */
+	const action_generating = 'generation';
+
+
+	/**
+	 * @type EE_Message_Repository $_message_repository
+	 */
+	protected $_message_repository;
+
+	/**
+	 * Sets the limit of how many messages are generated per process.
+	 *
+	 * @type int
+	 */
+	protected $_batch_count;
+
+
+	/**
+	 * This is an array of cached queue items being stored in this object.
+	 * The array keys will be the ID of the EE_Message in the db if saved.  If the EE_Message
+	 * is not saved to the db then its key will be an increment of "UNS" (i.e. UNS1, UNS2 etc.)
+	 *
+	 * @type EE_Message[]
+	 */
+	protected $_cached_queue_items;
+
+	/**
+	 * Tracks the number of unsaved queue items.
+	 *
+	 * @type int
+	 */
+	protected $_unsaved_count = 0;
+
+	/**
+	 * used to record if a do_messenger_hooks has already been called for a message type.  This prevents multiple
+	 * hooks getting fired if users have setup their action/filter hooks to prevent duplicate calls.
+	 *
+	 * @type array
+	 */
+	protected $_did_hook = [];
+
+
+	/**
+	 * Constructor.
+	 * Setup all the initial properties and load a EE_Message_Repository.
+	 *
+	 * @param EE_Message_Repository $message_repository
+	 */
+	public function __construct(EE_Message_Repository $message_repository)
+	{
+		$this->_batch_count        = apply_filters('FHEE__EE_Messages_Queue___batch_count', 50);
+		$this->_message_repository = $message_repository;
+	}
+
+
+	/**
+	 * Add a EE_Message object to the queue
+	 *
+	 * @param EE_Message $message
+	 * @param array      $data         This will be an array of data to attach to the object in the repository.  If the
+	 *                                 object is persisted, this data will be saved on an extra_meta object related to
+	 *                                 EE_Message.
+	 * @param bool       $preview      Whether this EE_Message represents a preview or not.
+	 * @param bool       $test_send    This indicates whether to do a test send instead of actual send. A test send will
+	 *                                 use the messenger send method but typically is based on preview data.
+	 * @return bool          Whether the message was successfully added to the repository or not.
+	 */
+	public function add(EE_Message $message, $data = [], $preview = false, $test_send = false)
+	{
+		$data['preview']   = $preview;
+		$data['test_send'] = $test_send;
+		return $this->_message_repository->add($message, $data);
+	}
+
+
+	/**
+	 * Removes EE_Message from _queue that matches the given EE_Message if the pointer is on a matching EE_Message
+	 *
+	 * @param EE_Message $message The message to detach from the queue
+	 * @param bool       $persist This flag indicates whether to attempt to delete the object from the db as well.
+	 * @return bool
+	 */
+	public function remove(EE_Message $message, $persist = false)
+	{
+		if ($persist && $this->_message_repository->current() !== $message) {
+			// get pointer on right message
+			if ($this->_message_repository->has($message)) {
+				$this->_message_repository->rewind();
+				while ($this->_message_repository->valid()) {
+					if ($this->_message_repository->current() === $message) {
+						break;
+					}
+					$this->_message_repository->next();
+				}
+			} else {
+				return false;
+			}
+		}
+		return $persist ? $this->_message_repository->delete() : $this->_message_repository->remove($message);
+	}
+
+
+	/**
+	 * Persists all queued EE_Message objects to the db.
+	 *
+	 * @param bool $do_hooks_only @see EE_Message_Repository::saveAll
+	 * @return array @see EE_Messages_Repository::saveAll() for return values.
+	 */
+	public function save($do_hooks_only = false)
+	{
+		return $this->_message_repository->saveAll($do_hooks_only);
+	}
+
+
+	/**
+	 * @return EE_Message_Repository
+	 */
+	public function get_message_repository()
+	{
+		return $this->_message_repository;
+	}
+
+
+	/**
+	 * This does the following things:
+	 * 1. Checks if there is a lock on generation (prevents race conditions).  If there is a lock then exits (return
+	 * false).
+	 * 2. If no lock, sets lock, then retrieves a batch of non-generated EE_Message objects and adds to queue
+	 * 3. Returns bool.  True = batch ready.  False = no batch ready (or nothing available for generation).
+	 * Note: Callers should make sure they release the lock otherwise batch generation will be prevented from
+	 * continuing. The lock is on a transient that is set to expire after one hour as a fallback in case locks are not
+	 * removed.
+	 *
+	 * @return bool  true if successfully retrieved batch, false no batch ready.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_batch_to_generate()
+	{
+		if ($this->is_locked()) {
+			return false;
+		}
+
+		// lock batch generation to prevent race conditions.
+		$this->lock_queue();
+
+		$query_args = [
+			// key 0 = where conditions
+			0          => ['STS_ID' => EEM_Message::status_incomplete],
+			'order_by' => $this->_get_priority_orderby(),
+			'limit'    => $this->_batch_count,
+		];
+		$messages   = EEM_Message::instance()->get_all($query_args);
+
+		if (! $messages) {
+			return false; // nothing to generate
+		}
+
+		foreach ($messages as $message) {
+			if ($message instanceof EE_Message) {
+				$data = $message->all_extra_meta_array();
+				$this->add($message, $data);
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * This does the following things:
+	 * 1. Checks if there is a lock on sending (prevents race conditions).  If there is a lock then exits (return
+	 * false).
+	 * 2. Grabs the allowed number of messages to send for the rate_limit.  If cannot send any more messages, then
+	 * return false.
+	 * 2. If no lock, sets lock, then retrieves a batch of EE_Message objects, adds to queue and triggers execution.
+	 * 3. On success or unsuccessful send, sets status appropriately.
+	 * 4. Saves messages via the queue
+	 * 5. Releases lock.
+	 *
+	 * @return bool  true on success, false if something preventing sending (i.e. lock set).  Note: true does not
+	 *               necessarily mean that all messages were successfully sent.  It just means that this method
+	 *               successfully completed. On true, client may want to call $this->count_STS_in_queue(
+	 *               EEM_Message::status_failed ) to see if any failed EE_Message objects.  Each failed message object
+	 *               will also have a saved error message on it to assist with notifying user.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_to_send_batch_and_send()
+	{
+		$rate_limit = $this->get_rate_limit();
+		if (
+			$rate_limit < 1
+			|| $this->is_locked(EE_Messages_Queue::action_sending)
+		) {
+			return false;
+		}
+
+		$this->lock_queue(EE_Messages_Queue::action_sending);
+
+		$batch = $this->_batch_count < $rate_limit ? $this->_batch_count : $rate_limit;
+
+		$query_args = [
+			// key 0 = where conditions
+			0          => ['STS_ID' => ['IN', EEM_Message::instance()->stati_indicating_to_send()]],
+			'order_by' => $this->_get_priority_orderby(),
+			'limit'    => $batch,
+		];
+
+		$messages_to_send = EEM_Message::instance()->get_all($query_args);
+
+
+		// any to send?
+		if (! $messages_to_send) {
+			$this->unlock_queue(EE_Messages_Queue::action_sending);
+			return false;
+		}
+
+		$queue_count = 0;
+
+		// add to queue.
+		foreach ($messages_to_send as $message) {
+			if ($message instanceof EE_Message) {
+				$queue_count++;
+				$this->add($message);
+			}
+		}
+
+		// send messages  (this also updates the rate limit)
+		$this->execute();
+
+		// release lock
+		$this->unlock_queue(EE_Messages_Queue::action_sending);
+		// update rate limit
+		$this->set_rate_limit($queue_count);
+		return true;
+	}
+
+
+	/**
+	 * Locks the queue so that no other queues can call the "batch" methods.
+	 *
+	 * @param string $type The type of queue being locked.
+	 */
+	public function lock_queue($type = EE_Messages_Queue::action_generating)
+	{
+		update_option($this->_get_lock_key($type), $this->_get_lock_expiry($type));
+	}
+
+
+	/**
+	 * Unlocks the queue so that batch methods can be used.
+	 *
+	 * @param string $type The type of queue being unlocked.
+	 */
+	public function unlock_queue($type = EE_Messages_Queue::action_generating)
+	{
+		delete_option($this->_get_lock_key($type));
+	}
+
+
+	/**
+	 * Retrieve the key used for the lock transient.
+	 *
+	 * @param string $type The type of lock.
+	 * @return string
+	 */
+	protected function _get_lock_key($type = EE_Messages_Queue::action_generating)
+	{
+		return '_ee_lock_' . $type;
+	}
+
+
+	/**
+	 * Retrieve the expiry time for the lock transient.
+	 *
+	 * @param string $type The type of lock
+	 * @return int   time to expiry in seconds.
+	 */
+	protected function _get_lock_expiry($type = EE_Messages_Queue::action_generating)
+	{
+		return time() + (int) apply_filters('FHEE__EE_Messages_Queue__lock_expiry', HOUR_IN_SECONDS, $type);
+	}
+
+
+	/**
+	 * Returns the key used for rate limit transient.
+	 *
+	 * @return string
+	 */
+	protected function _get_rate_limit_key()
+	{
+		return '_ee_rate_limit';
+	}
+
+
+	/**
+	 * Returns the rate limit expiry time.
+	 *
+	 * @return int
+	 */
+	protected function _get_rate_limit_expiry()
+	{
+		return time() + (int) apply_filters('FHEE__EE_Messages_Queue__rate_limit_expiry', HOUR_IN_SECONDS);
+	}
+
+
+	/**
+	 * Returns the default rate limit for sending messages.
+	 *
+	 * @return int
+	 */
+	protected function _default_rate_limit()
+	{
+		return (int) apply_filters('FHEE__EE_Messages_Queue___rate_limit', 200);
+	}
+
+
+	/**
+	 * Return the orderby array for priority.
+	 *
+	 * @return array
+	 */
+	protected function _get_priority_orderby()
+	{
+		return [
+			'MSG_priority' => 'ASC',
+			'MSG_modified' => 'DESC',
+		];
+	}
+
+
+	/**
+	 * Returns whether batch methods are "locked" or not, and if models an currently be used to query the database.
+	 * Return true when batch methods should not be used; returns false when they can be.
+	 *
+	 * @param string $type The type of lock being checked for.
+	 * @return bool
+	 */
+	public function is_locked($type = EE_Messages_Queue::action_generating)
+	{
+		if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+			return true;
+		}
+		$lock = (int) get_option($this->_get_lock_key($type), 0);
+		/**
+		 * This filters the default is_locked behaviour.
+		 */
+		$is_locked = filter_var(
+			apply_filters(
+				'FHEE__EE_Messages_Queue__is_locked',
+				$lock > time(),
+				$this
+			),
+			FILTER_VALIDATE_BOOLEAN
+		);
+
+		/**
+		 * @see usage of this filter in EE_Messages_Queue::initiate_request_by_priority() method.
+		 *            Also implemented here because messages processed on the same request should not have any locks applied.
+		 */
+		if (
+			apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
+			|| EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
+		) {
+			$is_locked = false;
+		}
+
+
+		return $is_locked;
+	}
+
+
+	/**
+	 * Retrieves the rate limit that may be cached as a transient.
+	 * If the rate limit is not set, then this sets the default rate limit and expiry and returns it.
+	 *
+	 * @param bool $return_expiry If true then return the expiry time not the rate_limit.
+	 * @return int
+	 */
+	protected function get_rate_limit($return_expiry = false)
+	{
+		$stored_rate_info = get_option($this->_get_rate_limit_key(), []);
+		$rate_limit       = isset($stored_rate_info[0])
+			? (int) $stored_rate_info[0]
+			: 0;
+		$expiry           = isset($stored_rate_info[1])
+			? (int) $stored_rate_info[1]
+			: 0;
+		// set the default for tracking?
+		if (empty($stored_rate_info) || time() > $expiry) {
+			$expiry     = $this->_get_rate_limit_expiry();
+			$rate_limit = $this->_default_rate_limit();
+			update_option($this->_get_rate_limit_key(), [$rate_limit, $expiry]);
+		}
+		return $return_expiry ? $expiry : $rate_limit;
+	}
+
+
+	/**
+	 * This updates existing rate limit with the new limit which is the old minus the batch.
+	 *
+	 * @param int $batch_completed This sets the new rate limit based on the given batch that was completed.
+	 */
+	protected function set_rate_limit($batch_completed)
+	{
+		// first get the most up to date rate limit (in case its expired and reset)
+		$rate_limit = $this->get_rate_limit();
+		$expiry     = $this->get_rate_limit(true);
+		$new_limit  = $rate_limit - $batch_completed;
+		// updating the transient option directly to avoid resetting the expiry.
+
+		update_option($this->_get_rate_limit_key(), [$new_limit, $expiry]);
+	}
+
+
+	/**
+	 * This method checks the queue for ANY EE_Message objects with a priority matching the given priority passed in.
+	 * If that exists, then we immediately initiate a non-blocking request to do the requested action type.
+	 * Note: Keep in mind that there is the possibility that the request will not execute if there is already another
+	 * request running on a queue for the given task.
+	 *
+	 * @param string $task     This indicates what type of request is going to be initiated.
+	 * @param int    $priority This indicates the priority that triggers initiating the request.
+	 * @return bool|EE_Messages_Queue|void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function initiate_request_by_priority($task = 'generate', $priority = EEM_Message::priority_high)
+	{
+		// determine what status is matched with the priority as part of the trigger conditions.
+		$status = $task == 'generate'
+			? EEM_Message::status_incomplete
+			: EEM_Message::instance()->stati_indicating_to_send();
+		// always make sure we save because either this will get executed immediately on a separate request
+		// or remains in the queue for the regularly scheduled queue batch.
+		$this->save();
+		/**
+		 * This filter/option allows users to override processing of messages on separate requests and instead have everything
+		 * happen on the same request.  If this is utilized remember:
+		 * - message priorities don't matter
+		 * - existing unprocessed messages in the queue will not get processed unless manually triggered.
+		 * - things will be perceived to take longer to happen for end users (i.e. registrations) because of the additional
+		 *   processing happening on the same request.
+		 * - any race condition protection (locks) are removed because they don't apply when things are processed on
+		 *   the same request.
+		 */
+		if (
+			apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
+			|| EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
+		) {
+			$messages_processor = EE_Registry::instance()->load_lib('Messages_Processor');
+			if ($messages_processor instanceof EE_Messages_Processor) {
+				return $messages_processor->process_immediately_from_queue($this);
+			}
+			// if we get here then that means the messages processor couldn't be loaded so messages will just remain
+			// queued for manual triggering by end user.
+		}
+
+		if ($this->_message_repository->count_by_priority_and_status($priority, $status)) {
+			EE_Messages_Scheduler::initiate_scheduled_non_blocking_request($task);
+		}
+	}
+
+
+	/**
+	 *  Loops through the EE_Message objects in the _queue and calls the messenger send methods for each message.
+	 *
+	 * @param bool     $save                      Used to indicate whether to save the message queue after sending
+	 *                                            (default will save).
+	 * @param mixed    $sending_messenger         (optional) When the sending messenger is different than
+	 *                                            what is on the EE_Message object in the queue.
+	 *                                            For instance, showing the browser view of an email message,
+	 *                                            or giving a pdf generated view of an html document.
+	 *                                            This should be an instance of EE_messenger but if you call this
+	 *                                            method
+	 *                                            intending it to be a sending messenger but a valid one could not be
+	 *                                            retrieved then send in an instance of EE_Error that contains the
+	 *                                            related error message.
+	 * @param bool|int $by_priority               When set, this indicates that only messages
+	 *                                            matching the given priority should be executed.
+	 * @return int        Number of messages sent.  Note, 0 does not mean that no messages were processed.
+	 *                                            Also, if the messenger is an request type messenger (or a preview),
+	 *                                            its entirely possible that the messenger will exit before
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function execute($save = true, $sending_messenger = null, $by_priority = false)
+	{
+		$messages_sent   = 0;
+		$this->_did_hook = [];
+		$this->_message_repository->rewind();
+
+		while ($this->_message_repository->valid()) {
+			$error_messages = [];
+			$message        = $this->_message_repository->current();
+
+			// only process things that are queued for sending
+			if (! in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_to_send())) {
+				$this->_message_repository->next();
+				continue;
+			}
+			// if $by_priority is set and does not match then continue;
+			if ($by_priority && $by_priority != $message->priority()) {
+				$this->_message_repository->next();
+				continue;
+			}
+			// error checking
+			if (! $message->valid_messenger()) {
+				$error_messages[] = sprintf(
+					esc_html__('The %s messenger is not active at time of sending.', 'event_espresso'),
+					$message->messenger()
+				);
+			}
+			if (! $message->valid_message_type()) {
+				$error_messages[] = sprintf(
+					esc_html__('The %s message type is not active at the time of sending.', 'event_espresso'),
+					$message->message_type()
+				);
+			}
+			// if there was supposed to be a sending messenger for this message, but it was invalid/inactive,
+			// then it will instead be an EE_Error object, so let's check for that
+			if ($sending_messenger instanceof EE_Error) {
+				$error_messages[] = $sending_messenger->getMessage();
+			}
+			// if there are no errors, then let's process the message
+			if (empty($error_messages)) {
+				if ($save) {
+					$message->set_messenger_is_executing();
+				}
+				if ($this->_process_message($message, $sending_messenger)) {
+					$messages_sent++;
+				}
+			}
+			$this->_set_error_message($message, $error_messages);
+			// add modified time
+			$message->set_modified(time());
+			// we save each message after its processed to make sure its status persists in case PHP times-out or runs
+			// out of memory. @see https://events.codebasehq.com/projects/event-espresso/tickets/10281
+			if ($save) {
+				$message->save();
+			}
+
+			$this->_message_repository->next();
+		}
+		if ($save) {
+			$this->save(true);
+		}
+		return $messages_sent;
+	}
+
+
+	/**
+	 * _process_message
+	 *
+	 * @param EE_Message $message
+	 * @param mixed      $sending_messenger (optional)
+	 * @return bool
+	 */
+	protected function _process_message(EE_Message $message, $sending_messenger = null)
+	{
+		// these *should* have been validated in the execute() method above
+		$messenger    = $message->messenger_object();
+		$message_type = $message->message_type_object();
+		// do actions for sending messenger if it differs from generating messenger and swap values.
+		if (
+			$sending_messenger instanceof EE_messenger
+			&& $messenger instanceof EE_messenger
+			&& $sending_messenger->name != $messenger->name
+		) {
+			$messenger->do_secondary_messenger_hooks($sending_messenger->name);
+			$messenger = $sending_messenger;
+		}
+		// send using messenger, but double check objects
+		if ($messenger instanceof EE_messenger && $message_type instanceof EE_message_type) {
+			// set hook for message type (but only if not using another messenger to send).
+			if (! isset($this->_did_hook[ $message_type->name ])) {
+				$message_type->do_messenger_hooks($messenger);
+				$this->_did_hook[ $message_type->name ] = 1;
+			}
+			// if preview then use preview method
+			return $this->_message_repository->is_preview()
+				? $this->_do_preview($message, $messenger, $message_type, $this->_message_repository->is_test_send())
+				: $this->_do_send($message, $messenger, $message_type);
+		}
+		return false;
+	}
+
+
+	/**
+	 * The intention of this method is to count how many EE_Message objects
+	 * are in the queue with a given status.
+	 * Example usage:
+	 * After a caller calls the "EE_Message_Queue::execute()" method, the caller can check if there were any failed
+	 * sends by calling $queue->count_STS_in_queue( EEM_Message_Queue::status_failed ).
+	 *
+	 * @param array|string $status Stati to check for in queue
+	 * @return int  Count of EE_Message's matching the given status.
+	 */
+	public function count_STS_in_queue($status)
+	{
+		$count  = 0;
+		$status = is_array($status) ? $status : [$status];
+		$this->_message_repository->rewind();
+		foreach ($this->_message_repository as $message) {
+			if (in_array($message->STS_ID(), $status)) {
+				$count++;
+			}
+		}
+		return $count;
+	}
+
+
+	/**
+	 * Executes the get_preview method on the provided messenger.
+	 *
+	 * @param EE_Message      $message
+	 * @param EE_messenger    $messenger
+	 * @param EE_message_type $message_type
+	 * @param                 $test_send
+	 * @return bool   true means all went well, false means, not so much.
+	 */
+	protected function _do_preview(
+		EE_Message $message,
+		EE_messenger $messenger,
+		EE_message_type $message_type,
+		$test_send
+	) {
+		if ($preview = $messenger->get_preview($message, $message_type, $test_send)) {
+			if (! $test_send) {
+				$message->set_content($preview);
+			}
+			$message->set_STS_ID(EEM_Message::status_sent);
+			return true;
+		} else {
+			$message->set_STS_ID(EEM_Message::status_failed);
+			return false;
+		}
+	}
+
+
+	/**
+	 * Executes the send method on the provided messenger
+	 * EE_Messengers are expected to:
+	 * - return true if the send was successful.
+	 * - return false if the send was unsuccessful but can be tried again.
+	 * - throw an Exception if the send was unsuccessful and cannot be tried again.
+	 *
+	 * @param EE_Message      $message
+	 * @param EE_messenger    $messenger
+	 * @param EE_message_type $message_type
+	 * @return bool true means all went well, false means, not so much.
+	 */
+	protected function _do_send(EE_Message $message, EE_messenger $messenger, EE_message_type $message_type)
+	{
+		try {
+			if ($messenger->send_message($message, $message_type)) {
+				$message->set_STS_ID(EEM_Message::status_sent);
+				return true;
+			} else {
+				$message->set_STS_ID(EEM_Message::status_retry);
+				return false;
+			}
+		} catch (SendMessageException $e) {
+			$message->set_STS_ID(EEM_Message::status_failed);
+			$message->set_error_message($e->getMessage());
+			return false;
+		}
+	}
+
+
+	/**
+	 * This sets any necessary error messages on the message object and its status to failed.
+	 *
+	 * @param EE_Message $message
+	 * @param array      $error_messages the response from the messenger.
+	 * @throws EE_Error
+	 */
+	protected function _set_error_message(EE_Message $message, $error_messages)
+	{
+		$error_messages = (array) $error_messages;
+		if (in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_failed_sending())) {
+			$notices          = EE_Error::has_notices();
+			$error_messages[] = esc_html__(
+				'Messenger and Message Type were valid and active, but the messenger send method failed.',
+				'event_espresso'
+			);
+			if ($notices === 1) {
+				$notices           = EE_Error::get_vanilla_notices();
+				$notices['errors'] = isset($notices['errors']) ? $notices['errors'] : [];
+				$error_messages[]  = implode("\n", $notices['errors']);
+			}
+		}
+		if (count($error_messages) > 0) {
+			$msg = esc_html__('Message was not executed successfully.', 'event_espresso');
+			$msg = $msg . "\n" . implode("\n", $error_messages);
+			$message->set_error_message($msg);
+		}
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -172,9 +172,9 @@ 
             'order_by' => $this->_get_priority_orderby(),
             'limit'    => $this->_batch_count,
         ];
-        $messages   = EEM_Message::instance()->get_all($query_args);
+        $messages = EEM_Message::instance()->get_all($query_args);
 
-        if (! $messages) {
+        if ( ! $messages) {
             return false; // nothing to generate
         }
 
@@ -232,7 +232,7 @@ 
 
 
         // any to send?
-        if (! $messages_to_send) {
+        if ( ! $messages_to_send) {
             $this->unlock_queue(EE_Messages_Queue::action_sending);
             return false;
         }
@@ -288,7 +288,7 @@ 
      */
     protected function _get_lock_key($type = EE_Messages_Queue::action_generating)
     {
-        return '_ee_lock_' . $type;
+        return '_ee_lock_'.$type;
     }
 
 
@@ -360,7 +360,7 @@ 
      */
     public function is_locked($type = EE_Messages_Queue::action_generating)
     {
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+        if ( ! EE_Maintenance_Mode::instance()->models_can_query()) {
             return true;
         }
         $lock = (int) get_option($this->_get_lock_key($type), 0);
@@ -517,7 +517,7 @@ 
             $message        = $this->_message_repository->current();
 
             // only process things that are queued for sending
-            if (! in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_to_send())) {
+            if ( ! in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_to_send())) {
                 $this->_message_repository->next();
                 continue;
             }
@@ -527,13 +527,13 @@ 
                 continue;
             }
             // error checking
-            if (! $message->valid_messenger()) {
+            if ( ! $message->valid_messenger()) {
                 $error_messages[] = sprintf(
                     esc_html__('The %s messenger is not active at time of sending.', 'event_espresso'),
                     $message->messenger()
                 );
             }
-            if (! $message->valid_message_type()) {
+            if ( ! $message->valid_message_type()) {
                 $error_messages[] = sprintf(
                     esc_html__('The %s message type is not active at the time of sending.', 'event_espresso'),
                     $message->message_type()
@@ -595,9 +595,9 @@ 
         // send using messenger, but double check objects
         if ($messenger instanceof EE_messenger && $message_type instanceof EE_message_type) {
             // set hook for message type (but only if not using another messenger to send).
-            if (! isset($this->_did_hook[ $message_type->name ])) {
+            if ( ! isset($this->_did_hook[$message_type->name])) {
                 $message_type->do_messenger_hooks($messenger);
-                $this->_did_hook[ $message_type->name ] = 1;
+                $this->_did_hook[$message_type->name] = 1;
             }
             // if preview then use preview method
             return $this->_message_repository->is_preview()
@@ -648,7 +648,7 @@ 
         $test_send
     ) {
         if ($preview = $messenger->get_preview($message, $message_type, $test_send)) {
-            if (! $test_send) {
+            if ( ! $test_send) {
                 $message->set_content($preview);
             }
             $message->set_STS_ID(EEM_Message::status_sent);
@@ -714,7 +714,7 @@ 
         }
         if (count($error_messages) > 0) {
             $msg = esc_html__('Message was not executed successfully.', 'event_espresso');
-            $msg = $msg . "\n" . implode("\n", $error_messages);
+            $msg = $msg."\n".implode("\n", $error_messages);
             $message->set_error_message($msg);
         }
     }

core/libraries/messages/EE_Messages_Processor.lib.php

Spacing +8 added lines, -8 removed lines

@@ -284,7 +284,7 @@ 
     public function queue_for_generation(EE_Message_To_Generate $message_to_generate, $test_send = false)
     {
         if ($message_to_generate->valid()) {
-            if (! $this->_generator->create_and_add_message_to_queue($message_to_generate, $test_send)) {
+            if ( ! $this->_generator->create_and_add_message_to_queue($message_to_generate, $test_send)) {
                 throw new RuntimeException(
                     esc_html__('Message failed to generate', 'event_espresso')
                 );
@@ -330,7 +330,7 @@ 
     protected function _queue_for_generation_loop($messages_to_generate)
     {
         // make sure is in an array.
-        if (! is_array($messages_to_generate)) {
+        if ( ! is_array($messages_to_generate)) {
             $messages_to_generate = [$messages_to_generate];
         }
 
@@ -370,7 +370,7 @@ 
      */
     public function generate_for_preview(EE_Message_To_Generate $message_to_generate, $test_send = false)
     {
-        if (! $message_to_generate->valid()) {
+        if ( ! $message_to_generate->valid()) {
             EE_Error::add_error(
                 esc_html__('Unable to generate preview because of invalid data', 'event_espresso'),
                 __FILE__,
@@ -407,7 +407,7 @@ 
      */
     public function queue_for_sending(EE_Message_To_Generate $message_to_generate)
     {
-        if (! $message_to_generate->valid()) {
+        if ( ! $message_to_generate->valid()) {
             return false;
         }
         $this->_init_queue_and_generator();
@@ -432,7 +432,7 @@ 
      */
     public function generate_and_send_now(EE_Message_To_Generate $message_to_generate)
     {
-        if (! $message_to_generate->valid()) {
+        if ( ! $message_to_generate->valid()) {
             return null;
         }
         // is there supposed to be a sending messenger for this message?
@@ -579,7 +579,7 @@ 
 
         foreach ($regIDs as $regID) {
             $reg = EEM_Registration::instance()->get_one_by_ID($regID);
-            if (! $reg instanceof EE_Registration) {
+            if ( ! $reg instanceof EE_Registration) {
                 EE_Error::add_error(
                     sprintf(
                         esc_html__(
@@ -591,7 +591,7 @@ 
                 );
                 return false;
             }
-            $regs_to_send[ $reg->transaction_ID() ][ $reg->status_ID() ][] = $reg;
+            $regs_to_send[$reg->transaction_ID()][$reg->status_ID()][] = $reg;
         }
 
         $messages_to_generate = [];
@@ -599,7 +599,7 @@ 
         foreach ($regs_to_send as $status_group) {
             foreach ($status_group as $status_id => $registrations) {
                 $message_type = EEH_MSG_Template::convert_reg_status_to_message_type($status_id);
-                if (! $message_type) {
+                if ( ! $message_type) {
                     continue;
                 }
                 $messages_to_generate = array_merge(

Indentation +598 added lines, -598 removed lines

@@ -14,602 +14,602 @@
  */
 class EE_Messages_Processor
 {
-    /**
-     * @type EE_Message_Resource_Manager $_message_resource_manager
-     */
-    protected $_message_resource_manager;
-
-    /**
-     * @type EE_Messages_Queue
-     */
-    protected $_queue;
-
-    /**
-     * @type  EE_Messages_Generator
-     */
-    protected $_generator;
-
-
-    /**
-     * constructor
-     *
-     * @param EE_Message_Resource_Manager $message_resource_manager
-     */
-    public function __construct(EE_Message_Resource_Manager $message_resource_manager)
-    {
-        $this->_message_resource_manager = $message_resource_manager;
-        $this->_init_queue_and_generator();
-    }
-
-
-    /**
-     * This method sets (or resets) the various properties for use.
-     *
-     * - $_queue = holds the messages queue
-     * - $_generator = holds the messages generator
-     */
-    protected function _init_queue_and_generator()
-    {
-        $this->_generator = EE_Registry::factory('EE_Messages_Generator');
-        $this->_queue     = $this->_generator->generation_queue();
-    }
-
-
-    /**
-     * This returns the current set queue.
-     *
-     * @return EE_Messages_Queue
-     */
-    public function get_queue()
-    {
-        return $this->_queue;
-    }
-
-
-    /**
-     * This method can be utilized to process messages from a queue and they will be processed immediately on the same
-     * request. Please note that this method alone does not bypass the usual "locks" for generation/sending (it assumes
-     * client code has already filtered those if necessary).
-     *
-     * @param EE_Messages_Queue $queue_to_process
-     * @return bool  true for success false for error.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function process_immediately_from_queue(EE_Messages_Queue $queue_to_process)
-    {
-        $success              = false;
-        $messages_to_send     = [];
-        $messages_to_generate = [];
-        // loop through and setup the various messages from the queue so we know what is being processed
-        $queue_to_process->get_message_repository()->rewind();
-        foreach ($queue_to_process->get_message_repository() as $message) {
-            if ($message->STS_ID() === EEM_Message::status_incomplete) {
-                $messages_to_generate[] = $message;
-                continue;
-            }
-
-            if (in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_to_send())) {
-                $messages_to_send[] = $message;
-            }
-        }
-
-        // do generation/sends
-        if ($messages_to_generate) {
-            $success = $this->batch_generate_from_queue($messages_to_generate, true);
-        }
-
-        if ($messages_to_send) {
-            $sent = $this->batch_send_from_queue($messages_to_send, true);
-            // if there was messages to generate and it failed, then we override any success value for the sending process
-            // otherwise we just use the return from batch send.  The intent is that there is a simple response for success/fail.
-            // Either everything was successful or we consider it a fail.  To be clear, this is a limitation of doing
-            // all messages processing on the same request.
-            $success = $messages_to_generate && ! $success ? false : $sent;
-        }
-        return $success;
-    }
-
-
-    /**
-     * Calls the EE_Messages_Queue::get_batch_to_generate() method and sends to EE_Messages_Generator.
-     *
-     * @param EE_Message[] $messages    Array of EE_Message objects (optional) to build the queue with.
-     * @param bool         $clear_queue Whether to ensure a fresh queue or not.
-     *
-     * @return bool|EE_Messages_Queue return false if nothing generated.  This returns a new EE_Message_Queue with
-     *                                   generated messages.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function batch_generate_from_queue($messages = [], $clear_queue = false)
-    {
-        if ($this->_build_queue_for_generation($messages, $clear_queue)) {
-            $new_queue = $this->_generator->generate();
-            if ($new_queue instanceof EE_Messages_Queue) {
-                // unlock queue
-                $this->_queue->unlock_queue();
-                $new_queue->initiate_request_by_priority('send');
-                return $new_queue;
-            }
-        }
-        $this->_queue->unlock_queue();
-        return false;
-    }
-
-
-    /**
-     * This method preps a queue for generation.
-     *
-     * @param EE_Message[] $messages    Array of EE_Message objects to build the queue with
-     *
-     * @param bool         $clear_queue This indicates whether the existing queue should be dumped or not.
-     *
-     * @return bool true means queue prepped, false means there was a lock so no generation please.
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since    4.9.0
-     *
-     */
-    protected function _build_queue_for_generation($messages = [], $clear_queue = false)
-    {
-
-        if ($clear_queue) {
-            $this->_init_queue_and_generator();
-        }
-
-        if ($messages) {
-            // if generation is locked then get out now because that means processing is already happening.
-            if ($this->_queue->is_locked()) {
-                return false;
-            }
-
-            $this->_queue->lock_queue();
-            $messages = is_array($messages) ? $messages : [$messages];
-            foreach ($messages as $message) {
-                if ($message instanceof EE_Message) {
-                    $data = $message->all_extra_meta_array();
-                    $this->_queue->add($message, $data);
-                }
-            }
-            return true;
-        } else {
-            return $this->_queue->get_batch_to_generate();
-        }
-    }
-
-
-    /**
-     * This method preps a queue for sending.
-     *
-     * @param EE_Message[] $messages
-     * @param bool         $clear_queue Used to indicate whether to start with a fresh queue or not.
-     *
-     * @return bool true means queue prepped, false means there was a lock so no queue prepped.
-     */
-    protected function _build_queue_for_sending($messages, $clear_queue = false)
-    {
-        // if sending is locked then get out now because that means processing is already happening.
-        if ($this->_queue->is_locked(EE_Messages_Queue::action_sending)) {
-            return false;
-        }
-
-        $this->_queue->lock_queue(EE_Messages_Queue::action_sending);
-
-        if ($clear_queue) {
-            $this->_init_queue_and_generator();
-        }
-
-        $messages = is_array($messages) ? $messages : [$messages];
-
-        foreach ($messages as $message) {
-            $this->_queue->add($message);
-        }
-        return true;
-    }
-
-
-    /**
-     * Calls the EE_Message_Queue::get_to_send_batch_and_send() method and then immediately just calls
-     * EE_Message_Queue::execute() to iterate and send unsent messages.
-     *
-     * @param EE_Message[] $messages    If an array of messages is sent in then use it.
-     *
-     * @param bool         $clear_queue Whether to initialize a new queue or keep the existing one.
-     *
-     * @return EE_Messages_Queue
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function batch_send_from_queue($messages = [], $clear_queue = false)
-    {
-
-        if ($messages && $this->_build_queue_for_sending($messages, $clear_queue)) {
-            $this->_queue->execute();
-            $this->_queue->unlock_queue(EE_Messages_Queue::action_sending);
-        } else {
-            // get messages to send and execute.
-            $this->_queue->get_to_send_batch_and_send();
-        }
-        // note: callers can use the EE_Messages_Queue::count_STS_in_queue() method to find out if there were any failed
-        // messages in the queue and decide how to handle at that point.
-        return $this->_queue;
-    }
-
-
-    /**
-     * This immediately generates messages using the given array of EE_Message_To_Generate objects and returns the
-     * EE_Message_Queue with the generated messages for the caller to work with.  Note, this does NOT save the generated
-     * messages in the queue, leaving it up to the caller to do so.
-     *
-     * @param EE_Message_To_Generate[] $messages_to_generate
-     * @return EE_Messages_Queue
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function generate_and_return($messages_to_generate)
-    {
-        $this->_init_queue_and_generator();
-        $this->_queue_for_generation_loop($messages_to_generate);
-        return $this->_generator->generate(false);
-    }
-
-
-    /**
-     * Executes the generator generate method on the current internal queue, and returns the generated queue.
-     *
-     * @param bool $persist Indicate whether to instruct the generator to persist the generated queue (true) or not
-     *                      (false).
-     * @return EE_Messages_Queue
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function generate_queue($persist = true)
-    {
-        return $this->_generator->generate($persist);
-    }
-
-
-    /**
-     * Queue for generation.  Note this does NOT persist to the db.  Client code should call
-     * get_message_repository()->save() if desire to persist.  This method is provided to client code to decide what it
-     * wants to do with queued messages for generation.
-     *
-     * @param EE_Message_To_Generate $message_to_generate
-     * @param bool                   $test_send Whether this item is for a test send or not.
-     * @return void
-     */
-    public function queue_for_generation(EE_Message_To_Generate $message_to_generate, $test_send = false)
-    {
-        if ($message_to_generate->valid()) {
-            if (! $this->_generator->create_and_add_message_to_queue($message_to_generate, $test_send)) {
-                throw new RuntimeException(
-                    esc_html__('Message failed to generate', 'event_espresso')
-                );
-            }
-        }
-    }
-
-
-    /**
-     * This receives an array of EE_Message_To_Generate objects, converts them to EE_Message adds them to the
-     * generation queue and then persists to storage.
-     *
-     * @param EE_Message_To_Generate[] $messages_to_generate
-     */
-    public function batch_queue_for_generation_and_persist($messages_to_generate)
-    {
-        $this->_init_queue_and_generator();
-        $this->_queue_for_generation_loop($messages_to_generate);
-        $this->_queue->save();
-    }
-
-
-    /**
-     * This receives an array of EE_Message_To_Generate objects, converts them to EE_Message and adds them to the
-     * generation queue.  Does NOT persist to storage (unless there is an error. Client code can retrieve the generated
-     * queue by calling EEM_Messages_Processor::get_queue()
-     *
-     * @param EE_Message_To_Generate[] $messages_to_generate
-     */
-    public function batch_queue_for_generation_no_persist($messages_to_generate)
-    {
-        $this->_init_queue_and_generator();
-        $this->_queue_for_generation_loop($messages_to_generate);
-    }
-
-
-    /**
-     * Simply loops through the given array of EE_Message_To_Generate objects and adds them to the _queue as EE_Message
-     * objects.
-     *
-     * @param EE_Message_To_Generate[] $messages_to_generate
-     */
-    protected function _queue_for_generation_loop($messages_to_generate)
-    {
-        // make sure is in an array.
-        if (! is_array($messages_to_generate)) {
-            $messages_to_generate = [$messages_to_generate];
-        }
-
-        foreach ($messages_to_generate as $message_to_generate) {
-            if ($message_to_generate instanceof EE_Message_To_Generate && $message_to_generate->valid()) {
-                $this->queue_for_generation($message_to_generate);
-            }
-        }
-    }
-
-
-    /**
-     * Receives an array of EE_Message_To_Generate objects and generates the EE_Message objects, then persists (so its
-     * queued for sending).
-     *
-     * @param EE_Message_To_Generate[]
-     * @return EE_Messages_Queue
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function generate_and_queue_for_sending($messages_to_generate)
-    {
-        $this->_init_queue_and_generator();
-        $this->_queue_for_generation_loop($messages_to_generate);
-        return $this->_generator->generate();
-    }
-
-
-    /**
-     * Generate for preview and execute right away.
-     *
-     * @param EE_Message_To_Generate $message_to_generate
-     * @param bool                   $test_send Whether this is a test send or not.
-     * @return  EE_Messages_Queue | bool   false if unable to generate otherwise the generated queue.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function generate_for_preview(EE_Message_To_Generate $message_to_generate, $test_send = false)
-    {
-        if (! $message_to_generate->valid()) {
-            EE_Error::add_error(
-                esc_html__('Unable to generate preview because of invalid data', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // just make sure preview is set on the $message_to_generate (in case client forgot)
-        $message_to_generate->set_preview(true);
-        $this->_init_queue_and_generator();
-        $this->queue_for_generation($message_to_generate, $test_send);
-        $generated_queue = $this->_generator->generate(false);
-        if ($generated_queue->execute(false)) {
-            // the first queue item should be the preview
-            $generated_queue->get_message_repository()->rewind();
-            if ($generated_queue->get_message_repository()->valid()) {
-                return $generated_queue;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * This queues for sending.
-     * The messenger send now method is also verified to see if sending immediately is requested.
-     * otherwise its just saved to the queue.
-     *
-     * @param EE_Message_To_Generate $message_to_generate
-     * @return bool true or false for success.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function queue_for_sending(EE_Message_To_Generate $message_to_generate)
-    {
-        if (! $message_to_generate->valid()) {
-            return false;
-        }
-        $this->_init_queue_and_generator();
-        $message = $message_to_generate->get_EE_Message();
-        $this->_queue->add($message);
-        if ($message->send_now()) {
-            $this->_queue->execute(false);
-        } else {
-            $this->_queue->save();
-        }
-        return true;
-    }
-
-
-    /**
-     * This generates and sends from the given EE_Message_To_Generate class immediately.
-     *
-     * @param EE_Message_To_Generate $message_to_generate
-     * @return EE_Messages_Queue | null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function generate_and_send_now(EE_Message_To_Generate $message_to_generate)
-    {
-        if (! $message_to_generate->valid()) {
-            return null;
-        }
-        // is there supposed to be a sending messenger for this message?
-        if ($message_to_generate instanceof EEI_Has_Sending_Messenger) {
-            // make sure it's valid, but if it's not,
-            // then set the value of $sending_messenger to an EE_Error object
-            // so that downstream code can easily see that things went wrong.
-            $sending_messenger = $message_to_generate->sending_messenger() instanceof EE_messenger
-                ? $message_to_generate->sending_messenger()
-                : new EE_Error(
-                    esc_html__(
-                        'There was a specific sending messenger requested for the send action, but it was either invalid or not active at time of sending.',
-                        'event_espresso'
-                    )
-                );
-        } else {
-            $sending_messenger = null;
-        }
-
-        if ($message_to_generate->get_EE_Message()->STS_ID() === EEM_Message::status_idle) {
-            $this->_init_queue_and_generator();
-            $this->_queue->add($message_to_generate->get_EE_Message());
-            $this->_queue->execute(false, $sending_messenger);
-            return $this->_queue;
-        } elseif ($message_to_generate->get_EE_Message()->STS_ID() === EEM_Message::status_incomplete) {
-            $generated_queue = $this->generate_and_return([$message_to_generate]);
-            $generated_queue->execute(false, $sending_messenger);
-            return $generated_queue;
-        }
-        return null;
-    }
-
-
-    /**
-     * Creates mtg objects for all active messengers and queues for generation.
-     * This method also calls the execute by priority method on the queue which will optionally kick off a new
-     * non-blocking request to complete the action if the priority for the message requires immediate action.
-     *
-     * @param string $message_type
-     * @param mixed  $data    The data being used for generation.
-     * @param bool   $persist Whether to persist the queued messages to the db or not.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function generate_for_all_active_messengers($message_type, $data, $persist = true)
-    {
-        $messages_to_generate = $this->setup_mtgs_for_all_active_messengers($message_type, $data);
-        if ($persist) {
-            $this->batch_queue_for_generation_and_persist($messages_to_generate);
-            $this->_queue->initiate_request_by_priority();
-        } else {
-            $this->batch_queue_for_generation_no_persist($messages_to_generate);
-        }
-    }
-
-
-    /**
-     * This simply loops through all active messengers and takes care of setting up the
-     * EE_Message_To_Generate objects.
-     *
-     * @param $message_type
-     * @param $data
-     *
-     * @return EE_Message_To_Generate[]
-     */
-    public function setup_mtgs_for_all_active_messengers($message_type, $data)
-    {
-        $messages_to_generate = [];
-        foreach ($this->_message_resource_manager->active_messengers() as $messenger_slug => $messenger_object) {
-            $message_to_generate = new EE_Message_To_Generate($messenger_slug, $message_type, $data);
-            if ($message_to_generate->valid()) {
-                $messages_to_generate[] = $message_to_generate;
-            }
-        }
-        return $messages_to_generate;
-    }
-
-
-    /**
-     * This accepts an array of EE_Message::MSG_ID values
-     * and will use that to retrieve the objects from the database and send.
-     *
-     * @param array $message_ids
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setup_messages_from_ids_and_send($message_ids)
-    {
-        $this->_init_queue_and_generator();
-        $messages = EEM_Message::instance()->get_all(
-            [
-                 [
-                     'MSG_ID' => ['IN', $message_ids],
-                     'STS_ID' => [
-                         'IN',
-                         array_merge(
-                             EEM_Message::instance()->stati_indicating_sent(),
-                             [EEM_Message::status_retry]
-                         ),
-                     ],
-                 ],
-             ]
-        );
-        // set the Messages to resend.
-        foreach ($messages as $message) {
-            if ($message instanceof EE_Message) {
-                $message->set_STS_ID(EEM_Message::status_resend);
-                $this->_queue->add($message);
-            }
-        }
-
-        $this->_queue->initiate_request_by_priority('send');
-    }
-
-
-    /**
-     * This method checks for registration IDs in the request via the given key and creates the messages to generate
-     * objects from them, then returns the array of messages to generate objects.
-     * Note, this sets up registrations for the registration family of message types.
-     *
-     * @param string $registration_ids_key This is used to indicate what represents the registration ids in the request.
-     *
-     * @return EE_Message_To_Generate[]|bool
-     * @throws EE_Error
-     */
-    public function setup_messages_to_generate_from_registration_ids_in_request($registration_ids_key = '_REG_ID')
-    {
-        /** @var RequestInterface $request */
-        $request      = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $regs_to_send = [];
-        $regIDs       = $request->getRequestParam($registration_ids_key, [], 'int', true);
-        if (empty($regIDs)) {
-            EE_Error::add_error(
-                esc_html__('Something went wrong because we\'re missing the registration ID', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-
-        // make sure is an array
-        $regIDs = is_array($regIDs) ? $regIDs : [$regIDs];
-
-        foreach ($regIDs as $regID) {
-            $reg = EEM_Registration::instance()->get_one_by_ID($regID);
-            if (! $reg instanceof EE_Registration) {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'Unable to retrieve a registration object for the given reg id (%s)',
-                            'event_espresso'
-                        ),
-                        $regID
-                    )
-                );
-                return false;
-            }
-            $regs_to_send[ $reg->transaction_ID() ][ $reg->status_ID() ][] = $reg;
-        }
-
-        $messages_to_generate = [];
-
-        foreach ($regs_to_send as $status_group) {
-            foreach ($status_group as $status_id => $registrations) {
-                $message_type = EEH_MSG_Template::convert_reg_status_to_message_type($status_id);
-                if (! $message_type) {
-                    continue;
-                }
-                $messages_to_generate = array_merge(
-                    $messages_to_generate,
-                    $this->setup_mtgs_for_all_active_messengers(
-                        $message_type,
-                        [$registrations, $status_id]
-                    )
-                );
-            }
-        }
-
-        return $messages_to_generate;
-    }
+	/**
+	 * @type EE_Message_Resource_Manager $_message_resource_manager
+	 */
+	protected $_message_resource_manager;
+
+	/**
+	 * @type EE_Messages_Queue
+	 */
+	protected $_queue;
+
+	/**
+	 * @type  EE_Messages_Generator
+	 */
+	protected $_generator;
+
+
+	/**
+	 * constructor
+	 *
+	 * @param EE_Message_Resource_Manager $message_resource_manager
+	 */
+	public function __construct(EE_Message_Resource_Manager $message_resource_manager)
+	{
+		$this->_message_resource_manager = $message_resource_manager;
+		$this->_init_queue_and_generator();
+	}
+
+
+	/**
+	 * This method sets (or resets) the various properties for use.
+	 *
+	 * - $_queue = holds the messages queue
+	 * - $_generator = holds the messages generator
+	 */
+	protected function _init_queue_and_generator()
+	{
+		$this->_generator = EE_Registry::factory('EE_Messages_Generator');
+		$this->_queue     = $this->_generator->generation_queue();
+	}
+
+
+	/**
+	 * This returns the current set queue.
+	 *
+	 * @return EE_Messages_Queue
+	 */
+	public function get_queue()
+	{
+		return $this->_queue;
+	}
+
+
+	/**
+	 * This method can be utilized to process messages from a queue and they will be processed immediately on the same
+	 * request. Please note that this method alone does not bypass the usual "locks" for generation/sending (it assumes
+	 * client code has already filtered those if necessary).
+	 *
+	 * @param EE_Messages_Queue $queue_to_process
+	 * @return bool  true for success false for error.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function process_immediately_from_queue(EE_Messages_Queue $queue_to_process)
+	{
+		$success              = false;
+		$messages_to_send     = [];
+		$messages_to_generate = [];
+		// loop through and setup the various messages from the queue so we know what is being processed
+		$queue_to_process->get_message_repository()->rewind();
+		foreach ($queue_to_process->get_message_repository() as $message) {
+			if ($message->STS_ID() === EEM_Message::status_incomplete) {
+				$messages_to_generate[] = $message;
+				continue;
+			}
+
+			if (in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_to_send())) {
+				$messages_to_send[] = $message;
+			}
+		}
+
+		// do generation/sends
+		if ($messages_to_generate) {
+			$success = $this->batch_generate_from_queue($messages_to_generate, true);
+		}
+
+		if ($messages_to_send) {
+			$sent = $this->batch_send_from_queue($messages_to_send, true);
+			// if there was messages to generate and it failed, then we override any success value for the sending process
+			// otherwise we just use the return from batch send.  The intent is that there is a simple response for success/fail.
+			// Either everything was successful or we consider it a fail.  To be clear, this is a limitation of doing
+			// all messages processing on the same request.
+			$success = $messages_to_generate && ! $success ? false : $sent;
+		}
+		return $success;
+	}
+
+
+	/**
+	 * Calls the EE_Messages_Queue::get_batch_to_generate() method and sends to EE_Messages_Generator.
+	 *
+	 * @param EE_Message[] $messages    Array of EE_Message objects (optional) to build the queue with.
+	 * @param bool         $clear_queue Whether to ensure a fresh queue or not.
+	 *
+	 * @return bool|EE_Messages_Queue return false if nothing generated.  This returns a new EE_Message_Queue with
+	 *                                   generated messages.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function batch_generate_from_queue($messages = [], $clear_queue = false)
+	{
+		if ($this->_build_queue_for_generation($messages, $clear_queue)) {
+			$new_queue = $this->_generator->generate();
+			if ($new_queue instanceof EE_Messages_Queue) {
+				// unlock queue
+				$this->_queue->unlock_queue();
+				$new_queue->initiate_request_by_priority('send');
+				return $new_queue;
+			}
+		}
+		$this->_queue->unlock_queue();
+		return false;
+	}
+
+
+	/**
+	 * This method preps a queue for generation.
+	 *
+	 * @param EE_Message[] $messages    Array of EE_Message objects to build the queue with
+	 *
+	 * @param bool         $clear_queue This indicates whether the existing queue should be dumped or not.
+	 *
+	 * @return bool true means queue prepped, false means there was a lock so no generation please.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since    4.9.0
+	 *
+	 */
+	protected function _build_queue_for_generation($messages = [], $clear_queue = false)
+	{
+
+		if ($clear_queue) {
+			$this->_init_queue_and_generator();
+		}
+
+		if ($messages) {
+			// if generation is locked then get out now because that means processing is already happening.
+			if ($this->_queue->is_locked()) {
+				return false;
+			}
+
+			$this->_queue->lock_queue();
+			$messages = is_array($messages) ? $messages : [$messages];
+			foreach ($messages as $message) {
+				if ($message instanceof EE_Message) {
+					$data = $message->all_extra_meta_array();
+					$this->_queue->add($message, $data);
+				}
+			}
+			return true;
+		} else {
+			return $this->_queue->get_batch_to_generate();
+		}
+	}
+
+
+	/**
+	 * This method preps a queue for sending.
+	 *
+	 * @param EE_Message[] $messages
+	 * @param bool         $clear_queue Used to indicate whether to start with a fresh queue or not.
+	 *
+	 * @return bool true means queue prepped, false means there was a lock so no queue prepped.
+	 */
+	protected function _build_queue_for_sending($messages, $clear_queue = false)
+	{
+		// if sending is locked then get out now because that means processing is already happening.
+		if ($this->_queue->is_locked(EE_Messages_Queue::action_sending)) {
+			return false;
+		}
+
+		$this->_queue->lock_queue(EE_Messages_Queue::action_sending);
+
+		if ($clear_queue) {
+			$this->_init_queue_and_generator();
+		}
+
+		$messages = is_array($messages) ? $messages : [$messages];
+
+		foreach ($messages as $message) {
+			$this->_queue->add($message);
+		}
+		return true;
+	}
+
+
+	/**
+	 * Calls the EE_Message_Queue::get_to_send_batch_and_send() method and then immediately just calls
+	 * EE_Message_Queue::execute() to iterate and send unsent messages.
+	 *
+	 * @param EE_Message[] $messages    If an array of messages is sent in then use it.
+	 *
+	 * @param bool         $clear_queue Whether to initialize a new queue or keep the existing one.
+	 *
+	 * @return EE_Messages_Queue
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function batch_send_from_queue($messages = [], $clear_queue = false)
+	{
+
+		if ($messages && $this->_build_queue_for_sending($messages, $clear_queue)) {
+			$this->_queue->execute();
+			$this->_queue->unlock_queue(EE_Messages_Queue::action_sending);
+		} else {
+			// get messages to send and execute.
+			$this->_queue->get_to_send_batch_and_send();
+		}
+		// note: callers can use the EE_Messages_Queue::count_STS_in_queue() method to find out if there were any failed
+		// messages in the queue and decide how to handle at that point.
+		return $this->_queue;
+	}
+
+
+	/**
+	 * This immediately generates messages using the given array of EE_Message_To_Generate objects and returns the
+	 * EE_Message_Queue with the generated messages for the caller to work with.  Note, this does NOT save the generated
+	 * messages in the queue, leaving it up to the caller to do so.
+	 *
+	 * @param EE_Message_To_Generate[] $messages_to_generate
+	 * @return EE_Messages_Queue
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function generate_and_return($messages_to_generate)
+	{
+		$this->_init_queue_and_generator();
+		$this->_queue_for_generation_loop($messages_to_generate);
+		return $this->_generator->generate(false);
+	}
+
+
+	/**
+	 * Executes the generator generate method on the current internal queue, and returns the generated queue.
+	 *
+	 * @param bool $persist Indicate whether to instruct the generator to persist the generated queue (true) or not
+	 *                      (false).
+	 * @return EE_Messages_Queue
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function generate_queue($persist = true)
+	{
+		return $this->_generator->generate($persist);
+	}
+
+
+	/**
+	 * Queue for generation.  Note this does NOT persist to the db.  Client code should call
+	 * get_message_repository()->save() if desire to persist.  This method is provided to client code to decide what it
+	 * wants to do with queued messages for generation.
+	 *
+	 * @param EE_Message_To_Generate $message_to_generate
+	 * @param bool                   $test_send Whether this item is for a test send or not.
+	 * @return void
+	 */
+	public function queue_for_generation(EE_Message_To_Generate $message_to_generate, $test_send = false)
+	{
+		if ($message_to_generate->valid()) {
+			if (! $this->_generator->create_and_add_message_to_queue($message_to_generate, $test_send)) {
+				throw new RuntimeException(
+					esc_html__('Message failed to generate', 'event_espresso')
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * This receives an array of EE_Message_To_Generate objects, converts them to EE_Message adds them to the
+	 * generation queue and then persists to storage.
+	 *
+	 * @param EE_Message_To_Generate[] $messages_to_generate
+	 */
+	public function batch_queue_for_generation_and_persist($messages_to_generate)
+	{
+		$this->_init_queue_and_generator();
+		$this->_queue_for_generation_loop($messages_to_generate);
+		$this->_queue->save();
+	}
+
+
+	/**
+	 * This receives an array of EE_Message_To_Generate objects, converts them to EE_Message and adds them to the
+	 * generation queue.  Does NOT persist to storage (unless there is an error. Client code can retrieve the generated
+	 * queue by calling EEM_Messages_Processor::get_queue()
+	 *
+	 * @param EE_Message_To_Generate[] $messages_to_generate
+	 */
+	public function batch_queue_for_generation_no_persist($messages_to_generate)
+	{
+		$this->_init_queue_and_generator();
+		$this->_queue_for_generation_loop($messages_to_generate);
+	}
+
+
+	/**
+	 * Simply loops through the given array of EE_Message_To_Generate objects and adds them to the _queue as EE_Message
+	 * objects.
+	 *
+	 * @param EE_Message_To_Generate[] $messages_to_generate
+	 */
+	protected function _queue_for_generation_loop($messages_to_generate)
+	{
+		// make sure is in an array.
+		if (! is_array($messages_to_generate)) {
+			$messages_to_generate = [$messages_to_generate];
+		}
+
+		foreach ($messages_to_generate as $message_to_generate) {
+			if ($message_to_generate instanceof EE_Message_To_Generate && $message_to_generate->valid()) {
+				$this->queue_for_generation($message_to_generate);
+			}
+		}
+	}
+
+
+	/**
+	 * Receives an array of EE_Message_To_Generate objects and generates the EE_Message objects, then persists (so its
+	 * queued for sending).
+	 *
+	 * @param EE_Message_To_Generate[]
+	 * @return EE_Messages_Queue
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function generate_and_queue_for_sending($messages_to_generate)
+	{
+		$this->_init_queue_and_generator();
+		$this->_queue_for_generation_loop($messages_to_generate);
+		return $this->_generator->generate();
+	}
+
+
+	/**
+	 * Generate for preview and execute right away.
+	 *
+	 * @param EE_Message_To_Generate $message_to_generate
+	 * @param bool                   $test_send Whether this is a test send or not.
+	 * @return  EE_Messages_Queue | bool   false if unable to generate otherwise the generated queue.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function generate_for_preview(EE_Message_To_Generate $message_to_generate, $test_send = false)
+	{
+		if (! $message_to_generate->valid()) {
+			EE_Error::add_error(
+				esc_html__('Unable to generate preview because of invalid data', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// just make sure preview is set on the $message_to_generate (in case client forgot)
+		$message_to_generate->set_preview(true);
+		$this->_init_queue_and_generator();
+		$this->queue_for_generation($message_to_generate, $test_send);
+		$generated_queue = $this->_generator->generate(false);
+		if ($generated_queue->execute(false)) {
+			// the first queue item should be the preview
+			$generated_queue->get_message_repository()->rewind();
+			if ($generated_queue->get_message_repository()->valid()) {
+				return $generated_queue;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * This queues for sending.
+	 * The messenger send now method is also verified to see if sending immediately is requested.
+	 * otherwise its just saved to the queue.
+	 *
+	 * @param EE_Message_To_Generate $message_to_generate
+	 * @return bool true or false for success.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function queue_for_sending(EE_Message_To_Generate $message_to_generate)
+	{
+		if (! $message_to_generate->valid()) {
+			return false;
+		}
+		$this->_init_queue_and_generator();
+		$message = $message_to_generate->get_EE_Message();
+		$this->_queue->add($message);
+		if ($message->send_now()) {
+			$this->_queue->execute(false);
+		} else {
+			$this->_queue->save();
+		}
+		return true;
+	}
+
+
+	/**
+	 * This generates and sends from the given EE_Message_To_Generate class immediately.
+	 *
+	 * @param EE_Message_To_Generate $message_to_generate
+	 * @return EE_Messages_Queue | null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function generate_and_send_now(EE_Message_To_Generate $message_to_generate)
+	{
+		if (! $message_to_generate->valid()) {
+			return null;
+		}
+		// is there supposed to be a sending messenger for this message?
+		if ($message_to_generate instanceof EEI_Has_Sending_Messenger) {
+			// make sure it's valid, but if it's not,
+			// then set the value of $sending_messenger to an EE_Error object
+			// so that downstream code can easily see that things went wrong.
+			$sending_messenger = $message_to_generate->sending_messenger() instanceof EE_messenger
+				? $message_to_generate->sending_messenger()
+				: new EE_Error(
+					esc_html__(
+						'There was a specific sending messenger requested for the send action, but it was either invalid or not active at time of sending.',
+						'event_espresso'
+					)
+				);
+		} else {
+			$sending_messenger = null;
+		}
+
+		if ($message_to_generate->get_EE_Message()->STS_ID() === EEM_Message::status_idle) {
+			$this->_init_queue_and_generator();
+			$this->_queue->add($message_to_generate->get_EE_Message());
+			$this->_queue->execute(false, $sending_messenger);
+			return $this->_queue;
+		} elseif ($message_to_generate->get_EE_Message()->STS_ID() === EEM_Message::status_incomplete) {
+			$generated_queue = $this->generate_and_return([$message_to_generate]);
+			$generated_queue->execute(false, $sending_messenger);
+			return $generated_queue;
+		}
+		return null;
+	}
+
+
+	/**
+	 * Creates mtg objects for all active messengers and queues for generation.
+	 * This method also calls the execute by priority method on the queue which will optionally kick off a new
+	 * non-blocking request to complete the action if the priority for the message requires immediate action.
+	 *
+	 * @param string $message_type
+	 * @param mixed  $data    The data being used for generation.
+	 * @param bool   $persist Whether to persist the queued messages to the db or not.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function generate_for_all_active_messengers($message_type, $data, $persist = true)
+	{
+		$messages_to_generate = $this->setup_mtgs_for_all_active_messengers($message_type, $data);
+		if ($persist) {
+			$this->batch_queue_for_generation_and_persist($messages_to_generate);
+			$this->_queue->initiate_request_by_priority();
+		} else {
+			$this->batch_queue_for_generation_no_persist($messages_to_generate);
+		}
+	}
+
+
+	/**
+	 * This simply loops through all active messengers and takes care of setting up the
+	 * EE_Message_To_Generate objects.
+	 *
+	 * @param $message_type
+	 * @param $data
+	 *
+	 * @return EE_Message_To_Generate[]
+	 */
+	public function setup_mtgs_for_all_active_messengers($message_type, $data)
+	{
+		$messages_to_generate = [];
+		foreach ($this->_message_resource_manager->active_messengers() as $messenger_slug => $messenger_object) {
+			$message_to_generate = new EE_Message_To_Generate($messenger_slug, $message_type, $data);
+			if ($message_to_generate->valid()) {
+				$messages_to_generate[] = $message_to_generate;
+			}
+		}
+		return $messages_to_generate;
+	}
+
+
+	/**
+	 * This accepts an array of EE_Message::MSG_ID values
+	 * and will use that to retrieve the objects from the database and send.
+	 *
+	 * @param array $message_ids
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setup_messages_from_ids_and_send($message_ids)
+	{
+		$this->_init_queue_and_generator();
+		$messages = EEM_Message::instance()->get_all(
+			[
+				 [
+					 'MSG_ID' => ['IN', $message_ids],
+					 'STS_ID' => [
+						 'IN',
+						 array_merge(
+							 EEM_Message::instance()->stati_indicating_sent(),
+							 [EEM_Message::status_retry]
+						 ),
+					 ],
+				 ],
+			 ]
+		);
+		// set the Messages to resend.
+		foreach ($messages as $message) {
+			if ($message instanceof EE_Message) {
+				$message->set_STS_ID(EEM_Message::status_resend);
+				$this->_queue->add($message);
+			}
+		}
+
+		$this->_queue->initiate_request_by_priority('send');
+	}
+
+
+	/**
+	 * This method checks for registration IDs in the request via the given key and creates the messages to generate
+	 * objects from them, then returns the array of messages to generate objects.
+	 * Note, this sets up registrations for the registration family of message types.
+	 *
+	 * @param string $registration_ids_key This is used to indicate what represents the registration ids in the request.
+	 *
+	 * @return EE_Message_To_Generate[]|bool
+	 * @throws EE_Error
+	 */
+	public function setup_messages_to_generate_from_registration_ids_in_request($registration_ids_key = '_REG_ID')
+	{
+		/** @var RequestInterface $request */
+		$request      = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$regs_to_send = [];
+		$regIDs       = $request->getRequestParam($registration_ids_key, [], 'int', true);
+		if (empty($regIDs)) {
+			EE_Error::add_error(
+				esc_html__('Something went wrong because we\'re missing the registration ID', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+
+		// make sure is an array
+		$regIDs = is_array($regIDs) ? $regIDs : [$regIDs];
+
+		foreach ($regIDs as $regID) {
+			$reg = EEM_Registration::instance()->get_one_by_ID($regID);
+			if (! $reg instanceof EE_Registration) {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'Unable to retrieve a registration object for the given reg id (%s)',
+							'event_espresso'
+						),
+						$regID
+					)
+				);
+				return false;
+			}
+			$regs_to_send[ $reg->transaction_ID() ][ $reg->status_ID() ][] = $reg;
+		}
+
+		$messages_to_generate = [];
+
+		foreach ($regs_to_send as $status_group) {
+			foreach ($status_group as $status_id => $registrations) {
+				$message_type = EEH_MSG_Template::convert_reg_status_to_message_type($status_id);
+				if (! $message_type) {
+					continue;
+				}
+				$messages_to_generate = array_merge(
+					$messages_to_generate,
+					$this->setup_mtgs_for_all_active_messengers(
+						$message_type,
+						[$registrations, $status_id]
+					)
+				);
+			}
+		}
+
+		return $messages_to_generate;
+	}
 }

core/libraries/messages/EE_Messages_Generator.lib.php

Indentation +987 added lines, -987 removed lines

@@ -15,992 +15,992 @@
  */
 class EE_Messages_Generator
 {
-    /**
-     * @type EE_Messages_Data_Handler_Collection
-     */
-    protected $_data_handler_collection;
-
-    /**
-     * @type  EE_Message_Template_Group_Collection
-     */
-    protected $_template_collection;
-
-    /**
-     * This will hold the data handler for the current EE_Message being generated.
-     *
-     * @type EE_Messages_incoming_data
-     */
-    protected $_current_data_handler;
-
-    /**
-     * This holds the EE_Messages_Queue that contains the messages to generate.
-     *
-     * @type EE_Messages_Queue
-     */
-    protected $_generation_queue;
-
-    /**
-     * This holds the EE_Messages_Queue that will store the generated EE_Message objects.
-     *
-     * @type EE_Messages_Queue
-     */
-    protected $_ready_queue;
-
-    /**
-     * This is a container for any error messages that get created through the generation
-     * process.
-     *
-     * @type array
-     */
-    protected $_error_msg = [];
-
-    /**
-     * Flag used to set when the current EE_Message in the generation queue has been verified.
-     *
-     * @type bool
-     */
-    protected $_verified = false;
-
-    /**
-     * This will hold the current messenger object corresponding with the current EE_Message in the generation queue.
-     *
-     * @type EE_messenger
-     */
-    protected $_current_messenger;
-
-    /**
-     * This will hold the current message type object corresponding with the current EE_Message in the generation queue.
-     *
-     * @type EE_message_type
-     */
-    protected $_current_message_type;
-
-    /**
-     * @type EEH_Parse_Shortcodes
-     */
-    protected $_shortcode_parser;
-
-
-    /**
-     * @param EE_Messages_Queue                    $generation_queue
-     * @param EE_Messages_Queue                    $ready_queue
-     * @param EE_Messages_Data_Handler_Collection  $data_handler_collection
-     * @param EE_Message_Template_Group_Collection $template_collection
-     * @param EEH_Parse_Shortcodes                 $shortcode_parser
-     */
-    public function __construct(
-        EE_Messages_Queue $generation_queue,
-        EE_Messages_Queue $ready_queue,
-        EE_Messages_Data_Handler_Collection $data_handler_collection,
-        EE_Message_Template_Group_Collection $template_collection,
-        EEH_Parse_Shortcodes $shortcode_parser
-    ) {
-        $this->_generation_queue        = $generation_queue;
-        $this->_ready_queue             = $ready_queue;
-        $this->_data_handler_collection = $data_handler_collection;
-        $this->_template_collection     = $template_collection;
-        $this->_shortcode_parser        = $shortcode_parser;
-    }
-
-
-    /**
-     * @return EE_Messages_Queue
-     */
-    public function generation_queue()
-    {
-        return $this->_generation_queue;
-    }
-
-
-    /**
-     *  This iterates through the provided queue and generates the EE_Message objects.
-     *  When iterating through the queue, the queued item that served as the base for generating other EE_Message
-     *  objects gets removed and the new EE_Message objects get added to a NEW queue.  The NEW queue is then returned
-     *  for the caller to decide what to do with it.
-     *
-     * @param bool $save Whether to save the EE_Message objects in the new queue or just return.
-     * @return EE_Messages_Queue The new queue for holding generated EE_Message objects.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function generate($save = true)
-    {
-        // iterate through the messages in the queue, generate, and add to new queue.
-        $this->_generation_queue->get_message_repository()->rewind();
-
-        while ($this->_generation_queue->get_message_repository()->valid()) {
-            // reset "current" properties
-            $this->_reset_current_properties();
-
-            $msg = $this->_generation_queue->get_message_repository()->current();
-
-            /**
-             * need to get the next object and capture it for setting manually after deletes.  The reason is that when
-             * an object is removed from the repo then valid for the next object will fail.
-             */
-            $this->_generation_queue->get_message_repository()->next();
-            $next_msg = $this->_generation_queue->get_message_repository()->current();
-            // restore pointer to current item
-            $this->_generation_queue->get_message_repository()->set_current($msg);
-
-            // skip and delete if the current $msg is NOT incomplete (queued for generation)
-            if ($msg->STS_ID() !== EEM_Message::status_incomplete) {
-                // we keep this item in the db just remove from the repo.
-                $this->_generation_queue->get_message_repository()->remove($msg);
-                // next item
-                $this->_generation_queue->get_message_repository()->set_current($next_msg);
-                continue;
-            }
-
-            if ($this->_verify()) {
-                // let's get generating!
-                $this->_generate();
-            }
-
-            // don't persist debug_only messages if the messages system is not in debug mode.
-            if (
-                $msg->STS_ID() === EEM_Message::status_debug_only
-                && ! EEM_Message::debug()
-            ) {
-                do_action(
-                    'AHEE__EE_Messages_Generator__generate__before_debug_delete',
-                    $msg,
-                    $this->_error_msg,
-                    $this->_current_messenger,
-                    $this->_current_message_type,
-                    $this->_current_data_handler
-                );
-                $this->_generation_queue->get_message_repository()->delete();
-                $this->_generation_queue->get_message_repository()->set_current($next_msg);
-                continue;
-            }
-
-            // if there are error messages then let's set the status and the error message.
-            if ($this->_error_msg) {
-                // if the status is already debug only, then let's leave it at that.
-                if ($msg->STS_ID() !== EEM_Message::status_debug_only) {
-                    $msg->set_STS_ID(EEM_Message::status_failed);
-                }
-                do_action(
-                    'AHEE__EE_Messages_Generator__generate__processing_failed_message',
-                    $msg,
-                    $this->_error_msg,
-                    $this->_current_messenger,
-                    $this->_current_message_type,
-                    $this->_current_data_handler
-                );
-                $msg->set_error_message(
-                    esc_html__('Message failed to generate for the following reasons: ', 'event_espresso')
-                    . "\n"
-                    . implode("\n", $this->_error_msg)
-                );
-                $msg->set_modified(time());
-            } else {
-                do_action(
-                    'AHEE__EE_Messages_Generator__generate__before_successful_generated_message_delete',
-                    $msg,
-                    $this->_error_msg,
-                    $this->_current_messenger,
-                    $this->_current_message_type,
-                    $this->_current_data_handler
-                );
-                // remove from db
-                $this->_generation_queue->get_message_repository()->delete();
-            }
-            // next item
-            $this->_generation_queue->get_message_repository()->set_current($next_msg);
-        }
-
-        // generation queue is ALWAYS saved to record any errors in the generation process.
-        $this->_generation_queue->save();
-
-        /**
-         * save _ready_queue if flag set.
-         * Note: The EE_Message objects have values set via the EE_Base_Class::set_field_or_extra_meta() method.  This
-         * means if a field was added that is not a valid database column.  The EE_Message was already saved to the db
-         * so a EE_Extra_Meta entry could be created and attached to the EE_Message.  In those cases the save flag is
-         * irrelevant.
-         */
-        if ($save) {
-            $this->_ready_queue->save();
-        }
-
-        // final reset of properties
-        $this->_reset_current_properties();
-
-        return $this->_ready_queue;
-    }
-
-
-    /**
-     * This resets all the properties used for holding "current" values corresponding to the current EE_Message object
-     * in the generation queue.
-     */
-    protected function _reset_current_properties()
-    {
-        $this->_verified = false;
-        // make sure any _data value in the current message type is reset
-        if ($this->_current_message_type instanceof EE_message_type) {
-            $this->_current_message_type->reset_data();
-        }
-        $this->_current_messenger = $this->_current_message_type = $this->_current_data_handler = null;
-    }
-
-
-    /**
-     * This proceeds with the actual generation of a message.  By the time this is called, there should already be a
-     * $_current_data_handler set and all incoming information should be validated for the current EE_Message in the
-     * _generating_queue.
-     *
-     * @return bool Whether the message was successfully generated or not.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _generate()
-    {
-        // double check verification has run and that everything is ready to work with (saves us having to validate
-        // everything again).
-        if (! $this->_verified) {
-            return false; // get out because we don't have a valid setup to work with.
-        }
-
-
-        try {
-            $addressees = $this->_current_message_type->get_addressees(
-                $this->_current_data_handler,
-                $this->_generation_queue->get_message_repository()->current()->context()
-            );
-        } catch (EE_Error $e) {
-            $this->_error_msg[] = $e->getMessage();
-            return false;
-        }
-
-
-        // if no addressees then get out because there is nothing to generation (possible bad data).
-        if (! $this->_valid_addressees($addressees)) {
-            do_action(
-                'AHEE__EE_Messages_Generator___generate__invalid_addressees',
-                $this->_generation_queue->get_message_repository()->current(),
-                $addressees,
-                $this->_current_messenger,
-                $this->_current_message_type,
-                $this->_current_data_handler
-            );
-            $this->_generation_queue->get_message_repository()->current()->set_STS_ID(
-                EEM_Message::status_debug_only
-            );
-            $this->_error_msg[] = esc_html__(
-                'This is not a critical error but an informational notice. Unable to generate messages EE_Messages_Addressee objects.  There were no attendees prepared by the data handler. Sometimes this is because messages only get generated for certain registration statuses. For example, the ticket notice message type only goes to approved registrations.',
-                'event_espresso'
-            );
-            return false;
-        }
-
-        $message_template_group = $this->_get_message_template_group();
-
-        // in the unlikely event there is no EE_Message_Template_Group available, get out!
-        if (! $message_template_group instanceof EE_Message_Template_Group) {
-            $this->_error_msg[] = esc_html__(
-                'Unable to get the Message Templates for the Message being generated.  No message template group accessible.',
-                'event_espresso'
-            );
-            return false;
-        }
-
-        // get formatted templates for using to parse and setup EE_Message objects.
-        $templates = $this->_get_templates($message_template_group);
-
-
-        // setup new EE_Message objects (and add to _ready_queue)
-        return $this->_assemble_messages($addressees, $templates, $message_template_group);
-    }
-
-
-    /**
-     * Retrieves the message template group being used for generating messages.
-     * Note: this also utilizes the EE_Message_Template_Group_Collection to avoid having to hit the db multiple times.
-     *
-     * @return EE_Message_Template_Group|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _get_message_template_group()
-    {
-        // first see if there is a specific message template group requested
-        // (current message in the queue has a specific GRP_ID)
-        $message_template_group = $this->_specific_message_template_group_from_queue();
-        if ($message_template_group instanceof EE_Message_Template_Group) {
-            return $message_template_group;
-        }
-
-        // get event_ids from the data handler so we can check to see
-        // if there's already a message template group for them in the collection.
-        $event_ids              = $this->_get_event_ids_from_current_data_handler();
-        $message_template_group = $this->_template_collection->get_by_key(
-            $this->_template_collection->getKey(
-                $this->_current_messenger->name,
-                $this->_current_message_type->name,
-                $event_ids
-            )
-        );
-
-        // if we have a message template group then no need to hit the database, just return it.
-        if ($message_template_group instanceof EE_Message_Template_Group) {
-            return $message_template_group;
-        }
-
-        // get the global group first for this messenger and message type
-        // to ensure there is no override set.
-        $global_message_template_group =
-            $this->_get_global_message_template_group_for_current_messenger_and_message_type();
-
-        if (
-            $global_message_template_group instanceof EE_Message_Template_Group
-            && $global_message_template_group->get('MTP_is_override')
-        ) {
-            return $global_message_template_group;
-        }
-
-        // if we're still here, that means there was no message template group for the events in the collection and
-        // the global message template group for the messenger and message type is not set for override.  So next step
-        // is to see if there is a common shared custom message template group for this set of events.
-        $message_template_group = $this->_get_shared_message_template_for_events($event_ids);
-        if ($message_template_group instanceof EE_Message_Template_Group) {
-            return $message_template_group;
-        }
-
-        // STILL here?  Okay that means the fallback is to just use the global message template group for this event
-        // set. So we'll cache the global group for this event set (so this logic doesn't have to be repeated in this
-        // request) and return it.
-        if ($global_message_template_group instanceof EE_Message_Template_Group) {
-            $this->_template_collection->add(
-                $global_message_template_group,
-                $event_ids
-            );
-            return $global_message_template_group;
-        }
-
-        // if we land here that means there's NO active message template group for this set.
-        // TODO this will be a good target for some optimization down the road.  Whenever there is no active message
-        // template group for a given event set then cache that result so we don't repeat the logic.  However, for now,
-        // this should likely bit hit rarely enough that it's not a significant issue.
-        return null;
-    }
-
-
-    /**
-     * This checks the current message in the queue and determines if there is a specific Message Template Group
-     * requested for that message.
-     *
-     * @return EE_Message_Template_Group|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _specific_message_template_group_from_queue()
-    {
-        // is there a GRP_ID already on the EE_Message object?  If there is, then a specific template has been requested
-        // so let's use that.
-        $GRP_ID = $this->_generation_queue->get_message_repository()->current()->GRP_ID();
-
-        if ($GRP_ID) {
-            // attempt to retrieve from repo first
-            $message_template_group = $this->_template_collection->get_by_ID($GRP_ID);
-            if ($message_template_group instanceof EE_Message_Template_Group) {
-                return $message_template_group;  // got it!
-            }
-
-            // nope don't have it yet.  Get from DB then add to repo if its not here, then that means the current GRP_ID
-            // is not valid, so we'll continue on in the code assuming there's NO GRP_ID.
-            $message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
-            if ($message_template_group instanceof EE_Message_Template_Group) {
-                $this->_template_collection->add($message_template_group);
-                return $message_template_group;
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * Returns whether the event ids passed in all share the same message template group for the current message type
-     * and messenger.
-     *
-     * @param array $event_ids
-     * @return bool true means they DO share the same message template group, false means they don't.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _queue_shares_same_message_template_group_for_events(array $event_ids)
-    {
-        foreach ($this->_current_data_handler->events as $event) {
-            $event_ids[ $event['ID'] ] = $event['ID'];
-        }
-        $count_of_message_template_groups = EEM_Message_Template_Group::instance()->count(
-            [
-                [
-                    'Event.EVT_ID'     => ['IN', $event_ids],
-                    'MTP_messenger'    => $this->_current_messenger->name,
-                    'MTP_message_type' => $this->_current_message_type->name,
-                ],
-            ],
-            'GRP_ID',
-            true
-        );
-        return $count_of_message_template_groups === 1;
-    }
-
-
-    /**
-     * This will get the shared message template group for events that are in the current data handler but ONLY if
-     * there's a single shared message template group among all the events.  Otherwise it returns null.
-     *
-     * @param array $event_ids
-     * @return EE_Message_Template_Group|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _get_shared_message_template_for_events(array $event_ids)
-    {
-        $message_template_group = null;
-        if ($this->_queue_shares_same_message_template_group_for_events($event_ids)) {
-            $message_template_group = EEM_Message_Template_Group::instance()->get_one(
-                [
-                    [
-                        'Event.EVT_ID'     => ['IN', $event_ids],
-                        'MTP_messenger'    => $this->_current_messenger->name,
-                        'MTP_message_type' => $this->_current_message_type->name,
-                        'MTP_is_active'    => true,
-                    ],
-                    'group_by' => 'GRP_ID',
-                ]
-            );
-            // store this in the collection if its valid
-            if ($message_template_group instanceof EE_Message_Template_Group) {
-                $this->_template_collection->add(
-                    $message_template_group,
-                    $event_ids
-                );
-            }
-        }
-        return $message_template_group;
-    }
-
-
-    /**
-     * Retrieves the global message template group for the current messenger and message type.
-     *
-     * @return EE_Message_Template_Group|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _get_global_message_template_group_for_current_messenger_and_message_type()
-    {
-        // first check the collection (we use an array with 0 in it to represent global groups).
-        $global_message_template_group = $this->_template_collection->get_by_key(
-            $this->_template_collection->getKey(
-                $this->_current_messenger->name,
-                $this->_current_message_type->name,
-                [0]
-            )
-        );
-
-        // if we don't have a group lets hit the db.
-        if (! $global_message_template_group instanceof EE_Message_Template_Group) {
-            $global_message_template_group = EEM_Message_Template_Group::instance()->get_one(
-                [
-                    [
-                        'MTP_messenger'    => $this->_current_messenger->name,
-                        'MTP_message_type' => $this->_current_message_type->name,
-                        'MTP_is_active'    => true,
-                        'MTP_is_global'    => true,
-                    ],
-                ]
-            );
-            // if we have a group, add it to the collection.
-            if ($global_message_template_group instanceof EE_Message_Template_Group) {
-                $this->_template_collection->add(
-                    $global_message_template_group,
-                    [0]
-                );
-            }
-        }
-        return $global_message_template_group;
-    }
-
-
-    /**
-     * Returns an array of event ids for all the events within the current data handler.
-     *
-     * @return array
-     */
-    protected function _get_event_ids_from_current_data_handler()
-    {
-        $event_ids = [];
-        foreach ($this->_current_data_handler->events as $event) {
-            $event_ids[ $event['ID'] ] = $event['ID'];
-        }
-        return $event_ids;
-    }
-
-
-    /**
-     *  Retrieves formatted array of template information for each context specific to the given
-     *  EE_Message_Template_Group
-     *
-     * @param EE_Message_Template_Group $message_template_group
-     * @return array The returned array is in this structure:
-     *                          array(
-     *                          'field_name' => array(
-     *                          'context' => 'content'
-     *                          )
-     *                          )
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _get_templates(EE_Message_Template_Group $message_template_group)
-    {
-        $templates         = [];
-        $context_templates = $message_template_group->context_templates();
-        foreach ($context_templates as $context => $template_fields) {
-            foreach ($template_fields as $template_field => $template_obj) {
-                if (! $template_obj instanceof EE_Message_Template) {
-                    continue;
-                }
-                $templates[ $template_field ][ $context ] = $template_obj->get('MTP_content');
-            }
-        }
-        return $templates;
-    }
-
-
-    /**
-     * Assembles new fully generated EE_Message objects and adds to _ready_queue
-     *
-     * @param array                     $addressees  Array of EE_Messages_Addressee objects indexed by message type
-     *                                               context.
-     * @param array                     $templates   formatted array of templates used for parsing data.
-     * @param EE_Message_Template_Group $message_template_group
-     * @return bool true if message generation went a-ok.  false if some sort of exception occurred.  Note: The
-     *                                               method will attempt to generate ALL EE_Message objects and add to
-     *                                               the _ready_queue.  Successfully generated messages get added to the
-     *                                               queue with EEM_Message::status_idle, unsuccessfully generated
-     *                                               messages will get added to the queue as EEM_Message::status_failed.
-     *                                               Very rarely should "false" be returned from this method.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidIdentifierException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _assemble_messages($addressees, $templates, EE_Message_Template_Group $message_template_group)
-    {
-
-        // if templates are empty then get out because we can't generate anything.
-        if (! $templates) {
-            $this->_error_msg[] = esc_html__(
-                'Unable to assemble messages because there are no templates retrieved for generating the messages with',
-                'event_espresso'
-            );
-            return false;
-        }
-
-        // We use this as the counter for generated messages because don't forget we may be executing this inside of a
-        // generation_queue.  So _ready_queue may have generated EE_Message objects already.
-        $generated_count = 0;
-        foreach ($addressees as $context => $recipients) {
-            foreach ($recipients as $recipient) {
-                $message = $this->_setup_message_object($context, $recipient, $templates, $message_template_group);
-                if ($message instanceof EE_Message) {
-                    $this->_ready_queue->add(
-                        $message,
-                        [],
-                        $this->_generation_queue->get_message_repository()->is_preview(),
-                        $this->_generation_queue->get_message_repository()->is_test_send()
-                    );
-                    $generated_count++;
-                }
-
-                // if the current MSG being generated is for a test send then we'll only use ONE message in the
-                // generation.
-                if ($this->_generation_queue->get_message_repository()->is_test_send()) {
-                    break 2;
-                }
-            }
-        }
-
-        // if there are no generated messages then something else fatal went wrong.
-        return $generated_count > 0;
-    }
-
-
-    /**
-     * @param string                    $context   The context for the generated message.
-     * @param EE_Messages_Addressee     $recipient
-     * @param array                     $templates formatted array of templates used for parsing data.
-     * @param EE_Message_Template_Group $message_template_group
-     * @return bool|EE_Message
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws InvalidIdentifierException
-     */
-    protected function _setup_message_object(
-        $context,
-        EE_Messages_Addressee $recipient,
-        $templates,
-        EE_Message_Template_Group $message_template_group
-    ) {
-        // stuff we already know
-        $transaction_id = $recipient->txn instanceof EE_Transaction ? $recipient->txn->ID() : 0;
-        $transaction_id = empty($transaction_id) && $this->_current_data_handler->txn instanceof EE_Transaction
-            ? $this->_current_data_handler->txn->ID()
-            : $transaction_id;
-        $message_fields = [
-            'GRP_ID'           => $message_template_group->ID(),
-            'TXN_ID'           => $transaction_id,
-            'MSG_messenger'    => $this->_current_messenger->name,
-            'MSG_message_type' => $this->_current_message_type->name,
-            'MSG_context'      => $context,
-        ];
-
-        // recipient id and type should be on the EE_Messages_Addressee object but if this is empty, let's try to grab
-        // the info from the att_obj found in the EE_Messages_Addressee object.
-        if (empty($recipient->recipient_id) || empty($recipient->recipient_type)) {
-            $message_fields['MSG_recipient_ID']   = $recipient->att_obj instanceof EE_Attendee
-                ? $recipient->att_obj->ID()
-                : 0;
-            $message_fields['MSG_recipient_type'] = 'Attendee';
-        } else {
-            $message_fields['MSG_recipient_ID']   = $recipient->recipient_id;
-            $message_fields['MSG_recipient_type'] = $recipient->recipient_type;
-        }
-        $message = EE_Message_Factory::create($message_fields);
-
-        // grab valid shortcodes for shortcode parser
-        $mt_shortcodes = $this->_current_message_type->get_valid_shortcodes();
-        $m_shortcodes  = $this->_current_messenger->get_valid_shortcodes();
-
-        // if the 'to' field is empty or the context is inactive we skip EXCEPT if we're previewing
-        if (
-            ! $this->_generation_queue->get_message_repository()->is_preview()
-            && (
-                (empty($templates['to'][ $context ]) && ! $this->_current_messenger->allow_empty_to_field())
-                || ! $message_template_group->is_context_active($context)
-            )
-        ) {
-            // we silently exit here and do NOT record a fail because the message is "turned off" by having no "to"
-            // field.
-            return false;
-        }
-        $error_msg = [];
-        foreach ($templates as $field => $field_context) {
-            $error_msg = [];
-            // let's setup the valid shortcodes for the incoming context.
-            $valid_shortcodes = $mt_shortcodes[ $context ];
-            // merge in valid shortcodes for the field.
-            $shortcodes = isset($m_shortcodes[ $field ]) ? $m_shortcodes[ $field ] : $valid_shortcodes;
-            if (isset($field_context[ $context ])) {
-                // prefix field.
-                $column_name = 'MSG_' . $field;
-                try {
-                    $content = $this->_shortcode_parser->parse_message_template(
-                        $field_context[ $context ],
-                        $recipient,
-                        $shortcodes,
-                        $this->_current_message_type,
-                        $this->_current_messenger,
-                        $message
-                    );
-                    // the model field removes slashes when setting (usually necessary when the input is from the
-                    // request) but this value is from another model and has no slashes. So add them so it matches
-                    // what the field expected (otherwise slashes will have been stripped from this an extra time)
-                    $message->set_field_or_extra_meta($column_name, addslashes($content));
-                } catch (EE_Error $e) {
-                    $error_msg[] = sprintf(
-                    /* Translators: First place holder is message model field name.
+	/**
+	 * @type EE_Messages_Data_Handler_Collection
+	 */
+	protected $_data_handler_collection;
+
+	/**
+	 * @type  EE_Message_Template_Group_Collection
+	 */
+	protected $_template_collection;
+
+	/**
+	 * This will hold the data handler for the current EE_Message being generated.
+	 *
+	 * @type EE_Messages_incoming_data
+	 */
+	protected $_current_data_handler;
+
+	/**
+	 * This holds the EE_Messages_Queue that contains the messages to generate.
+	 *
+	 * @type EE_Messages_Queue
+	 */
+	protected $_generation_queue;
+
+	/**
+	 * This holds the EE_Messages_Queue that will store the generated EE_Message objects.
+	 *
+	 * @type EE_Messages_Queue
+	 */
+	protected $_ready_queue;
+
+	/**
+	 * This is a container for any error messages that get created through the generation
+	 * process.
+	 *
+	 * @type array
+	 */
+	protected $_error_msg = [];
+
+	/**
+	 * Flag used to set when the current EE_Message in the generation queue has been verified.
+	 *
+	 * @type bool
+	 */
+	protected $_verified = false;
+
+	/**
+	 * This will hold the current messenger object corresponding with the current EE_Message in the generation queue.
+	 *
+	 * @type EE_messenger
+	 */
+	protected $_current_messenger;
+
+	/**
+	 * This will hold the current message type object corresponding with the current EE_Message in the generation queue.
+	 *
+	 * @type EE_message_type
+	 */
+	protected $_current_message_type;
+
+	/**
+	 * @type EEH_Parse_Shortcodes
+	 */
+	protected $_shortcode_parser;
+
+
+	/**
+	 * @param EE_Messages_Queue                    $generation_queue
+	 * @param EE_Messages_Queue                    $ready_queue
+	 * @param EE_Messages_Data_Handler_Collection  $data_handler_collection
+	 * @param EE_Message_Template_Group_Collection $template_collection
+	 * @param EEH_Parse_Shortcodes                 $shortcode_parser
+	 */
+	public function __construct(
+		EE_Messages_Queue $generation_queue,
+		EE_Messages_Queue $ready_queue,
+		EE_Messages_Data_Handler_Collection $data_handler_collection,
+		EE_Message_Template_Group_Collection $template_collection,
+		EEH_Parse_Shortcodes $shortcode_parser
+	) {
+		$this->_generation_queue        = $generation_queue;
+		$this->_ready_queue             = $ready_queue;
+		$this->_data_handler_collection = $data_handler_collection;
+		$this->_template_collection     = $template_collection;
+		$this->_shortcode_parser        = $shortcode_parser;
+	}
+
+
+	/**
+	 * @return EE_Messages_Queue
+	 */
+	public function generation_queue()
+	{
+		return $this->_generation_queue;
+	}
+
+
+	/**
+	 *  This iterates through the provided queue and generates the EE_Message objects.
+	 *  When iterating through the queue, the queued item that served as the base for generating other EE_Message
+	 *  objects gets removed and the new EE_Message objects get added to a NEW queue.  The NEW queue is then returned
+	 *  for the caller to decide what to do with it.
+	 *
+	 * @param bool $save Whether to save the EE_Message objects in the new queue or just return.
+	 * @return EE_Messages_Queue The new queue for holding generated EE_Message objects.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function generate($save = true)
+	{
+		// iterate through the messages in the queue, generate, and add to new queue.
+		$this->_generation_queue->get_message_repository()->rewind();
+
+		while ($this->_generation_queue->get_message_repository()->valid()) {
+			// reset "current" properties
+			$this->_reset_current_properties();
+
+			$msg = $this->_generation_queue->get_message_repository()->current();
+
+			/**
+			 * need to get the next object and capture it for setting manually after deletes.  The reason is that when
+			 * an object is removed from the repo then valid for the next object will fail.
+			 */
+			$this->_generation_queue->get_message_repository()->next();
+			$next_msg = $this->_generation_queue->get_message_repository()->current();
+			// restore pointer to current item
+			$this->_generation_queue->get_message_repository()->set_current($msg);
+
+			// skip and delete if the current $msg is NOT incomplete (queued for generation)
+			if ($msg->STS_ID() !== EEM_Message::status_incomplete) {
+				// we keep this item in the db just remove from the repo.
+				$this->_generation_queue->get_message_repository()->remove($msg);
+				// next item
+				$this->_generation_queue->get_message_repository()->set_current($next_msg);
+				continue;
+			}
+
+			if ($this->_verify()) {
+				// let's get generating!
+				$this->_generate();
+			}
+
+			// don't persist debug_only messages if the messages system is not in debug mode.
+			if (
+				$msg->STS_ID() === EEM_Message::status_debug_only
+				&& ! EEM_Message::debug()
+			) {
+				do_action(
+					'AHEE__EE_Messages_Generator__generate__before_debug_delete',
+					$msg,
+					$this->_error_msg,
+					$this->_current_messenger,
+					$this->_current_message_type,
+					$this->_current_data_handler
+				);
+				$this->_generation_queue->get_message_repository()->delete();
+				$this->_generation_queue->get_message_repository()->set_current($next_msg);
+				continue;
+			}
+
+			// if there are error messages then let's set the status and the error message.
+			if ($this->_error_msg) {
+				// if the status is already debug only, then let's leave it at that.
+				if ($msg->STS_ID() !== EEM_Message::status_debug_only) {
+					$msg->set_STS_ID(EEM_Message::status_failed);
+				}
+				do_action(
+					'AHEE__EE_Messages_Generator__generate__processing_failed_message',
+					$msg,
+					$this->_error_msg,
+					$this->_current_messenger,
+					$this->_current_message_type,
+					$this->_current_data_handler
+				);
+				$msg->set_error_message(
+					esc_html__('Message failed to generate for the following reasons: ', 'event_espresso')
+					. "\n"
+					. implode("\n", $this->_error_msg)
+				);
+				$msg->set_modified(time());
+			} else {
+				do_action(
+					'AHEE__EE_Messages_Generator__generate__before_successful_generated_message_delete',
+					$msg,
+					$this->_error_msg,
+					$this->_current_messenger,
+					$this->_current_message_type,
+					$this->_current_data_handler
+				);
+				// remove from db
+				$this->_generation_queue->get_message_repository()->delete();
+			}
+			// next item
+			$this->_generation_queue->get_message_repository()->set_current($next_msg);
+		}
+
+		// generation queue is ALWAYS saved to record any errors in the generation process.
+		$this->_generation_queue->save();
+
+		/**
+		 * save _ready_queue if flag set.
+		 * Note: The EE_Message objects have values set via the EE_Base_Class::set_field_or_extra_meta() method.  This
+		 * means if a field was added that is not a valid database column.  The EE_Message was already saved to the db
+		 * so a EE_Extra_Meta entry could be created and attached to the EE_Message.  In those cases the save flag is
+		 * irrelevant.
+		 */
+		if ($save) {
+			$this->_ready_queue->save();
+		}
+
+		// final reset of properties
+		$this->_reset_current_properties();
+
+		return $this->_ready_queue;
+	}
+
+
+	/**
+	 * This resets all the properties used for holding "current" values corresponding to the current EE_Message object
+	 * in the generation queue.
+	 */
+	protected function _reset_current_properties()
+	{
+		$this->_verified = false;
+		// make sure any _data value in the current message type is reset
+		if ($this->_current_message_type instanceof EE_message_type) {
+			$this->_current_message_type->reset_data();
+		}
+		$this->_current_messenger = $this->_current_message_type = $this->_current_data_handler = null;
+	}
+
+
+	/**
+	 * This proceeds with the actual generation of a message.  By the time this is called, there should already be a
+	 * $_current_data_handler set and all incoming information should be validated for the current EE_Message in the
+	 * _generating_queue.
+	 *
+	 * @return bool Whether the message was successfully generated or not.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _generate()
+	{
+		// double check verification has run and that everything is ready to work with (saves us having to validate
+		// everything again).
+		if (! $this->_verified) {
+			return false; // get out because we don't have a valid setup to work with.
+		}
+
+
+		try {
+			$addressees = $this->_current_message_type->get_addressees(
+				$this->_current_data_handler,
+				$this->_generation_queue->get_message_repository()->current()->context()
+			);
+		} catch (EE_Error $e) {
+			$this->_error_msg[] = $e->getMessage();
+			return false;
+		}
+
+
+		// if no addressees then get out because there is nothing to generation (possible bad data).
+		if (! $this->_valid_addressees($addressees)) {
+			do_action(
+				'AHEE__EE_Messages_Generator___generate__invalid_addressees',
+				$this->_generation_queue->get_message_repository()->current(),
+				$addressees,
+				$this->_current_messenger,
+				$this->_current_message_type,
+				$this->_current_data_handler
+			);
+			$this->_generation_queue->get_message_repository()->current()->set_STS_ID(
+				EEM_Message::status_debug_only
+			);
+			$this->_error_msg[] = esc_html__(
+				'This is not a critical error but an informational notice. Unable to generate messages EE_Messages_Addressee objects.  There were no attendees prepared by the data handler. Sometimes this is because messages only get generated for certain registration statuses. For example, the ticket notice message type only goes to approved registrations.',
+				'event_espresso'
+			);
+			return false;
+		}
+
+		$message_template_group = $this->_get_message_template_group();
+
+		// in the unlikely event there is no EE_Message_Template_Group available, get out!
+		if (! $message_template_group instanceof EE_Message_Template_Group) {
+			$this->_error_msg[] = esc_html__(
+				'Unable to get the Message Templates for the Message being generated.  No message template group accessible.',
+				'event_espresso'
+			);
+			return false;
+		}
+
+		// get formatted templates for using to parse and setup EE_Message objects.
+		$templates = $this->_get_templates($message_template_group);
+
+
+		// setup new EE_Message objects (and add to _ready_queue)
+		return $this->_assemble_messages($addressees, $templates, $message_template_group);
+	}
+
+
+	/**
+	 * Retrieves the message template group being used for generating messages.
+	 * Note: this also utilizes the EE_Message_Template_Group_Collection to avoid having to hit the db multiple times.
+	 *
+	 * @return EE_Message_Template_Group|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _get_message_template_group()
+	{
+		// first see if there is a specific message template group requested
+		// (current message in the queue has a specific GRP_ID)
+		$message_template_group = $this->_specific_message_template_group_from_queue();
+		if ($message_template_group instanceof EE_Message_Template_Group) {
+			return $message_template_group;
+		}
+
+		// get event_ids from the data handler so we can check to see
+		// if there's already a message template group for them in the collection.
+		$event_ids              = $this->_get_event_ids_from_current_data_handler();
+		$message_template_group = $this->_template_collection->get_by_key(
+			$this->_template_collection->getKey(
+				$this->_current_messenger->name,
+				$this->_current_message_type->name,
+				$event_ids
+			)
+		);
+
+		// if we have a message template group then no need to hit the database, just return it.
+		if ($message_template_group instanceof EE_Message_Template_Group) {
+			return $message_template_group;
+		}
+
+		// get the global group first for this messenger and message type
+		// to ensure there is no override set.
+		$global_message_template_group =
+			$this->_get_global_message_template_group_for_current_messenger_and_message_type();
+
+		if (
+			$global_message_template_group instanceof EE_Message_Template_Group
+			&& $global_message_template_group->get('MTP_is_override')
+		) {
+			return $global_message_template_group;
+		}
+
+		// if we're still here, that means there was no message template group for the events in the collection and
+		// the global message template group for the messenger and message type is not set for override.  So next step
+		// is to see if there is a common shared custom message template group for this set of events.
+		$message_template_group = $this->_get_shared_message_template_for_events($event_ids);
+		if ($message_template_group instanceof EE_Message_Template_Group) {
+			return $message_template_group;
+		}
+
+		// STILL here?  Okay that means the fallback is to just use the global message template group for this event
+		// set. So we'll cache the global group for this event set (so this logic doesn't have to be repeated in this
+		// request) and return it.
+		if ($global_message_template_group instanceof EE_Message_Template_Group) {
+			$this->_template_collection->add(
+				$global_message_template_group,
+				$event_ids
+			);
+			return $global_message_template_group;
+		}
+
+		// if we land here that means there's NO active message template group for this set.
+		// TODO this will be a good target for some optimization down the road.  Whenever there is no active message
+		// template group for a given event set then cache that result so we don't repeat the logic.  However, for now,
+		// this should likely bit hit rarely enough that it's not a significant issue.
+		return null;
+	}
+
+
+	/**
+	 * This checks the current message in the queue and determines if there is a specific Message Template Group
+	 * requested for that message.
+	 *
+	 * @return EE_Message_Template_Group|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _specific_message_template_group_from_queue()
+	{
+		// is there a GRP_ID already on the EE_Message object?  If there is, then a specific template has been requested
+		// so let's use that.
+		$GRP_ID = $this->_generation_queue->get_message_repository()->current()->GRP_ID();
+
+		if ($GRP_ID) {
+			// attempt to retrieve from repo first
+			$message_template_group = $this->_template_collection->get_by_ID($GRP_ID);
+			if ($message_template_group instanceof EE_Message_Template_Group) {
+				return $message_template_group;  // got it!
+			}
+
+			// nope don't have it yet.  Get from DB then add to repo if its not here, then that means the current GRP_ID
+			// is not valid, so we'll continue on in the code assuming there's NO GRP_ID.
+			$message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
+			if ($message_template_group instanceof EE_Message_Template_Group) {
+				$this->_template_collection->add($message_template_group);
+				return $message_template_group;
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * Returns whether the event ids passed in all share the same message template group for the current message type
+	 * and messenger.
+	 *
+	 * @param array $event_ids
+	 * @return bool true means they DO share the same message template group, false means they don't.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _queue_shares_same_message_template_group_for_events(array $event_ids)
+	{
+		foreach ($this->_current_data_handler->events as $event) {
+			$event_ids[ $event['ID'] ] = $event['ID'];
+		}
+		$count_of_message_template_groups = EEM_Message_Template_Group::instance()->count(
+			[
+				[
+					'Event.EVT_ID'     => ['IN', $event_ids],
+					'MTP_messenger'    => $this->_current_messenger->name,
+					'MTP_message_type' => $this->_current_message_type->name,
+				],
+			],
+			'GRP_ID',
+			true
+		);
+		return $count_of_message_template_groups === 1;
+	}
+
+
+	/**
+	 * This will get the shared message template group for events that are in the current data handler but ONLY if
+	 * there's a single shared message template group among all the events.  Otherwise it returns null.
+	 *
+	 * @param array $event_ids
+	 * @return EE_Message_Template_Group|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _get_shared_message_template_for_events(array $event_ids)
+	{
+		$message_template_group = null;
+		if ($this->_queue_shares_same_message_template_group_for_events($event_ids)) {
+			$message_template_group = EEM_Message_Template_Group::instance()->get_one(
+				[
+					[
+						'Event.EVT_ID'     => ['IN', $event_ids],
+						'MTP_messenger'    => $this->_current_messenger->name,
+						'MTP_message_type' => $this->_current_message_type->name,
+						'MTP_is_active'    => true,
+					],
+					'group_by' => 'GRP_ID',
+				]
+			);
+			// store this in the collection if its valid
+			if ($message_template_group instanceof EE_Message_Template_Group) {
+				$this->_template_collection->add(
+					$message_template_group,
+					$event_ids
+				);
+			}
+		}
+		return $message_template_group;
+	}
+
+
+	/**
+	 * Retrieves the global message template group for the current messenger and message type.
+	 *
+	 * @return EE_Message_Template_Group|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _get_global_message_template_group_for_current_messenger_and_message_type()
+	{
+		// first check the collection (we use an array with 0 in it to represent global groups).
+		$global_message_template_group = $this->_template_collection->get_by_key(
+			$this->_template_collection->getKey(
+				$this->_current_messenger->name,
+				$this->_current_message_type->name,
+				[0]
+			)
+		);
+
+		// if we don't have a group lets hit the db.
+		if (! $global_message_template_group instanceof EE_Message_Template_Group) {
+			$global_message_template_group = EEM_Message_Template_Group::instance()->get_one(
+				[
+					[
+						'MTP_messenger'    => $this->_current_messenger->name,
+						'MTP_message_type' => $this->_current_message_type->name,
+						'MTP_is_active'    => true,
+						'MTP_is_global'    => true,
+					],
+				]
+			);
+			// if we have a group, add it to the collection.
+			if ($global_message_template_group instanceof EE_Message_Template_Group) {
+				$this->_template_collection->add(
+					$global_message_template_group,
+					[0]
+				);
+			}
+		}
+		return $global_message_template_group;
+	}
+
+
+	/**
+	 * Returns an array of event ids for all the events within the current data handler.
+	 *
+	 * @return array
+	 */
+	protected function _get_event_ids_from_current_data_handler()
+	{
+		$event_ids = [];
+		foreach ($this->_current_data_handler->events as $event) {
+			$event_ids[ $event['ID'] ] = $event['ID'];
+		}
+		return $event_ids;
+	}
+
+
+	/**
+	 *  Retrieves formatted array of template information for each context specific to the given
+	 *  EE_Message_Template_Group
+	 *
+	 * @param EE_Message_Template_Group $message_template_group
+	 * @return array The returned array is in this structure:
+	 *                          array(
+	 *                          'field_name' => array(
+	 *                          'context' => 'content'
+	 *                          )
+	 *                          )
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _get_templates(EE_Message_Template_Group $message_template_group)
+	{
+		$templates         = [];
+		$context_templates = $message_template_group->context_templates();
+		foreach ($context_templates as $context => $template_fields) {
+			foreach ($template_fields as $template_field => $template_obj) {
+				if (! $template_obj instanceof EE_Message_Template) {
+					continue;
+				}
+				$templates[ $template_field ][ $context ] = $template_obj->get('MTP_content');
+			}
+		}
+		return $templates;
+	}
+
+
+	/**
+	 * Assembles new fully generated EE_Message objects and adds to _ready_queue
+	 *
+	 * @param array                     $addressees  Array of EE_Messages_Addressee objects indexed by message type
+	 *                                               context.
+	 * @param array                     $templates   formatted array of templates used for parsing data.
+	 * @param EE_Message_Template_Group $message_template_group
+	 * @return bool true if message generation went a-ok.  false if some sort of exception occurred.  Note: The
+	 *                                               method will attempt to generate ALL EE_Message objects and add to
+	 *                                               the _ready_queue.  Successfully generated messages get added to the
+	 *                                               queue with EEM_Message::status_idle, unsuccessfully generated
+	 *                                               messages will get added to the queue as EEM_Message::status_failed.
+	 *                                               Very rarely should "false" be returned from this method.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _assemble_messages($addressees, $templates, EE_Message_Template_Group $message_template_group)
+	{
+
+		// if templates are empty then get out because we can't generate anything.
+		if (! $templates) {
+			$this->_error_msg[] = esc_html__(
+				'Unable to assemble messages because there are no templates retrieved for generating the messages with',
+				'event_espresso'
+			);
+			return false;
+		}
+
+		// We use this as the counter for generated messages because don't forget we may be executing this inside of a
+		// generation_queue.  So _ready_queue may have generated EE_Message objects already.
+		$generated_count = 0;
+		foreach ($addressees as $context => $recipients) {
+			foreach ($recipients as $recipient) {
+				$message = $this->_setup_message_object($context, $recipient, $templates, $message_template_group);
+				if ($message instanceof EE_Message) {
+					$this->_ready_queue->add(
+						$message,
+						[],
+						$this->_generation_queue->get_message_repository()->is_preview(),
+						$this->_generation_queue->get_message_repository()->is_test_send()
+					);
+					$generated_count++;
+				}
+
+				// if the current MSG being generated is for a test send then we'll only use ONE message in the
+				// generation.
+				if ($this->_generation_queue->get_message_repository()->is_test_send()) {
+					break 2;
+				}
+			}
+		}
+
+		// if there are no generated messages then something else fatal went wrong.
+		return $generated_count > 0;
+	}
+
+
+	/**
+	 * @param string                    $context   The context for the generated message.
+	 * @param EE_Messages_Addressee     $recipient
+	 * @param array                     $templates formatted array of templates used for parsing data.
+	 * @param EE_Message_Template_Group $message_template_group
+	 * @return bool|EE_Message
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws InvalidIdentifierException
+	 */
+	protected function _setup_message_object(
+		$context,
+		EE_Messages_Addressee $recipient,
+		$templates,
+		EE_Message_Template_Group $message_template_group
+	) {
+		// stuff we already know
+		$transaction_id = $recipient->txn instanceof EE_Transaction ? $recipient->txn->ID() : 0;
+		$transaction_id = empty($transaction_id) && $this->_current_data_handler->txn instanceof EE_Transaction
+			? $this->_current_data_handler->txn->ID()
+			: $transaction_id;
+		$message_fields = [
+			'GRP_ID'           => $message_template_group->ID(),
+			'TXN_ID'           => $transaction_id,
+			'MSG_messenger'    => $this->_current_messenger->name,
+			'MSG_message_type' => $this->_current_message_type->name,
+			'MSG_context'      => $context,
+		];
+
+		// recipient id and type should be on the EE_Messages_Addressee object but if this is empty, let's try to grab
+		// the info from the att_obj found in the EE_Messages_Addressee object.
+		if (empty($recipient->recipient_id) || empty($recipient->recipient_type)) {
+			$message_fields['MSG_recipient_ID']   = $recipient->att_obj instanceof EE_Attendee
+				? $recipient->att_obj->ID()
+				: 0;
+			$message_fields['MSG_recipient_type'] = 'Attendee';
+		} else {
+			$message_fields['MSG_recipient_ID']   = $recipient->recipient_id;
+			$message_fields['MSG_recipient_type'] = $recipient->recipient_type;
+		}
+		$message = EE_Message_Factory::create($message_fields);
+
+		// grab valid shortcodes for shortcode parser
+		$mt_shortcodes = $this->_current_message_type->get_valid_shortcodes();
+		$m_shortcodes  = $this->_current_messenger->get_valid_shortcodes();
+
+		// if the 'to' field is empty or the context is inactive we skip EXCEPT if we're previewing
+		if (
+			! $this->_generation_queue->get_message_repository()->is_preview()
+			&& (
+				(empty($templates['to'][ $context ]) && ! $this->_current_messenger->allow_empty_to_field())
+				|| ! $message_template_group->is_context_active($context)
+			)
+		) {
+			// we silently exit here and do NOT record a fail because the message is "turned off" by having no "to"
+			// field.
+			return false;
+		}
+		$error_msg = [];
+		foreach ($templates as $field => $field_context) {
+			$error_msg = [];
+			// let's setup the valid shortcodes for the incoming context.
+			$valid_shortcodes = $mt_shortcodes[ $context ];
+			// merge in valid shortcodes for the field.
+			$shortcodes = isset($m_shortcodes[ $field ]) ? $m_shortcodes[ $field ] : $valid_shortcodes;
+			if (isset($field_context[ $context ])) {
+				// prefix field.
+				$column_name = 'MSG_' . $field;
+				try {
+					$content = $this->_shortcode_parser->parse_message_template(
+						$field_context[ $context ],
+						$recipient,
+						$shortcodes,
+						$this->_current_message_type,
+						$this->_current_messenger,
+						$message
+					);
+					// the model field removes slashes when setting (usually necessary when the input is from the
+					// request) but this value is from another model and has no slashes. So add them so it matches
+					// what the field expected (otherwise slashes will have been stripped from this an extra time)
+					$message->set_field_or_extra_meta($column_name, addslashes($content));
+				} catch (EE_Error $e) {
+					$error_msg[] = sprintf(
+					/* Translators: First place holder is message model field name.
                      * Second placeholder is exception error message */
-                        esc_html__(
-                            'There was a problem generating the content for the field %s: %s',
-                            'event_espresso'
-                        ),
-                        $field,
-                        $e->getMessage()
-                    );
-                    $message->set_STS_ID(EEM_Message::status_failed);
-                }
-            }
-        }
-
-        if ($message->STS_ID() === EEM_Message::status_failed) {
-            $error_msg = esc_html__('There were problems generating this message:', 'event_espresso')
-                         . "\n"
-                         . implode("\n", $error_msg);
-            $message->set_error_message($error_msg);
-        } else {
-            $message->set_STS_ID(EEM_Message::status_idle);
-        }
-        return $message;
-    }
-
-
-    /**
-     * This verifies that the incoming array has a EE_messenger object and a EE_message_type object and sets appropriate
-     * error message if either is missing.
-     *
-     * @return bool true means there were no errors, false means there were errors.
-     */
-    protected function _verify()
-    {
-        // reset error message to an empty array.
-        $this->_error_msg = [];
-        // set the verified flag so we know everything has been validated.
-        $this->_verified = $this->_validate_messenger_and_message_type() && $this->_validate_and_setup_data();
-        return $this->_verified;
-    }
-
-
-    /**
-     * This accepts an array and validates that it is an array indexed by context with each value being an array of
-     * EE_Messages_Addressee objects.
-     *
-     * @param array $addressees Keys correspond to contexts for the message type and values are EE_Messages_Addressee[]
-     * @return bool
-     */
-    protected function _valid_addressees($addressees)
-    {
-        if (! $addressees || ! is_array($addressees)) {
-            return false;
-        }
-
-        foreach ($addressees as $addressee_array) {
-            foreach ($addressee_array as $addressee) {
-                if (! $addressee instanceof EE_Messages_Addressee) {
-                    return false;
-                }
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * This validates the messenger, message type, and presences of generation data for the current EE_Message in the
-     * queue. This process sets error messages if something is wrong.
-     *
-     * @return bool   true is if there are no errors.  false is if there is.
-     */
-    protected function _validate_messenger_and_message_type()
-    {
-        // first are there any existing error messages?  If so then return.
-        if ($this->_error_msg) {
-            return false;
-        }
-        $message = $this->_generation_queue->get_message_repository()->current();
-        try {
-            $this->_current_messenger = $message->valid_messenger(true)
-                ? $message->messenger_object()
-                : null;
-        } catch (Exception $e) {
-            $this->_error_msg[] = $e->getMessage();
-        }
-        try {
-            $this->_current_message_type = $message->valid_message_type(true)
-                ? $message->message_type_object()
-                : null;
-        } catch (Exception $e) {
-            $this->_error_msg[] = $e->getMessage();
-        }
-
-        /**
-         * Check if there is any generation data, but only if this is not for a preview.
-         */
-        if (
-            ! $this->_generation_queue->get_message_repository()->get_generation_data()
-            && (
-                ! $this->_generation_queue->get_message_repository()->is_preview()
-                && $this->_generation_queue->get_message_repository()->get_data_handler()
-                   !== 'EE_Messages_Preview_incoming_data'
-            )
-        ) {
-            $this->_error_msg[] = esc_html__(
-                'There is no generation data for this message. Unable to generate.',
-                'event_espresso'
-            );
-        }
-
-        return empty($this->_error_msg);
-    }
-
-
-    /**
-     * This method retrieves the expected data handler for the message type and validates the generation data for that
-     * data handler.
-     *
-     * @return bool true means there are no errors.  false means there were errors (and handler did not get setup).
-     */
-    protected function _validate_and_setup_data()
-    {
-
-        // First, are there any existing error messages?  If so, return because if there were errors elsewhere this
-        // can't be used anyways.
-        if ($this->_error_msg) {
-            return false;
-        }
-
-        $generation_data = $this->_generation_queue->get_message_repository()->get_generation_data();
-
-        /** @type EE_Messages_incoming_data $data_handler_class_name - well not really... just the class name actually */
-        $data_handler_class_name = $this->_generation_queue->get_message_repository()->get_data_handler()
-            ? $this->_generation_queue->get_message_repository()->get_data_handler()
-            : 'EE_Messages_' . $this->_current_message_type->get_data_handler($generation_data) . '_incoming_data';
-
-        // If this EE_Message is for a preview, then let's switch out to the preview data handler.
-        if ($this->_generation_queue->get_message_repository()->is_preview()) {
-            $data_handler_class_name = 'EE_Messages_Preview_incoming_data';
-        }
-
-        // First get the class name for the data handler (and also verifies it exists.
-        if (! class_exists($data_handler_class_name)) {
-            $this->_error_msg[] = sprintf(
-            /* Translators: Both placeholders are the names of php classes. */
-                esc_html__(
-                    'The included data handler class name does not match any valid, accessible, "%1$s" classes.  Looking for %2$s.',
-                    'event_espresso'
-                ),
-                'EE_Messages_incoming_data',
-                $data_handler_class_name
-            );
-            return false;
-        }
-
-        // convert generation_data for data_handler_instantiation.
-        $generation_data = $data_handler_class_name::convert_data_from_persistent_storage($generation_data);
-
-        // note, this may set error messages as well.
-        $this->_set_data_handler($generation_data, $data_handler_class_name);
-
-        return empty($this->_error_msg);
-    }
-
-
-    /**
-     * Sets the $_current_data_handler property that is used for generating the current EE_Message in the queue, and
-     * adds it to the _data repository.
-     *
-     * @param mixed  $generating_data           This is data expected by the instantiated data handler.
-     * @param string $data_handler_class_name   This is the reference string indicating what data handler is being
-     *                                          instantiated.
-     */
-    protected function _set_data_handler($generating_data, $data_handler_class_name)
-    {
-        // valid classname for the data handler.  Now let's setup the key for the data handler repository to see if
-        // there is already a ready data handler in the repository.
-        $this->_current_data_handler = $this->_data_handler_collection->get_by_key(
-            $this->_data_handler_collection->get_key(
-                $data_handler_class_name,
-                $generating_data
-            )
-        );
-        if (! $this->_current_data_handler instanceof EE_Messages_incoming_data) {
-            // no saved data_handler in the repo so let's set one up and add it to the repo.
-            try {
-                $this->_current_data_handler = new $data_handler_class_name($generating_data);
-                $this->_data_handler_collection->add($this->_current_data_handler, $generating_data);
-            } catch (Exception $e) {
-                $this->_error_msg[] = $e->getMessage();
-            }
-        }
-    }
-
-
-    /**
-     * The queued EE_Message for generation does not save the data used for generation as objects
-     * because serialization of those objects could be problematic if the data is saved to the db.
-     * So this method calls the static method on the associated data_handler for the given message_type
-     * and that preps the data for later instantiation when generating.
-     *
-     * @param EE_Message_To_Generate $message_to_generate
-     * @param bool                   $preview Indicate whether this is being used for a preview or not.
-     * @return mixed Prepped data for persisting to the queue.  false is returned if unable to prep data.
-     */
-    protected function _prepare_data_for_queue(EE_Message_To_Generate $message_to_generate, $preview)
-    {
-        if (! $message_to_generate->valid()) {
-            return false; // unable to get the data because the info in the EE_Message_To_Generate class is invalid.
-        }
-        /** @type EE_Messages_incoming_data $data_handler - well not really... just the class name actually */
-        $data_handler = $message_to_generate->get_data_handler_class_name($preview);
-        return $data_handler::convert_data_for_persistent_storage($message_to_generate->data());
-    }
-
-
-    /**
-     * This sets up a EEM_Message::status_incomplete EE_Message object and adds it to the generation queue.
-     *
-     * @param EE_Message_To_Generate $message_to_generate
-     * @param bool                   $test_send Whether this is just a test send or not.  Typically used for previews.
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function create_and_add_message_to_queue(EE_Message_To_Generate $message_to_generate, $test_send = false)
-    {
-        // prep data
-        $data    = $this->_prepare_data_for_queue($message_to_generate, $message_to_generate->preview());
-        $request = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\RequestInterface');
-
-        $message = $message_to_generate->get_EE_Message();
-        $GRP_ID  = $request->getRequestParam('GRP_ID', 0, 'int');
-
-        $GRP_ID = apply_filters(
-            'FHEE__EE_Messages_Generator__create_and_add_message_to_queue_GRP_ID',
-            $GRP_ID > 0 ? $GRP_ID : $message->GRP_ID(),
-            $message,
-            $message_to_generate,
-            $test_send
-        );
-
-        if ($GRP_ID > 0) {
-            $message->set_GRP_ID($GRP_ID);
-        }
-
-        if ($data === false) {
-            $message->set_STS_ID(EEM_Message::status_failed);
-            $message->set_error_message(
-                esc_html__(
-                    'Unable to prepare data for persistence to the database.',
-                    'event_espresso'
-                )
-            );
-        } else {
-            // make sure that the data handler is cached on the message as well
-            $data['data_handler_class_name'] = $message_to_generate->get_data_handler_class_name();
-        }
-
-        return $this->_generation_queue->add($message, $data, $message_to_generate->preview(), $test_send);
-    }
+						esc_html__(
+							'There was a problem generating the content for the field %s: %s',
+							'event_espresso'
+						),
+						$field,
+						$e->getMessage()
+					);
+					$message->set_STS_ID(EEM_Message::status_failed);
+				}
+			}
+		}
+
+		if ($message->STS_ID() === EEM_Message::status_failed) {
+			$error_msg = esc_html__('There were problems generating this message:', 'event_espresso')
+						 . "\n"
+						 . implode("\n", $error_msg);
+			$message->set_error_message($error_msg);
+		} else {
+			$message->set_STS_ID(EEM_Message::status_idle);
+		}
+		return $message;
+	}
+
+
+	/**
+	 * This verifies that the incoming array has a EE_messenger object and a EE_message_type object and sets appropriate
+	 * error message if either is missing.
+	 *
+	 * @return bool true means there were no errors, false means there were errors.
+	 */
+	protected function _verify()
+	{
+		// reset error message to an empty array.
+		$this->_error_msg = [];
+		// set the verified flag so we know everything has been validated.
+		$this->_verified = $this->_validate_messenger_and_message_type() && $this->_validate_and_setup_data();
+		return $this->_verified;
+	}
+
+
+	/**
+	 * This accepts an array and validates that it is an array indexed by context with each value being an array of
+	 * EE_Messages_Addressee objects.
+	 *
+	 * @param array $addressees Keys correspond to contexts for the message type and values are EE_Messages_Addressee[]
+	 * @return bool
+	 */
+	protected function _valid_addressees($addressees)
+	{
+		if (! $addressees || ! is_array($addressees)) {
+			return false;
+		}
+
+		foreach ($addressees as $addressee_array) {
+			foreach ($addressee_array as $addressee) {
+				if (! $addressee instanceof EE_Messages_Addressee) {
+					return false;
+				}
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * This validates the messenger, message type, and presences of generation data for the current EE_Message in the
+	 * queue. This process sets error messages if something is wrong.
+	 *
+	 * @return bool   true is if there are no errors.  false is if there is.
+	 */
+	protected function _validate_messenger_and_message_type()
+	{
+		// first are there any existing error messages?  If so then return.
+		if ($this->_error_msg) {
+			return false;
+		}
+		$message = $this->_generation_queue->get_message_repository()->current();
+		try {
+			$this->_current_messenger = $message->valid_messenger(true)
+				? $message->messenger_object()
+				: null;
+		} catch (Exception $e) {
+			$this->_error_msg[] = $e->getMessage();
+		}
+		try {
+			$this->_current_message_type = $message->valid_message_type(true)
+				? $message->message_type_object()
+				: null;
+		} catch (Exception $e) {
+			$this->_error_msg[] = $e->getMessage();
+		}
+
+		/**
+		 * Check if there is any generation data, but only if this is not for a preview.
+		 */
+		if (
+			! $this->_generation_queue->get_message_repository()->get_generation_data()
+			&& (
+				! $this->_generation_queue->get_message_repository()->is_preview()
+				&& $this->_generation_queue->get_message_repository()->get_data_handler()
+				   !== 'EE_Messages_Preview_incoming_data'
+			)
+		) {
+			$this->_error_msg[] = esc_html__(
+				'There is no generation data for this message. Unable to generate.',
+				'event_espresso'
+			);
+		}
+
+		return empty($this->_error_msg);
+	}
+
+
+	/**
+	 * This method retrieves the expected data handler for the message type and validates the generation data for that
+	 * data handler.
+	 *
+	 * @return bool true means there are no errors.  false means there were errors (and handler did not get setup).
+	 */
+	protected function _validate_and_setup_data()
+	{
+
+		// First, are there any existing error messages?  If so, return because if there were errors elsewhere this
+		// can't be used anyways.
+		if ($this->_error_msg) {
+			return false;
+		}
+
+		$generation_data = $this->_generation_queue->get_message_repository()->get_generation_data();
+
+		/** @type EE_Messages_incoming_data $data_handler_class_name - well not really... just the class name actually */
+		$data_handler_class_name = $this->_generation_queue->get_message_repository()->get_data_handler()
+			? $this->_generation_queue->get_message_repository()->get_data_handler()
+			: 'EE_Messages_' . $this->_current_message_type->get_data_handler($generation_data) . '_incoming_data';
+
+		// If this EE_Message is for a preview, then let's switch out to the preview data handler.
+		if ($this->_generation_queue->get_message_repository()->is_preview()) {
+			$data_handler_class_name = 'EE_Messages_Preview_incoming_data';
+		}
+
+		// First get the class name for the data handler (and also verifies it exists.
+		if (! class_exists($data_handler_class_name)) {
+			$this->_error_msg[] = sprintf(
+			/* Translators: Both placeholders are the names of php classes. */
+				esc_html__(
+					'The included data handler class name does not match any valid, accessible, "%1$s" classes.  Looking for %2$s.',
+					'event_espresso'
+				),
+				'EE_Messages_incoming_data',
+				$data_handler_class_name
+			);
+			return false;
+		}
+
+		// convert generation_data for data_handler_instantiation.
+		$generation_data = $data_handler_class_name::convert_data_from_persistent_storage($generation_data);
+
+		// note, this may set error messages as well.
+		$this->_set_data_handler($generation_data, $data_handler_class_name);
+
+		return empty($this->_error_msg);
+	}
+
+
+	/**
+	 * Sets the $_current_data_handler property that is used for generating the current EE_Message in the queue, and
+	 * adds it to the _data repository.
+	 *
+	 * @param mixed  $generating_data           This is data expected by the instantiated data handler.
+	 * @param string $data_handler_class_name   This is the reference string indicating what data handler is being
+	 *                                          instantiated.
+	 */
+	protected function _set_data_handler($generating_data, $data_handler_class_name)
+	{
+		// valid classname for the data handler.  Now let's setup the key for the data handler repository to see if
+		// there is already a ready data handler in the repository.
+		$this->_current_data_handler = $this->_data_handler_collection->get_by_key(
+			$this->_data_handler_collection->get_key(
+				$data_handler_class_name,
+				$generating_data
+			)
+		);
+		if (! $this->_current_data_handler instanceof EE_Messages_incoming_data) {
+			// no saved data_handler in the repo so let's set one up and add it to the repo.
+			try {
+				$this->_current_data_handler = new $data_handler_class_name($generating_data);
+				$this->_data_handler_collection->add($this->_current_data_handler, $generating_data);
+			} catch (Exception $e) {
+				$this->_error_msg[] = $e->getMessage();
+			}
+		}
+	}
+
+
+	/**
+	 * The queued EE_Message for generation does not save the data used for generation as objects
+	 * because serialization of those objects could be problematic if the data is saved to the db.
+	 * So this method calls the static method on the associated data_handler for the given message_type
+	 * and that preps the data for later instantiation when generating.
+	 *
+	 * @param EE_Message_To_Generate $message_to_generate
+	 * @param bool                   $preview Indicate whether this is being used for a preview or not.
+	 * @return mixed Prepped data for persisting to the queue.  false is returned if unable to prep data.
+	 */
+	protected function _prepare_data_for_queue(EE_Message_To_Generate $message_to_generate, $preview)
+	{
+		if (! $message_to_generate->valid()) {
+			return false; // unable to get the data because the info in the EE_Message_To_Generate class is invalid.
+		}
+		/** @type EE_Messages_incoming_data $data_handler - well not really... just the class name actually */
+		$data_handler = $message_to_generate->get_data_handler_class_name($preview);
+		return $data_handler::convert_data_for_persistent_storage($message_to_generate->data());
+	}
+
+
+	/**
+	 * This sets up a EEM_Message::status_incomplete EE_Message object and adds it to the generation queue.
+	 *
+	 * @param EE_Message_To_Generate $message_to_generate
+	 * @param bool                   $test_send Whether this is just a test send or not.  Typically used for previews.
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function create_and_add_message_to_queue(EE_Message_To_Generate $message_to_generate, $test_send = false)
+	{
+		// prep data
+		$data    = $this->_prepare_data_for_queue($message_to_generate, $message_to_generate->preview());
+		$request = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\RequestInterface');
+
+		$message = $message_to_generate->get_EE_Message();
+		$GRP_ID  = $request->getRequestParam('GRP_ID', 0, 'int');
+
+		$GRP_ID = apply_filters(
+			'FHEE__EE_Messages_Generator__create_and_add_message_to_queue_GRP_ID',
+			$GRP_ID > 0 ? $GRP_ID : $message->GRP_ID(),
+			$message,
+			$message_to_generate,
+			$test_send
+		);
+
+		if ($GRP_ID > 0) {
+			$message->set_GRP_ID($GRP_ID);
+		}
+
+		if ($data === false) {
+			$message->set_STS_ID(EEM_Message::status_failed);
+			$message->set_error_message(
+				esc_html__(
+					'Unable to prepare data for persistence to the database.',
+					'event_espresso'
+				)
+			);
+		} else {
+			// make sure that the data handler is cached on the message as well
+			$data['data_handler_class_name'] = $message_to_generate->get_data_handler_class_name();
+		}
+
+		return $this->_generation_queue->add($message, $data, $message_to_generate->preview(), $test_send);
+	}
 }

Spacing +22 added lines, -22 removed lines

@@ -266,7 +266,7 @@ 
     {
         // double check verification has run and that everything is ready to work with (saves us having to validate
         // everything again).
-        if (! $this->_verified) {
+        if ( ! $this->_verified) {
             return false; // get out because we don't have a valid setup to work with.
         }
 
@@ -283,7 +283,7 @@ 
 
 
         // if no addressees then get out because there is nothing to generation (possible bad data).
-        if (! $this->_valid_addressees($addressees)) {
+        if ( ! $this->_valid_addressees($addressees)) {
             do_action(
                 'AHEE__EE_Messages_Generator___generate__invalid_addressees',
                 $this->_generation_queue->get_message_repository()->current(),
@@ -305,7 +305,7 @@ 
         $message_template_group = $this->_get_message_template_group();
 
         // in the unlikely event there is no EE_Message_Template_Group available, get out!
-        if (! $message_template_group instanceof EE_Message_Template_Group) {
+        if ( ! $message_template_group instanceof EE_Message_Template_Group) {
             $this->_error_msg[] = esc_html__(
                 'Unable to get the Message Templates for the Message being generated.  No message template group accessible.',
                 'event_espresso'
@@ -417,7 +417,7 @@ 
             // attempt to retrieve from repo first
             $message_template_group = $this->_template_collection->get_by_ID($GRP_ID);
             if ($message_template_group instanceof EE_Message_Template_Group) {
-                return $message_template_group;  // got it!
+                return $message_template_group; // got it!
             }
 
             // nope don't have it yet.  Get from DB then add to repo if its not here, then that means the current GRP_ID
@@ -446,7 +446,7 @@ 
     protected function _queue_shares_same_message_template_group_for_events(array $event_ids)
     {
         foreach ($this->_current_data_handler->events as $event) {
-            $event_ids[ $event['ID'] ] = $event['ID'];
+            $event_ids[$event['ID']] = $event['ID'];
         }
         $count_of_message_template_groups = EEM_Message_Template_Group::instance()->count(
             [
@@ -522,7 +522,7 @@ 
         );
 
         // if we don't have a group lets hit the db.
-        if (! $global_message_template_group instanceof EE_Message_Template_Group) {
+        if ( ! $global_message_template_group instanceof EE_Message_Template_Group) {
             $global_message_template_group = EEM_Message_Template_Group::instance()->get_one(
                 [
                     [
@@ -554,7 +554,7 @@ 
     {
         $event_ids = [];
         foreach ($this->_current_data_handler->events as $event) {
-            $event_ids[ $event['ID'] ] = $event['ID'];
+            $event_ids[$event['ID']] = $event['ID'];
         }
         return $event_ids;
     }
@@ -583,10 +583,10 @@ 
         $context_templates = $message_template_group->context_templates();
         foreach ($context_templates as $context => $template_fields) {
             foreach ($template_fields as $template_field => $template_obj) {
-                if (! $template_obj instanceof EE_Message_Template) {
+                if ( ! $template_obj instanceof EE_Message_Template) {
                     continue;
                 }
-                $templates[ $template_field ][ $context ] = $template_obj->get('MTP_content');
+                $templates[$template_field][$context] = $template_obj->get('MTP_content');
             }
         }
         return $templates;
@@ -617,7 +617,7 @@ 
     {
 
         // if templates are empty then get out because we can't generate anything.
-        if (! $templates) {
+        if ( ! $templates) {
             $this->_error_msg[] = esc_html__(
                 'Unable to assemble messages because there are no templates retrieved for generating the messages with',
                 'event_espresso'
@@ -707,7 +707,7 @@ 
         if (
             ! $this->_generation_queue->get_message_repository()->is_preview()
             && (
-                (empty($templates['to'][ $context ]) && ! $this->_current_messenger->allow_empty_to_field())
+                (empty($templates['to'][$context]) && ! $this->_current_messenger->allow_empty_to_field())
                 || ! $message_template_group->is_context_active($context)
             )
         ) {
@@ -719,15 +719,15 @@ 
         foreach ($templates as $field => $field_context) {
             $error_msg = [];
             // let's setup the valid shortcodes for the incoming context.
-            $valid_shortcodes = $mt_shortcodes[ $context ];
+            $valid_shortcodes = $mt_shortcodes[$context];
             // merge in valid shortcodes for the field.
-            $shortcodes = isset($m_shortcodes[ $field ]) ? $m_shortcodes[ $field ] : $valid_shortcodes;
-            if (isset($field_context[ $context ])) {
+            $shortcodes = isset($m_shortcodes[$field]) ? $m_shortcodes[$field] : $valid_shortcodes;
+            if (isset($field_context[$context])) {
                 // prefix field.
-                $column_name = 'MSG_' . $field;
+                $column_name = 'MSG_'.$field;
                 try {
                     $content = $this->_shortcode_parser->parse_message_template(
-                        $field_context[ $context ],
+                        $field_context[$context],
                         $recipient,
                         $shortcodes,
                         $this->_current_message_type,
@@ -791,13 +791,13 @@ 
      */
     protected function _valid_addressees($addressees)
     {
-        if (! $addressees || ! is_array($addressees)) {
+        if ( ! $addressees || ! is_array($addressees)) {
             return false;
         }
 
         foreach ($addressees as $addressee_array) {
             foreach ($addressee_array as $addressee) {
-                if (! $addressee instanceof EE_Messages_Addressee) {
+                if ( ! $addressee instanceof EE_Messages_Addressee) {
                     return false;
                 }
             }
@@ -875,7 +875,7 @@ 
         /** @type EE_Messages_incoming_data $data_handler_class_name - well not really... just the class name actually */
         $data_handler_class_name = $this->_generation_queue->get_message_repository()->get_data_handler()
             ? $this->_generation_queue->get_message_repository()->get_data_handler()
-            : 'EE_Messages_' . $this->_current_message_type->get_data_handler($generation_data) . '_incoming_data';
+            : 'EE_Messages_'.$this->_current_message_type->get_data_handler($generation_data).'_incoming_data';
 
         // If this EE_Message is for a preview, then let's switch out to the preview data handler.
         if ($this->_generation_queue->get_message_repository()->is_preview()) {
@@ -883,7 +883,7 @@ 
         }
 
         // First get the class name for the data handler (and also verifies it exists.
-        if (! class_exists($data_handler_class_name)) {
+        if ( ! class_exists($data_handler_class_name)) {
             $this->_error_msg[] = sprintf(
             /* Translators: Both placeholders are the names of php classes. */
                 esc_html__(
@@ -924,7 +924,7 @@ 
                 $generating_data
             )
         );
-        if (! $this->_current_data_handler instanceof EE_Messages_incoming_data) {
+        if ( ! $this->_current_data_handler instanceof EE_Messages_incoming_data) {
             // no saved data_handler in the repo so let's set one up and add it to the repo.
             try {
                 $this->_current_data_handler = new $data_handler_class_name($generating_data);
@@ -948,7 +948,7 @@ 
      */
     protected function _prepare_data_for_queue(EE_Message_To_Generate $message_to_generate, $preview)
     {
-        if (! $message_to_generate->valid()) {
+        if ( ! $message_to_generate->valid()) {
             return false; // unable to get the data because the info in the EE_Message_To_Generate class is invalid.
         }
         /** @type EE_Messages_incoming_data $data_handler - well not really... just the class name actually */

core/libraries/messages/EE_Message_To_Generate.php

Spacing +2 added lines, -2 removed lines

@@ -297,8 +297,8 @@
      */
     public static function verify_and_retrieve_class_name_for_data_handler_reference($data_handler_reference)
     {
-        $class_name = 'EE_Messages_' . $data_handler_reference . '_incoming_data';
-        if (! class_exists($class_name)) {
+        $class_name = 'EE_Messages_'.$data_handler_reference.'_incoming_data';
+        if ( ! class_exists($class_name)) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(

Indentation +304 added lines, -304 removed lines

@@ -11,308 +11,308 @@
  */
 class EE_Message_To_Generate
 {
-    /**
-     * @var string
-     */
-    protected $_messenger_name;
-
-    /**
-     * @var string
-     */
-    protected $_message_type_name;
-
-    /**
-     * @var EE_messenger
-     */
-    protected $_messenger;
-
-    /**
-     * @var EE_message_type
-     */
-    protected $_message_type;
-
-    /**
-     * Identifier for the context the message is to be generated for.
-     *
-     * @var string
-     */
-    protected $_context = '';
-
-    /**
-     * Data that will be used to generate message.
-     *
-     * @var array
-     */
-    protected $_data = [];
-
-    /**
-     * Whether this message is for a preview or not.
-     *
-     * @var bool
-     */
-    protected $_preview = false;
-
-    /**
-     * @var EE_Message
-     */
-    protected $_message;
-
-    /**
-     * This is set by the constructor to indicate whether the incoming messenger
-     * and message type are valid.  This can then be checked by callers to determine whether
-     * to generate this message or not.
-     *
-     * @var bool
-     */
-    protected $_valid = false;
-
-    /**
-     * If there are any errors (non exception errors) they get added to this array for callers to decide
-     * how to handle.
-     *
-     * @var array
-     */
-    protected $_error_msg = [];
-
-    /**
-     * Can be accessed via the send_now() method, this is set in the validation
-     * routine via the EE_messenger::send_now() method.
-     *
-     * @var bool
-     */
-    protected $_send_now = false;
-
-    /**
-     * Holds the classname for the data handler used by the current message type.
-     * This is set on the first call to the public `get_data_handler_class_name()` method.
-     *
-     * @var string
-     */
-    protected $_data_handler_class_name = '';
-
-    /**
-     * one of the message status constants on EEM_Message
-     *
-     * @var string
-     * @since 4.10.29.p
-     */
-    protected $_status = '';
-
-    /**
-     * use $_status var above
-     *
-     * @var string
-     * @deprecated 4.10.29.p
-     */
-    protected $_message_status = '';
-
-
-    /**
-     * Constructor
-     *
-     * @param string $messenger_name    Slug representing messenger
-     * @param string $message_type_name Slug representing message type.
-     * @param mixed  $data              Data used for generating message.
-     * @param string $context           Optional context to restrict message generated for.
-     * @param bool   $preview           Whether this is being used to generate a preview or not.
-     * @param string $status
-     */
-    public function __construct(
-        $messenger_name,
-        $message_type_name,
-        $data = [],
-        $context = '',
-        $preview = false,
-        $status = EEM_Message::status_incomplete
-    ) {
-        $this->_messenger_name    = $messenger_name;
-        $this->_message_type_name = $message_type_name;
-        $this->_data              = is_array($data) ? $data : [$data];
-        $this->_context           = $context;
-        $this->_preview           = $preview;
-        $this->_status            = $status;
-        // attempt to generate message immediately
-        $this->_message = $this->_generate_message();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function context()
-    {
-        return $this->_context;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function data()
-    {
-        return $this->_data;
-    }
-
-
-    /**
-     * @return EE_messenger
-     */
-    public function messenger()
-    {
-        return $this->_messenger;
-    }
-
-
-    /**
-     * @return EE_message_type
-     */
-    public function message_type()
-    {
-        return $this->_message_type;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function preview()
-    {
-        return $this->_preview;
-    }
-
-
-    /**
-     * @param boolean $preview
-     */
-    public function set_preview($preview)
-    {
-        $this->_preview = filter_var($preview, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function send_now()
-    {
-        return $this->_send_now;
-    }
-
-
-    /**
-     * Simply returns the state of the $_valid property.
-     *
-     * @return bool
-     */
-    public function valid()
-    {
-        return $this->_valid;
-    }
-
-
-    /**
-     * generates an EE_Message using the supplied arguments and some defaults
-     *
-     * @param array $properties
-     * @return EE_Message
-     */
-    protected function _generate_message($properties = [])
-    {
-        $message = EE_Message_Factory::create(
-            array_merge(
-                [
-                    'MSG_messenger'    => $this->_messenger_name,
-                    'MSG_message_type' => $this->_message_type_name,
-                    'MSG_context'      => $this->_context,
-                    'STS_ID'           => $this->_status,
-                ],
-                $properties
-            )
-        );
-        // validate the message, and if it's good, set some properties
-        try {
-            $message->is_valid_for_sending_or_generation(true);
-            $this->_valid        = true;
-            $this->_messenger    = $message->messenger_object();
-            $this->_message_type = $message->message_type_object();
-            $this->_send_now     = $message->send_now();
-        } catch (Exception $e) {
-            $this->_valid       = false;
-            $this->_error_msg[] = $e->getMessage();
-        }
-        return $message;
-    }
-
-
-    /**
-     *  Returns an instantiated EE_Message object from the internal data.
-     *
-     * @return EE_Message
-     */
-    public function get_EE_Message()
-    {
-        // already set ?
-        if ($this->_message instanceof EE_Message) {
-            return $this->_message;
-        }
-        // no? then let's create one
-        $this->_message = $this->_generate_message();
-        return $this->_message;
-    }
-
-
-    /**
-     * This returns the data_handler class name for the internal message type set.
-     * Note: this also verifies that the data handler class exists.  If it doesn't then $_valid is set to false
-     * and the data_handler_class name is set to an empty string.
-     *
-     * @param bool $preview Used to indicate that the preview data handler is to be returned.
-     * @return  string
-     */
-    public function get_data_handler_class_name($preview = false)
-    {
-        if ($this->_data_handler_class_name === '' && $this->valid()) {
-            $ref = $preview ? 'Preview' : $this->_message_type->get_data_handler($this->_data);
-            // make sure internal data is updated.
-            $this->_data = $this->_message_type->get_data();
-
-            // verify
-            $this->_data_handler_class_name =
-                EE_Message_To_Generate::verify_and_retrieve_class_name_for_data_handler_reference($ref);
-            if ($this->_data_handler_class_name === '') {
-                $this->_valid = false;
-            }
-        }
-        return $this->_data_handler_class_name;
-    }
-
-
-    /**
-     * Validates the given string as a reference for an existing, accessible data handler and returns the class name
-     * For the handler the reference matches.
-     *
-     * @param string $data_handler_reference
-     * @return string
-     */
-    public static function verify_and_retrieve_class_name_for_data_handler_reference($data_handler_reference)
-    {
-        $class_name = 'EE_Messages_' . $data_handler_reference . '_incoming_data';
-        if (! class_exists($class_name)) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The included data handler reference (%s) does not match any valid, accessible, "EE_Messages_incoming_data" classes.  Looking for %s.',
-                        'event_espresso'
-                    ),
-                    $data_handler_reference,
-                    $class_name
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $class_name = ''; // clear out class_name so caller knows this isn't valid.
-        }
-        return $class_name;
-    }
+	/**
+	 * @var string
+	 */
+	protected $_messenger_name;
+
+	/**
+	 * @var string
+	 */
+	protected $_message_type_name;
+
+	/**
+	 * @var EE_messenger
+	 */
+	protected $_messenger;
+
+	/**
+	 * @var EE_message_type
+	 */
+	protected $_message_type;
+
+	/**
+	 * Identifier for the context the message is to be generated for.
+	 *
+	 * @var string
+	 */
+	protected $_context = '';
+
+	/**
+	 * Data that will be used to generate message.
+	 *
+	 * @var array
+	 */
+	protected $_data = [];
+
+	/**
+	 * Whether this message is for a preview or not.
+	 *
+	 * @var bool
+	 */
+	protected $_preview = false;
+
+	/**
+	 * @var EE_Message
+	 */
+	protected $_message;
+
+	/**
+	 * This is set by the constructor to indicate whether the incoming messenger
+	 * and message type are valid.  This can then be checked by callers to determine whether
+	 * to generate this message or not.
+	 *
+	 * @var bool
+	 */
+	protected $_valid = false;
+
+	/**
+	 * If there are any errors (non exception errors) they get added to this array for callers to decide
+	 * how to handle.
+	 *
+	 * @var array
+	 */
+	protected $_error_msg = [];
+
+	/**
+	 * Can be accessed via the send_now() method, this is set in the validation
+	 * routine via the EE_messenger::send_now() method.
+	 *
+	 * @var bool
+	 */
+	protected $_send_now = false;
+
+	/**
+	 * Holds the classname for the data handler used by the current message type.
+	 * This is set on the first call to the public `get_data_handler_class_name()` method.
+	 *
+	 * @var string
+	 */
+	protected $_data_handler_class_name = '';
+
+	/**
+	 * one of the message status constants on EEM_Message
+	 *
+	 * @var string
+	 * @since 4.10.29.p
+	 */
+	protected $_status = '';
+
+	/**
+	 * use $_status var above
+	 *
+	 * @var string
+	 * @deprecated 4.10.29.p
+	 */
+	protected $_message_status = '';
+
+
+	/**
+	 * Constructor
+	 *
+	 * @param string $messenger_name    Slug representing messenger
+	 * @param string $message_type_name Slug representing message type.
+	 * @param mixed  $data              Data used for generating message.
+	 * @param string $context           Optional context to restrict message generated for.
+	 * @param bool   $preview           Whether this is being used to generate a preview or not.
+	 * @param string $status
+	 */
+	public function __construct(
+		$messenger_name,
+		$message_type_name,
+		$data = [],
+		$context = '',
+		$preview = false,
+		$status = EEM_Message::status_incomplete
+	) {
+		$this->_messenger_name    = $messenger_name;
+		$this->_message_type_name = $message_type_name;
+		$this->_data              = is_array($data) ? $data : [$data];
+		$this->_context           = $context;
+		$this->_preview           = $preview;
+		$this->_status            = $status;
+		// attempt to generate message immediately
+		$this->_message = $this->_generate_message();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function context()
+	{
+		return $this->_context;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function data()
+	{
+		return $this->_data;
+	}
+
+
+	/**
+	 * @return EE_messenger
+	 */
+	public function messenger()
+	{
+		return $this->_messenger;
+	}
+
+
+	/**
+	 * @return EE_message_type
+	 */
+	public function message_type()
+	{
+		return $this->_message_type;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function preview()
+	{
+		return $this->_preview;
+	}
+
+
+	/**
+	 * @param boolean $preview
+	 */
+	public function set_preview($preview)
+	{
+		$this->_preview = filter_var($preview, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function send_now()
+	{
+		return $this->_send_now;
+	}
+
+
+	/**
+	 * Simply returns the state of the $_valid property.
+	 *
+	 * @return bool
+	 */
+	public function valid()
+	{
+		return $this->_valid;
+	}
+
+
+	/**
+	 * generates an EE_Message using the supplied arguments and some defaults
+	 *
+	 * @param array $properties
+	 * @return EE_Message
+	 */
+	protected function _generate_message($properties = [])
+	{
+		$message = EE_Message_Factory::create(
+			array_merge(
+				[
+					'MSG_messenger'    => $this->_messenger_name,
+					'MSG_message_type' => $this->_message_type_name,
+					'MSG_context'      => $this->_context,
+					'STS_ID'           => $this->_status,
+				],
+				$properties
+			)
+		);
+		// validate the message, and if it's good, set some properties
+		try {
+			$message->is_valid_for_sending_or_generation(true);
+			$this->_valid        = true;
+			$this->_messenger    = $message->messenger_object();
+			$this->_message_type = $message->message_type_object();
+			$this->_send_now     = $message->send_now();
+		} catch (Exception $e) {
+			$this->_valid       = false;
+			$this->_error_msg[] = $e->getMessage();
+		}
+		return $message;
+	}
+
+
+	/**
+	 *  Returns an instantiated EE_Message object from the internal data.
+	 *
+	 * @return EE_Message
+	 */
+	public function get_EE_Message()
+	{
+		// already set ?
+		if ($this->_message instanceof EE_Message) {
+			return $this->_message;
+		}
+		// no? then let's create one
+		$this->_message = $this->_generate_message();
+		return $this->_message;
+	}
+
+
+	/**
+	 * This returns the data_handler class name for the internal message type set.
+	 * Note: this also verifies that the data handler class exists.  If it doesn't then $_valid is set to false
+	 * and the data_handler_class name is set to an empty string.
+	 *
+	 * @param bool $preview Used to indicate that the preview data handler is to be returned.
+	 * @return  string
+	 */
+	public function get_data_handler_class_name($preview = false)
+	{
+		if ($this->_data_handler_class_name === '' && $this->valid()) {
+			$ref = $preview ? 'Preview' : $this->_message_type->get_data_handler($this->_data);
+			// make sure internal data is updated.
+			$this->_data = $this->_message_type->get_data();
+
+			// verify
+			$this->_data_handler_class_name =
+				EE_Message_To_Generate::verify_and_retrieve_class_name_for_data_handler_reference($ref);
+			if ($this->_data_handler_class_name === '') {
+				$this->_valid = false;
+			}
+		}
+		return $this->_data_handler_class_name;
+	}
+
+
+	/**
+	 * Validates the given string as a reference for an existing, accessible data handler and returns the class name
+	 * For the handler the reference matches.
+	 *
+	 * @param string $data_handler_reference
+	 * @return string
+	 */
+	public static function verify_and_retrieve_class_name_for_data_handler_reference($data_handler_reference)
+	{
+		$class_name = 'EE_Messages_' . $data_handler_reference . '_incoming_data';
+		if (! class_exists($class_name)) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The included data handler reference (%s) does not match any valid, accessible, "EE_Messages_incoming_data" classes.  Looking for %s.',
+						'event_espresso'
+					),
+					$data_handler_reference,
+					$class_name
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$class_name = ''; // clear out class_name so caller knows this isn't valid.
+		}
+		return $class_name;
+	}
 }

core/libraries/batch/JobHandlers/PreviewEventDeletion.php

Spacing +2 added lines, -2 removed lines

@@ -215,7 +215,7 @@ 
             if ($units_processed >= $batch_size) {
                 break;
             }
-            if (!$root_node instanceof ModelObjNode) {
+            if ( ! $root_node instanceof ModelObjNode) {
                 throw new InvalidClassException('ModelObjNode');
             }
             if ($root_node->isComplete()) {
@@ -226,7 +226,7 @@ 
         $job_parameters->mark_processed($units_processed);
         // If the most-recently processed root node is complete, we must be all done because we're doing them
         // sequentially.
-        if (! isset($root_node) || (isset($root_node) && $root_node instanceof ModelObjNode && $root_node->isComplete())) {
+        if ( ! isset($root_node) || (isset($root_node) && $root_node instanceof ModelObjNode && $root_node->isComplete())) {
             $job_parameters->set_status(JobParameters::status_complete);
             // Show a full progress bar.
             $job_parameters->set_units_processed($job_parameters->job_size());

Indentation +213 added lines, -213 removed lines

@@ -33,149 +33,149 @@ 
  */
 class PreviewEventDeletion extends JobHandler
 {
-    /**
-     * @var NodeGroupDao
-     */
-    protected $model_obj_node_group_persister;
+	/**
+	 * @var NodeGroupDao
+	 */
+	protected $model_obj_node_group_persister;
 
-    public function __construct(NodeGroupDao $model_obj_node_group_persister)
-    {
-        $this->model_obj_node_group_persister = $model_obj_node_group_persister;
-    }
+	public function __construct(NodeGroupDao $model_obj_node_group_persister)
+	{
+		$this->model_obj_node_group_persister = $model_obj_node_group_persister;
+	}
 
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
 
-    /**
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public function create_job(JobParameters $job_parameters)
-    {
-        // Set the "root" model objects we will want to delete (record their ID and model)
-        $event_ids = $job_parameters->request_datum('EVT_IDs', array());
-        // Find all the root nodes to delete (this isn't just events, because there's other data, like related tickets,
-        // prices, message templates, etc, whose model definition doesn't make them dependent on events. But,
-        // we have no UI to access them independent of events, so they may as well get deleted too.)
-        $roots = [];
-        foreach ($event_ids as $event_id) {
-            $roots[] = new ModelObjNode(
-                $event_id,
-                EEM_Event::instance()
-            );
-            // Also, we want to delete their related, non-global, tickets, prices and message templates
-            $related_non_global_tickets = EEM_Ticket::instance()->get_all_deleted_and_undeleted(
-                [
-                    [
-                        'TKT_is_default' => false,
-                        'Datetime.EVT_ID' => $event_id
-                    ]
-                ]
-            );
-            foreach ($related_non_global_tickets as $ticket) {
-                $roots[] = new ModelObjNode(
-                    $ticket->ID(),
-                    $ticket->get_model(),
-                    ['Registration']
-                );
-            }
-            $related_non_global_prices = EEM_Price::instance()->get_all_deleted_and_undeleted(
-                [
-                    [
-                        'PRC_is_default' => false,
-                        'Ticket.Datetime.EVT_ID' => $event_id
-                    ]
-                ]
-            );
-            foreach ($related_non_global_prices as $price) {
-                $roots[] = new ModelObjNode(
-                    $price->ID(),
-                    $price->get_model()
-                );
-            }
-        }
-        $transactions_ids = $this->getTransactionsToDelete($event_ids);
-        foreach ($transactions_ids as $transaction_id) {
-            $roots[] = new ModelObjNode(
-                $transaction_id,
-                EEM_Transaction::instance(),
-                ['Registration']
-            );
-        }
-        $job_parameters->add_extra_data('roots', $roots);
-        // Set an estimate of how long this will take (we're discovering as we go, so it seems impossible to give
-        // an accurate count.)
-        $estimated_work_per_model_obj = 10;
-        $count_regs = EEM_Registration::instance()->count(
-            [
-                [
-                    'EVT_ID' => ['IN', $event_ids]
-                ]
-            ]
-        );
-        $job_parameters->set_job_size((count($roots) + $count_regs) * $estimated_work_per_model_obj);
-        return new JobStepResponse(
-            $job_parameters,
-            esc_html__('Generating preview of data to be deleted...', 'event_espresso')
-        );
-    }
+	/**
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public function create_job(JobParameters $job_parameters)
+	{
+		// Set the "root" model objects we will want to delete (record their ID and model)
+		$event_ids = $job_parameters->request_datum('EVT_IDs', array());
+		// Find all the root nodes to delete (this isn't just events, because there's other data, like related tickets,
+		// prices, message templates, etc, whose model definition doesn't make them dependent on events. But,
+		// we have no UI to access them independent of events, so they may as well get deleted too.)
+		$roots = [];
+		foreach ($event_ids as $event_id) {
+			$roots[] = new ModelObjNode(
+				$event_id,
+				EEM_Event::instance()
+			);
+			// Also, we want to delete their related, non-global, tickets, prices and message templates
+			$related_non_global_tickets = EEM_Ticket::instance()->get_all_deleted_and_undeleted(
+				[
+					[
+						'TKT_is_default' => false,
+						'Datetime.EVT_ID' => $event_id
+					]
+				]
+			);
+			foreach ($related_non_global_tickets as $ticket) {
+				$roots[] = new ModelObjNode(
+					$ticket->ID(),
+					$ticket->get_model(),
+					['Registration']
+				);
+			}
+			$related_non_global_prices = EEM_Price::instance()->get_all_deleted_and_undeleted(
+				[
+					[
+						'PRC_is_default' => false,
+						'Ticket.Datetime.EVT_ID' => $event_id
+					]
+				]
+			);
+			foreach ($related_non_global_prices as $price) {
+				$roots[] = new ModelObjNode(
+					$price->ID(),
+					$price->get_model()
+				);
+			}
+		}
+		$transactions_ids = $this->getTransactionsToDelete($event_ids);
+		foreach ($transactions_ids as $transaction_id) {
+			$roots[] = new ModelObjNode(
+				$transaction_id,
+				EEM_Transaction::instance(),
+				['Registration']
+			);
+		}
+		$job_parameters->add_extra_data('roots', $roots);
+		// Set an estimate of how long this will take (we're discovering as we go, so it seems impossible to give
+		// an accurate count.)
+		$estimated_work_per_model_obj = 10;
+		$count_regs = EEM_Registration::instance()->count(
+			[
+				[
+					'EVT_ID' => ['IN', $event_ids]
+				]
+			]
+		);
+		$job_parameters->set_job_size((count($roots) + $count_regs) * $estimated_work_per_model_obj);
+		return new JobStepResponse(
+			$job_parameters,
+			esc_html__('Generating preview of data to be deleted...', 'event_espresso')
+		);
+	}
 
-    /**
-     * @since 4.10.12.p
-     * @param EE_Base_Class[] $model_objs
-     * @param array $dont_traverse_models
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function createModelObjNodes($model_objs, array $dont_traverse_models = [])
-    {
-        $nodes = [];
-        foreach ($model_objs as $model_obj) {
-            $nodes[] = new ModelObjNode(
-                $model_obj->ID(),
-                $model_obj->get_model(),
-                $dont_traverse_models
-            );
-        }
-        return $nodes;
-    }
+	/**
+	 * @since 4.10.12.p
+	 * @param EE_Base_Class[] $model_objs
+	 * @param array $dont_traverse_models
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function createModelObjNodes($model_objs, array $dont_traverse_models = [])
+	{
+		$nodes = [];
+		foreach ($model_objs as $model_obj) {
+			$nodes[] = new ModelObjNode(
+				$model_obj->ID(),
+				$model_obj->get_model(),
+				$dont_traverse_models
+			);
+		}
+		return $nodes;
+	}
 
-    /**
-     * Gets all the transactions related to these events that aren't related to other events. They'll be deleted too.
-     * (Ones that are related to other events can stay around until those other events are deleted too.)
-     * @since 4.10.12.p
-     * @param $event_ids
-     * @return array of transaction IDs
-     */
-    protected function getTransactionsToDelete($event_ids)
-    {
-        if (empty($event_ids)) {
-            return [];
-        }
-        global $wpdb;
-        $event_ids = array_map(
-            'intval',
-            $event_ids
-        );
-        $imploded_sanitized_event_ids = implode(',', $event_ids);
-        // Select transactions with registrations for the events $event_ids which also don't have registrations
-        // for any events NOT in $event_ids.
-        // Notice the outer query searched for transactions whose registrations ARE in $event_ids,
-        // whereas the inner query checks if the outer query's transaction has any registrations that are
-        // NOT IN $event_ids (ie, don't have registrations for events we're not just about to delete.)
-        return array_map(
-            'intval',
-            $wpdb->get_col(
-                "SELECT
+	/**
+	 * Gets all the transactions related to these events that aren't related to other events. They'll be deleted too.
+	 * (Ones that are related to other events can stay around until those other events are deleted too.)
+	 * @since 4.10.12.p
+	 * @param $event_ids
+	 * @return array of transaction IDs
+	 */
+	protected function getTransactionsToDelete($event_ids)
+	{
+		if (empty($event_ids)) {
+			return [];
+		}
+		global $wpdb;
+		$event_ids = array_map(
+			'intval',
+			$event_ids
+		);
+		$imploded_sanitized_event_ids = implode(',', $event_ids);
+		// Select transactions with registrations for the events $event_ids which also don't have registrations
+		// for any events NOT in $event_ids.
+		// Notice the outer query searched for transactions whose registrations ARE in $event_ids,
+		// whereas the inner query checks if the outer query's transaction has any registrations that are
+		// NOT IN $event_ids (ie, don't have registrations for events we're not just about to delete.)
+		return array_map(
+			'intval',
+			$wpdb->get_col(
+				"SELECT
                       DISTINCT t.TXN_ID
                     FROM
                       {$wpdb->prefix}esp_transaction t INNER JOIN
@@ -193,83 +193,83 @@ 
                            tsub.TXN_ID=t.TXN_ID AND
                            rsub.EVT_ID NOT IN ({$imploded_sanitized_event_ids})
                        )"
-            )
-        );
-    }
+			)
+		);
+	}
 
-    /**
-     * Performs another step of the job
-     * @param JobParameters $job_parameters
-     * @param int $batch_size
-     * @return JobStepResponse
-     */
-    public function continue_job(JobParameters $job_parameters, $batch_size = 50)
-    {
-        // Serializing and unserializing is what really makes this drag on (eg on localhost, the ajax requests took
-        // about 4 seconds when the batch size was 250, but 3 seconds when the batch size was 50. So like
-        // 50% of the request is just serializing and unserializing.) So, make the batches much bigger.
-        $batch_size *= 3;
-        $units_processed = 0;
-        foreach ($job_parameters->extra_datum('roots', array()) as $root_node) {
-            if ($units_processed >= $batch_size) {
-                break;
-            }
-            if (!$root_node instanceof ModelObjNode) {
-                throw new InvalidClassException('ModelObjNode');
-            }
-            if ($root_node->isComplete()) {
-                continue;
-            }
-            $units_processed += $root_node->visit($batch_size - $units_processed);
-        }
-        $job_parameters->mark_processed($units_processed);
-        // If the most-recently processed root node is complete, we must be all done because we're doing them
-        // sequentially.
-        if (! isset($root_node) || (isset($root_node) && $root_node instanceof ModelObjNode && $root_node->isComplete())) {
-            $job_parameters->set_status(JobParameters::status_complete);
-            // Show a full progress bar.
-            $job_parameters->set_units_processed($job_parameters->job_size());
-            $deletion_job_code = $job_parameters->request_datum('deletion_job_code');
-            $this->model_obj_node_group_persister->persistModelObjNodesGroup(
-                $job_parameters->extra_datum('roots'),
-                $deletion_job_code
-            );
-            return new JobStepResponse(
-                $job_parameters,
-                esc_html__('Finished identifying items for deletion.', 'event_espresso'),
-                [
-                    'deletion_job_code' => $deletion_job_code
-                ]
-            );
-        } else {
-            // Because the job size was a guess, it may have likely been proven wrong. We don't want to show more work
-            // done than we originally said there would be. So adjust the estimate.
-            if (($job_parameters->units_processed() / $job_parameters->job_size()) > .8) {
-                $job_parameters->set_job_size($job_parameters->job_size() * 2);
-            }
-            return new JobStepResponse(
-                $job_parameters,
-                sprintf(
-                    esc_html__('Identified %d items for deletion.', 'event_espresso'),
-                    $units_processed
-                )
-            );
-        }
-    }
+	/**
+	 * Performs another step of the job
+	 * @param JobParameters $job_parameters
+	 * @param int $batch_size
+	 * @return JobStepResponse
+	 */
+	public function continue_job(JobParameters $job_parameters, $batch_size = 50)
+	{
+		// Serializing and unserializing is what really makes this drag on (eg on localhost, the ajax requests took
+		// about 4 seconds when the batch size was 250, but 3 seconds when the batch size was 50. So like
+		// 50% of the request is just serializing and unserializing.) So, make the batches much bigger.
+		$batch_size *= 3;
+		$units_processed = 0;
+		foreach ($job_parameters->extra_datum('roots', array()) as $root_node) {
+			if ($units_processed >= $batch_size) {
+				break;
+			}
+			if (!$root_node instanceof ModelObjNode) {
+				throw new InvalidClassException('ModelObjNode');
+			}
+			if ($root_node->isComplete()) {
+				continue;
+			}
+			$units_processed += $root_node->visit($batch_size - $units_processed);
+		}
+		$job_parameters->mark_processed($units_processed);
+		// If the most-recently processed root node is complete, we must be all done because we're doing them
+		// sequentially.
+		if (! isset($root_node) || (isset($root_node) && $root_node instanceof ModelObjNode && $root_node->isComplete())) {
+			$job_parameters->set_status(JobParameters::status_complete);
+			// Show a full progress bar.
+			$job_parameters->set_units_processed($job_parameters->job_size());
+			$deletion_job_code = $job_parameters->request_datum('deletion_job_code');
+			$this->model_obj_node_group_persister->persistModelObjNodesGroup(
+				$job_parameters->extra_datum('roots'),
+				$deletion_job_code
+			);
+			return new JobStepResponse(
+				$job_parameters,
+				esc_html__('Finished identifying items for deletion.', 'event_espresso'),
+				[
+					'deletion_job_code' => $deletion_job_code
+				]
+			);
+		} else {
+			// Because the job size was a guess, it may have likely been proven wrong. We don't want to show more work
+			// done than we originally said there would be. So adjust the estimate.
+			if (($job_parameters->units_processed() / $job_parameters->job_size()) > .8) {
+				$job_parameters->set_job_size($job_parameters->job_size() * 2);
+			}
+			return new JobStepResponse(
+				$job_parameters,
+				sprintf(
+					esc_html__('Identified %d items for deletion.', 'event_espresso'),
+					$units_processed
+				)
+			);
+		}
+	}
 
-    /**
-     * Performs any clean-up logic when we know the job is completed
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     */
-    public function cleanup_job(JobParameters $job_parameters)
-    {
-        // Nothing much to do. We can't delete the option with the built tree because we may need it in a moment for the deletion
-        return new JobStepResponse(
-            $job_parameters,
-            esc_html__('All done', 'event_espresso')
-        );
-    }
+	/**
+	 * Performs any clean-up logic when we know the job is completed
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 */
+	public function cleanup_job(JobParameters $job_parameters)
+	{
+		// Nothing much to do. We can't delete the option with the built tree because we may need it in a moment for the deletion
+		return new JobStepResponse(
+			$job_parameters,
+			esc_html__('All done', 'event_espresso')
+		);
+	}
 }
 // End of file EventDeletion.php
 // Location: EventEspressoBatchRequest\JobHandlers/EventDeletion.php