eventespresso / event-espresso-core

core/helpers/EEH_Qtip_Loader.helper.php

Spacing +42 added lines, -42 removed lines

@@ -32,7 +32,7 @@ 
 	 */
 	public static function instance() {
 		// check if class object is instantiated
-		if ( self::$_instance === NULL  or ! is_object( self::$_instance ) or ! ( self::$_instance instanceof EEH_Qtip_Loader )) {
+		if (self::$_instance === NULL or ! is_object(self::$_instance) or ! (self::$_instance instanceof EEH_Qtip_Loader)) {
 			self::$_instance = new self();
 		}
 		return self::$_instance;
@@ -48,8 +48,8 @@ 
 	 */
 	private function __construct() {
 		//let's just make sure this is instantiated in the right place.
-		if ( did_action( 'wp_print_styles' ) || did_action( 'admin_head' )) {
-			EE_Error::doing_it_wrong( 'EEH_Qtip_Loader', __('This helper must be instantiated before or within a callback for the WordPress wp_enqueue_scripts hook action hook.', 'event_espresso' ), '4.1' );
+		if (did_action('wp_print_styles') || did_action('admin_head')) {
+			EE_Error::doing_it_wrong('EEH_Qtip_Loader', __('This helper must be instantiated before or within a callback for the WordPress wp_enqueue_scripts hook action hook.', 'event_espresso'), '4.1');
 		}
 	}
 
@@ -61,25 +61,25 @@ 
 	 * @return void
 	 */
 	public function register_and_enqueue() {
-		$qtips_js = !defined('SCRIPT_DEBUG') ? EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.js' : EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.js';
-		$qtip_map = EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.map';
-		$qtipcss = !defined('SCRIPT_DEBUG') ? EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.css' : EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.css';
+		$qtips_js = ! defined('SCRIPT_DEBUG') ? EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.js' : EE_THIRD_PARTY_URL.'qtip/jquery.qtip.js';
+		$qtip_map = EE_THIRD_PARTY_URL.'qtip/jquery.qtip.min.map';
+		$qtipcss = ! defined('SCRIPT_DEBUG') ? EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.css' : EE_THIRD_PARTY_URL.'qtip/jquery.qtip.css';
 
-		wp_register_script('qtip-map', $qtip_map, array(), '3', TRUE );
-		wp_register_script('qtip', $qtips_js, array('jquery'), '3.0.3', TRUE );
-		wp_register_script('ee-qtip-helper', EE_HELPERS_ASSETS . 'ee-qtip-helper.js', array('qtip', 'jquery-cookie'), EVENT_ESPRESSO_VERSION, TRUE );
+		wp_register_script('qtip-map', $qtip_map, array(), '3', TRUE);
+		wp_register_script('qtip', $qtips_js, array('jquery'), '3.0.3', TRUE);
+		wp_register_script('ee-qtip-helper', EE_HELPERS_ASSETS.'ee-qtip-helper.js', array('qtip', 'jquery-cookie'), EVENT_ESPRESSO_VERSION, TRUE);
 
-		wp_register_style('qtip-css', $qtipcss, array(), '2.2' );
+		wp_register_style('qtip-css', $qtipcss, array(), '2.2');
 
 		//k now let's see if there are any registered qtips.  If there are, then we need to setup the localized script for ee-qtip-helper.js (and enqueue ee-qtip-helper.js of course!)
-		if ( !empty( $this->_qtips ) ) {
+		if ( ! empty($this->_qtips)) {
 			wp_enqueue_script('ee-qtip-helper');
 			wp_enqueue_style('qtip-css');
 			$qtips = array();
-			foreach ( $this->_qtips as $qtip ) {
+			foreach ($this->_qtips as $qtip) {
 				$qts = $qtip->get_tips();
-				foreach ( $qts as $qt ) {
-					if ( ! $qt instanceof EE_Qtip )
+				foreach ($qts as $qt) {
+					if ( ! $qt instanceof EE_Qtip)
 						continue;
 					$qtips[] = array(
 						'content_id' => $qt->content_id,
@@ -88,8 +88,8 @@ 
 						);
 				}
 			}
-			if ( !empty($qtips) )
-				wp_localize_script('ee-qtip-helper', 'EE_QTIP_HELPER', array( 'qtips' => $qtips ) );
+			if ( ! empty($qtips))
+				wp_localize_script('ee-qtip-helper', 'EE_QTIP_HELPER', array('qtips' => $qtips));
 
 		} else {
 			//qtips has been requested without any registration (so assuming its just directly used in the admin).
@@ -111,24 +111,24 @@ 
 	 * @param  string|array $configname name of the Qtip class (full class name is expected and will be used for looking for file, Qtip config classes must extend EE_Qtip_Config) [if this is an array, then we loop through the array to instantiate and setup the qtips]
 	 * @return void
 	 */
-	public function register( $configname, $paths = array() ) {
+	public function register($configname, $paths = array()) {
 
 		//let's just make sure this is instantiated in the right place.
-		if ( did_action('wp_enqueue_scripts') || did_action('admin_enqueue_scripts') ) {
-			EE_Error::doing_it_wrong( 'EEH_Qtip_Loader->register()', __('EE_Qtip_Config objects must be registered before wp_enqueue_scripts is called.', 'event_espresso' ), '4.1' );
+		if (did_action('wp_enqueue_scripts') || did_action('admin_enqueue_scripts')) {
+			EE_Error::doing_it_wrong('EEH_Qtip_Loader->register()', __('EE_Qtip_Config objects must be registered before wp_enqueue_scripts is called.', 'event_espresso'), '4.1');
 		}
 
 		$configname = (array) $configname; //typecast to array
-		foreach ( $configname as $config ) {
-			$this->_register( $config, $paths );
+		foreach ($configname as $config) {
+			$this->_register($config, $paths);
 		}
 
 		//hook into appropriate footer
 		$footer_action = is_admin() ? 'admin_footer' : 'wp_footer';
-		add_action($footer_action, array($this, 'setup_qtip'), 10 );
+		add_action($footer_action, array($this, 'setup_qtip'), 10);
 
 		//make sure we "turn on" qtip js.
-		add_filter('FHEE_load_qtip', '__return_true' );
+		add_filter('FHEE_load_qtip', '__return_true');
 	}
 
 
@@ -142,15 +142,15 @@ 
 	 * @throws EE_Error
 	 * @return void
 	 */
-	private function _register( $config, $paths ) {
+	private function _register($config, $paths) {
 		//before doing anything we have to make sure that EE_Qtip_Config parent is required.
-		EE_Registry::instance()->load_lib( 'Qtip_Config', array(), TRUE );
+		EE_Registry::instance()->load_lib('Qtip_Config', array(), TRUE);
 
-		if ( !empty( $paths ) ) {
+		if ( ! empty($paths)) {
 			$paths = (array) $paths;
-			foreach ( $paths as $path ) {
-				$path = $path . $config . '.lib.php';
-				if ( !is_readable($path ) ) {
+			foreach ($paths as $path) {
+				$path = $path.$config.'.lib.php';
+				if ( ! is_readable($path)) {
 					continue;
 				} else {
 					require_once $path;
@@ -159,26 +159,26 @@ 
 		}
 
 		//does class exist at this point?  If it does then let's instantiate.  If it doesn't then let's continue with other paths.
-		if ( !class_exists($config) ) {
-			$path = EE_LIBRARIES . 'qtips/' . $config . '.lib.php';
-			if ( !is_readable($path ) ) {
-				throw new EE_Error( sprintf( __('Unable to load the Qtip Config registered for this page (%s) because none of the file paths attempted are readable.  Please check the spelling of the paths you\'ve used in the registration', 'event_espresso'), $config ) );
+		if ( ! class_exists($config)) {
+			$path = EE_LIBRARIES.'qtips/'.$config.'.lib.php';
+			if ( ! is_readable($path)) {
+				throw new EE_Error(sprintf(__('Unable to load the Qtip Config registered for this page (%s) because none of the file paths attempted are readable.  Please check the spelling of the paths you\'ve used in the registration', 'event_espresso'), $config));
 			} else {
 				require_once $path;
 			}
 		}
 
 		//now we attempt a class_exists one more time.
-		if ( !class_exists( $config ) )
-			throw new EE_Error( sprintf( __('The Qtip_Config class being registered (%s) does not exist, please check the spelling.', 'event_espresso'), $config ) );
+		if ( ! class_exists($config))
+			throw new EE_Error(sprintf(__('The Qtip_Config class being registered (%s) does not exist, please check the spelling.', 'event_espresso'), $config));
 
 		//made it HERE?  FINALLY, let's get things setup.
 		$a = new ReflectionClass($config);
 		$qtip = $a->newInstance();
 
 		//verify that $qtip is a valid object
-		if ( ! $qtip instanceof EE_Qtip_Config )
-			throw new EE_Error( sprintf( esc_html__( 'The class given for the Qtip loader (%1$s) is not a child of the %2$sEE_Qtip_Config%3$s class. Please make sure you are extending EE_Qtip_Config.', 'event_espresso'), $config, '<strong>', '</strong>' ) );
+		if ( ! $qtip instanceof EE_Qtip_Config)
+			throw new EE_Error(sprintf(esc_html__('The class given for the Qtip loader (%1$s) is not a child of the %2$sEE_Qtip_Config%3$s class. Please make sure you are extending EE_Qtip_Config.', 'event_espresso'), $config, '<strong>', '</strong>'));
 
 		$this->_qtips[] = $a->newInstance();
 
@@ -194,12 +194,12 @@ 
 	 * @return void
 	 */
 	public function setup_qtip() {
-		if ( empty( $this->_qtips ) )
+		if (empty($this->_qtips))
 			return; //no qtips!
 
 		$content = array();
 
-		foreach ( $this->_qtips as $qtip ) {
+		foreach ($this->_qtips as $qtip) {
 			$content[] = $this->_generate_content_container($qtip);
 		}
 
@@ -216,10 +216,10 @@ 
 	private function _generate_content_container($qtip) {
 		$qts = $qtip->get_tips();
 		$content = array();
-		foreach ( $qts as $qt ) {
-			if ( ! $qt instanceof EE_Qtip )
+		foreach ($qts as $qt) {
+			if ( ! $qt instanceof EE_Qtip)
 				continue;
-			$content[] = '<div class="ee-qtip-helper-content hidden" id="' . $qt->content_id . '">' . $qt->content . '</div>';
+			$content[] = '<div class="ee-qtip-helper-content hidden" id="'.$qt->content_id.'">'.$qt->content.'</div>';
 		}
 
 		return implode('<br />', $content);

core/domain/DomainBase.php

Indentation +120 added lines, -120 removed lines

@@ -19,126 +19,126 @@
 abstract class DomainBase implements DomainInterface
 {
 
-    /**
-     * Equivalent to `__FILE__` for main plugin file.
-     *
-     * @var FilePath
-     */
-    private $plugin_file;
+	/**
+	 * Equivalent to `__FILE__` for main plugin file.
+	 *
+	 * @var FilePath
+	 */
+	private $plugin_file;
 
-    /**
-     * String indicating version for plugin
-     *
-     * @var string
-     */
-    private $version;
-
-    /**
-     * @var string $plugin_basename
-     */
-    private $plugin_basename;
-
-    /**
-     * @var string $plugin_path
-     */
-    private $plugin_path;
-
-    /**
-     * @var string $plugin_url
-     */
-    private $plugin_url;
-
-
-
-    /**
-     * Initializes internal properties.
-     *
-     * @param FilePath $plugin_file
-     * @param Version  $version
-     */
-    public function __construct(FilePath $plugin_file, Version $version)
-    {
-        $this->plugin_file = $plugin_file;
-        $this->version = $version;
-        $this->plugin_basename = plugin_basename($this->pluginFile());
-        $this->plugin_path = plugin_dir_path($this->pluginFile());
-        $this->plugin_url = plugin_dir_url($this->pluginFile());
-    }
-
-
-    /**
-     * @return string
-     */
-    public function pluginFile()
-    {
-        return (string) $this->plugin_file;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function pluginBasename()
-    {
-        return $this->plugin_basename;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function pluginPath()
-    {
-        return $this->plugin_path;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function pluginUrl()
-    {
-        return $this->plugin_url;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function version()
-    {
-        return (string) $this->version;
-    }
-
-
-
-    /**
-     * @return Version
-     */
-    public function versionValueObject()
-    {
-        return $this->version;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function distributionAssetsPath()
-    {
-        return $this->pluginPath() . 'assets/dist/';
-    }
+	/**
+	 * String indicating version for plugin
+	 *
+	 * @var string
+	 */
+	private $version;
+
+	/**
+	 * @var string $plugin_basename
+	 */
+	private $plugin_basename;
+
+	/**
+	 * @var string $plugin_path
+	 */
+	private $plugin_path;
+
+	/**
+	 * @var string $plugin_url
+	 */
+	private $plugin_url;
+
+
+
+	/**
+	 * Initializes internal properties.
+	 *
+	 * @param FilePath $plugin_file
+	 * @param Version  $version
+	 */
+	public function __construct(FilePath $plugin_file, Version $version)
+	{
+		$this->plugin_file = $plugin_file;
+		$this->version = $version;
+		$this->plugin_basename = plugin_basename($this->pluginFile());
+		$this->plugin_path = plugin_dir_path($this->pluginFile());
+		$this->plugin_url = plugin_dir_url($this->pluginFile());
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function pluginFile()
+	{
+		return (string) $this->plugin_file;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function pluginBasename()
+	{
+		return $this->plugin_basename;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function pluginPath()
+	{
+		return $this->plugin_path;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function pluginUrl()
+	{
+		return $this->plugin_url;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function version()
+	{
+		return (string) $this->version;
+	}
+
+
+
+	/**
+	 * @return Version
+	 */
+	public function versionValueObject()
+	{
+		return $this->version;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function distributionAssetsPath()
+	{
+		return $this->pluginPath() . 'assets/dist/';
+	}
 
-
-    /**
-     * @return string
-     */
-    public function distributionAssetsUrl()
-    {
-        return $this->pluginUrl() . 'assets/dist/';
-    }
+
+	/**
+	 * @return string
+	 */
+	public function distributionAssetsUrl()
+	{
+		return $this->pluginUrl() . 'assets/dist/';
+	}
 }

Spacing +2 added lines, -2 removed lines

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

core/services/request/InvalidRequestStackMiddlewareException.php

Indentation +29 added lines, -29 removed lines

@@ -19,33 +19,33 @@
 class InvalidRequestStackMiddlewareException extends InvalidDataTypeException
 {
 
-    /**
-     * @param  mixed     $middleware_app_class
-     * @param  string    $message
-     * @param int        $code
-     * @param Exception $previous
-     */
-    public function __construct($middleware_app_class, $message = '', $code = 0, Exception $previous = null)
-    {
-        if(is_array($middleware_app_class)) {
-            $middleware_app_class = reset($middleware_app_class);
-        }
-        if (empty($message)) {
-            $message = sprintf(
-                esc_html__(
-                    'The supplied Request Stack Middleware class "%1$s" is invalid or could no be found.',
-                    'event_espresso'
-                ),
-                $middleware_app_class
-            );
-        }
-        parent::__construct(
-            '$middleware_app_class',
-            $middleware_app_class,
-            'EventEspresso\core\services\request\middleware\Middleware',
-            $message,
-            $code,
-            $previous
-        );
-    }
+	/**
+	 * @param  mixed     $middleware_app_class
+	 * @param  string    $message
+	 * @param int        $code
+	 * @param Exception $previous
+	 */
+	public function __construct($middleware_app_class, $message = '', $code = 0, Exception $previous = null)
+	{
+		if(is_array($middleware_app_class)) {
+			$middleware_app_class = reset($middleware_app_class);
+		}
+		if (empty($message)) {
+			$message = sprintf(
+				esc_html__(
+					'The supplied Request Stack Middleware class "%1$s" is invalid or could no be found.',
+					'event_espresso'
+				),
+				$middleware_app_class
+			);
+		}
+		parent::__construct(
+			'$middleware_app_class',
+			$middleware_app_class,
+			'EventEspresso\core\services\request\middleware\Middleware',
+			$message,
+			$code,
+			$previous
+		);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -27,7 +27,7 @@
      */
     public function __construct($middleware_app_class, $message = '', $code = 0, Exception $previous = null)
     {
-        if(is_array($middleware_app_class)) {
+        if (is_array($middleware_app_class)) {
             $middleware_app_class = reset($middleware_app_class);
         }
         if (empty($message)) {

core/services/request/RequestStackBuilder.php

Indentation +87 added lines, -87 removed lines

@@ -24,97 +24,97 @@
 class RequestStackBuilder extends SplDoublyLinkedList
 {
 
-    /**
-     * @type LoaderInterface $loader
-     */
-    private $loader;
+	/**
+	 * @type LoaderInterface $loader
+	 */
+	private $loader;
 
 
-    /**
-     * RequestStackBuilder constructor.
-     *
-     * @param LoaderInterface $loader
-     */
-    public function __construct(LoaderInterface $loader)
-    {
-        $this->loader = $loader;
-        $this->setIteratorMode(SplDoublyLinkedList::IT_MODE_LIFO | SplDoublyLinkedList::IT_MODE_KEEP);
-    }
+	/**
+	 * RequestStackBuilder constructor.
+	 *
+	 * @param LoaderInterface $loader
+	 */
+	public function __construct(LoaderInterface $loader)
+	{
+		$this->loader = $loader;
+		$this->setIteratorMode(SplDoublyLinkedList::IT_MODE_LIFO | SplDoublyLinkedList::IT_MODE_KEEP);
+	}
 
 
-    /**
-     * builds decorated middleware stack
-     * by continuously injecting previous middleware app into the next
-     *
-     * @param RequestStackCoreAppInterface $application
-     * @return RequestStack
-     * @throws Exception
-     */
-    public function resolve(RequestStackCoreAppInterface $application)
-    {
-        $core_app = $application;
-        // NOW... because the RequestStack is following the decorator pattern,
-        // the first stack app we add will end up at the center of the stack,
-        // and will end up being the last item to actually run, but we don't want that!
-        // Basically we're dealing with TWO stacks, and transferring items from one to the other,
-        // BUT... we want the final stack to be in the same order as the first.
-        // So we need to reverse the iterator mode when transferring items,
-        // because if we don't, the second stack will end  up in the incorrect order.
-        $this->setIteratorMode(SplDoublyLinkedList::IT_MODE_FIFO | SplDoublyLinkedList::IT_MODE_KEEP);
-        for ($this->rewind(); $this->valid(); $this->next()) {
-            try {
-                $middleware_app       = $this->validateMiddlewareAppDetails($this->current(), true);
-                $middleware_app_class = array_shift($middleware_app);
-                $middleware_app_args  = is_array($middleware_app) ? $middleware_app : array();
-                $middleware_app_args  = array($application, $this->loader) + $middleware_app_args;
-                $application          = $this->loader->getShared($middleware_app_class, $middleware_app_args);
-            } catch (InvalidRequestStackMiddlewareException $exception) {
-                if(WP_DEBUG) {
-                    new ExceptionStackTraceDisplay($exception);
-                    continue;
-                }
-                error_log($exception->getMessage());
-            }
-        }
-        return new RequestStack($application, $core_app);
-    }
+	/**
+	 * builds decorated middleware stack
+	 * by continuously injecting previous middleware app into the next
+	 *
+	 * @param RequestStackCoreAppInterface $application
+	 * @return RequestStack
+	 * @throws Exception
+	 */
+	public function resolve(RequestStackCoreAppInterface $application)
+	{
+		$core_app = $application;
+		// NOW... because the RequestStack is following the decorator pattern,
+		// the first stack app we add will end up at the center of the stack,
+		// and will end up being the last item to actually run, but we don't want that!
+		// Basically we're dealing with TWO stacks, and transferring items from one to the other,
+		// BUT... we want the final stack to be in the same order as the first.
+		// So we need to reverse the iterator mode when transferring items,
+		// because if we don't, the second stack will end  up in the incorrect order.
+		$this->setIteratorMode(SplDoublyLinkedList::IT_MODE_FIFO | SplDoublyLinkedList::IT_MODE_KEEP);
+		for ($this->rewind(); $this->valid(); $this->next()) {
+			try {
+				$middleware_app       = $this->validateMiddlewareAppDetails($this->current(), true);
+				$middleware_app_class = array_shift($middleware_app);
+				$middleware_app_args  = is_array($middleware_app) ? $middleware_app : array();
+				$middleware_app_args  = array($application, $this->loader) + $middleware_app_args;
+				$application          = $this->loader->getShared($middleware_app_class, $middleware_app_args);
+			} catch (InvalidRequestStackMiddlewareException $exception) {
+				if(WP_DEBUG) {
+					new ExceptionStackTraceDisplay($exception);
+					continue;
+				}
+				error_log($exception->getMessage());
+			}
+		}
+		return new RequestStack($application, $core_app);
+	}
 
 
-    /**
-     * Ensures that the app details that have been pushed onto RequestStackBuilder
-     * are all ordered correctly so that the middleware can be properly constructed
-     *
-     * @param array $middleware_app
-     * @param bool  $recurse
-     * @return array
-     * @throws InvalidRequestStackMiddlewareException
-     */
-    protected function validateMiddlewareAppDetails(array $middleware_app, $recurse = false)
-    {
-        $middleware_app_class = reset($middleware_app);
-        // is array empty ?
-        if($middleware_app_class === false) {
-            throw new InvalidRequestStackMiddlewareException($middleware_app_class);
-        }
-        // are the class and arguments in the wrong order ?
-        if(is_array($middleware_app_class)) {
-            if ($recurse === true) {
-                return $this->validateMiddlewareAppDetails(array_reverse($middleware_app));
-            }
-            throw new InvalidRequestStackMiddlewareException($middleware_app_class);
-        }
-        // is filter callback working like legacy middleware and sending a numerically indexed array ?
-        if(is_int($middleware_app_class)) {
-            if ($recurse === true) {
-                $middleware_app = array_reverse($middleware_app);
-                return $this->validateMiddlewareAppDetails(array(reset($middleware_app), array()));
-            }
-            throw new InvalidRequestStackMiddlewareException($middleware_app_class);
-        }
-        // is $middleware_app_class a valid FQCN (or class is already loaded) ?
-        if(! class_exists($middleware_app_class)) {
-            throw new InvalidRequestStackMiddlewareException($middleware_app_class);
-        }
-        return $middleware_app;
-    }
+	/**
+	 * Ensures that the app details that have been pushed onto RequestStackBuilder
+	 * are all ordered correctly so that the middleware can be properly constructed
+	 *
+	 * @param array $middleware_app
+	 * @param bool  $recurse
+	 * @return array
+	 * @throws InvalidRequestStackMiddlewareException
+	 */
+	protected function validateMiddlewareAppDetails(array $middleware_app, $recurse = false)
+	{
+		$middleware_app_class = reset($middleware_app);
+		// is array empty ?
+		if($middleware_app_class === false) {
+			throw new InvalidRequestStackMiddlewareException($middleware_app_class);
+		}
+		// are the class and arguments in the wrong order ?
+		if(is_array($middleware_app_class)) {
+			if ($recurse === true) {
+				return $this->validateMiddlewareAppDetails(array_reverse($middleware_app));
+			}
+			throw new InvalidRequestStackMiddlewareException($middleware_app_class);
+		}
+		// is filter callback working like legacy middleware and sending a numerically indexed array ?
+		if(is_int($middleware_app_class)) {
+			if ($recurse === true) {
+				$middleware_app = array_reverse($middleware_app);
+				return $this->validateMiddlewareAppDetails(array(reset($middleware_app), array()));
+			}
+			throw new InvalidRequestStackMiddlewareException($middleware_app_class);
+		}
+		// is $middleware_app_class a valid FQCN (or class is already loaded) ?
+		if(! class_exists($middleware_app_class)) {
+			throw new InvalidRequestStackMiddlewareException($middleware_app_class);
+		}
+		return $middleware_app;
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -69,7 +69,7 @@ 
                 $middleware_app_args  = array($application, $this->loader) + $middleware_app_args;
                 $application          = $this->loader->getShared($middleware_app_class, $middleware_app_args);
             } catch (InvalidRequestStackMiddlewareException $exception) {
-                if(WP_DEBUG) {
+                if (WP_DEBUG) {
                     new ExceptionStackTraceDisplay($exception);
                     continue;
                 }
@@ -93,18 +93,18 @@ 
     {
         $middleware_app_class = reset($middleware_app);
         // is array empty ?
-        if($middleware_app_class === false) {
+        if ($middleware_app_class === false) {
             throw new InvalidRequestStackMiddlewareException($middleware_app_class);
         }
         // are the class and arguments in the wrong order ?
-        if(is_array($middleware_app_class)) {
+        if (is_array($middleware_app_class)) {
             if ($recurse === true) {
                 return $this->validateMiddlewareAppDetails(array_reverse($middleware_app));
             }
             throw new InvalidRequestStackMiddlewareException($middleware_app_class);
         }
         // is filter callback working like legacy middleware and sending a numerically indexed array ?
-        if(is_int($middleware_app_class)) {
+        if (is_int($middleware_app_class)) {
             if ($recurse === true) {
                 $middleware_app = array_reverse($middleware_app);
                 return $this->validateMiddlewareAppDetails(array(reset($middleware_app), array()));
@@ -112,7 +112,7 @@ 
             throw new InvalidRequestStackMiddlewareException($middleware_app_class);
         }
         // is $middleware_app_class a valid FQCN (or class is already loaded) ?
-        if(! class_exists($middleware_app_class)) {
+        if ( ! class_exists($middleware_app_class)) {
             throw new InvalidRequestStackMiddlewareException($middleware_app_class);
         }
         return $middleware_app;

core/domain/DomainInterface.php

Indentation +32 added lines, -32 removed lines

@@ -16,49 +16,49 @@
 interface DomainInterface extends InterminableInterface
 {
 
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public function pluginFile();
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public function pluginFile();
 
 
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public function pluginBasename();
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public function pluginBasename();
 
 
-    /**
-     * @return string
-     */
-    public function pluginPath();
+	/**
+	 * @return string
+	 */
+	public function pluginPath();
 
 
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public function pluginUrl();
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public function pluginUrl();
 
 
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public function version();
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public function version();
 
 
-    /**
-     * @return string
-     */
-    public function distributionAssetsPath();
+	/**
+	 * @return string
+	 */
+	public function distributionAssetsPath();
 
 
-    /**
-     * @return string
-     */
-    public function distributionAssetsUrl();
+	/**
+	 * @return string
+	 */
+	public function distributionAssetsUrl();
 
 }

core/services/assets/Registry.php

Indentation +449 added lines, -449 removed lines

@@ -24,459 +24,459 @@
 class Registry
 {
 
-    /**
-     * @var EE_Template_Config $template_config
-     */
-    protected $template_config;
-
-    /**
-     * @var EE_Currency_Config $currency_config
-     */
-    protected $currency_config;
-
-    /**
-     * This holds the jsdata data object that will be exposed on pages that enqueue the `eejs-core` script.
-     *
-     * @var array
-     */
-    protected $jsdata = array();
-
-
-    /**
-     * This keeps track of all scripts with registered data.  It is used to prevent duplicate data objects setup in the
-     * page source.
-     * @var array
-     */
-    protected $script_handles_with_data = array();
-
-
-    /**
-     * @var DomainInterface
-     */
-    protected $domain;
-
-
-    /**
-     * Registry constructor.
-     * Hooking into WP actions for script registry.
-     *
-     * @param EE_Template_Config $template_config
-     * @param EE_Currency_Config $currency_config
-     * @param DomainInterface    $domain
-     */
-    public function __construct(
-        EE_Template_Config $template_config,
-        EE_Currency_Config $currency_config,
-        DomainInterface $domain
-    ) {
-        $this->template_config = $template_config;
-        $this->currency_config = $currency_config;
-        $this->domain = $domain;
-        add_action('wp_enqueue_scripts', array($this, 'scripts'), 1);
-        add_action('admin_enqueue_scripts', array($this, 'scripts'), 1);
-        add_action('wp_enqueue_scripts', array($this, 'enqueueData'), 2);
-        add_action('admin_enqueue_scripts', array($this, 'enqueueData'), 2);
-        add_action('wp_print_footer_scripts', array($this, 'enqueueData'), 1);
-        add_action('admin_print_footer_scripts', array($this, 'enqueueData'), 1);
-    }
-
-
-
-    /**
-     * Callback for the WP script actions.
-     * Used to register globally accessible core scripts.
-     * Also used to add the eejs.data object to the source for any js having eejs-core as a dependency.
-     */
-    public function scripts()
-    {
-        global $wp_version;
-        wp_register_script(
-            'eejs-core',
-            EE_PLUGIN_DIR_URL . 'core/services/assets/core_assets/eejs-core.js',
-            array(),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        //only run this if WordPress 4.4.0 > is in use.
-        if (version_compare($wp_version, '4.4.0', '>')) {
-            //js.api
-            wp_register_script(
-                'eejs-api',
-                EE_LIBRARIES_URL . 'rest_api/assets/js/eejs-api.min.js',
-                array('underscore', 'eejs-core'),
-                EVENT_ESPRESSO_VERSION,
-                true
-            );
-            $this->jsdata['eejs_api_nonce'] = wp_create_nonce('wp_rest');
-            $this->jsdata['paths'] = array('rest_route' => rest_url('ee/v4.8.36/'));
-        }
-        if (! is_admin()) {
-            $this->loadCoreCss();
-        }
-        $this->loadCoreJs();
-        $this->loadJqueryValidate();
-        $this->loadAccountingJs();
-        $this->loadQtipJs();
-    }
-
-
-
-    /**
-     * Call back for the script print in frontend and backend.
-     * Used to call wp_localize_scripts so that data can be added throughout the runtime until this later hook point.
-     *
-     * @since 4.9.31.rc.015
-     */
-    public function enqueueData()
-    {
-        $this->removeAlreadyRegisteredDataForScriptHandles();
-        wp_localize_script('eejs-core', 'eejs', array('data' => $this->jsdata));
-        wp_localize_script('espresso_core', 'eei18n', EE_Registry::$i18n_js_strings);
-        $this->localizeAccountingJs();
-        $this->addRegisteredScriptHandlesWithData('eejs-core');
-        $this->addRegisteredScriptHandlesWithData('espresso_core');
-    }
-
-
-
-    /**
-     * Used to add data to eejs.data object.
-     * Note:  Overriding existing data is not allowed.
-     * Data will be accessible as a javascript object when you list `eejs-core` as a dependency for your javascript.
-     * If the data you add is something like this:
-     *  $this->addData( 'my_plugin_data', array( 'foo' => 'gar' ) );
-     * It will be exposed in the page source as:
-     *  eejs.data.my_plugin_data.foo == gar
-     *
-     * @param string       $key   Key used to access your data
-     * @param string|array $value Value to attach to key
-     * @throws InvalidArgumentException
-     */
-    public function addData($key, $value)
-    {
-        if ($this->verifyDataNotExisting($key)) {
-            $this->jsdata[$key] = $value;
-        }
-    }
-
-
-
-    /**
-     * Similar to addData except this allows for users to push values to an existing key where the values on key are
-     * elements in an array.
-     * When you use this method, the value you include will be appended to the end of an array on $key.
-     * So if the $key was 'test' and you added a value of 'my_data' then it would be represented in the javascript
-     * object like this, eejs.data.test = [ my_data,
-     * ]
-     * If there has already been a scalar value attached to the data object given key, then
-     * this will throw an exception.
-     *
-     * @param string       $key   Key to attach data to.
-     * @param string|array $value Value being registered.
-     * @throws InvalidArgumentException
-     */
-    public function pushData($key, $value)
-    {
-        if (isset($this->jsdata[$key])
-            && ! is_array($this->jsdata[$key])
-        ) {
-            throw new invalidArgumentException(
-                sprintf(
-                    __(
-                        'The value for %1$s is already set and it is not an array. The %2$s method can only be used to
+	/**
+	 * @var EE_Template_Config $template_config
+	 */
+	protected $template_config;
+
+	/**
+	 * @var EE_Currency_Config $currency_config
+	 */
+	protected $currency_config;
+
+	/**
+	 * This holds the jsdata data object that will be exposed on pages that enqueue the `eejs-core` script.
+	 *
+	 * @var array
+	 */
+	protected $jsdata = array();
+
+
+	/**
+	 * This keeps track of all scripts with registered data.  It is used to prevent duplicate data objects setup in the
+	 * page source.
+	 * @var array
+	 */
+	protected $script_handles_with_data = array();
+
+
+	/**
+	 * @var DomainInterface
+	 */
+	protected $domain;
+
+
+	/**
+	 * Registry constructor.
+	 * Hooking into WP actions for script registry.
+	 *
+	 * @param EE_Template_Config $template_config
+	 * @param EE_Currency_Config $currency_config
+	 * @param DomainInterface    $domain
+	 */
+	public function __construct(
+		EE_Template_Config $template_config,
+		EE_Currency_Config $currency_config,
+		DomainInterface $domain
+	) {
+		$this->template_config = $template_config;
+		$this->currency_config = $currency_config;
+		$this->domain = $domain;
+		add_action('wp_enqueue_scripts', array($this, 'scripts'), 1);
+		add_action('admin_enqueue_scripts', array($this, 'scripts'), 1);
+		add_action('wp_enqueue_scripts', array($this, 'enqueueData'), 2);
+		add_action('admin_enqueue_scripts', array($this, 'enqueueData'), 2);
+		add_action('wp_print_footer_scripts', array($this, 'enqueueData'), 1);
+		add_action('admin_print_footer_scripts', array($this, 'enqueueData'), 1);
+	}
+
+
+
+	/**
+	 * Callback for the WP script actions.
+	 * Used to register globally accessible core scripts.
+	 * Also used to add the eejs.data object to the source for any js having eejs-core as a dependency.
+	 */
+	public function scripts()
+	{
+		global $wp_version;
+		wp_register_script(
+			'eejs-core',
+			EE_PLUGIN_DIR_URL . 'core/services/assets/core_assets/eejs-core.js',
+			array(),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		//only run this if WordPress 4.4.0 > is in use.
+		if (version_compare($wp_version, '4.4.0', '>')) {
+			//js.api
+			wp_register_script(
+				'eejs-api',
+				EE_LIBRARIES_URL . 'rest_api/assets/js/eejs-api.min.js',
+				array('underscore', 'eejs-core'),
+				EVENT_ESPRESSO_VERSION,
+				true
+			);
+			$this->jsdata['eejs_api_nonce'] = wp_create_nonce('wp_rest');
+			$this->jsdata['paths'] = array('rest_route' => rest_url('ee/v4.8.36/'));
+		}
+		if (! is_admin()) {
+			$this->loadCoreCss();
+		}
+		$this->loadCoreJs();
+		$this->loadJqueryValidate();
+		$this->loadAccountingJs();
+		$this->loadQtipJs();
+	}
+
+
+
+	/**
+	 * Call back for the script print in frontend and backend.
+	 * Used to call wp_localize_scripts so that data can be added throughout the runtime until this later hook point.
+	 *
+	 * @since 4.9.31.rc.015
+	 */
+	public function enqueueData()
+	{
+		$this->removeAlreadyRegisteredDataForScriptHandles();
+		wp_localize_script('eejs-core', 'eejs', array('data' => $this->jsdata));
+		wp_localize_script('espresso_core', 'eei18n', EE_Registry::$i18n_js_strings);
+		$this->localizeAccountingJs();
+		$this->addRegisteredScriptHandlesWithData('eejs-core');
+		$this->addRegisteredScriptHandlesWithData('espresso_core');
+	}
+
+
+
+	/**
+	 * Used to add data to eejs.data object.
+	 * Note:  Overriding existing data is not allowed.
+	 * Data will be accessible as a javascript object when you list `eejs-core` as a dependency for your javascript.
+	 * If the data you add is something like this:
+	 *  $this->addData( 'my_plugin_data', array( 'foo' => 'gar' ) );
+	 * It will be exposed in the page source as:
+	 *  eejs.data.my_plugin_data.foo == gar
+	 *
+	 * @param string       $key   Key used to access your data
+	 * @param string|array $value Value to attach to key
+	 * @throws InvalidArgumentException
+	 */
+	public function addData($key, $value)
+	{
+		if ($this->verifyDataNotExisting($key)) {
+			$this->jsdata[$key] = $value;
+		}
+	}
+
+
+
+	/**
+	 * Similar to addData except this allows for users to push values to an existing key where the values on key are
+	 * elements in an array.
+	 * When you use this method, the value you include will be appended to the end of an array on $key.
+	 * So if the $key was 'test' and you added a value of 'my_data' then it would be represented in the javascript
+	 * object like this, eejs.data.test = [ my_data,
+	 * ]
+	 * If there has already been a scalar value attached to the data object given key, then
+	 * this will throw an exception.
+	 *
+	 * @param string       $key   Key to attach data to.
+	 * @param string|array $value Value being registered.
+	 * @throws InvalidArgumentException
+	 */
+	public function pushData($key, $value)
+	{
+		if (isset($this->jsdata[$key])
+			&& ! is_array($this->jsdata[$key])
+		) {
+			throw new invalidArgumentException(
+				sprintf(
+					__(
+						'The value for %1$s is already set and it is not an array. The %2$s method can only be used to
                          push values to this data element when it is an array.',
-                        'event_espresso'
-                    ),
-                    $key,
-                    __METHOD__
-                )
-            );
-        }
-        $this->jsdata[$key][] = $value;
-    }
-
-
-
-    /**
-     * Used to set content used by javascript for a template.
-     * Note: Overrides of existing registered templates are not allowed.
-     *
-     * @param string $template_reference
-     * @param string $template_content
-     * @throws InvalidArgumentException
-     */
-    public function addTemplate($template_reference, $template_content)
-    {
-        if (! isset($this->jsdata['templates'])) {
-            $this->jsdata['templates'] = array();
-        }
-        //no overrides allowed.
-        if (isset($this->jsdata['templates'][$template_reference])) {
-            throw new invalidArgumentException(
-                sprintf(
-                    __(
-                        'The %1$s key already exists for the templates array in the js data array.  No overrides are allowed.',
-                        'event_espresso'
-                    ),
-                    $template_reference
-                )
-            );
-        }
-        $this->jsdata['templates'][$template_reference] = $template_content;
-    }
-
-
-
-    /**
-     * Retrieve the template content already registered for the given reference.
-     *
-     * @param string $template_reference
-     * @return string
-     */
-    public function getTemplate($template_reference)
-    {
-        return isset($this->jsdata['templates'], $this->jsdata['templates'][$template_reference])
-            ? $this->jsdata['templates'][$template_reference]
-            : '';
-    }
-
-
-
-    /**
-     * Retrieve registered data.
-     *
-     * @param string $key Name of key to attach data to.
-     * @return mixed                If there is no for the given key, then false is returned.
-     */
-    public function getData($key)
-    {
-        return isset($this->jsdata[$key])
-            ? $this->jsdata[$key]
-            : false;
-    }
-
-
-
-    /**
-     * Verifies whether the given data exists already on the jsdata array.
-     * Overriding data is not allowed.
-     *
-     * @param string $key Index for data.
-     * @return bool        If valid then return true.
-     * @throws InvalidArgumentException if data already exists.
-     */
-    protected function verifyDataNotExisting($key)
-    {
-        if (isset($this->jsdata[$key])) {
-            if (is_array($this->jsdata[$key])) {
-                throw new InvalidArgumentException(
-                    sprintf(
-                        __(
-                            'The value for %1$s already exists in the Registry::eejs object.
+						'event_espresso'
+					),
+					$key,
+					__METHOD__
+				)
+			);
+		}
+		$this->jsdata[$key][] = $value;
+	}
+
+
+
+	/**
+	 * Used to set content used by javascript for a template.
+	 * Note: Overrides of existing registered templates are not allowed.
+	 *
+	 * @param string $template_reference
+	 * @param string $template_content
+	 * @throws InvalidArgumentException
+	 */
+	public function addTemplate($template_reference, $template_content)
+	{
+		if (! isset($this->jsdata['templates'])) {
+			$this->jsdata['templates'] = array();
+		}
+		//no overrides allowed.
+		if (isset($this->jsdata['templates'][$template_reference])) {
+			throw new invalidArgumentException(
+				sprintf(
+					__(
+						'The %1$s key already exists for the templates array in the js data array.  No overrides are allowed.',
+						'event_espresso'
+					),
+					$template_reference
+				)
+			);
+		}
+		$this->jsdata['templates'][$template_reference] = $template_content;
+	}
+
+
+
+	/**
+	 * Retrieve the template content already registered for the given reference.
+	 *
+	 * @param string $template_reference
+	 * @return string
+	 */
+	public function getTemplate($template_reference)
+	{
+		return isset($this->jsdata['templates'], $this->jsdata['templates'][$template_reference])
+			? $this->jsdata['templates'][$template_reference]
+			: '';
+	}
+
+
+
+	/**
+	 * Retrieve registered data.
+	 *
+	 * @param string $key Name of key to attach data to.
+	 * @return mixed                If there is no for the given key, then false is returned.
+	 */
+	public function getData($key)
+	{
+		return isset($this->jsdata[$key])
+			? $this->jsdata[$key]
+			: false;
+	}
+
+
+
+	/**
+	 * Verifies whether the given data exists already on the jsdata array.
+	 * Overriding data is not allowed.
+	 *
+	 * @param string $key Index for data.
+	 * @return bool        If valid then return true.
+	 * @throws InvalidArgumentException if data already exists.
+	 */
+	protected function verifyDataNotExisting($key)
+	{
+		if (isset($this->jsdata[$key])) {
+			if (is_array($this->jsdata[$key])) {
+				throw new InvalidArgumentException(
+					sprintf(
+						__(
+							'The value for %1$s already exists in the Registry::eejs object.
                             Overrides are not allowed. Since the value of this data is an array, you may want to use the
                             %2$s method to push your value to the array.',
-                            'event_espresso'
-                        ),
-                        $key,
-                        'pushData()'
-                    )
-                );
-            }
-            throw new InvalidArgumentException(
-                sprintf(
-                    __(
-                        'The value for %1$s already exists in the Registry::eejs object. Overrides are not
+							'event_espresso'
+						),
+						$key,
+						'pushData()'
+					)
+				);
+			}
+			throw new InvalidArgumentException(
+				sprintf(
+					__(
+						'The value for %1$s already exists in the Registry::eejs object. Overrides are not
                         allowed.  Consider attaching your value to a different key',
-                        'event_espresso'
-                    ),
-                    $key
-                )
-            );
-        }
-        return true;
-    }
-
-
-
-    /**
-     * registers core default stylesheets
-     */
-    private function loadCoreCss()
-    {
-        if ($this->template_config->enable_default_style) {
-            $default_stylesheet_path = is_readable(EVENT_ESPRESSO_UPLOAD_DIR . 'css/style.css')
-                ? EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css'
-                : EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css';
-            wp_register_style(
-                'espresso_default',
-                $default_stylesheet_path,
-                array('dashicons'),
-                EVENT_ESPRESSO_VERSION
-            );
-            //Load custom style sheet if available
-            if ($this->template_config->custom_style_sheet !== null) {
-                wp_register_style(
-                    'espresso_custom_css',
-                    EVENT_ESPRESSO_UPLOAD_URL . 'css/' . $this->template_config->custom_style_sheet,
-                    array('espresso_default'),
-                    EVENT_ESPRESSO_VERSION
-                );
-            }
-        }
-    }
-
-
-
-    /**
-     * registers core default javascript
-     */
-    private function loadCoreJs()
-    {
-        // load core js
-        wp_register_script(
-            'espresso_core',
-            EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
-            array('jquery'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-    }
-
-
-
-    /**
-     * registers jQuery Validate for form validation
-     */
-    private function loadJqueryValidate()
-    {
-        // register jQuery Validate and additional methods
-        wp_register_script(
-            'jquery-validate',
-            EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.min.js',
-            array('jquery'),
-            '1.15.0',
-            true
-        );
-        wp_register_script(
-            'jquery-validate-extra-methods',
-            EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.additional-methods.min.js',
-            array('jquery', 'jquery-validate'),
-            '1.15.0',
-            true
-        );
-    }
-
-
-
-    /**
-     * registers accounting.js for performing client-side calculations
-     */
-    private function loadAccountingJs()
-    {
-        //accounting.js library
-        // @link http://josscrowcroft.github.io/accounting.js/
-        wp_register_script(
-            'ee-accounting-core',
-            EE_THIRD_PARTY_URL . 'accounting/accounting.js',
-            array('underscore'),
-            '0.3.2',
-            true
-        );
-        wp_register_script(
-            'ee-accounting',
-            EE_GLOBAL_ASSETS_URL . 'scripts/ee-accounting-config.js',
-            array('ee-accounting-core'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-    }
-
-
-
-    /**
-     * registers accounting.js for performing client-side calculations
-     */
-    private function localizeAccountingJs()
-    {
-        wp_localize_script(
-            'ee-accounting',
-            'EE_ACCOUNTING_CFG',
-            array(
-                'currency' => array(
-                    'symbol'    => $this->currency_config->sign,
-                    'format'    => array(
-                        'pos'  => $this->currency_config->sign_b4 ? '%s%v' : '%v%s',
-                        'neg'  => $this->currency_config->sign_b4 ? '- %s%v' : '- %v%s',
-                        'zero' => $this->currency_config->sign_b4 ? '%s--' : '--%s',
-                    ),
-                    'decimal'   => $this->currency_config->dec_mrk,
-                    'thousand'  => $this->currency_config->thsnds,
-                    'precision' => $this->currency_config->dec_plc,
-                ),
-                'number'   => array(
-                    'precision' => $this->currency_config->dec_plc,
-                    'thousand'  => $this->currency_config->thsnds,
-                    'decimal'   => $this->currency_config->dec_mrk,
-                ),
-            )
-        );
-        $this->addRegisteredScriptHandlesWithData('ee-accounting');
-    }
-
-
-
-    /**
-     * registers assets for cleaning your ears
-     */
-    private function loadQtipJs()
-    {
-        // qtip is turned OFF by default, but prior to the wp_enqueue_scripts hook,
-        // can be turned back on again via: add_filter('FHEE_load_qtip', '__return_true' );
-        if (apply_filters('FHEE_load_qtip', false)) {
-            EEH_Qtip_Loader::instance()->register_and_enqueue();
-        }
-    }
-
-
-    /**
-     * This is used to set registered script handles that have data.
-     * @param string $script_handle
-     */
-    private function addRegisteredScriptHandlesWithData($script_handle)
-    {
-        $this->script_handles_with_data[$script_handle] = $script_handle;
-    }
-
-
-    /**
-     * Checks WP_Scripts for all of each script handle registered internally as having data and unsets from the
-     * Dependency stored in WP_Scripts if its set.
-     */
-    private function removeAlreadyRegisteredDataForScriptHandles()
-    {
-        if (empty($this->script_handles_with_data)) {
-            return;
-        }
-        foreach ($this->script_handles_with_data as $script_handle) {
-            $this->removeAlreadyRegisteredDataForScriptHandle($script_handle);
-        }
-    }
-
-
-    /**
-     * Removes any data dependency registered in WP_Scripts if its set.
-     * @param string $script_handle
-     */
-    private function removeAlreadyRegisteredDataForScriptHandle($script_handle)
-    {
-        if (isset($this->script_handles_with_data[$script_handle])) {
-            global $wp_scripts;
-            if ($wp_scripts->get_data($script_handle, 'data')) {
-                unset($wp_scripts->registered[$script_handle]->extra['data']);
-                unset($this->script_handles_with_data[$script_handle]);
-            }
-        }
-    }
+						'event_espresso'
+					),
+					$key
+				)
+			);
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * registers core default stylesheets
+	 */
+	private function loadCoreCss()
+	{
+		if ($this->template_config->enable_default_style) {
+			$default_stylesheet_path = is_readable(EVENT_ESPRESSO_UPLOAD_DIR . 'css/style.css')
+				? EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css'
+				: EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css';
+			wp_register_style(
+				'espresso_default',
+				$default_stylesheet_path,
+				array('dashicons'),
+				EVENT_ESPRESSO_VERSION
+			);
+			//Load custom style sheet if available
+			if ($this->template_config->custom_style_sheet !== null) {
+				wp_register_style(
+					'espresso_custom_css',
+					EVENT_ESPRESSO_UPLOAD_URL . 'css/' . $this->template_config->custom_style_sheet,
+					array('espresso_default'),
+					EVENT_ESPRESSO_VERSION
+				);
+			}
+		}
+	}
+
+
+
+	/**
+	 * registers core default javascript
+	 */
+	private function loadCoreJs()
+	{
+		// load core js
+		wp_register_script(
+			'espresso_core',
+			EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+			array('jquery'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+	}
+
+
+
+	/**
+	 * registers jQuery Validate for form validation
+	 */
+	private function loadJqueryValidate()
+	{
+		// register jQuery Validate and additional methods
+		wp_register_script(
+			'jquery-validate',
+			EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.min.js',
+			array('jquery'),
+			'1.15.0',
+			true
+		);
+		wp_register_script(
+			'jquery-validate-extra-methods',
+			EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.additional-methods.min.js',
+			array('jquery', 'jquery-validate'),
+			'1.15.0',
+			true
+		);
+	}
+
+
+
+	/**
+	 * registers accounting.js for performing client-side calculations
+	 */
+	private function loadAccountingJs()
+	{
+		//accounting.js library
+		// @link http://josscrowcroft.github.io/accounting.js/
+		wp_register_script(
+			'ee-accounting-core',
+			EE_THIRD_PARTY_URL . 'accounting/accounting.js',
+			array('underscore'),
+			'0.3.2',
+			true
+		);
+		wp_register_script(
+			'ee-accounting',
+			EE_GLOBAL_ASSETS_URL . 'scripts/ee-accounting-config.js',
+			array('ee-accounting-core'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+	}
+
+
+
+	/**
+	 * registers accounting.js for performing client-side calculations
+	 */
+	private function localizeAccountingJs()
+	{
+		wp_localize_script(
+			'ee-accounting',
+			'EE_ACCOUNTING_CFG',
+			array(
+				'currency' => array(
+					'symbol'    => $this->currency_config->sign,
+					'format'    => array(
+						'pos'  => $this->currency_config->sign_b4 ? '%s%v' : '%v%s',
+						'neg'  => $this->currency_config->sign_b4 ? '- %s%v' : '- %v%s',
+						'zero' => $this->currency_config->sign_b4 ? '%s--' : '--%s',
+					),
+					'decimal'   => $this->currency_config->dec_mrk,
+					'thousand'  => $this->currency_config->thsnds,
+					'precision' => $this->currency_config->dec_plc,
+				),
+				'number'   => array(
+					'precision' => $this->currency_config->dec_plc,
+					'thousand'  => $this->currency_config->thsnds,
+					'decimal'   => $this->currency_config->dec_mrk,
+				),
+			)
+		);
+		$this->addRegisteredScriptHandlesWithData('ee-accounting');
+	}
+
+
+
+	/**
+	 * registers assets for cleaning your ears
+	 */
+	private function loadQtipJs()
+	{
+		// qtip is turned OFF by default, but prior to the wp_enqueue_scripts hook,
+		// can be turned back on again via: add_filter('FHEE_load_qtip', '__return_true' );
+		if (apply_filters('FHEE_load_qtip', false)) {
+			EEH_Qtip_Loader::instance()->register_and_enqueue();
+		}
+	}
+
+
+	/**
+	 * This is used to set registered script handles that have data.
+	 * @param string $script_handle
+	 */
+	private function addRegisteredScriptHandlesWithData($script_handle)
+	{
+		$this->script_handles_with_data[$script_handle] = $script_handle;
+	}
+
+
+	/**
+	 * Checks WP_Scripts for all of each script handle registered internally as having data and unsets from the
+	 * Dependency stored in WP_Scripts if its set.
+	 */
+	private function removeAlreadyRegisteredDataForScriptHandles()
+	{
+		if (empty($this->script_handles_with_data)) {
+			return;
+		}
+		foreach ($this->script_handles_with_data as $script_handle) {
+			$this->removeAlreadyRegisteredDataForScriptHandle($script_handle);
+		}
+	}
+
+
+	/**
+	 * Removes any data dependency registered in WP_Scripts if its set.
+	 * @param string $script_handle
+	 */
+	private function removeAlreadyRegisteredDataForScriptHandle($script_handle)
+	{
+		if (isset($this->script_handles_with_data[$script_handle])) {
+			global $wp_scripts;
+			if ($wp_scripts->get_data($script_handle, 'data')) {
+				unset($wp_scripts->registered[$script_handle]->extra['data']);
+				unset($this->script_handles_with_data[$script_handle]);
+			}
+		}
+	}
 
 
 }

core/libraries/messages/messenger/EE_Email_messenger.class.php

Indentation +645 added lines, -645 removed lines

@@ -8,649 +8,649 @@
 class EE_Email_messenger extends EE_messenger
 {
 
-    /**
-     * To field for email
-     * @var string
-     */
-    protected $_to = '';
-
-
-    /**
-     * CC field for email.
-     * @var string
-     */
-    protected $_cc = '';
-
-    /**
-     * From field for email
-     * @var string
-     */
-    protected $_from = '';
-
-
-    /**
-     * Subject field for email
-     * @var string
-     */
-    protected $_subject = '';
-
-
-    /**
-     * Content field for email
-     * @var string
-     */
-    protected $_content = '';
-
-
-    /**
-     * constructor
-     *
-     * @access public
-     */
-    public function __construct()
-    {
-        //set name and description properties
-        $this->name                = 'email';
-        $this->description         = sprintf(
-            esc_html__(
-                'This messenger delivers messages via email using the built-in %s function included with WordPress',
-                'event_espresso'
-            ),
-            '<code>wp_mail</code>'
-        );
-        $this->label               = array(
-            'singular' => esc_html__('email', 'event_espresso'),
-            'plural'   => esc_html__('emails', 'event_espresso'),
-        );
-        $this->activate_on_install = true;
-
-        //we're using defaults so let's call parent constructor that will take care of setting up all the other
-        // properties
-        parent::__construct();
-    }
-
-
-    /**
-     * see abstract declaration in parent class for details.
-     */
-    protected function _set_admin_pages()
-    {
-        $this->admin_registered_pages = array(
-            'events_edit' => true,
-        );
-    }
-
-
-    /**
-     * see abstract declaration in parent class for details
-     */
-    protected function _set_valid_shortcodes()
-    {
-        //remember by leaving the other fields not set, those fields will inherit the valid shortcodes from the
-        // message type.
-        $this->_valid_shortcodes = array(
-            'to'   => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
-            'cc' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
-            'from' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
-        );
-    }
-
-
-    /**
-     * see abstract declaration in parent class for details
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_validator_config()
-    {
-        $valid_shortcodes = $this->get_valid_shortcodes();
-
-        $this->_validator_config = array(
-            'to'            => array(
-                'shortcodes' => $valid_shortcodes['to'],
-                'type'       => 'email',
-            ),
-            'cc' => array(
-                'shortcodes' => $valid_shortcodes['to'],
-                'type' => 'email',
-            ),
-            'from'          => array(
-                'shortcodes' => $valid_shortcodes['from'],
-                'type'       => 'email',
-            ),
-            'subject'       => array(
-                'shortcodes' => array(
-                    'organization',
-                    'primary_registration_details',
-                    'event_author',
-                    'primary_registration_details',
-                    'recipient_details',
-                ),
-            ),
-            'content'       => array(
-                'shortcodes' => array(
-                    'event_list',
-                    'attendee_list',
-                    'ticket_list',
-                    'organization',
-                    'primary_registration_details',
-                    'primary_registration_list',
-                    'event_author',
-                    'recipient_details',
-                    'recipient_list',
-                    'transaction',
-                    'messenger',
-                ),
-            ),
-            'attendee_list' => array(
-                'shortcodes' => array('attendee', 'event_list', 'ticket_list'),
-                'required'   => array('[ATTENDEE_LIST]'),
-            ),
-            'event_list'    => array(
-                'shortcodes' => array(
-                    'event',
-                    'attendee_list',
-                    'ticket_list',
-                    'venue',
-                    'datetime_list',
-                    'attendee',
-                    'primary_registration_details',
-                    'primary_registration_list',
-                    'event_author',
-                    'recipient_details',
-                    'recipient_list',
-                ),
-                'required'   => array('[EVENT_LIST]'),
-            ),
-            'ticket_list'   => array(
-                'shortcodes' => array(
-                    'event_list',
-                    'attendee_list',
-                    'ticket',
-                    'datetime_list',
-                    'primary_registration_details',
-                    'recipient_details',
-                ),
-                'required'   => array('[TICKET_LIST]'),
-            ),
-            'datetime_list' => array(
-                'shortcodes' => array('datetime'),
-                'required'   => array('[DATETIME_LIST]'),
-            ),
-        );
-    }
-
-
-    /**
-     * @see   parent EE_messenger class for docs
-     * @since 4.5.0
-     */
-    public function do_secondary_messenger_hooks($sending_messenger_name)
-    {
-        if ($sending_messenger_name = 'html') {
-            add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
-        }
-    }
-
-
-    public function add_email_css(
-        $variation_path,
-        $messenger,
-        $message_type,
-        $type,
-        $variation,
-        $file_extension,
-        $url,
-        EE_Messages_Template_Pack $template_pack
-    ) {
-        //prevent recursion on this callback.
-        remove_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10);
-        $variation = $this->get_variation($template_pack, $message_type, $url, 'main', $variation, false);
-
-        add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
-        return $variation;
-    }
-
-
-    /**
-     * See parent for details
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_test_settings_fields()
-    {
-        $this->_test_settings_fields = array(
-            'to'      => array(
-                'input'      => 'text',
-                'label'      => esc_html__('Send a test email to', 'event_espresso'),
-                'type'       => 'email',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-                'default'    => get_bloginfo('admin_email'),
-            ),
-            'subject' => array(
-                'input'      => 'hidden',
-                'label'      => '',
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => false,
-                'format'     => '%s',
-                'value'      => sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name')),
-                'default'    => '',
-                'css_class'  => '',
-            ),
-        );
-    }
-
-
-    /**
-     * _set_template_fields
-     * This sets up the fields that a messenger requires for the message to go out.
-     *
-     * @access  protected
-     * @return void
-     */
-    protected function _set_template_fields()
-    {
-        // any extra template fields that are NOT used by the messenger but will get used by a messenger field for
-        // shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field
-        // they relate to.  This is important for the Messages_admin to know what fields to display to the user.
-        //  Also, notice that the "values" are equal to the field type that messages admin will use to know what
-        // kind of field to display. The values ALSO have one index labeled "shortcode".  the values in that array
-        // indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be
-        // displayed.  If the required shortcode isn't part of the shortcodes array then the field is not needed and
-        // will not be displayed/parsed.
-        $this->_template_fields = array(
-            'to'      => array(
-                'input'      => 'text',
-                'label'      => esc_html_x(
-                    'To',
-                    'Label for the "To" field for email addresses',
-                    'event_espresso'
-                ),
-                'type'       => 'string',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'cc'      => array(
-                'input'      => 'text',
-                'label'      => esc_html_x(
-                    'CC',
-                    'Label for the "Carbon Copy" field used for additional email addresses',
-                    'event_espresso'
-                ),
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'from'    => array(
-                'input'      => 'text',
-                'label'      => esc_html_x(
-                    'From',
-                    'Label for the "From" field for email addresses.',
-                    'event_espresso'
-                ),
-                'type'       => 'string',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'subject' => array(
-                'input'      => 'text',
-                'label'      => esc_html_x(
-                    'Subject',
-                    'Label for the "Subject" field (short description of contents) for emails.',
-                    'event_espresso'
-                ),
-                'type'       => 'string',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'content' => '',
-            //left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
-            'extra'   => array(
-                'content' => array(
-                    'main'          => array(
-                        'input'      => 'wp_editor',
-                        'label'      => esc_html__('Main Content', 'event_espresso'),
-                        'type'       => 'string',
-                        'required'   => true,
-                        'validation' => true,
-                        'format'     => '%s',
-                        'rows'       => '15',
-                    ),
-                    'event_list'    => array(
-                        'input'               => 'wp_editor',
-                        'label'               => '[EVENT_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'rows'                => '15',
-                        'shortcodes_required' => array('[EVENT_LIST]'),
-                    ),
-                    'attendee_list' => array(
-                        'input'               => 'textarea',
-                        'label'               => '[ATTENDEE_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => array('[ATTENDEE_LIST]'),
-                    ),
-                    'ticket_list'   => array(
-                        'input'               => 'textarea',
-                        'label'               => '[TICKET_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '10',
-                        'shortcodes_required' => array('[TICKET_LIST]'),
-                    ),
-                    'datetime_list' => array(
-                        'input'               => 'textarea',
-                        'label'               => '[DATETIME_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '10',
-                        'shortcodes_required' => array('[DATETIME_LIST]'),
-                    ),
-                ),
-            ),
-        );
-    }
-
-
-    /**
-     * See definition of this class in parent
-     */
-    protected function _set_default_message_types()
-    {
-        $this->_default_message_types = array(
-            'payment',
-            'payment_refund',
-            'registration',
-            'not_approved_registration',
-            'pending_approval',
-        );
-    }
-
-
-    /**
-     * @see   definition of this class in parent
-     * @since 4.5.0
-     */
-    protected function _set_valid_message_types()
-    {
-        $this->_valid_message_types = array(
-            'payment',
-            'registration',
-            'not_approved_registration',
-            'declined_registration',
-            'cancelled_registration',
-            'pending_approval',
-            'registration_summary',
-            'payment_reminder',
-            'payment_declined',
-            'payment_refund',
-        );
-    }
-
-
-    /**
-     * setting up admin_settings_fields for messenger.
-     */
-    protected function _set_admin_settings_fields()
-    {
-    }
-
-    /**
-     * We just deliver the messages don't kill us!!
-     *
-     * @return bool|WP_Error true if message delivered, false if it didn't deliver OR bubble up any error object if
-     *              present.
-     * @throws EE_Error
-     * @throws \TijsVerkoyen\CssToInlineStyles\Exception
-     */
-    protected function _send_message()
-    {
-        $success = wp_mail(
-            $this->_to,
-            //some old values for subject may be expecting HTML entities to be decoded in the subject
-            //and subjects aren't interpreted as HTML, so there should be no HTML in them
-            wp_strip_all_tags(wp_specialchars_decode($this->_subject, ENT_QUOTES)),
-            $this->_body(),
-            $this->_headers()
-        );
-        if (! $success) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The email did not send successfully.%3$sThe WordPress wp_mail function is used for sending mails but does not give any useful information when an email fails to send.%3$sIt is possible the "to" address (%1$s) or "from" address (%2$s) is invalid.%3$s',
-                        'event_espresso'
-                    ),
-                    $this->_to,
-                    $this->_from,
-                    '<br />'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return $success;
-    }
-
-
-    /**
-     * see parent for definition
-     *
-     * @return string html body of the message content and the related css.
-     * @throws EE_Error
-     * @throws \TijsVerkoyen\CssToInlineStyles\Exception
-     */
-    protected function _preview()
-    {
-        return $this->_body(true);
-    }
-
-
-    /**
-     * Setup headers for email
-     *
-     * @access protected
-     * @return string formatted header for email
-     */
-    protected function _headers()
-    {
-        $this->_ensure_has_from_email_address();
-        $from    = $this->_from;
-        $headers = array(
-            'From:' . $from,
-            'Reply-To:' . $from,
-            'Content-Type:text/html; charset=utf-8',
-        );
-
-        /**
-         * Second condition added as a result of https://events.codebasehq.com/projects/event-espresso/tickets/11416 to
-         * cover back compat where there may be users who have saved cc values in their db for the newsletter message
-         * type which they are no longer able to change.
-         */
-        if (! empty($this->_cc) && ! $this->_incoming_message_type instanceof EE_Newsletter_message_type) {
-            $headers[] = 'cc: ' . $this->_cc;
-        }
-
-        //but wait!  Header's for the from is NOT reliable because some plugins don't respect From: as set in the
-        // header.
-        add_filter('wp_mail_from', array($this, 'set_from_address'), 100);
-        add_filter('wp_mail_from_name', array($this, 'set_from_name'), 100);
-        return apply_filters('FHEE__EE_Email_messenger___headers', $headers, $this->_incoming_message_type, $this);
-    }
-
-
-    /**
-     * This simply ensures that the from address is not empty.  If it is, then we use whatever is set as the site email
-     * address for the from address to avoid problems with sending emails.
-     */
-    protected function _ensure_has_from_email_address()
-    {
-        if (empty($this->_from)) {
-            $this->_from = get_bloginfo('admin_email');
-        }
-    }
-
-
-    /**
-     * This simply parses whatever is set as the $_from address and determines if it is in the format {name} <{email}>
-     * or just {email} and returns an array with the "from_name" and "from_email" as the values. Note from_name *MAY*
-     * be empty
-     *
-     * @since 4.3.1
-     * @return array
-     */
-    private function _parse_from()
-    {
-        if (strpos($this->_from, '<') !== false) {
-            $from_name = substr($this->_from, 0, strpos($this->_from, '<') - 1);
-            $from_name = str_replace('"', '', $from_name);
-            $from_name = trim($from_name);
-
-            $from_email = substr($this->_from, strpos($this->_from, '<') + 1);
-            $from_email = str_replace('>', '', $from_email);
-            $from_email = trim($from_email);
-        } elseif (trim($this->_from) !== '') {
-            $from_name  = '';
-            $from_email = trim($this->_from);
-        } else {
-            $from_name = $from_email = '';
-        }
-        return array($from_name, $from_email);
-    }
-
-
-    /**
-     * Callback for the wp_mail_from filter.
-     *
-     * @since 4.3.1
-     * @param string $from_email What the original from_email is.
-     * @return string
-     */
-    public function set_from_address($from_email)
-    {
-        $parsed_from = $this->_parse_from();
-        //includes fallback if the parsing failed.
-        $from_email = is_array($parsed_from) && ! empty($parsed_from[1])
-            ? $parsed_from[1]
-            : get_bloginfo('admin_email');
-        return $from_email;
-    }
-
-
-    /**
-     * Callback fro the wp_mail_from_name filter.
-     *
-     * @since 4.3.1
-     * @param string $from_name The original from_name.
-     * @return string
-     */
-    public function set_from_name($from_name)
-    {
-        $parsed_from = $this->_parse_from();
-        if (is_array($parsed_from) && ! empty($parsed_from[0])) {
-            $from_name = $parsed_from[0];
-        }
-
-        //if from name is "WordPress" let's sub in the site name instead (more friendly!)
-        //but realize the default name is HTML entity-encoded
-        $from_name = $from_name == 'WordPress' ? wp_specialchars_decode(get_bloginfo(), ENT_QUOTES) : $from_name;
-
-        return $from_name;
-    }
-
-
-    /**
-     * setup body for email
-     *
-     * @param bool $preview will determine whether this is preview template or not.
-     * @return string formatted body for email.
-     * @throws EE_Error
-     * @throws \TijsVerkoyen\CssToInlineStyles\Exception
-     */
-    protected function _body($preview = false)
-    {
-        //setup template args!
-        $this->_template_args = array(
-            'subject'   => $this->_subject,
-            'from'      => $this->_from,
-            'main_body' => wpautop($this->_content),
-        );
-        $body                 = $this->_get_main_template($preview);
-
-        /**
-         * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched.
-         *
-         * @type    bool $preview Indicates whether a preview is being generated or not.
-         * @return  bool    true  indicates to use the inliner, false bypasses it.
-         */
-        if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) {
-            //require CssToInlineStyles library and its dependencies via composer autoloader
-            require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php';
-
-            //now if this isn't a preview, let's setup the body so it has inline styles
-            if (! $preview || ($preview && defined('DOING_AJAX'))) {
-                $style = file_get_contents(
-                    $this->get_variation(
-                        $this->_tmp_pack,
-                        $this->_incoming_message_type->name,
-                        false,
-                        'main',
-                        $this->_variation
-                    ),
-                    true
-                );
-                $CSS   = new TijsVerkoyen\CssToInlineStyles\CssToInlineStyles($body, $style);
-                //for some reason the library has a bracket and new line at the beginning.  This takes care of that.
-                $body  = ltrim($CSS->convert(true), ">\n");
-                //see https://events.codebasehq.com/projects/event-espresso/tickets/8609
-                $body  = ltrim($body, "<?");
-            }
-
-        }
-        return $body;
-    }
-
-
-    /**
-     * This just returns any existing test settings that might be saved in the database
-     *
-     * @access public
-     * @return array
-     */
-    public function get_existing_test_settings()
-    {
-        $settings = parent::get_existing_test_settings();
-        //override subject if present because we always want it to be fresh.
-        if (is_array($settings) && ! empty($settings['subject'])) {
-            $settings['subject'] = sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name'));
-        }
-        return $settings;
-    }
+	/**
+	 * To field for email
+	 * @var string
+	 */
+	protected $_to = '';
+
+
+	/**
+	 * CC field for email.
+	 * @var string
+	 */
+	protected $_cc = '';
+
+	/**
+	 * From field for email
+	 * @var string
+	 */
+	protected $_from = '';
+
+
+	/**
+	 * Subject field for email
+	 * @var string
+	 */
+	protected $_subject = '';
+
+
+	/**
+	 * Content field for email
+	 * @var string
+	 */
+	protected $_content = '';
+
+
+	/**
+	 * constructor
+	 *
+	 * @access public
+	 */
+	public function __construct()
+	{
+		//set name and description properties
+		$this->name                = 'email';
+		$this->description         = sprintf(
+			esc_html__(
+				'This messenger delivers messages via email using the built-in %s function included with WordPress',
+				'event_espresso'
+			),
+			'<code>wp_mail</code>'
+		);
+		$this->label               = array(
+			'singular' => esc_html__('email', 'event_espresso'),
+			'plural'   => esc_html__('emails', 'event_espresso'),
+		);
+		$this->activate_on_install = true;
+
+		//we're using defaults so let's call parent constructor that will take care of setting up all the other
+		// properties
+		parent::__construct();
+	}
+
+
+	/**
+	 * see abstract declaration in parent class for details.
+	 */
+	protected function _set_admin_pages()
+	{
+		$this->admin_registered_pages = array(
+			'events_edit' => true,
+		);
+	}
+
+
+	/**
+	 * see abstract declaration in parent class for details
+	 */
+	protected function _set_valid_shortcodes()
+	{
+		//remember by leaving the other fields not set, those fields will inherit the valid shortcodes from the
+		// message type.
+		$this->_valid_shortcodes = array(
+			'to'   => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
+			'cc' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
+			'from' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
+		);
+	}
+
+
+	/**
+	 * see abstract declaration in parent class for details
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_validator_config()
+	{
+		$valid_shortcodes = $this->get_valid_shortcodes();
+
+		$this->_validator_config = array(
+			'to'            => array(
+				'shortcodes' => $valid_shortcodes['to'],
+				'type'       => 'email',
+			),
+			'cc' => array(
+				'shortcodes' => $valid_shortcodes['to'],
+				'type' => 'email',
+			),
+			'from'          => array(
+				'shortcodes' => $valid_shortcodes['from'],
+				'type'       => 'email',
+			),
+			'subject'       => array(
+				'shortcodes' => array(
+					'organization',
+					'primary_registration_details',
+					'event_author',
+					'primary_registration_details',
+					'recipient_details',
+				),
+			),
+			'content'       => array(
+				'shortcodes' => array(
+					'event_list',
+					'attendee_list',
+					'ticket_list',
+					'organization',
+					'primary_registration_details',
+					'primary_registration_list',
+					'event_author',
+					'recipient_details',
+					'recipient_list',
+					'transaction',
+					'messenger',
+				),
+			),
+			'attendee_list' => array(
+				'shortcodes' => array('attendee', 'event_list', 'ticket_list'),
+				'required'   => array('[ATTENDEE_LIST]'),
+			),
+			'event_list'    => array(
+				'shortcodes' => array(
+					'event',
+					'attendee_list',
+					'ticket_list',
+					'venue',
+					'datetime_list',
+					'attendee',
+					'primary_registration_details',
+					'primary_registration_list',
+					'event_author',
+					'recipient_details',
+					'recipient_list',
+				),
+				'required'   => array('[EVENT_LIST]'),
+			),
+			'ticket_list'   => array(
+				'shortcodes' => array(
+					'event_list',
+					'attendee_list',
+					'ticket',
+					'datetime_list',
+					'primary_registration_details',
+					'recipient_details',
+				),
+				'required'   => array('[TICKET_LIST]'),
+			),
+			'datetime_list' => array(
+				'shortcodes' => array('datetime'),
+				'required'   => array('[DATETIME_LIST]'),
+			),
+		);
+	}
+
+
+	/**
+	 * @see   parent EE_messenger class for docs
+	 * @since 4.5.0
+	 */
+	public function do_secondary_messenger_hooks($sending_messenger_name)
+	{
+		if ($sending_messenger_name = 'html') {
+			add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
+		}
+	}
+
+
+	public function add_email_css(
+		$variation_path,
+		$messenger,
+		$message_type,
+		$type,
+		$variation,
+		$file_extension,
+		$url,
+		EE_Messages_Template_Pack $template_pack
+	) {
+		//prevent recursion on this callback.
+		remove_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10);
+		$variation = $this->get_variation($template_pack, $message_type, $url, 'main', $variation, false);
+
+		add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
+		return $variation;
+	}
+
+
+	/**
+	 * See parent for details
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_test_settings_fields()
+	{
+		$this->_test_settings_fields = array(
+			'to'      => array(
+				'input'      => 'text',
+				'label'      => esc_html__('Send a test email to', 'event_espresso'),
+				'type'       => 'email',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+				'default'    => get_bloginfo('admin_email'),
+			),
+			'subject' => array(
+				'input'      => 'hidden',
+				'label'      => '',
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => false,
+				'format'     => '%s',
+				'value'      => sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name')),
+				'default'    => '',
+				'css_class'  => '',
+			),
+		);
+	}
+
+
+	/**
+	 * _set_template_fields
+	 * This sets up the fields that a messenger requires for the message to go out.
+	 *
+	 * @access  protected
+	 * @return void
+	 */
+	protected function _set_template_fields()
+	{
+		// any extra template fields that are NOT used by the messenger but will get used by a messenger field for
+		// shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field
+		// they relate to.  This is important for the Messages_admin to know what fields to display to the user.
+		//  Also, notice that the "values" are equal to the field type that messages admin will use to know what
+		// kind of field to display. The values ALSO have one index labeled "shortcode".  the values in that array
+		// indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be
+		// displayed.  If the required shortcode isn't part of the shortcodes array then the field is not needed and
+		// will not be displayed/parsed.
+		$this->_template_fields = array(
+			'to'      => array(
+				'input'      => 'text',
+				'label'      => esc_html_x(
+					'To',
+					'Label for the "To" field for email addresses',
+					'event_espresso'
+				),
+				'type'       => 'string',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'cc'      => array(
+				'input'      => 'text',
+				'label'      => esc_html_x(
+					'CC',
+					'Label for the "Carbon Copy" field used for additional email addresses',
+					'event_espresso'
+				),
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'from'    => array(
+				'input'      => 'text',
+				'label'      => esc_html_x(
+					'From',
+					'Label for the "From" field for email addresses.',
+					'event_espresso'
+				),
+				'type'       => 'string',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'subject' => array(
+				'input'      => 'text',
+				'label'      => esc_html_x(
+					'Subject',
+					'Label for the "Subject" field (short description of contents) for emails.',
+					'event_espresso'
+				),
+				'type'       => 'string',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'content' => '',
+			//left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
+			'extra'   => array(
+				'content' => array(
+					'main'          => array(
+						'input'      => 'wp_editor',
+						'label'      => esc_html__('Main Content', 'event_espresso'),
+						'type'       => 'string',
+						'required'   => true,
+						'validation' => true,
+						'format'     => '%s',
+						'rows'       => '15',
+					),
+					'event_list'    => array(
+						'input'               => 'wp_editor',
+						'label'               => '[EVENT_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'rows'                => '15',
+						'shortcodes_required' => array('[EVENT_LIST]'),
+					),
+					'attendee_list' => array(
+						'input'               => 'textarea',
+						'label'               => '[ATTENDEE_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => array('[ATTENDEE_LIST]'),
+					),
+					'ticket_list'   => array(
+						'input'               => 'textarea',
+						'label'               => '[TICKET_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '10',
+						'shortcodes_required' => array('[TICKET_LIST]'),
+					),
+					'datetime_list' => array(
+						'input'               => 'textarea',
+						'label'               => '[DATETIME_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '10',
+						'shortcodes_required' => array('[DATETIME_LIST]'),
+					),
+				),
+			),
+		);
+	}
+
+
+	/**
+	 * See definition of this class in parent
+	 */
+	protected function _set_default_message_types()
+	{
+		$this->_default_message_types = array(
+			'payment',
+			'payment_refund',
+			'registration',
+			'not_approved_registration',
+			'pending_approval',
+		);
+	}
+
+
+	/**
+	 * @see   definition of this class in parent
+	 * @since 4.5.0
+	 */
+	protected function _set_valid_message_types()
+	{
+		$this->_valid_message_types = array(
+			'payment',
+			'registration',
+			'not_approved_registration',
+			'declined_registration',
+			'cancelled_registration',
+			'pending_approval',
+			'registration_summary',
+			'payment_reminder',
+			'payment_declined',
+			'payment_refund',
+		);
+	}
+
+
+	/**
+	 * setting up admin_settings_fields for messenger.
+	 */
+	protected function _set_admin_settings_fields()
+	{
+	}
+
+	/**
+	 * We just deliver the messages don't kill us!!
+	 *
+	 * @return bool|WP_Error true if message delivered, false if it didn't deliver OR bubble up any error object if
+	 *              present.
+	 * @throws EE_Error
+	 * @throws \TijsVerkoyen\CssToInlineStyles\Exception
+	 */
+	protected function _send_message()
+	{
+		$success = wp_mail(
+			$this->_to,
+			//some old values for subject may be expecting HTML entities to be decoded in the subject
+			//and subjects aren't interpreted as HTML, so there should be no HTML in them
+			wp_strip_all_tags(wp_specialchars_decode($this->_subject, ENT_QUOTES)),
+			$this->_body(),
+			$this->_headers()
+		);
+		if (! $success) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The email did not send successfully.%3$sThe WordPress wp_mail function is used for sending mails but does not give any useful information when an email fails to send.%3$sIt is possible the "to" address (%1$s) or "from" address (%2$s) is invalid.%3$s',
+						'event_espresso'
+					),
+					$this->_to,
+					$this->_from,
+					'<br />'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return $success;
+	}
+
+
+	/**
+	 * see parent for definition
+	 *
+	 * @return string html body of the message content and the related css.
+	 * @throws EE_Error
+	 * @throws \TijsVerkoyen\CssToInlineStyles\Exception
+	 */
+	protected function _preview()
+	{
+		return $this->_body(true);
+	}
+
+
+	/**
+	 * Setup headers for email
+	 *
+	 * @access protected
+	 * @return string formatted header for email
+	 */
+	protected function _headers()
+	{
+		$this->_ensure_has_from_email_address();
+		$from    = $this->_from;
+		$headers = array(
+			'From:' . $from,
+			'Reply-To:' . $from,
+			'Content-Type:text/html; charset=utf-8',
+		);
+
+		/**
+		 * Second condition added as a result of https://events.codebasehq.com/projects/event-espresso/tickets/11416 to
+		 * cover back compat where there may be users who have saved cc values in their db for the newsletter message
+		 * type which they are no longer able to change.
+		 */
+		if (! empty($this->_cc) && ! $this->_incoming_message_type instanceof EE_Newsletter_message_type) {
+			$headers[] = 'cc: ' . $this->_cc;
+		}
+
+		//but wait!  Header's for the from is NOT reliable because some plugins don't respect From: as set in the
+		// header.
+		add_filter('wp_mail_from', array($this, 'set_from_address'), 100);
+		add_filter('wp_mail_from_name', array($this, 'set_from_name'), 100);
+		return apply_filters('FHEE__EE_Email_messenger___headers', $headers, $this->_incoming_message_type, $this);
+	}
+
+
+	/**
+	 * This simply ensures that the from address is not empty.  If it is, then we use whatever is set as the site email
+	 * address for the from address to avoid problems with sending emails.
+	 */
+	protected function _ensure_has_from_email_address()
+	{
+		if (empty($this->_from)) {
+			$this->_from = get_bloginfo('admin_email');
+		}
+	}
+
+
+	/**
+	 * This simply parses whatever is set as the $_from address and determines if it is in the format {name} <{email}>
+	 * or just {email} and returns an array with the "from_name" and "from_email" as the values. Note from_name *MAY*
+	 * be empty
+	 *
+	 * @since 4.3.1
+	 * @return array
+	 */
+	private function _parse_from()
+	{
+		if (strpos($this->_from, '<') !== false) {
+			$from_name = substr($this->_from, 0, strpos($this->_from, '<') - 1);
+			$from_name = str_replace('"', '', $from_name);
+			$from_name = trim($from_name);
+
+			$from_email = substr($this->_from, strpos($this->_from, '<') + 1);
+			$from_email = str_replace('>', '', $from_email);
+			$from_email = trim($from_email);
+		} elseif (trim($this->_from) !== '') {
+			$from_name  = '';
+			$from_email = trim($this->_from);
+		} else {
+			$from_name = $from_email = '';
+		}
+		return array($from_name, $from_email);
+	}
+
+
+	/**
+	 * Callback for the wp_mail_from filter.
+	 *
+	 * @since 4.3.1
+	 * @param string $from_email What the original from_email is.
+	 * @return string
+	 */
+	public function set_from_address($from_email)
+	{
+		$parsed_from = $this->_parse_from();
+		//includes fallback if the parsing failed.
+		$from_email = is_array($parsed_from) && ! empty($parsed_from[1])
+			? $parsed_from[1]
+			: get_bloginfo('admin_email');
+		return $from_email;
+	}
+
+
+	/**
+	 * Callback fro the wp_mail_from_name filter.
+	 *
+	 * @since 4.3.1
+	 * @param string $from_name The original from_name.
+	 * @return string
+	 */
+	public function set_from_name($from_name)
+	{
+		$parsed_from = $this->_parse_from();
+		if (is_array($parsed_from) && ! empty($parsed_from[0])) {
+			$from_name = $parsed_from[0];
+		}
+
+		//if from name is "WordPress" let's sub in the site name instead (more friendly!)
+		//but realize the default name is HTML entity-encoded
+		$from_name = $from_name == 'WordPress' ? wp_specialchars_decode(get_bloginfo(), ENT_QUOTES) : $from_name;
+
+		return $from_name;
+	}
+
+
+	/**
+	 * setup body for email
+	 *
+	 * @param bool $preview will determine whether this is preview template or not.
+	 * @return string formatted body for email.
+	 * @throws EE_Error
+	 * @throws \TijsVerkoyen\CssToInlineStyles\Exception
+	 */
+	protected function _body($preview = false)
+	{
+		//setup template args!
+		$this->_template_args = array(
+			'subject'   => $this->_subject,
+			'from'      => $this->_from,
+			'main_body' => wpautop($this->_content),
+		);
+		$body                 = $this->_get_main_template($preview);
+
+		/**
+		 * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched.
+		 *
+		 * @type    bool $preview Indicates whether a preview is being generated or not.
+		 * @return  bool    true  indicates to use the inliner, false bypasses it.
+		 */
+		if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) {
+			//require CssToInlineStyles library and its dependencies via composer autoloader
+			require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php';
+
+			//now if this isn't a preview, let's setup the body so it has inline styles
+			if (! $preview || ($preview && defined('DOING_AJAX'))) {
+				$style = file_get_contents(
+					$this->get_variation(
+						$this->_tmp_pack,
+						$this->_incoming_message_type->name,
+						false,
+						'main',
+						$this->_variation
+					),
+					true
+				);
+				$CSS   = new TijsVerkoyen\CssToInlineStyles\CssToInlineStyles($body, $style);
+				//for some reason the library has a bracket and new line at the beginning.  This takes care of that.
+				$body  = ltrim($CSS->convert(true), ">\n");
+				//see https://events.codebasehq.com/projects/event-espresso/tickets/8609
+				$body  = ltrim($body, "<?");
+			}
+
+		}
+		return $body;
+	}
+
+
+	/**
+	 * This just returns any existing test settings that might be saved in the database
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public function get_existing_test_settings()
+	{
+		$settings = parent::get_existing_test_settings();
+		//override subject if present because we always want it to be fresh.
+		if (is_array($settings) && ! empty($settings['subject'])) {
+			$settings['subject'] = sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name'));
+		}
+		return $settings;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -58,7 +58,7 @@ 
             ),
             '<code>wp_mail</code>'
         );
-        $this->label               = array(
+        $this->label = array(
             'singular' => esc_html__('email', 'event_espresso'),
             'plural'   => esc_html__('emails', 'event_espresso'),
         );
@@ -440,7 +440,7 @@ 
             $this->_body(),
             $this->_headers()
         );
-        if (! $success) {
+        if ( ! $success) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -484,8 +484,8 @@ 
         $this->_ensure_has_from_email_address();
         $from    = $this->_from;
         $headers = array(
-            'From:' . $from,
-            'Reply-To:' . $from,
+            'From:'.$from,
+            'Reply-To:'.$from,
             'Content-Type:text/html; charset=utf-8',
         );
 
@@ -494,8 +494,8 @@ 
          * cover back compat where there may be users who have saved cc values in their db for the newsletter message
          * type which they are no longer able to change.
          */
-        if (! empty($this->_cc) && ! $this->_incoming_message_type instanceof EE_Newsletter_message_type) {
-            $headers[] = 'cc: ' . $this->_cc;
+        if ( ! empty($this->_cc) && ! $this->_incoming_message_type instanceof EE_Newsletter_message_type) {
+            $headers[] = 'cc: '.$this->_cc;
         }
 
         //but wait!  Header's for the from is NOT reliable because some plugins don't respect From: as set in the
@@ -602,7 +602,7 @@ 
             'from'      => $this->_from,
             'main_body' => wpautop($this->_content),
         );
-        $body                 = $this->_get_main_template($preview);
+        $body = $this->_get_main_template($preview);
 
         /**
          * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched.
@@ -612,10 +612,10 @@ 
          */
         if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) {
             //require CssToInlineStyles library and its dependencies via composer autoloader
-            require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php';
+            require_once EE_THIRD_PARTY.'cssinliner/vendor/autoload.php';
 
             //now if this isn't a preview, let's setup the body so it has inline styles
-            if (! $preview || ($preview && defined('DOING_AJAX'))) {
+            if ( ! $preview || ($preview && defined('DOING_AJAX'))) {
                 $style = file_get_contents(
                     $this->get_variation(
                         $this->_tmp_pack,

core/libraries/messages/EE_Messages_Base.lib.php

Indentation +15 added lines, -15 removed lines

@@ -300,20 +300,20 @@
 	}
 
 
-    /**
-     * Allows a message type to specifically exclude template fields for the provided messenger.
-     * Filtered so this can be programmatically altered as well.
-     * @param string $messenger_name name of messenger
-     * @return array
-     */
+	/**
+	 * Allows a message type to specifically exclude template fields for the provided messenger.
+	 * Filtered so this can be programmatically altered as well.
+	 * @param string $messenger_name name of messenger
+	 * @return array
+	 */
 	public function excludedFieldsForMessenger($messenger_name)
-    {
-        return apply_filters(
-            'FHEE__EE_Messages_Base__excludedFieldForMessenger',
-            array(),
-            $messenger_name,
-            $this->name,
-            $this
-        );
-    }
+	{
+		return apply_filters(
+			'FHEE__EE_Messages_Base__excludedFieldForMessenger',
+			array(),
+			$messenger_name,
+			$this->name,
+			$this
+		);
+	}
 }

core/helpers/EEH_MSG_Template.helper.php

Indentation +5 added lines, -5 removed lines

@@ -492,7 +492,7 @@ 
 		if ( ! empty( $sending_messenger ) ) {
 			$with_messengers = $message_type->with_messengers();
 			if ( ! isset( $with_messengers[$message->messenger()] )
-			     || ! in_array( $sending_messenger, $with_messengers[$message->messenger()] ) ) {
+				 || ! in_array( $sending_messenger, $with_messengers[$message->messenger()] ) ) {
 				throw new EE_Error(
 					sprintf(
 						__(
@@ -1202,14 +1202,14 @@ 
 			return array();
 		}
 
-        $excluded_fields_for_messenger = $message_type->excludedFieldsForMessenger($messenger_name);
+		$excluded_fields_for_messenger = $message_type->excludedFieldsForMessenger($messenger_name);
 
 		//okay now let's assemble an array with the messenger template fields added to the message_type contexts.
 		foreach ( $message_type->get_contexts() as $context => $details ) {
 			foreach ( $messenger->get_template_fields() as $field => $value ) {
-			    if (in_array($field, $excluded_fields_for_messenger, true)) {
-			        continue;
-                }
+				if (in_array($field, $excluded_fields_for_messenger, true)) {
+					continue;
+				}
 				$template_fields[ $context ][ $field ] = $value;
 			}
 		}

Spacing +197 added lines, -197 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
 	exit('NO direct script access allowed');
 
 /**
@@ -59,24 +59,24 @@ 
 	 *                was not a new generated template but just reactivated (which only happens for global templates that
 	 *                already exist in the database.
 	 */
-	public static function generate_new_templates( $messenger, $message_types, $GRP_ID = 0, $global = false ) {
+	public static function generate_new_templates($messenger, $message_types, $GRP_ID = 0, $global = false) {
 		//make sure message_type is an array.
 		$message_types = (array) $message_types;
 		$templates = array();
 
-		if ( empty( $messenger ) ) {
-			throw new EE_Error( __('We need a messenger to generate templates!', 'event_espresso') );
+		if (empty($messenger)) {
+			throw new EE_Error(__('We need a messenger to generate templates!', 'event_espresso'));
 		}
 
 		//if we STILL have empty $message_types then we need to generate an error message b/c we NEED message types to do the template files.
-		if ( empty( $message_types ) ) {
-			throw new EE_Error( __('We need at least one message type to generate templates!', 'event_espresso') );
+		if (empty($message_types)) {
+			throw new EE_Error(__('We need at least one message type to generate templates!', 'event_espresso'));
 		}
 
 		EEH_MSG_Template::_set_autoloader();
-		foreach ( $message_types as $message_type ) {
+		foreach ($message_types as $message_type) {
 			//if global then let's attempt to get the GRP_ID for this combo IF GRP_ID is empty.
-			if ( $global && empty( $GRP_ID ) ) {
+			if ($global && empty($GRP_ID)) {
 				$GRP_ID = EEM_Message_Template_Group::instance()->get_one(
 					array(
 						array(
@@ -91,7 +91,7 @@ 
 			// if this is global template generation.
 			// First let's determine if we already HAVE global templates for this messenger and message_type combination.
 			//  If we do then NO generation!!
-			if ( $global && EEH_MSG_Template::already_generated( $messenger, $message_type, $GRP_ID ) ) {
+			if ($global && EEH_MSG_Template::already_generated($messenger, $message_type, $GRP_ID)) {
 				$templates[] = array(
 					'GRP_ID' => $GRP_ID,
 					'MTP_context' => '',
@@ -99,9 +99,9 @@ 
 				//we already have generated templates for this so let's go to the next message type.
 				continue;
 			}
-			$new_message_template_group = EEH_MSG_Template::create_new_templates( $messenger, $message_type, $GRP_ID, $global );
+			$new_message_template_group = EEH_MSG_Template::create_new_templates($messenger, $message_type, $GRP_ID, $global);
 
-			if ( ! $new_message_template_group ) {
+			if ( ! $new_message_template_group) {
 				continue;
 			}
 			$templates[] = $new_message_template_group;
@@ -118,10 +118,10 @@ 
 	 * @param  int $GRP_ID        GRP ID ( if a custom template) (if not provided then we're just doing global template check)
 	 * @return bool                true = generated, false = hasn't been generated.
 	 */
-	public static function already_generated( $messenger, $message_type, $GRP_ID = 0 ) {
+	public static function already_generated($messenger, $message_type, $GRP_ID = 0) {
 		EEH_MSG_Template::_set_autoloader();
 		//what method we use depends on whether we have an GRP_ID or not
-		$count = empty( $GRP_ID )
+		$count = empty($GRP_ID)
 			? EEM_Message_Template::instance()->count(
 				array(
 					array(
@@ -131,7 +131,7 @@ 
 					)
 				)
 			)
-			: EEM_Message_Template::instance()->count( array( array( 'GRP_ID' => $GRP_ID ) ) );
+			: EEM_Message_Template::instance()->count(array(array('GRP_ID' => $GRP_ID)));
 
 		return $count > 0;
 	}
@@ -147,15 +147,15 @@ 
 	 * @param  array  $message_type_names  Message type slug
 	 * @return  int 						count of updated records.
 	 */
-	public static function update_to_active( $messenger_names, $message_type_names ) {
-		$messenger_names = is_array( $messenger_names ) ? $messenger_names : array( $messenger_names );
-		$message_type_names = is_array( $message_type_names ) ? $message_type_names : array( $message_type_names );
+	public static function update_to_active($messenger_names, $message_type_names) {
+		$messenger_names = is_array($messenger_names) ? $messenger_names : array($messenger_names);
+		$message_type_names = is_array($message_type_names) ? $message_type_names : array($message_type_names);
 		return EEM_Message_Template_Group::instance()->update(
-			array( 'MTP_is_active' => 1 ),
+			array('MTP_is_active' => 1),
 			array(
 				array(
-					'MTP_messenger' 	=> array( 'IN', $messenger_names ),
-					'MTP_message_type'  => array( 'IN', $message_type_names )
+					'MTP_messenger' 	=> array('IN', $messenger_names),
+					'MTP_message_type'  => array('IN', $message_type_names)
 				)
 			)
 		);
@@ -176,7 +176,7 @@ 
 	 *
 	 * @return int  count of updated records.
 	 */
-	public static function update_to_inactive( $messenger_names = array(), $message_type_names = array() ) {
+	public static function update_to_inactive($messenger_names = array(), $message_type_names = array()) {
 		return EEM_Message_Template_Group::instance()->deactivate_message_template_groups_for(
 			$messenger_names,
 			$message_type_names
@@ -193,9 +193,9 @@ 
 	 * @param string $type
 	 * @return array array consisting of installed messenger objects and installed message type objects.
 	 */
-	public static function get_installed_message_objects( $type = 'all' ) {
+	public static function get_installed_message_objects($type = 'all') {
 		self::_set_autoloader();
-		$message_resource_manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
 		return array(
 			'messenger' => $message_resource_manager->installed_messengers(),
 			'message_type' => $message_resource_manager->installed_message_types()
@@ -231,74 +231,74 @@ 
 		$context = 'admin',
 		$merged = false
 	) {
-		$messenger_name = str_replace( ' ', '_', ucwords( str_replace( '_', ' ', $messenger ) ) );
-		$mt_name = str_replace( ' ', '_', ucwords( str_replace( '_', ' ', $message_type ) ) );
+		$messenger_name = str_replace(' ', '_', ucwords(str_replace('_', ' ', $messenger)));
+		$mt_name = str_replace(' ', '_', ucwords(str_replace('_', ' ', $message_type)));
 		/** @var EE_Message_Resource_Manager $message_resource_manager */
-		$message_resource_manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
 		//convert slug to object
-		$messenger = $message_resource_manager->get_messenger( $messenger );
+		$messenger = $message_resource_manager->get_messenger($messenger);
 
 		//if messenger isn't a EE_messenger resource then bail.
-		if ( ! $messenger instanceof EE_messenger ) {
+		if ( ! $messenger instanceof EE_messenger) {
 			return array();
 		}
 
 		//validate class for getting our list of shortcodes
-		$classname = 'EE_Messages_' . $messenger_name . '_' . $mt_name . '_Validator';
-		if ( ! class_exists( $classname ) ) {
-			$msg[] = __( 'The Validator class was unable to load', 'event_espresso' );
+		$classname = 'EE_Messages_'.$messenger_name.'_'.$mt_name.'_Validator';
+		if ( ! class_exists($classname)) {
+			$msg[] = __('The Validator class was unable to load', 'event_espresso');
 			$msg[] = sprintf(
-				__( 'The class name compiled was %s. Please check and make sure the spelling and case is correct for the class name and that there is an autoloader in place for this class', 'event_espresso' ),
+				__('The class name compiled was %s. Please check and make sure the spelling and case is correct for the class name and that there is an autoloader in place for this class', 'event_espresso'),
 				$classname
 			);
-			throw new EE_Error( implode( '||', $msg ) );
+			throw new EE_Error(implode('||', $msg));
 		}
 
 		/** @type EE_Messages_Validator $_VLD */
-		$_VLD = new $classname( array(), $context );
+		$_VLD = new $classname(array(), $context);
 		$valid_shortcodes = $_VLD->get_validators();
 
 		//let's make sure we're only getting the shortcode part of the validators
 		$shortcodes = array();
-		foreach ( $valid_shortcodes as $field => $validators ) {
-			$shortcodes[ $field ] = $validators['shortcodes'];
+		foreach ($valid_shortcodes as $field => $validators) {
+			$shortcodes[$field] = $validators['shortcodes'];
 		}
 		$valid_shortcodes = $shortcodes;
 
 		//if not all fields let's make sure we ONLY include the shortcodes for the specified fields.
-		if ( ! empty( $fields ) ) {
+		if ( ! empty($fields)) {
 			$specified_shortcodes = array();
-			foreach ( $fields as $field ) {
-				if ( isset( $valid_shortcodes[ $field ] ) ) {
-					$specified_shortcodes[ $field ] = $valid_shortcodes[ $field ];
+			foreach ($fields as $field) {
+				if (isset($valid_shortcodes[$field])) {
+					$specified_shortcodes[$field] = $valid_shortcodes[$field];
 				}
 			}
 			$valid_shortcodes = $specified_shortcodes;
 		}
 
 		//if not merged then let's replace the fields with the localized fields
-		if ( ! $merged ) {
+		if ( ! $merged) {
 			//let's get all the fields for the set messenger so that we can get the localized label and use that in the returned array.
 			$field_settings = $messenger->get_template_fields();
 			$localized = array();
-			foreach ( $valid_shortcodes as $field => $shortcodes ) {
+			foreach ($valid_shortcodes as $field => $shortcodes) {
 				//get localized field label
-				if ( isset( $field_settings[ $field ] ) ) {
+				if (isset($field_settings[$field])) {
 					//possible that this is used as a main field.
-					if ( empty( $field_settings[ $field ] ) ) {
-						if ( isset( $field_settings['extra'][ $field ] ) ) {
-							$_field = $field_settings['extra'][ $field ]['main']['label'];
+					if (empty($field_settings[$field])) {
+						if (isset($field_settings['extra'][$field])) {
+							$_field = $field_settings['extra'][$field]['main']['label'];
 						} else {
 							$_field = $field;
 						}
 					} else {
-						$_field = $field_settings[ $field ]['label'];
+						$_field = $field_settings[$field]['label'];
 					}
-				} else if ( isset( $field_settings['extra'] ) ) {
+				} else if (isset($field_settings['extra'])) {
 					//loop through extra "main fields" and see if any of their children have our field
-					foreach ( $field_settings['extra'] as $main_field => $fields ) {
-						if ( isset( $fields[ $field ] ) ) {
-							$_field = $fields[ $field ]['label'];
+					foreach ($field_settings['extra'] as $main_field => $fields) {
+						if (isset($fields[$field])) {
+							$_field = $fields[$field]['label'];
 						} else {
 							$_field = $field;
 						}
@@ -306,22 +306,22 @@ 
 				} else {
 					$_field = $field;
 				}
-				if ( isset( $_field ) ) {
-					$localized[ $_field ] = $shortcodes;
+				if (isset($_field)) {
+					$localized[$_field] = $shortcodes;
 				}
 			}
 			$valid_shortcodes = $localized;
 		}
 
 		//if $merged then let's merge all the shortcodes into one list NOT indexed by field.
-		if ( $merged ) {
+		if ($merged) {
 			$merged_codes = array();
-			foreach ( $valid_shortcodes as $field => $shortcode ) {
-				foreach ( $shortcode as $code => $label ) {
-					if ( isset( $merged_codes[ $code ] ) ) {
+			foreach ($valid_shortcodes as $field => $shortcode) {
+				foreach ($shortcode as $code => $label) {
+					if (isset($merged_codes[$code])) {
 						continue;
 					} else {
-						$merged_codes[ $code ] = $label;
+						$merged_codes[$code] = $label;
 					}
 				}
 			}
@@ -341,10 +341,10 @@ 
 	 * @throws \EE_Error
 	 * @return EE_messenger
 	 */
-	public static function messenger_obj( $messenger ) {
+	public static function messenger_obj($messenger) {
 		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-		$Message_Resource_Manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
-		return $Message_Resource_Manager->get_messenger( $messenger );
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		return $Message_Resource_Manager->get_messenger($messenger);
 	}
 
 
@@ -357,10 +357,10 @@ 
 	 * @throws \EE_Error
 	 * @return EE_message_type
 	 */
-	public static function message_type_obj( $message_type ) {
+	public static function message_type_obj($message_type) {
 		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-		$Message_Resource_Manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
-		return $Message_Resource_Manager->get_message_type( $message_type );
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		return $Message_Resource_Manager->get_message_type($message_type);
 	}
 
 
@@ -374,11 +374,11 @@ 
 	 * @param  string   $message_type message type to check for.
 	 * @return boolean
 	 */
-	public static function is_mt_active( $message_type ) {
+	public static function is_mt_active($message_type) {
 		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-		$Message_Resource_Manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
 		$active_mts = $Message_Resource_Manager->list_of_active_message_types();
-		return in_array( $message_type, $active_mts );
+		return in_array($message_type, $active_mts);
 	}
 
 
@@ -391,10 +391,10 @@ 
 	 * @param  string  $messenger slug for messenger to check.
 	 * @return boolean
 	 */
-	public static function is_messenger_active( $messenger ) {
+	public static function is_messenger_active($messenger) {
 		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-		$Message_Resource_Manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
-		$active_messenger = $Message_Resource_Manager->get_active_messenger( $messenger );
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$active_messenger = $Message_Resource_Manager->get_active_messenger($messenger);
 		return $active_messenger instanceof EE_messenger ? true : false;
 	}
 
@@ -412,11 +412,11 @@ 
 	public static function get_active_messengers_in_db() {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
-			__( 'Please use EE_Message_Resource_Manager::get_active_messengers_option() instead.', 'event_espresso' ),
+			__('Please use EE_Message_Resource_Manager::get_active_messengers_option() instead.', 'event_espresso'),
 			'4.9.0'
 		);
 		/** @var EE_Message_Resource_Manager $Message_Resource_Manager */
-		$Message_Resource_Manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
 		return $Message_Resource_Manager->get_active_messengers_option();
 	}
 
@@ -433,15 +433,15 @@ 
 	 *
 	 * @return bool FALSE if not updated, TRUE if updated.
 	 */
-	public static function update_active_messengers_in_db( $data_to_save ) {
+	public static function update_active_messengers_in_db($data_to_save) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
-			__( 'Please use EE_Message_Resource_Manager::update_active_messengers_option() instead.', 'event_espresso' ),
+			__('Please use EE_Message_Resource_Manager::update_active_messengers_option() instead.', 'event_espresso'),
 			'4.9.0'
 		);
 		/** @var EE_Message_Resource_Manager $Message_Resource_Manager */
-		$Message_Resource_Manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
-		return $Message_Resource_Manager->update_active_messengers_option( $data_to_save );
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		return $Message_Resource_Manager->update_active_messengers_option($data_to_save);
 	}
 
 
@@ -465,34 +465,34 @@ 
 		$sending_messenger = ''
 	) {
 		//first determine if the url can be to the EE_Message object.
-		if ( ! $message_type->always_generate() ) {
-			return EEH_MSG_Template::generate_browser_trigger( $message );
+		if ( ! $message_type->always_generate()) {
+			return EEH_MSG_Template::generate_browser_trigger($message);
 		}
 
 		//if $registration object is not valid then exit early because there's nothing that can be generated.
-		if ( ! $registration instanceof EE_Registration ) {
+		if ( ! $registration instanceof EE_Registration) {
 			throw new EE_Error(
-				__( 'Incoming value for registration is not a valid EE_Registration object.', 'event_espresso' )
+				__('Incoming value for registration is not a valid EE_Registration object.', 'event_espresso')
 			);
 		}
 
 		//validate given context
 		$contexts = $message_type->get_contexts();
-		if ( $message->context() !== '' && ! isset( $contexts[$message->context()] ) ) {
+		if ($message->context() !== '' && ! isset($contexts[$message->context()])) {
 			throw new EE_Error(
 				sprintf(
-					__( 'The context %s is not a valid context for %s.', 'event_espresso' ),
+					__('The context %s is not a valid context for %s.', 'event_espresso'),
 					$message->context(),
-					get_class( $message_type )
+					get_class($message_type)
 				)
 			);
 		}
 
 		//valid sending messenger but only if sending messenger set.  Otherwise generating messenger is used.
-		if ( ! empty( $sending_messenger ) ) {
+		if ( ! empty($sending_messenger)) {
 			$with_messengers = $message_type->with_messengers();
-			if ( ! isset( $with_messengers[$message->messenger()] )
-			     || ! in_array( $sending_messenger, $with_messengers[$message->messenger()] ) ) {
+			if ( ! isset($with_messengers[$message->messenger()])
+			     || ! in_array($sending_messenger, $with_messengers[$message->messenger()])) {
 				throw new EE_Error(
 					sprintf(
 						__(
@@ -500,7 +500,7 @@ 
 							'event_espresso'
 						),
 						$sending_messenger,
-						get_class( $message_type )
+						get_class($message_type)
 					)
 				);
 			}
@@ -523,14 +523,14 @@ 
 	 * @param EE_Message $message
 	 * @return string.
 	 */
-	public static function generate_browser_trigger( EE_Message $message ) {
+	public static function generate_browser_trigger(EE_Message $message) {
 		$query_args = array(
 			'ee' => 'msg_browser_trigger',
 			'token' => $message->MSG_token()
 		);
 		return apply_filters(
 			'FHEE__EEH_MSG_Template__generate_browser_trigger',
-			add_query_arg( $query_args, site_url() ),
+			add_query_arg($query_args, site_url()),
 			$message
 		);
 	}
@@ -545,7 +545,7 @@ 
 	 * @param EE_Message $message
 	 * @return string
 	 */
-	public static function generate_error_display_trigger( EE_Message $message ) {
+	public static function generate_error_display_trigger(EE_Message $message) {
 		return apply_filters(
 			'FHEE__EEH_MSG_Template__generate_error_display_trigger',
 			add_query_arg(
@@ -595,7 +595,7 @@ 
 			'GRP_ID' => $message_template_group,
 			'id' => $data_id
 			);
-		$url = add_query_arg( $query_args, get_home_url() );
+		$url = add_query_arg($query_args, get_home_url());
 
 		//made it here so now we can just get the url and filter it.  Filtered globally and by message type.
 		$url = apply_filters(
@@ -623,9 +623,9 @@ 
 	 * @param string $type  What action to return.
 	 * @return string
 	 */
-	public static function get_message_action_icon( $type ) {
+	public static function get_message_action_icon($type) {
 		$action_icons = self::get_message_action_icons();
-		return isset( $action_icons[ $type ] ) ? $action_icons[ $type ] : '';
+		return isset($action_icons[$type]) ? $action_icons[$type] : '';
 	}
 
 
@@ -637,34 +637,34 @@ 
 	 * @return array
 	 */
 	public static function get_message_action_icons() {
-		return apply_filters( 'FHEE__EEH_MSG_Template__message_action_icons',
+		return apply_filters('FHEE__EEH_MSG_Template__message_action_icons',
 			array(
 				'view' => array(
-					'label' => __( 'View Message', 'event_espresso' ),
+					'label' => __('View Message', 'event_espresso'),
 					'css_class' => 'dashicons dashicons-welcome-view-site',
 				),
 				'error' => array(
-					'label' => __( 'View Error Message', 'event_espresso' ),
+					'label' => __('View Error Message', 'event_espresso'),
 					'css_class' => 'dashicons dashicons-info',
 				),
 				'see_notifications_for' => array(
-					'label' => __( 'View Related Messages', 'event_espresso' ),
+					'label' => __('View Related Messages', 'event_espresso'),
 					'css_class' => 'dashicons dashicons-megaphone',
 				),
 				'generate_now' => array(
-					'label' => __( 'Generate the message now.', 'event_espresso' ),
+					'label' => __('Generate the message now.', 'event_espresso'),
 					'css_class' => 'dashicons dashicons-admin-tools',
 				),
 				'send_now' => array(
-					'label' => __( 'Send Immediately', 'event_espresso' ),
+					'label' => __('Send Immediately', 'event_espresso'),
 					'css_class' => 'dashicons dashicons-controls-forward',
 				),
 				'queue_for_resending' => array(
-					'label' => __( 'Queue for Resending', 'event_espresso' ),
+					'label' => __('Queue for Resending', 'event_espresso'),
 					'css_class' => 'dashicons dashicons-controls-repeat',
 				),
 				'view_transaction' => array(
-					'label' => __( 'View related Transaction', 'event_espresso' ),
+					'label' => __('View related Transaction', 'event_espresso'),
 					'css_class' => 'dashicons dashicons-cart',
 				)
 			)
@@ -683,9 +683,9 @@ 
 	 *
 	 * @return string
 	 */
-	public static function get_message_action_url( $type, EE_Message $message = null, $query_params = array() ) {
-		$action_urls = self::get_message_action_urls( $message, $query_params );
-		return isset( $action_urls[ $type ] )  ? $action_urls[ $type ] : '';
+	public static function get_message_action_url($type, EE_Message $message = null, $query_params = array()) {
+		$action_urls = self::get_message_action_urls($message, $query_params);
+		return isset($action_urls[$type]) ? $action_urls[$type] : '';
 	}
 
 
@@ -700,15 +700,15 @@ 
 	 *
 	 * @return array
 	 */
-	public static function get_message_action_urls( EE_Message $message = null, $query_params = array() ) {
-		EE_Registry::instance()->load_helper( 'URL' );
+	public static function get_message_action_urls(EE_Message $message = null, $query_params = array()) {
+		EE_Registry::instance()->load_helper('URL');
 		//if $message is not an instance of EE_Message then let's just do a dummy.
-		$message = empty( $message ) ? EE_Message_Factory::create() : $message;
-		$action_urls =  apply_filters(
+		$message = empty($message) ? EE_Message_Factory::create() : $message;
+		$action_urls = apply_filters(
 			'FHEE__EEH_MSG_Template__get_message_action_url',
 			array(
-				'view' => EEH_MSG_Template::generate_browser_trigger( $message ),
-				'error' => EEH_MSG_Template::generate_error_display_trigger( $message ),
+				'view' => EEH_MSG_Template::generate_browser_trigger($message),
+				'error' => EEH_MSG_Template::generate_error_display_trigger($message),
 				'see_notifications_for' => EEH_URL::add_query_args_and_nonce(
 					array_merge(
 						array(
@@ -718,7 +718,7 @@ 
 						),
 						$query_params
 					),
-					admin_url( 'admin.php' )
+					admin_url('admin.php')
 				),
 				'generate_now' => EEH_URL::add_query_args_and_nonce(
 					array(
@@ -726,7 +726,7 @@ 
 						'action' => 'generate_now',
 						'MSG_ID' => $message->ID()
 					),
-					admin_url( 'admin.php' )
+					admin_url('admin.php')
 				),
 				'send_now' => EEH_URL::add_query_args_and_nonce(
 					array(
@@ -734,7 +734,7 @@ 
 						'action' => 'send_now',
 						'MSG_ID' => $message->ID()
 					),
-					admin_url( 'admin.php' )
+					admin_url('admin.php')
 				),
 				'queue_for_resending' => EEH_URL::add_query_args_and_nonce(
 					array(
@@ -742,7 +742,7 @@ 
 						'action' => 'queue_for_resending',
 						'MSG_ID' => $message->ID()
 					),
-					admin_url( 'admin.php' )
+					admin_url('admin.php')
 				),
 			)
 		);
@@ -760,7 +760,7 @@ 
 					'action' => 'view_transaction',
 					'TXN_ID' => $message->TXN_ID()
 				),
-				admin_url( 'admin.php' )
+				admin_url('admin.php')
 			);
 		} else {
 			$action_urls['view_transaction'] = '';
@@ -781,26 +781,26 @@ 
 	 *
 	 * @return string
 	 */
-	public static function get_message_action_link( $type, EE_Message $message = null, $query_params = array() ) {
-		$url = EEH_MSG_Template::get_message_action_url( $type, $message, $query_params );
-		$icon_css = EEH_MSG_Template::get_message_action_icon( $type );
-		$title = isset( $icon_css['label'] ) ? 'title="' . $icon_css['label'] . '"' : '';
+	public static function get_message_action_link($type, EE_Message $message = null, $query_params = array()) {
+		$url = EEH_MSG_Template::get_message_action_url($type, $message, $query_params);
+		$icon_css = EEH_MSG_Template::get_message_action_icon($type);
+		$title = isset($icon_css['label']) ? 'title="'.$icon_css['label'].'"' : '';
 
-		if ( empty( $url ) || empty( $icon_css ) || ! isset( $icon_css['css_class'] ) ) {
+		if (empty($url) || empty($icon_css) || ! isset($icon_css['css_class'])) {
 			return '';
 		}
 
 		$icon_css['css_class'] .= esc_attr(
 			apply_filters(
 				'FHEE__EEH_MSG_Template__get_message_action_link__icon_css_class',
-				' js-ee-message-action-link ee-message-action-link-' . $type,
+				' js-ee-message-action-link ee-message-action-link-'.$type,
 				$type,
 				$message,
 				$query_params
 			)
 		);
 
-		return '<a href="' . $url . '"' . $title . '><span class="' . esc_attr( $icon_css['css_class'] ) . '"></span></a>';
+		return '<a href="'.$url.'"'.$title.'><span class="'.esc_attr($icon_css['css_class']).'"></span></a>';
 
 	}
 
@@ -838,9 +838,9 @@ 
 	 * @param $reg_status
 	 * @return string
 	 */
-	public static function convert_reg_status_to_message_type( $reg_status ) {
+	public static function convert_reg_status_to_message_type($reg_status) {
 		$reg_status_array = self::reg_status_to_message_type_array();
-		return isset( $reg_status_array[$reg_status] ) ? $reg_status_array[$reg_status] : '';
+		return isset($reg_status_array[$reg_status]) ? $reg_status_array[$reg_status] : '';
 	}
 
 
@@ -874,9 +874,9 @@ 
 	 * @param $payment_status
 	 * @return string
 	 */
-	public static function convert_payment_status_to_message_type( $payment_status ) {
+	public static function convert_payment_status_to_message_type($payment_status) {
 		$payment_status_array = self::payment_status_to_message_type_array();
-		return isset( $payment_status_array[$payment_status] ) ? $payment_status_array[$payment_status] : '';
+		return isset($payment_status_array[$payment_status]) ? $payment_status_array[$payment_status] : '';
 	}
 
 
@@ -887,32 +887,32 @@ 
 	 *
 	 * @return EE_Messages_Template_Pack
 	 */
-	public static function get_template_pack( $template_pack_name ) {
-		if ( ! self::$_template_pack_collection instanceof EE_Object_Collection ) {
+	public static function get_template_pack($template_pack_name) {
+		if ( ! self::$_template_pack_collection instanceof EE_Object_Collection) {
 			self::$_template_pack_collection = new EE_Messages_Template_Pack_Collection();
 		}
 
 		//first see if in collection already
-		$template_pack = self::$_template_pack_collection->get_by_name( $template_pack_name );
+		$template_pack = self::$_template_pack_collection->get_by_name($template_pack_name);
 
-		if ( $template_pack instanceof EE_Messages_Template_Pack ) {
+		if ($template_pack instanceof EE_Messages_Template_Pack) {
 			return $template_pack;
 		}
 
 		//nope...let's get it.
 		//not set yet so let's attempt to get it.
-		$pack_class_name = 'EE_Messages_Template_Pack_' . str_replace(
+		$pack_class_name = 'EE_Messages_Template_Pack_'.str_replace(
 				' ',
 				'_',
 				ucwords(
-					str_replace( '_', ' ', $template_pack_name )
+					str_replace('_', ' ', $template_pack_name)
 				)
 			);
-		if ( ! class_exists( $pack_class_name ) && $template_pack_name !== 'default' ) {
-			return self::get_template_pack( 'default' );
+		if ( ! class_exists($pack_class_name) && $template_pack_name !== 'default') {
+			return self::get_template_pack('default');
 		} else {
 			$template_pack = new $pack_class_name;
-			self::$_template_pack_collection->add( $template_pack );
+			self::$_template_pack_collection->add($template_pack);
 			return $template_pack;
 		}
 	}
@@ -930,26 +930,26 @@ 
 	 */
 	public static function get_template_pack_collection() {
 		$new_collection = false;
-		if ( ! self::$_template_pack_collection instanceof EE_Messages_Template_Pack_Collection ) {
+		if ( ! self::$_template_pack_collection instanceof EE_Messages_Template_Pack_Collection) {
 			self::$_template_pack_collection = new EE_Messages_Template_Pack_Collection();
 			$new_collection = true;
 		}
 
 		//glob the defaults directory for messages
-		$templates = glob( EE_LIBRARIES . 'messages/defaults/*', GLOB_ONLYDIR );
-		foreach( $templates as $template_path ) {
+		$templates = glob(EE_LIBRARIES.'messages/defaults/*', GLOB_ONLYDIR);
+		foreach ($templates as $template_path) {
 			//grab folder name
-			$template = basename( $template_path );
+			$template = basename($template_path);
 
-			if ( ! $new_collection ) {
+			if ( ! $new_collection) {
 				//already have it?
-				if ( self::$_template_pack_collection->get_by_name( $template ) instanceof EE_Messages_Template_Pack ) {
+				if (self::$_template_pack_collection->get_by_name($template) instanceof EE_Messages_Template_Pack) {
 					continue;
 				}
 			}
 
 			//setup classname.
-			$template_pack_class_name = 'EE_Messages_Template_Pack_' . str_replace(
+			$template_pack_class_name = 'EE_Messages_Template_Pack_'.str_replace(
 					' ',
 					'_',
 					ucwords(
@@ -960,20 +960,20 @@ 
 						)
 					)
 				);
-			if ( ! class_exists( $template_pack_class_name ) ) {
+			if ( ! class_exists($template_pack_class_name)) {
 				continue;
 			}
-			self::$_template_pack_collection->add( new $template_pack_class_name );
+			self::$_template_pack_collection->add(new $template_pack_class_name);
 		}
 
 		/**
 		 * Filter for plugins to add in any additional template packs
 		 * Note the filter name here is for backward compat, this used to be found in EED_Messages.
 		 */
-		$additional_template_packs = apply_filters( 'FHEE__EED_Messages__get_template_packs__template_packs', array() );
-		foreach ( (array) $additional_template_packs as $template_pack ) {
-			if ( ! self::$_template_pack_collection->contains($template_pack ) ) {
-				self::$_template_pack_collection->add( $template_pack );
+		$additional_template_packs = apply_filters('FHEE__EED_Messages__get_template_packs__template_packs', array());
+		foreach ((array) $additional_template_packs as $template_pack) {
+			if ( ! self::$_template_pack_collection->contains($template_pack)) {
+				self::$_template_pack_collection->add($template_pack);
 			}
 		}
 		return self::$_template_pack_collection;
@@ -991,16 +991,16 @@ 
 	 * @return array
 	 * @throws \EE_Error
 	 */
-	public static function create_new_templates( $messenger_name, $message_type_name, $GRP_ID = 0, $global = false ) {
+	public static function create_new_templates($messenger_name, $message_type_name, $GRP_ID = 0, $global = false) {
 		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-		$Message_Resource_Manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
-		$messenger = $Message_Resource_Manager->valid_messenger( $messenger_name );
-		$message_type = $Message_Resource_Manager->valid_message_type( $message_type_name );
-		if ( ! EEH_MSG_Template::message_type_has_active_templates_for_messenger( $messenger, $message_type, $global ) ) {
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$messenger = $Message_Resource_Manager->valid_messenger($messenger_name);
+		$message_type = $Message_Resource_Manager->valid_message_type($message_type_name);
+		if ( ! EEH_MSG_Template::message_type_has_active_templates_for_messenger($messenger, $message_type, $global)) {
 			return array();
 		}
 		//whew made it this far!  Okay, let's go ahead and create the templates then
-		return EEH_MSG_Template::_create_new_templates( $messenger, $message_type, $GRP_ID, $global );
+		return EEH_MSG_Template::_create_new_templates($messenger, $message_type, $GRP_ID, $global);
 	}
 
 
@@ -1012,15 +1012,15 @@ 
 	 * @param                  $global
 	 * @return array|mixed
 	 */
-	protected static function _create_new_templates( EE_messenger $messenger, EE_message_type $message_type, $GRP_ID, $global ) {
+	protected static function _create_new_templates(EE_messenger $messenger, EE_message_type $message_type, $GRP_ID, $global) {
 		//if we're creating a custom template then we don't need to use the defaults class
-		if ( ! $global ) {
-			return EEH_MSG_Template::_create_custom_template_group( $messenger, $message_type, $GRP_ID );
+		if ( ! $global) {
+			return EEH_MSG_Template::_create_custom_template_group($messenger, $message_type, $GRP_ID);
 		}
 		/** @type EE_Messages_Template_Defaults $Message_Template_Defaults */
 		$Message_Template_Defaults = EE_Registry::factory(
 			'EE_Messages_Template_Defaults',
-			array( $messenger, $message_type, $GRP_ID )
+			array($messenger, $message_type, $GRP_ID)
 		);
 		//generate templates
 		$success = $Message_Template_Defaults->create_new_templates();
@@ -1028,10 +1028,10 @@ 
 		//if creating the template failed.  Then we should deactivate the related message_type for the messenger because
 		//its not active if it doesn't have a template.  Note this is only happening for GLOBAL template creation
 		//attempts.
-		if ( ! $success ) {
+		if ( ! $success) {
 			/** @var EE_Message_Resource_Manager $message_resource_manager */
-			$message_resource_manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
-			$message_resource_manager->deactivate_message_type_for_messenger( $message_type->name, $messenger->name );
+			$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+			$message_resource_manager->deactivate_message_type_for_messenger($message_type->name, $messenger->name);
 		}
 
 		/**
@@ -1059,11 +1059,11 @@ 
 	 * 										)
 	 * @access private
 	 */
-	private static function _create_custom_template_group( EE_messenger $messenger, EE_message_type $message_type, $GRP_ID ) {
+	private static function _create_custom_template_group(EE_messenger $messenger, EE_message_type $message_type, $GRP_ID) {
 		//defaults
-		$success = array( 'GRP_ID' => null, 'MTP_context' => '' );
+		$success = array('GRP_ID' => null, 'MTP_context' => '');
 		//get the template group to use as a template from the db.  If $GRP_ID is empty then we'll assume the base will be the global template matching the messenger and message type.
-		$Message_Template_Group = empty( $GRP_ID )
+		$Message_Template_Group = empty($GRP_ID)
 			? EEM_Message_Template_Group::instance()->get_one(
 				array(
 					array(
@@ -1073,9 +1073,9 @@ 
 					)
 				)
 			)
-			: EEM_Message_Template_Group::instance()->get_one_by_ID( $GRP_ID );
+			: EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
 		//if we don't have a mtg at this point then we need to bail.
-		if ( ! $Message_Template_Group instanceof EE_Message_Template_Group ) {
+		if ( ! $Message_Template_Group instanceof EE_Message_Template_Group) {
 			EE_Error::add_error(
 				sprintf(
 					__(
@@ -1094,42 +1094,42 @@ 
 		$message_templates = $Message_Template_Group->message_templates();
 		//now we have what we need to setup the new template
 		$new_mtg = clone $Message_Template_Group;
-		$new_mtg->set( 'GRP_ID', 0 );
-		$new_mtg->set( 'MTP_is_global', false );
-		$template_name = defined( 'DOING_AJAX' ) && ! empty( $_POST[ 'templateName' ] )
-			? $_POST[ 'templateName' ]
+		$new_mtg->set('GRP_ID', 0);
+		$new_mtg->set('MTP_is_global', false);
+		$template_name = defined('DOING_AJAX') && ! empty($_POST['templateName'])
+			? $_POST['templateName']
 			: __(
 				'New Custom Template',
 				'event_espresso'
 			);
-		$template_description = defined( "DOING_AJAX" ) && ! empty( $_POST[ 'templateDescription' ] )
-			? $_POST[ 'templateDescription' ]
+		$template_description = defined("DOING_AJAX") && ! empty($_POST['templateDescription'])
+			? $_POST['templateDescription']
 			: sprintf(
 				__(
 					'This is a custom template that was created for the %s messenger and %s message type.',
 					'event_espresso'
 				),
-				$new_mtg->messenger_obj()->label[ 'singular' ],
-				$new_mtg->message_type_obj()->label[ 'singular' ]
+				$new_mtg->messenger_obj()->label['singular'],
+				$new_mtg->message_type_obj()->label['singular']
 			);
-		$new_mtg->set( 'MTP_name', $template_name );
-		$new_mtg->set( 'MTP_description', $template_description );
+		$new_mtg->set('MTP_name', $template_name);
+		$new_mtg->set('MTP_description', $template_description);
 		//remove ALL relations on this template group so they don't get saved!
-		$new_mtg->_remove_relations( 'Message_Template' );
+		$new_mtg->_remove_relations('Message_Template');
 		$new_mtg->save();
-		$success[ 'GRP_ID' ] = $new_mtg->ID();
-		$success[ 'template_name' ] = $template_name;
+		$success['GRP_ID'] = $new_mtg->ID();
+		$success['template_name'] = $template_name;
 		//add new message templates and add relation to.
-		foreach ( $message_templates as $message_template ) {
-			if ( ! $message_template instanceof EE_Message_Template ) {
+		foreach ($message_templates as $message_template) {
+			if ( ! $message_template instanceof EE_Message_Template) {
 				continue;
 			}
 			$new_message_template = clone $message_template;
-			$new_message_template->set( 'MTP_ID', 0 );
-			$new_message_template->set( 'GRP_ID', $new_mtg->ID() ); //relation
+			$new_message_template->set('MTP_ID', 0);
+			$new_message_template->set('GRP_ID', $new_mtg->ID()); //relation
 			$new_message_template->save();
-			if ( empty( $success[ 'MTP_context' ] ) ) {
-				$success[ 'MTP_context' ] = $new_message_template->get( 'MTP_context' );
+			if (empty($success['MTP_context'])) {
+				$success['MTP_context'] = $new_message_template->get('MTP_context');
 			}
 		}
 		return $success;
@@ -1151,7 +1151,7 @@ 
 		$global = false
 	) {
 		//is given message_type valid for given messenger (if this is not a global save)
-		if ( $global ) {
+		if ($global) {
 			return true;
 		}
 		$active_templates = EEM_Message_Template_Group::instance()->count(
@@ -1163,7 +1163,7 @@ 
 				)
 			)
 		);
-		if ( $active_templates > 0 ) {
+		if ($active_templates > 0) {
 			return true;
 		}
 		EE_Error::add_error(
@@ -1192,30 +1192,30 @@ 
 	 * @param  string $message_type_name name of EE_message_type
 	 * @return array
 	 */
-	public static function get_fields( $messenger_name, $message_type_name ) {
+	public static function get_fields($messenger_name, $message_type_name) {
 		$template_fields = array();
 		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-		$Message_Resource_Manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
-		$messenger = $Message_Resource_Manager->valid_messenger( $messenger_name );
-		$message_type = $Message_Resource_Manager->valid_message_type( $message_type_name );
-		if ( ! EEH_MSG_Template::message_type_has_active_templates_for_messenger( $messenger, $message_type ) ) {
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$messenger = $Message_Resource_Manager->valid_messenger($messenger_name);
+		$message_type = $Message_Resource_Manager->valid_message_type($message_type_name);
+		if ( ! EEH_MSG_Template::message_type_has_active_templates_for_messenger($messenger, $message_type)) {
 			return array();
 		}
 
         $excluded_fields_for_messenger = $message_type->excludedFieldsForMessenger($messenger_name);
 
 		//okay now let's assemble an array with the messenger template fields added to the message_type contexts.
-		foreach ( $message_type->get_contexts() as $context => $details ) {
-			foreach ( $messenger->get_template_fields() as $field => $value ) {
+		foreach ($message_type->get_contexts() as $context => $details) {
+			foreach ($messenger->get_template_fields() as $field => $value) {
 			    if (in_array($field, $excluded_fields_for_messenger, true)) {
 			        continue;
                 }
-				$template_fields[ $context ][ $field ] = $value;
+				$template_fields[$context][$field] = $value;
 			}
 		}
-		if ( empty( $template_fields ) ) {
+		if (empty($template_fields)) {
 			EE_Error::add_error(
-				__( 'Something went wrong and we couldn\'t get any templates assembled', 'event_espresso' ),
+				__('Something went wrong and we couldn\'t get any templates assembled', 'event_espresso'),
 				__FILE__,
 				__FUNCTION__,
 				__LINE__