eventespresso / event-espresso-core

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/services/bootstrap/BootstrapCore.php

Indentation +228 added lines, -228 removed lines

@@ -52,234 +52,234 @@
 class BootstrapCore
 {
 
-    /**
-     * @type LoaderInterface $loader
-     */
-    private $loader;
-
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
-
-    /**
-     * @var ResponseInterface $response
-     */
-    protected $response;
-
-    /**
-     * @var RequestStackBuilder $request_stack_builder
-     */
-    protected $request_stack_builder;
-
-    /**
-     * @var RequestStack $request_stack
-     */
-    protected $request_stack;
-
-
-    /**
-     * BootstrapCore constructor.
-     */
-    public function __construct()
-    {
-        // construct request stack and run middleware apps as soon as all WP plugins are loaded
-        add_action('plugins_loaded', array($this, 'initialize'), 0);
-    }
-
-
-    /**
-     * @throws InvalidRequestStackMiddlewareException
-     * @throws InvalidClassException
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function initialize()
-    {
-        $this->bootstrapDependencyInjectionContainer();
-        $this->bootstrapDomain();
-        $bootstrap_request = $this->bootstrapRequestResponseObjects();
-        add_action(
-            'EE_Load_Espresso_Core__handle_request__initialize_core_loading',
-            array($bootstrap_request, 'setupLegacyRequest')
-        );
-        $this->runRequestStack();
-    }
-
-
-    /**
-     * @throws ReflectionException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function bootstrapDependencyInjectionContainer()
-    {
-        $bootstrap_di = new BootstrapDependencyInjectionContainer();
-        $bootstrap_di->buildLegacyDependencyInjectionContainer();
-        $bootstrap_di->buildLoader();
-        $registry = $bootstrap_di->getRegistry();
-        $dependency_map = $bootstrap_di->getDependencyMap();
-        $dependency_map->initialize();
-        $registry->initialize();
-        $this->loader = $bootstrap_di->getLoader();
-    }
-
-
-    /**
-     * configures the Domain object for core
-     *
-     * @return void
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     * @throws InvalidFilePathException
-     * @throws InvalidInterfaceException
-     */
-    private function bootstrapDomain()
-    {
-        DomainFactory::getShared(
-            new FullyQualifiedName(
-                'EventEspresso\core\domain\Domain'
-            ),
-            array(
-                new FilePath(EVENT_ESPRESSO_MAIN_FILE),
-                Version::fromString(espresso_version())
-            )
-        );
-    }
-
-
-    /**
-     * sets up the request and response objects
-     *
-     * @return BootstrapRequestResponseObjects
-     * @throws InvalidArgumentException
-     */
-    private function bootstrapRequestResponseObjects()
-    {
-        /** @var BootstrapRequestResponseObjects $bootstrap_request */
-        $bootstrap_request = $this->loader->getShared(
-            'EventEspresso\core\services\bootstrap\BootstrapRequestResponseObjects',
-            array($this->loader)
-        );
-        $bootstrap_request->buildRequestResponse();
-        $bootstrap_request->shareRequestResponse();
-        $this->request  = $this->loader->getShared('EventEspresso\core\services\request\Request');
-        $this->response = $this->loader->getShared('EventEspresso\core\services\request\Response');
-        return $bootstrap_request;
-    }
-
-
-    /**
-     * run_request_stack
-     * construct request stack and run middleware apps
-     *
-     * @throws InvalidRequestStackMiddlewareException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function runRequestStack()
-    {
-        $this->loadAutoloader();
-        $this->setAutoloadersForRequiredFiles();
-        $this->request_stack_builder = $this->buildRequestStack();
-        $this->request_stack         = $this->request_stack_builder->resolve(
-            new RequestStackCoreApp()
-        );
-        $this->request_stack->handleRequest($this->request, $this->response);
-        $this->request_stack->handleResponse();
-    }
-
-
-    /**
-     * load_autoloader
-     *
-     * @throws EE_Error
-     */
-    protected function loadAutoloader()
-    {
-        // load interfaces
-        espresso_load_required(
-            'EEH_Autoloader',
-            EE_CORE . 'helpers' . DS . 'EEH_Autoloader.helper.php'
-        );
-        EEH_Autoloader::instance();
-    }
-
-
-
-    /**
-     * load_required_files
-     *
-     * @throws EE_Error
-     */
-    protected function setAutoloadersForRequiredFiles()
-    {
-        // load interfaces
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'interfaces', true);
-        // load helpers
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_HELPERS);
-        // load request stack
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'request_stack' . DS);
-        // load middleware
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'middleware' . DS);
-    }
-
-
-
-    /**
-     * build_request_stack
-     *
-     * @return RequestStackBuilder
-     */
-    public function buildRequestStack()
-    {
-        $request_stack_builder = new RequestStackBuilder($this->loader);
-        /**
-         * ! IMPORTANT ! The middleware stack operates FILO : FIRST IN LAST OUT
-         * so items at the beginning of the final middleware stack will run last.
-         * First parameter is the middleware classname, second is an array of arguments
-         */
-        $stack_apps            = apply_filters(
-            'FHEE__EventEspresso_core_services_bootstrap_BootstrapCore__buildRequestStack__stack_apps',
-            array(
-                // first in last out
-                'EventEspresso\core\services\request\middleware\BotDetector' => array(),
-                'EventEspresso\core\services\request\middleware\DetectFileEditorRequest' => array(),
-                'EventEspresso\core\services\request\middleware\PreProductionVersionWarning' => array(),
-                'EventEspresso\core\services\request\middleware\RecommendedVersions' => array(),
-                // last in first out
-                'EventEspresso\core\services\request\middleware\DetectLogin' => array(),
-            )
-        );
-        // legacy filter for backwards compatibility
-        $stack_apps            = apply_filters(
-            'FHEE__EE_Bootstrap__build_request_stack__stack_apps',
-            $stack_apps
-        );
-        // load middleware onto stack : FILO (First In Last Out)
-        // items at the beginning of the $stack_apps array will run last
-        foreach ((array) $stack_apps as $stack_app => $stack_app_args) {
-            $request_stack_builder->push(array($stack_app, $stack_app_args));
-        }
-        // finally, we'll add this on its own because we need it to always be part of the stack
-        // and we also need it to always run first because the rest of the system relies on it
-        $request_stack_builder->push(
-            array('EventEspresso\core\services\request\middleware\SetRequestTypeContextChecker', array())
-        );
-        return apply_filters(
-            'FHEE__EE_Bootstrap__build_request_stack__request_stack_builder',
-            $request_stack_builder
-        );
-    }
+	/**
+	 * @type LoaderInterface $loader
+	 */
+	private $loader;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
+
+	/**
+	 * @var ResponseInterface $response
+	 */
+	protected $response;
+
+	/**
+	 * @var RequestStackBuilder $request_stack_builder
+	 */
+	protected $request_stack_builder;
+
+	/**
+	 * @var RequestStack $request_stack
+	 */
+	protected $request_stack;
+
+
+	/**
+	 * BootstrapCore constructor.
+	 */
+	public function __construct()
+	{
+		// construct request stack and run middleware apps as soon as all WP plugins are loaded
+		add_action('plugins_loaded', array($this, 'initialize'), 0);
+	}
+
+
+	/**
+	 * @throws InvalidRequestStackMiddlewareException
+	 * @throws InvalidClassException
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function initialize()
+	{
+		$this->bootstrapDependencyInjectionContainer();
+		$this->bootstrapDomain();
+		$bootstrap_request = $this->bootstrapRequestResponseObjects();
+		add_action(
+			'EE_Load_Espresso_Core__handle_request__initialize_core_loading',
+			array($bootstrap_request, 'setupLegacyRequest')
+		);
+		$this->runRequestStack();
+	}
+
+
+	/**
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function bootstrapDependencyInjectionContainer()
+	{
+		$bootstrap_di = new BootstrapDependencyInjectionContainer();
+		$bootstrap_di->buildLegacyDependencyInjectionContainer();
+		$bootstrap_di->buildLoader();
+		$registry = $bootstrap_di->getRegistry();
+		$dependency_map = $bootstrap_di->getDependencyMap();
+		$dependency_map->initialize();
+		$registry->initialize();
+		$this->loader = $bootstrap_di->getLoader();
+	}
+
+
+	/**
+	 * configures the Domain object for core
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 * @throws InvalidFilePathException
+	 * @throws InvalidInterfaceException
+	 */
+	private function bootstrapDomain()
+	{
+		DomainFactory::getShared(
+			new FullyQualifiedName(
+				'EventEspresso\core\domain\Domain'
+			),
+			array(
+				new FilePath(EVENT_ESPRESSO_MAIN_FILE),
+				Version::fromString(espresso_version())
+			)
+		);
+	}
+
+
+	/**
+	 * sets up the request and response objects
+	 *
+	 * @return BootstrapRequestResponseObjects
+	 * @throws InvalidArgumentException
+	 */
+	private function bootstrapRequestResponseObjects()
+	{
+		/** @var BootstrapRequestResponseObjects $bootstrap_request */
+		$bootstrap_request = $this->loader->getShared(
+			'EventEspresso\core\services\bootstrap\BootstrapRequestResponseObjects',
+			array($this->loader)
+		);
+		$bootstrap_request->buildRequestResponse();
+		$bootstrap_request->shareRequestResponse();
+		$this->request  = $this->loader->getShared('EventEspresso\core\services\request\Request');
+		$this->response = $this->loader->getShared('EventEspresso\core\services\request\Response');
+		return $bootstrap_request;
+	}
+
+
+	/**
+	 * run_request_stack
+	 * construct request stack and run middleware apps
+	 *
+	 * @throws InvalidRequestStackMiddlewareException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function runRequestStack()
+	{
+		$this->loadAutoloader();
+		$this->setAutoloadersForRequiredFiles();
+		$this->request_stack_builder = $this->buildRequestStack();
+		$this->request_stack         = $this->request_stack_builder->resolve(
+			new RequestStackCoreApp()
+		);
+		$this->request_stack->handleRequest($this->request, $this->response);
+		$this->request_stack->handleResponse();
+	}
+
+
+	/**
+	 * load_autoloader
+	 *
+	 * @throws EE_Error
+	 */
+	protected function loadAutoloader()
+	{
+		// load interfaces
+		espresso_load_required(
+			'EEH_Autoloader',
+			EE_CORE . 'helpers' . DS . 'EEH_Autoloader.helper.php'
+		);
+		EEH_Autoloader::instance();
+	}
+
+
+
+	/**
+	 * load_required_files
+	 *
+	 * @throws EE_Error
+	 */
+	protected function setAutoloadersForRequiredFiles()
+	{
+		// load interfaces
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'interfaces', true);
+		// load helpers
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_HELPERS);
+		// load request stack
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'request_stack' . DS);
+		// load middleware
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'middleware' . DS);
+	}
+
+
+
+	/**
+	 * build_request_stack
+	 *
+	 * @return RequestStackBuilder
+	 */
+	public function buildRequestStack()
+	{
+		$request_stack_builder = new RequestStackBuilder($this->loader);
+		/**
+		 * ! IMPORTANT ! The middleware stack operates FILO : FIRST IN LAST OUT
+		 * so items at the beginning of the final middleware stack will run last.
+		 * First parameter is the middleware classname, second is an array of arguments
+		 */
+		$stack_apps            = apply_filters(
+			'FHEE__EventEspresso_core_services_bootstrap_BootstrapCore__buildRequestStack__stack_apps',
+			array(
+				// first in last out
+				'EventEspresso\core\services\request\middleware\BotDetector' => array(),
+				'EventEspresso\core\services\request\middleware\DetectFileEditorRequest' => array(),
+				'EventEspresso\core\services\request\middleware\PreProductionVersionWarning' => array(),
+				'EventEspresso\core\services\request\middleware\RecommendedVersions' => array(),
+				// last in first out
+				'EventEspresso\core\services\request\middleware\DetectLogin' => array(),
+			)
+		);
+		// legacy filter for backwards compatibility
+		$stack_apps            = apply_filters(
+			'FHEE__EE_Bootstrap__build_request_stack__stack_apps',
+			$stack_apps
+		);
+		// load middleware onto stack : FILO (First In Last Out)
+		// items at the beginning of the $stack_apps array will run last
+		foreach ((array) $stack_apps as $stack_app => $stack_app_args) {
+			$request_stack_builder->push(array($stack_app, $stack_app_args));
+		}
+		// finally, we'll add this on its own because we need it to always be part of the stack
+		// and we also need it to always run first because the rest of the system relies on it
+		$request_stack_builder->push(
+			array('EventEspresso\core\services\request\middleware\SetRequestTypeContextChecker', array())
+		);
+		return apply_filters(
+			'FHEE__EE_Bootstrap__build_request_stack__request_stack_builder',
+			$request_stack_builder
+		);
+	}
 
 
 }

espresso.php

Indentation +79 added lines, -79 removed lines

@@ -38,103 +38,103 @@
  * @since       4.0
  */
 if (function_exists('espresso_version')) {
-    if (! function_exists('espresso_duplicate_plugin_error')) {
-        /**
-         *    espresso_duplicate_plugin_error
-         *    displays if more than one version of EE is activated at the same time
-         */
-        function espresso_duplicate_plugin_error()
-        {
-            ?>
+	if (! function_exists('espresso_duplicate_plugin_error')) {
+		/**
+		 *    espresso_duplicate_plugin_error
+		 *    displays if more than one version of EE is activated at the same time
+		 */
+		function espresso_duplicate_plugin_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                    ); ?>
+					echo esc_html__(
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+					); ?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
-    }
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
+	}
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '5.3.9');
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '5.3.9');
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    printf(
-                        esc_html__(
-                            'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                            'event_espresso'
-                        ),
-                        EE_MIN_PHP_VER_REQUIRED,
-                        PHP_VERSION,
-                        '<br/>',
-                        '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
-                    );
-                    ?>
+					printf(
+						esc_html__(
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+							'event_espresso'
+						),
+						EE_MIN_PHP_VER_REQUIRED,
+						PHP_VERSION,
+						'<br/>',
+						'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
+					);
+					?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '4.9.59.rc.031');
-        }
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '4.9.59.rc.031');
+		}
 
-        /**
-         * espresso_plugin_activation
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-        }
+		/**
+		 * espresso_plugin_activation
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
 
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
-        bootstrap_espresso();
-    }
+		require_once __DIR__ . '/core/bootstrap_espresso.php';
+		bootstrap_espresso();
+	}
 }
 if (! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin($plugin_basename = '')
-    {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin($plugin_basename = '')
+	{
+		if (! function_exists('deactivate_plugins')) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }

caffeinated/core/libraries/messages/message_type/newsletter/EE_Messages_Email_Newsletter_Validator.class.php

Indentation +53 added lines, -53 removed lines

@@ -7,7 +7,7 @@ 
  * @since           4.3.0
  */
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -21,59 +21,59 @@ 
  */
 class EE_Messages_Email_Newsletter_Validator extends EE_Messages_Validator
 {
-    public function __construct($fields, $context)
-    {
-        $this->_m_name = 'email';
-        $this->_mt_name = 'newsletter';
+	public function __construct($fields, $context)
+	{
+		$this->_m_name = 'email';
+		$this->_mt_name = 'newsletter';
 
-        parent::__construct($fields, $context);
-    }
+		parent::__construct($fields, $context);
+	}
 
-    /**
-     * custom validator (restricting what was originally set by the messenger)
-     */
-    protected function _modify_validator()
-    {
-        if ($this->_context == 'attendee') {
-            $this->_valid_shortcodes_modifier[$this->_context]['from'] = array(
-                'recipient_details',
-                'email',
-                'organization',
-            );
-        }
+	/**
+	 * custom validator (restricting what was originally set by the messenger)
+	 */
+	protected function _modify_validator()
+	{
+		if ($this->_context == 'attendee') {
+			$this->_valid_shortcodes_modifier[$this->_context]['from'] = array(
+				'recipient_details',
+				'email',
+				'organization',
+			);
+		}
 
-        //excluded shortcodes
-        $fields = array('to', 'from', 'subject', 'content', 'newsletter_content');
-        foreach ($fields as $field) {
-            $this->_specific_shortcode_excludes[$field] = array(
-                '[RECIPIENT_REGISTRATION_CODE]',
-                '[EVENT_AUTHOR_FORMATTED_EMAIL]',
-                '[EVENT_AUTHOR_EMAIL]',
-            );
-        }
-        $add_excludes = array(
-            '[RECIPIENT_FNAME]',
-            '[RECIPIENT_LNAME]',
-            '[RECIPIENT_EMAIL]',
-            '[COMPANY]',
-            '[CO_ADD1]',
-            '[CO_ADD2]',
-            '[CO_CITY]',
-            '[CO_STATE]',
-            '[CO_ZIP]',
-            '[CO_LOGO]',
-            '[CO_PHONE]',
-            '[CO_LOGO_URL]',
-            '[CO_FACEBOOK_URL]',
-            '[CO_TWITTER_URL]',
-            '[CO_PINTEREST_URL]',
-            '[CO_GOOGLE_URL]',
-            '[CO_LINKEDIN_URL]',
-            '[CO_INSTAGRAM_URL]',
-        );
-        $this->_specific_shortcode_excludes['from'] = array_merge($this->_specific_shortcode_excludes['from'],
-            $add_excludes);
-        $this->_specific_shortcode_excludes['content'] = array_merge($this->_specific_shortcode_excludes['content'],
-            array('[DISPLAY_PDF_URL]', '[DISPLAY_PDF_BUTTON]'));
-    }
+		//excluded shortcodes
+		$fields = array('to', 'from', 'subject', 'content', 'newsletter_content');
+		foreach ($fields as $field) {
+			$this->_specific_shortcode_excludes[$field] = array(
+				'[RECIPIENT_REGISTRATION_CODE]',
+				'[EVENT_AUTHOR_FORMATTED_EMAIL]',
+				'[EVENT_AUTHOR_EMAIL]',
+			);
+		}
+		$add_excludes = array(
+			'[RECIPIENT_FNAME]',
+			'[RECIPIENT_LNAME]',
+			'[RECIPIENT_EMAIL]',
+			'[COMPANY]',
+			'[CO_ADD1]',
+			'[CO_ADD2]',
+			'[CO_CITY]',
+			'[CO_STATE]',
+			'[CO_ZIP]',
+			'[CO_LOGO]',
+			'[CO_PHONE]',
+			'[CO_LOGO_URL]',
+			'[CO_FACEBOOK_URL]',
+			'[CO_TWITTER_URL]',
+			'[CO_PINTEREST_URL]',
+			'[CO_GOOGLE_URL]',
+			'[CO_LINKEDIN_URL]',
+			'[CO_INSTAGRAM_URL]',
+		);
+		$this->_specific_shortcode_excludes['from'] = array_merge($this->_specific_shortcode_excludes['from'],
+			$add_excludes);
+		$this->_specific_shortcode_excludes['content'] = array_merge($this->_specific_shortcode_excludes['content'],
+			array('[DISPLAY_PDF_URL]', '[DISPLAY_PDF_BUTTON]'));
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -6,7 +6,7 @@
  * @subpackage      helpers
  * @since           4.3.0
  */
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 

caffeinated/core/libraries/messages/message_type/newsletter/EE_Newsletter_message_type.class.php

Indentation +147 added lines, -147 removed lines

@@ -7,7 +7,7 @@ 
  * @since           4.3.0
  */
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -23,152 +23,152 @@ 
 class EE_Newsletter_message_type extends EE_message_type
 {
 
-    public function __construct()
-    {
-        $this->name = 'newsletter';
-        $this->description = __('Batch message type messages are triggered manually by the admin for sending notifications to a selected group of recipients. This should only be used for more general notification type messages that contain information specific for the recipients. For "newsletter" type messages we recommend using an email list service like MailChimp, because sending non-related mail-outs to contacts increases the risk of your site domain getting added to spam lists, which will prevent messages getting to users.',
-            'event_espresso');
-        $this->label = array(
-            'singular' => __('batch', 'event_espresso'),
-            'plural'   => __('batches', 'event_espresso'),
-        );
-        $this->_master_templates = array(
-            'email' => 'registration',
-        );
-
-        parent::__construct();
-    }
-
-
-    protected function _set_admin_pages()
-    {
-        $this->admin_registered_pages = array(); //no admin pages to register this with.
-    }
-
-
-    protected function _set_data_handler()
-    {
-        $this->_data_handler = 'Registrations';
-        $this->_single_message = $this->_data instanceof EE_Registration;
-    }
-
-
-    protected function _get_data_for_context($context, EE_Registration $registration, $id)
-    {
-        //newsletter message type data handler is 'Registrations' and it expects an array of EE_Registration objects.
-        return array($registration);
-    }
-
-
-    protected function _set_admin_settings_fields()
-    {
-        $this->_admin_settings_fields = array();
-    }
-
-
-    protected function _set_contexts()
-    {
-        $this->_context_label = array(
-            'label'       => __('recipient', 'event_espresso'),
-            'plural'      => __('recipients', 'event_espresso'),
-            'description' => __('Recipient\'s are who will receive the message.', 'event_espresso'),
-        );
-
-        $this->_contexts = array(
-            'attendee' => array(
-                'label'       => __('Registrant', 'event_espresso'),
-                'description' => __('This template goes to selected registrants.', 'event_espresso'),
-            ),
-        );
-    }
-
-
-    /**
-     * used to set the valid shortcodes.
-     * For the newsletter message type we only have two valid shortcode libraries in use, recipient details and
-     * organization.  That's it!
-     *
-     * @since   4.3.0
-     * @return  void
-     */
-    protected function _set_valid_shortcodes()
-    {
-        parent::_set_valid_shortcodes();
-
-        $included_shortcodes = array(
-            'recipient_details',
-            'organization',
-            'newsletter',
-        );
-
-        foreach ($this->_valid_shortcodes as $context => $shortcodes) {
-            foreach ($shortcodes as $key => $shortcode) {
-                if (! in_array($shortcode, $included_shortcodes)) {
-                    unset($this->_valid_shortcodes[$context][$key]);
-                }
-            }
-            $this->_valid_shortcodes[$context][] = 'newsletter';
-        }
-
-    }
-
-
-    /**
-     * Override default _attendee_addressees in EE_message_type because we want to loop through the registrations
-     * for EE_message_type.
-     */
-    protected function _attendee_addressees()
-    {
-        $addressee = array();
-
-        //looping through registrations
-        foreach ($this->_data->registrations as $reg_id => $details) {
-            //set $attendee array to blank on each loop
-            $aee = array();
-
-            //need to get the attendee from this registration.
-            $attendee = isset($details['att_obj']) && $details['att_obj'] instanceof EE_Attendee
-                ? $details['att_obj']
-                : null;
-
-            if (! $attendee instanceof EE_Attendee) {
-                continue;
-            }
-
-            //set $aee from attendee object
-            $aee['att_obj'] = $attendee;
-            $aee['reg_objs'] = isset($this->_data->attendees[$attendee->ID()]['reg_objs'])
-                ? $this->_data->attendees[$attendee->ID()]['reg_objs']
-                : array();
-            $aee['attendee_email'] = $attendee->email();
-            $aee['tkt_objs'] = isset($this->_data->attendees[$attendee->ID()]['tkt_objs'])
-                ? $this->_data->attendees[$attendee->ID()]['tkt_objs']
-                : array();
-
-            if (isset($this->_data->attendees[$attendee->ID()]['evt_objs'])) {
-                $aee['evt_objs'] = $this->_data->attendees[$attendee->ID()]['evt_objs'];
-                $aee['events'] = $this->_data->attendees[$attendee->ID()]['evt_objs'];
-            } else {
-                $aee['evt_objs'] = $aee['events'] = array();
-            }
-
-            $aee['reg_obj'] = isset($details['reg_obj'])
-                ? $details['reg_obj']
-                : null;
-            $aee['attendees'] = $this->_data->attendees;
-
-            //merge in the primary attendee data
-            $aee = array_merge($this->_default_addressee_data, $aee);
-
-            //make sure txn is set
-            if (empty($aee['txn']) && $aee['reg_obj'] instanceof EE_Registration) {
-                $aee['txn'] = $aee['reg_obj']->transaction();
-            }
-
-            $addressee[] = new EE_Messages_Addressee($aee);
-        }
-        return $addressee;
-    }
+	public function __construct()
+	{
+		$this->name = 'newsletter';
+		$this->description = __('Batch message type messages are triggered manually by the admin for sending notifications to a selected group of recipients. This should only be used for more general notification type messages that contain information specific for the recipients. For "newsletter" type messages we recommend using an email list service like MailChimp, because sending non-related mail-outs to contacts increases the risk of your site domain getting added to spam lists, which will prevent messages getting to users.',
+			'event_espresso');
+		$this->label = array(
+			'singular' => __('batch', 'event_espresso'),
+			'plural'   => __('batches', 'event_espresso'),
+		);
+		$this->_master_templates = array(
+			'email' => 'registration',
+		);
+
+		parent::__construct();
+	}
+
+
+	protected function _set_admin_pages()
+	{
+		$this->admin_registered_pages = array(); //no admin pages to register this with.
+	}
+
+
+	protected function _set_data_handler()
+	{
+		$this->_data_handler = 'Registrations';
+		$this->_single_message = $this->_data instanceof EE_Registration;
+	}
+
+
+	protected function _get_data_for_context($context, EE_Registration $registration, $id)
+	{
+		//newsletter message type data handler is 'Registrations' and it expects an array of EE_Registration objects.
+		return array($registration);
+	}
+
+
+	protected function _set_admin_settings_fields()
+	{
+		$this->_admin_settings_fields = array();
+	}
+
+
+	protected function _set_contexts()
+	{
+		$this->_context_label = array(
+			'label'       => __('recipient', 'event_espresso'),
+			'plural'      => __('recipients', 'event_espresso'),
+			'description' => __('Recipient\'s are who will receive the message.', 'event_espresso'),
+		);
+
+		$this->_contexts = array(
+			'attendee' => array(
+				'label'       => __('Registrant', 'event_espresso'),
+				'description' => __('This template goes to selected registrants.', 'event_espresso'),
+			),
+		);
+	}
+
+
+	/**
+	 * used to set the valid shortcodes.
+	 * For the newsletter message type we only have two valid shortcode libraries in use, recipient details and
+	 * organization.  That's it!
+	 *
+	 * @since   4.3.0
+	 * @return  void
+	 */
+	protected function _set_valid_shortcodes()
+	{
+		parent::_set_valid_shortcodes();
+
+		$included_shortcodes = array(
+			'recipient_details',
+			'organization',
+			'newsletter',
+		);
+
+		foreach ($this->_valid_shortcodes as $context => $shortcodes) {
+			foreach ($shortcodes as $key => $shortcode) {
+				if (! in_array($shortcode, $included_shortcodes)) {
+					unset($this->_valid_shortcodes[$context][$key]);
+				}
+			}
+			$this->_valid_shortcodes[$context][] = 'newsletter';
+		}
+
+	}
+
+
+	/**
+	 * Override default _attendee_addressees in EE_message_type because we want to loop through the registrations
+	 * for EE_message_type.
+	 */
+	protected function _attendee_addressees()
+	{
+		$addressee = array();
+
+		//looping through registrations
+		foreach ($this->_data->registrations as $reg_id => $details) {
+			//set $attendee array to blank on each loop
+			$aee = array();
+
+			//need to get the attendee from this registration.
+			$attendee = isset($details['att_obj']) && $details['att_obj'] instanceof EE_Attendee
+				? $details['att_obj']
+				: null;
+
+			if (! $attendee instanceof EE_Attendee) {
+				continue;
+			}
+
+			//set $aee from attendee object
+			$aee['att_obj'] = $attendee;
+			$aee['reg_objs'] = isset($this->_data->attendees[$attendee->ID()]['reg_objs'])
+				? $this->_data->attendees[$attendee->ID()]['reg_objs']
+				: array();
+			$aee['attendee_email'] = $attendee->email();
+			$aee['tkt_objs'] = isset($this->_data->attendees[$attendee->ID()]['tkt_objs'])
+				? $this->_data->attendees[$attendee->ID()]['tkt_objs']
+				: array();
+
+			if (isset($this->_data->attendees[$attendee->ID()]['evt_objs'])) {
+				$aee['evt_objs'] = $this->_data->attendees[$attendee->ID()]['evt_objs'];
+				$aee['events'] = $this->_data->attendees[$attendee->ID()]['evt_objs'];
+			} else {
+				$aee['evt_objs'] = $aee['events'] = array();
+			}
+
+			$aee['reg_obj'] = isset($details['reg_obj'])
+				? $details['reg_obj']
+				: null;
+			$aee['attendees'] = $this->_data->attendees;
+
+			//merge in the primary attendee data
+			$aee = array_merge($this->_default_addressee_data, $aee);
+
+			//make sure txn is set
+			if (empty($aee['txn']) && $aee['reg_obj'] instanceof EE_Registration) {
+				$aee['txn'] = $aee['reg_obj']->transaction();
+			}
+
+			$addressee[] = new EE_Messages_Addressee($aee);
+		}
+		return $addressee;
+	}
 
 
 }

Spacing +3 added lines, -3 removed lines

@@ -6,7 +6,7 @@ 
  * @subpackage      helpers
  * @since           4.3.0
  */
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -103,7 +103,7 @@ 
 
         foreach ($this->_valid_shortcodes as $context => $shortcodes) {
             foreach ($shortcodes as $key => $shortcode) {
-                if (! in_array($shortcode, $included_shortcodes)) {
+                if ( ! in_array($shortcode, $included_shortcodes)) {
                     unset($this->_valid_shortcodes[$context][$key]);
                 }
             }
@@ -131,7 +131,7 @@ 
                 ? $details['att_obj']
                 : null;
 
-            if (! $attendee instanceof EE_Attendee) {
+            if ( ! $attendee instanceof EE_Attendee) {
                 continue;
             }