eventespresso / event-espresso-core

core/services/shortcodes/EspressoShortcode.php

Spacing +3 added lines, -3 removed lines

@@ -81,7 +81,7 @@ 
             }
         }
         return $this->shortcodeContent(
-            $this->sanitizeAttributes((array)$attributes)
+            $this->sanitizeAttributes((array) $attributes)
         );
     }
 
@@ -109,8 +109,8 @@ 
             // serialized attributes
             wp_json_encode($attributes),
             // Closure for generating content if cache is expired
-            function () use ($shortcode, $attributes) {
-                if($shortcode->initialized === false){
+            function() use ($shortcode, $attributes) {
+                if ($shortcode->initialized === false) {
                     $shortcode->initializeShortcode();
                 }
                 return $shortcode->processShortcode($attributes);

Indentation +213 added lines, -213 removed lines

@@ -21,219 +21,219 @@
 abstract class EspressoShortcode implements ShortcodeInterface
 {
 
-    /**
-     * transient prefix
-     *
-     * @type string
-     */
-    const CACHE_TRANSIENT_PREFIX = 'ee_sc_';
-
-    /**
-     * @var PostRelatedCacheManager $cache_manager
-     */
-    private $cache_manager;
-
-    /**
-     * true if ShortcodeInterface::initializeShortcode() has been called
-     * if false, then that will get called before processing
-     *
-     * @var boolean $initialized
-     */
-    private $initialized = false;
-
-
-
-    /**
-     * EspressoShortcode constructor
-     *
-     * @param PostRelatedCacheManager $cache_manager
-     */
-    public function __construct(PostRelatedCacheManager $cache_manager)
-    {
-        $this->cache_manager = $cache_manager;
-    }
-
-
-
-    /**
-     * @return void
-     */
-    public function shortcodeHasBeenInitialized()
-    {
-        $this->initialized = true;
-    }
-
-
-
-    /**
-     * enqueues scripts then processes the shortcode
-     *
-     * @param array $attributes
-     * @return string
-     * @throws EE_Error
-     */
-    final public function processShortcodeCallback($attributes = array())
-    {
-        if ($this instanceof EnqueueAssetsInterface) {
-            if (is_admin()) {
-                $this->enqueueAdminScripts();
-            } else {
-                $this->enqueueScripts();
-            }
-        }
-        return $this->shortcodeContent(
-            $this->sanitizeAttributes((array)$attributes)
-        );
-    }
-
-
-
-    /**
-     * If shortcode caching is enabled for the shortcode,
-     * and cached results exist, then that will be returned
-     * else new content will be generated.
-     * If caching is enabled, then the new content will be cached for later.
-     *
-     * @param array $attributes
-     * @return mixed|string
-     * @throws EE_Error
-     */
-    private function shortcodeContent(array $attributes)
-    {
-        $shortcode = $this;
-        $post_ID = $this->currentPostID();
-        // something like "SC_EVENTS-123"
-        $cache_ID = $this->shortcodeCacheID($post_ID);
-        $this->cache_manager->clearPostRelatedCacheOnUpdate($post_ID, $cache_ID);
-        return $this->cache_manager->get(
-            $cache_ID,
-            // serialized attributes
-            wp_json_encode($attributes),
-            // Closure for generating content if cache is expired
-            function () use ($shortcode, $attributes) {
-                if($shortcode->initialized === false){
-                    $shortcode->initializeShortcode();
-                }
-                return $shortcode->processShortcode($attributes);
-            },
-            // filterable cache expiration set by each shortcode
-            apply_filters(
-                'FHEE__EventEspresso_core_services_shortcodes_EspressoShortcode__shortcodeContent__cache_expiration',
-                $this->cacheExpiration(),
-                $this->getTag(),
-                $this
-            )
-        );
-    }
-
-
-
-    /**
-     * @return int
-     * @throws EE_Error
-     */
-    private function currentPostID()
-    {
-        // try to get EE_Event any way we can
-        $event = EEH_Event_View::get_event();
-        // then get some kind of ID
-        if ($event instanceof \EE_Event) {
-            $post_ID = $event->ID();
-        } else {
-            global $post;
-            $post_ID = $post->ID;
-        }
-        return $post_ID;
-    }
-
-
-
-    /**
-     * @param int $post_ID
-     * @return string
-     * @throws EE_Error
-     */
-    private function shortcodeCacheID($post_ID)
-    {
-        $tag = str_replace('ESPRESSO_', '', $this->getTag());
-        return "SC_{$tag}-{$post_ID}";
-    }
-
-
-
-    /**
-     * array for defining custom attribute sanitization callbacks,
-     * where keys match keys in your attributes array,
-     * and values represent the sanitization function you wish to be applied to that attribute.
-     * So for example, if you had an integer attribute named "event_id"
-     * that you wanted to be sanitized using absint(),
-     * then you would return the following:
-     *      array('event_id' => 'absint')
-     * Entering 'skip_sanitization' for the callback value
-     * means that no sanitization will be applied
-     * on the assumption that the attribute
-     * will be sanitized at some point... right?
-     * You wouldn't pass around unsanitized attributes would you?
-     * That would be very Tom Foolery of you!!!
-     *
-     * @return array
-     */
-    protected function customAttributeSanitizationMap()
-    {
-        return array();
-    }
-
-
-
-    /**
-     * Performs basic sanitization on shortcode attributes
-     * Since incoming attributes from the shortcode usage in the WP editor will all be strings,
-     * most attributes will by default be sanitized using the sanitize_text_field() function.
-     * This can be overridden using the customAttributeSanitizationMap() method (see above),
-     * all other attributes would be sanitized using the defaults in the switch statement below
-     *
-     * @param array $attributes
-     * @return array
-     */
-    private function sanitizeAttributes(array $attributes)
-    {
-        $custom_sanitization = $this->customAttributeSanitizationMap();
-        foreach ($attributes as $key => $value) {
-            // is a custom sanitization callback specified ?
-            if (isset($custom_sanitization[$key])) {
-                $callback = $custom_sanitization[$key];
-                if ($callback === 'skip_sanitization') {
-                    $attributes[$key] = $value;
-                    continue;
-                }
-                if (function_exists($callback)) {
-                    $attributes[$key] = $callback($value);
-                    continue;
-                }
-            }
-            switch (true) {
-                case $value === null :
-                case is_int($value) :
-                case is_float($value) :
-                    // typical booleans
-                case in_array($value, array(true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'), true) :
-                    $attributes[$key] = $value;
-                    break;
-                case is_string($value) :
-                    $attributes[$key] = sanitize_text_field($value);
-                    break;
-                case is_array($value) :
-                    $attributes[$key] = $this->sanitizeAttributes($value);
-                    break;
-                default :
-                    // only remaining data types are Object and Resource
-                    // which are not allowed as shortcode attributes
-                    $attributes[$key] = null;
-                    break;
-            }
-        }
-        return $attributes;
-    }
+	/**
+	 * transient prefix
+	 *
+	 * @type string
+	 */
+	const CACHE_TRANSIENT_PREFIX = 'ee_sc_';
+
+	/**
+	 * @var PostRelatedCacheManager $cache_manager
+	 */
+	private $cache_manager;
+
+	/**
+	 * true if ShortcodeInterface::initializeShortcode() has been called
+	 * if false, then that will get called before processing
+	 *
+	 * @var boolean $initialized
+	 */
+	private $initialized = false;
+
+
+
+	/**
+	 * EspressoShortcode constructor
+	 *
+	 * @param PostRelatedCacheManager $cache_manager
+	 */
+	public function __construct(PostRelatedCacheManager $cache_manager)
+	{
+		$this->cache_manager = $cache_manager;
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	public function shortcodeHasBeenInitialized()
+	{
+		$this->initialized = true;
+	}
+
+
+
+	/**
+	 * enqueues scripts then processes the shortcode
+	 *
+	 * @param array $attributes
+	 * @return string
+	 * @throws EE_Error
+	 */
+	final public function processShortcodeCallback($attributes = array())
+	{
+		if ($this instanceof EnqueueAssetsInterface) {
+			if (is_admin()) {
+				$this->enqueueAdminScripts();
+			} else {
+				$this->enqueueScripts();
+			}
+		}
+		return $this->shortcodeContent(
+			$this->sanitizeAttributes((array)$attributes)
+		);
+	}
+
+
+
+	/**
+	 * If shortcode caching is enabled for the shortcode,
+	 * and cached results exist, then that will be returned
+	 * else new content will be generated.
+	 * If caching is enabled, then the new content will be cached for later.
+	 *
+	 * @param array $attributes
+	 * @return mixed|string
+	 * @throws EE_Error
+	 */
+	private function shortcodeContent(array $attributes)
+	{
+		$shortcode = $this;
+		$post_ID = $this->currentPostID();
+		// something like "SC_EVENTS-123"
+		$cache_ID = $this->shortcodeCacheID($post_ID);
+		$this->cache_manager->clearPostRelatedCacheOnUpdate($post_ID, $cache_ID);
+		return $this->cache_manager->get(
+			$cache_ID,
+			// serialized attributes
+			wp_json_encode($attributes),
+			// Closure for generating content if cache is expired
+			function () use ($shortcode, $attributes) {
+				if($shortcode->initialized === false){
+					$shortcode->initializeShortcode();
+				}
+				return $shortcode->processShortcode($attributes);
+			},
+			// filterable cache expiration set by each shortcode
+			apply_filters(
+				'FHEE__EventEspresso_core_services_shortcodes_EspressoShortcode__shortcodeContent__cache_expiration',
+				$this->cacheExpiration(),
+				$this->getTag(),
+				$this
+			)
+		);
+	}
+
+
+
+	/**
+	 * @return int
+	 * @throws EE_Error
+	 */
+	private function currentPostID()
+	{
+		// try to get EE_Event any way we can
+		$event = EEH_Event_View::get_event();
+		// then get some kind of ID
+		if ($event instanceof \EE_Event) {
+			$post_ID = $event->ID();
+		} else {
+			global $post;
+			$post_ID = $post->ID;
+		}
+		return $post_ID;
+	}
+
+
+
+	/**
+	 * @param int $post_ID
+	 * @return string
+	 * @throws EE_Error
+	 */
+	private function shortcodeCacheID($post_ID)
+	{
+		$tag = str_replace('ESPRESSO_', '', $this->getTag());
+		return "SC_{$tag}-{$post_ID}";
+	}
+
+
+
+	/**
+	 * array for defining custom attribute sanitization callbacks,
+	 * where keys match keys in your attributes array,
+	 * and values represent the sanitization function you wish to be applied to that attribute.
+	 * So for example, if you had an integer attribute named "event_id"
+	 * that you wanted to be sanitized using absint(),
+	 * then you would return the following:
+	 *      array('event_id' => 'absint')
+	 * Entering 'skip_sanitization' for the callback value
+	 * means that no sanitization will be applied
+	 * on the assumption that the attribute
+	 * will be sanitized at some point... right?
+	 * You wouldn't pass around unsanitized attributes would you?
+	 * That would be very Tom Foolery of you!!!
+	 *
+	 * @return array
+	 */
+	protected function customAttributeSanitizationMap()
+	{
+		return array();
+	}
+
+
+
+	/**
+	 * Performs basic sanitization on shortcode attributes
+	 * Since incoming attributes from the shortcode usage in the WP editor will all be strings,
+	 * most attributes will by default be sanitized using the sanitize_text_field() function.
+	 * This can be overridden using the customAttributeSanitizationMap() method (see above),
+	 * all other attributes would be sanitized using the defaults in the switch statement below
+	 *
+	 * @param array $attributes
+	 * @return array
+	 */
+	private function sanitizeAttributes(array $attributes)
+	{
+		$custom_sanitization = $this->customAttributeSanitizationMap();
+		foreach ($attributes as $key => $value) {
+			// is a custom sanitization callback specified ?
+			if (isset($custom_sanitization[$key])) {
+				$callback = $custom_sanitization[$key];
+				if ($callback === 'skip_sanitization') {
+					$attributes[$key] = $value;
+					continue;
+				}
+				if (function_exists($callback)) {
+					$attributes[$key] = $callback($value);
+					continue;
+				}
+			}
+			switch (true) {
+				case $value === null :
+				case is_int($value) :
+				case is_float($value) :
+					// typical booleans
+				case in_array($value, array(true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'), true) :
+					$attributes[$key] = $value;
+					break;
+				case is_string($value) :
+					$attributes[$key] = sanitize_text_field($value);
+					break;
+				case is_array($value) :
+					$attributes[$key] = $this->sanitizeAttributes($value);
+					break;
+				default :
+					// only remaining data types are Object and Resource
+					// which are not allowed as shortcode attributes
+					$attributes[$key] = null;
+					break;
+			}
+		}
+		return $attributes;
+	}
 
 
 

core/exceptions/InvalidEntityException.php

Indentation +27 added lines, -27 removed lines

@@ -3,7 +3,7 @@ 
 namespace EventEspresso\core\exceptions;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -18,32 +18,32 @@ 
 class InvalidEntityException extends \InvalidArgumentException
 {
 
-    /**
-     * InvalidInterfaceException constructor.
-     *
-     * @param string     $actual   classname of what we got
-     * @param string     $expected classname of the entity we wanted
-     * @param string     $message
-     * @param int        $code
-     * @param \Exception $previous
-     */
-    public function __construct($actual, $expected, $message = '', $code = 0, \Exception $previous = null)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                __(
-                    'The supplied entity is an instance of "%1$s", but an instance of "%2$s" was expected. Object: %3$s',
-                    'event_espresso'
-                ),
-                is_object($actual)
-                    ? get_class($actual)
-                    : gettype($actual),
-                $expected,
-                var_export($actual, true)
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * InvalidInterfaceException constructor.
+	 *
+	 * @param string     $actual   classname of what we got
+	 * @param string     $expected classname of the entity we wanted
+	 * @param string     $message
+	 * @param int        $code
+	 * @param \Exception $previous
+	 */
+	public function __construct($actual, $expected, $message = '', $code = 0, \Exception $previous = null)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				__(
+					'The supplied entity is an instance of "%1$s", but an instance of "%2$s" was expected. Object: %3$s',
+					'event_espresso'
+				),
+				is_object($actual)
+					? get_class($actual)
+					: gettype($actual),
+				$expected,
+				var_export($actual, true)
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 
 }
 // End of file InvalidEntityException.php

Spacing +1 added lines, -1 removed lines

@@ -2,7 +2,7 @@
 
 namespace EventEspresso\core\exceptions;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 

core/libraries/form_sections/strategies/validation/EE_Email_Validation_Strategy.strategy.php

Indentation +103 added lines, -103 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -15,117 +15,117 @@ 
 class EE_Email_Validation_Strategy extends EE_Text_Validation_Strategy
 {
 
-    /**
-     * @param null $validation_error_message
-     */
-    public function __construct($validation_error_message = null)
-    {
-        if (! $validation_error_message) {
-            $validation_error_message = __("Please enter a valid email address.", "event_espresso");
-        }
-        parent::__construct($validation_error_message);
-    }
+	/**
+	 * @param null $validation_error_message
+	 */
+	public function __construct($validation_error_message = null)
+	{
+		if (! $validation_error_message) {
+			$validation_error_message = __("Please enter a valid email address.", "event_espresso");
+		}
+		parent::__construct($validation_error_message);
+	}
 
 
 
-    /**
-     * just checks the field isn't blank
-     *
-     * @param $normalized_value
-     * @return bool
-     * @throws \EE_Validation_Error
-     */
-    public function validate($normalized_value)
-    {
-        if ($normalized_value && ! $this->_validate_email($normalized_value)) {
-            throw new EE_Validation_Error($this->get_validation_error_message(), 'required');
-        }
-    }
+	/**
+	 * just checks the field isn't blank
+	 *
+	 * @param $normalized_value
+	 * @return bool
+	 * @throws \EE_Validation_Error
+	 */
+	public function validate($normalized_value)
+	{
+		if ($normalized_value && ! $this->_validate_email($normalized_value)) {
+			throw new EE_Validation_Error($this->get_validation_error_message(), 'required');
+		}
+	}
 
 
 
-    /**
-     * @return array
-     */
-    public function get_jquery_validation_rule_array()
-    {
-        return array('email' => true, 'messages' => array('email' => $this->get_validation_error_message()));
-    }
+	/**
+	 * @return array
+	 */
+	public function get_jquery_validation_rule_array()
+	{
+		return array('email' => true, 'messages' => array('email' => $this->get_validation_error_message()));
+	}
 
 
 
-    /**
-     * Validate an email address.
-     * Provide email address (raw input)
-     *
-     * @param $email
-     * @return bool of whether the email is valid or not
-     * @throws \EE_Validation_Error
-     */
-    private function _validate_email($email)
-    {
-        $validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level)
-            ? EE_Registry::instance()->CFG->registration->email_validation_level
-            : 'wp_default';
-        if (! preg_match('/^.+\@\S+$/', $email)) { // \.\S+
-            // email not in correct {string}@{string} format
-            return false;
-        } else {
-            $atIndex = strrpos($email, "@");
-            $domain = substr($email, $atIndex + 1);
-            $local = substr($email, 0, $atIndex);
-            $localLen = strlen($local);
-            $domainLen = strlen($domain);
-            if ($localLen < 1 || $localLen > 64) {
-                // local part length exceeded
-                return false;
-            } else if ($domainLen < 1 || $domainLen > 255) {
-                // domain part length exceeded
-                return false;
-            } else if ($local[0] === '.' || $local[$localLen - 1] === '.') {
-                // local part starts or ends with '.'
-                return false;
-            } else if (preg_match('/\\.\\./', $local)) {
-                // local part has two consecutive dots
-                return false;
-            } else if (preg_match('/\\.\\./', $domain)) {
-                // domain part has two consecutive dots
-                return false;
-            } else if ($validation_level === 'wp_default') {
-                return is_email($email);
-            } else if (
-                ($validation_level === 'i18n' || $validation_level === 'i18n_dns')
-                // plz see http://stackoverflow.com/a/24817336 re: the following regex
-                && ! preg_match(
-                    '/^(?!\.)((?!.*\.{2})[a-zA-Z0-9\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}\.!#$%&\'*+-\/=?^_`{|}~\-\d]+)@(?!\.)([a-zA-Z0-9\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}\-\.\d]+)((\.([a-zA-Z\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}]){2,63})+)$/u',
-                    $email
-                )
-            ) {
-                return false;
-            }
-            if ($validation_level === 'i18n_dns') {
-                if (! checkdnsrr($domain, "MX")) {
-                    // domain not found in MX records
-                    throw new EE_Validation_Error(
-                        __(
-                            'Although the email address provided is formatted correctly, a valid "MX record" could not be located for that address and domain. Please enter a valid email address.',
-                            'event_espresso'
-                        )
-                    );
-                } else if (! checkdnsrr($domain, "A")) {
-                    // domain not found in A records
-                    throw new EE_Validation_Error(
-                        __(
-                            'Although the email address provided is formatted correctly, a valid "A record" could not be located for that address and domain. Please enter a valid email address.',
-                            'event_espresso'
-                        )
-                    );
-                }
-            }
-        }
-        // you have successfully run the gauntlet young Padawan
-        return true;
-    }
+	/**
+	 * Validate an email address.
+	 * Provide email address (raw input)
+	 *
+	 * @param $email
+	 * @return bool of whether the email is valid or not
+	 * @throws \EE_Validation_Error
+	 */
+	private function _validate_email($email)
+	{
+		$validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level)
+			? EE_Registry::instance()->CFG->registration->email_validation_level
+			: 'wp_default';
+		if (! preg_match('/^.+\@\S+$/', $email)) { // \.\S+
+			// email not in correct {string}@{string} format
+			return false;
+		} else {
+			$atIndex = strrpos($email, "@");
+			$domain = substr($email, $atIndex + 1);
+			$local = substr($email, 0, $atIndex);
+			$localLen = strlen($local);
+			$domainLen = strlen($domain);
+			if ($localLen < 1 || $localLen > 64) {
+				// local part length exceeded
+				return false;
+			} else if ($domainLen < 1 || $domainLen > 255) {
+				// domain part length exceeded
+				return false;
+			} else if ($local[0] === '.' || $local[$localLen - 1] === '.') {
+				// local part starts or ends with '.'
+				return false;
+			} else if (preg_match('/\\.\\./', $local)) {
+				// local part has two consecutive dots
+				return false;
+			} else if (preg_match('/\\.\\./', $domain)) {
+				// domain part has two consecutive dots
+				return false;
+			} else if ($validation_level === 'wp_default') {
+				return is_email($email);
+			} else if (
+				($validation_level === 'i18n' || $validation_level === 'i18n_dns')
+				// plz see http://stackoverflow.com/a/24817336 re: the following regex
+				&& ! preg_match(
+					'/^(?!\.)((?!.*\.{2})[a-zA-Z0-9\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}\.!#$%&\'*+-\/=?^_`{|}~\-\d]+)@(?!\.)([a-zA-Z0-9\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}\-\.\d]+)((\.([a-zA-Z\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}]){2,63})+)$/u',
+					$email
+				)
+			) {
+				return false;
+			}
+			if ($validation_level === 'i18n_dns') {
+				if (! checkdnsrr($domain, "MX")) {
+					// domain not found in MX records
+					throw new EE_Validation_Error(
+						__(
+							'Although the email address provided is formatted correctly, a valid "MX record" could not be located for that address and domain. Please enter a valid email address.',
+							'event_espresso'
+						)
+					);
+				} else if (! checkdnsrr($domain, "A")) {
+					// domain not found in A records
+					throw new EE_Validation_Error(
+						__(
+							'Although the email address provided is formatted correctly, a valid "A record" could not be located for that address and domain. Please enter a valid email address.',
+							'event_espresso'
+						)
+					);
+				}
+			}
+		}
+		// you have successfully run the gauntlet young Padawan
+		return true;
+	}
 
 
 }

Spacing +5 added lines, -5 removed lines

@@ -1,4 +1,4 @@ 
-<?php if (! defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -20,7 +20,7 @@ 
      */
     public function __construct($validation_error_message = null)
     {
-        if (! $validation_error_message) {
+        if ( ! $validation_error_message) {
             $validation_error_message = __("Please enter a valid email address.", "event_espresso");
         }
         parent::__construct($validation_error_message);
@@ -67,7 +67,7 @@ 
         $validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level)
             ? EE_Registry::instance()->CFG->registration->email_validation_level
             : 'wp_default';
-        if (! preg_match('/^.+\@\S+$/', $email)) { // \.\S+
+        if ( ! preg_match('/^.+\@\S+$/', $email)) { // \.\S+
             // email not in correct {string}@{string} format
             return false;
         } else {
@@ -104,7 +104,7 @@ 
                 return false;
             }
             if ($validation_level === 'i18n_dns') {
-                if (! checkdnsrr($domain, "MX")) {
+                if ( ! checkdnsrr($domain, "MX")) {
                     // domain not found in MX records
                     throw new EE_Validation_Error(
                         __(
@@ -112,7 +112,7 @@ 
                             'event_espresso'
                         )
                     );
-                } else if (! checkdnsrr($domain, "A")) {
+                } else if ( ! checkdnsrr($domain, "A")) {
                     // domain not found in A records
                     throw new EE_Validation_Error(
                         __(

core/libraries/messages/EE_Message_Template_Group_Collection.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -47,7 +47,7 @@
     /**
      * This retrieves any EE_Message_Template_Group in the repo by its ID.
      *
-     * @param $GRP_ID
+     * @param integer $GRP_ID
      * @return EE_Message_Template_Group | null
      */
     public function get_by_ID($GRP_ID)

Indentation +100 added lines, -100 removed lines

@@ -14,115 +14,115 @@
 {
 
 
-    /**
-     * EE_Message_Template_Group_Collection constructor.
-     */
-    public function __construct()
-    {
-        $this->interface = 'EE_Message_Template_Group';
-    }
+	/**
+	 * EE_Message_Template_Group_Collection constructor.
+	 */
+	public function __construct()
+	{
+		$this->interface = 'EE_Message_Template_Group';
+	}
 
 
-    /**
-     * Adds the Message Template Group object to the repository.
-     *
-     * @param           $message_template_group
-     * @param array|int $EVT_ID    Some templates are specific to EVT, so this is provided as a way of
-     *                         indexing the template by key.  If this template is shared among multiple events then
-     *                         include the events as an array.
-     * @return bool
-     */
-    public function add($message_template_group, $EVT_ID = array())
-    {
-        $EVT_ID = is_array($EVT_ID) ? $EVT_ID : (array) $EVT_ID;
-        if ($message_template_group instanceof $this->interface) {
-            $data['key'] = $this->getKey(
-                $message_template_group->messenger(),
-                $message_template_group->message_type(),
-                $EVT_ID
-            );
-            return parent::add($message_template_group, $data);
-        }
-        return false;
-    }
+	/**
+	 * Adds the Message Template Group object to the repository.
+	 *
+	 * @param           $message_template_group
+	 * @param array|int $EVT_ID    Some templates are specific to EVT, so this is provided as a way of
+	 *                         indexing the template by key.  If this template is shared among multiple events then
+	 *                         include the events as an array.
+	 * @return bool
+	 */
+	public function add($message_template_group, $EVT_ID = array())
+	{
+		$EVT_ID = is_array($EVT_ID) ? $EVT_ID : (array) $EVT_ID;
+		if ($message_template_group instanceof $this->interface) {
+			$data['key'] = $this->getKey(
+				$message_template_group->messenger(),
+				$message_template_group->message_type(),
+				$EVT_ID
+			);
+			return parent::add($message_template_group, $data);
+		}
+		return false;
+	}
 
 
-    /**
-     * This retrieves any EE_Message_Template_Group in the repo by its ID.
-     *
-     * @param $GRP_ID
-     * @return EE_Message_Template_Group | null
-     */
-    public function get_by_ID($GRP_ID)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($this->current()->ID() === $GRP_ID) {
-                /** @var EE_Message_Template_Group $message_template_group */
-                $message_template_group = $this->current();
-                $this->rewind();
-                return $message_template_group;
-            }
-            $this->next();
-        }
-        return null;
-    }
+	/**
+	 * This retrieves any EE_Message_Template_Group in the repo by its ID.
+	 *
+	 * @param $GRP_ID
+	 * @return EE_Message_Template_Group | null
+	 */
+	public function get_by_ID($GRP_ID)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($this->current()->ID() === $GRP_ID) {
+				/** @var EE_Message_Template_Group $message_template_group */
+				$message_template_group = $this->current();
+				$this->rewind();
+				return $message_template_group;
+			}
+			$this->next();
+		}
+		return null;
+	}
 
 
-    /**
-     * Generates a hash used to identify a given Message Template Group.
-     *
-     * @param string $messenger    The EE_messenger->name
-     * @param string $message_type The EE_message_type->name
-     * @param int    $EVT_ID       Optional.  If the template is for a specific EVT then that should be included.
-     * @deprecated 4.9.40.rc.017  Use getKey instead.
-     * @return string
-     */
-    public function get_key($messenger, $message_type, $EVT_ID = 0)
-    {
-        $EVT_ID = (array) $EVT_ID;
-        return $this->getKey($messenger, $message_type, $EVT_ID);
-    }
+	/**
+	 * Generates a hash used to identify a given Message Template Group.
+	 *
+	 * @param string $messenger    The EE_messenger->name
+	 * @param string $message_type The EE_message_type->name
+	 * @param int    $EVT_ID       Optional.  If the template is for a specific EVT then that should be included.
+	 * @deprecated 4.9.40.rc.017  Use getKey instead.
+	 * @return string
+	 */
+	public function get_key($messenger, $message_type, $EVT_ID = 0)
+	{
+		$EVT_ID = (array) $EVT_ID;
+		return $this->getKey($messenger, $message_type, $EVT_ID);
+	}
 
 
-    /**
-     * Generates a hash used to identify a given Message Template Group
-     * @param string    $messenger      The EE_messenger->name
-     * @param string    $message_type   The EE_message_type->name
-     * @param array     $EVT_ID         Optional.  If the template is for a specific EVT_ID (or events) then that should
-     *                                  be included.
-     * @since 4.9.40.rc.017
-     * @return string
-     */
-    public function getKey($messenger, $message_type, array $EVT_ID = array())
-    {
-        sort($EVT_ID);
-        $EVT_ID = implode(',', array_unique($EVT_ID));
-        return md5($messenger . $message_type . $EVT_ID);
-    }
+	/**
+	 * Generates a hash used to identify a given Message Template Group
+	 * @param string    $messenger      The EE_messenger->name
+	 * @param string    $message_type   The EE_message_type->name
+	 * @param array     $EVT_ID         Optional.  If the template is for a specific EVT_ID (or events) then that should
+	 *                                  be included.
+	 * @since 4.9.40.rc.017
+	 * @return string
+	 */
+	public function getKey($messenger, $message_type, array $EVT_ID = array())
+	{
+		sort($EVT_ID);
+		$EVT_ID = implode(',', array_unique($EVT_ID));
+		return md5($messenger . $message_type . $EVT_ID);
+	}
 
 
-    /**
-     * This returns a saved EE_Message_Template_Group object if there is one in the repository indexed by a key matching
-     * the given string.
-     *
-     * @param string $key @see EE_Message_Template_Group::get_key() to setup a key formatted for searching.
-     * @return null|EE_Message_Template_Group
-     */
-    public function get_by_key($key)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            $data = $this->getInfo();
-            if (isset($data['key']) && $data['key'] === $key) {
-                /** @var EE_Message_Template_Group $message_template_group */
-                $message_template_group = $this->current();
-                $this->rewind();
-                return $message_template_group;
-            }
-            $this->next();
-        }
-        return null;
-    }
+	/**
+	 * This returns a saved EE_Message_Template_Group object if there is one in the repository indexed by a key matching
+	 * the given string.
+	 *
+	 * @param string $key @see EE_Message_Template_Group::get_key() to setup a key formatted for searching.
+	 * @return null|EE_Message_Template_Group
+	 */
+	public function get_by_key($key)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			$data = $this->getInfo();
+			if (isset($data['key']) && $data['key'] === $key) {
+				/** @var EE_Message_Template_Group $message_template_group */
+				$message_template_group = $this->current();
+				$this->rewind();
+				return $message_template_group;
+			}
+			$this->next();
+		}
+		return null;
+	}
 
 }

Spacing +1 added lines, -1 removed lines

@@ -98,7 +98,7 @@
     {
         sort($EVT_ID);
         $EVT_ID = implode(',', array_unique($EVT_ID));
-        return md5($messenger . $message_type . $EVT_ID);
+        return md5($messenger.$message_type.$EVT_ID);
     }
 
 

core/EE_Session.core.php

Spacing +148 added lines, -148 removed lines

@@ -2,7 +2,7 @@ 
 use EventEspresso\core\exceptions\InvalidSessionDataException;
 use EventEspresso\core\services\cache\CacheStorageInterface;
 
-if (!defined( 'EVENT_ESPRESSO_VERSION')) {exit('No direct script access allowed');}
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {exit('No direct script access allowed'); }
 /**
  *
  * EE_Session class
@@ -108,7 +108,7 @@ 
 	  * array for defining default session vars
 	  * @var array
 	  */
-	 private $_default_session_vars = array (
+	 private $_default_session_vars = array(
         'id'            => null,
         'user_id'       => null,
         'ip_address'    => null,
@@ -136,8 +136,8 @@ 
 		// check if class object is instantiated
 		// session loading is turned ON by default, but prior to the init hook, can be turned back OFF via:
 		// add_filter( 'FHEE_load_EE_Session', '__return_false' );
-		if ( ! self::$_instance instanceof EE_Session && apply_filters( 'FHEE_load_EE_Session', true ) ) {
-			self::$_instance = new self($cache_storage, $encryption );
+		if ( ! self::$_instance instanceof EE_Session && apply_filters('FHEE_load_EE_Session', true)) {
+			self::$_instance = new self($cache_storage, $encryption);
 		}
 		return self::$_instance;
 	}
@@ -152,15 +152,15 @@ 
 	  * @throws \EE_Error
 	  * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
 	  */
-	 protected function __construct(CacheStorageInterface $cache_storage, EE_Encryption $encryption = null ) {
+	 protected function __construct(CacheStorageInterface $cache_storage, EE_Encryption $encryption = null) {
 
 		// session loading is turned ON by default, but prior to the init hook, can be turned back OFF via: add_filter( 'FHEE_load_EE_Session', '__return_false' );
-		if ( ! apply_filters( 'FHEE_load_EE_Session', true ) ) {
+		if ( ! apply_filters('FHEE_load_EE_Session', true)) {
 			return;
 		}
-		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
-		if ( ! defined( 'ESPRESSO_SESSION' ) ) {
-			define( 'ESPRESSO_SESSION', true );
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		if ( ! defined('ESPRESSO_SESSION')) {
+			define('ESPRESSO_SESSION', true);
 		}
 		// default session lifespan in seconds
 		$this->_lifespan = apply_filters(
@@ -174,12 +174,12 @@ 
 		 * 		}
 		 */
 		// retrieve session options from db
-		$session_settings = (array) get_option( 'ee_session_settings', array() );
-		if ( ! empty( $session_settings )) {
+		$session_settings = (array) get_option('ee_session_settings', array());
+		if ( ! empty($session_settings)) {
 			// cycle though existing session options
-			foreach ( $session_settings as $var_name => $session_setting ) {
+			foreach ($session_settings as $var_name => $session_setting) {
 				// set values for class properties
-				$var_name = '_' . $var_name;
+				$var_name = '_'.$var_name;
 				$this->{$var_name} = $session_setting;
 			}
 		}
@@ -190,15 +190,15 @@ 
         // encrypt data via: $this->encryption->encrypt();
         $this->encryption = $encryption;
 		// filter hook allows outside functions/classes/plugins to change default empty cart
-		$extra_default_session_vars = apply_filters( 'FHEE__EE_Session__construct__extra_default_session_vars', array() );
-		array_merge( $this->_default_session_vars, $extra_default_session_vars );
+		$extra_default_session_vars = apply_filters('FHEE__EE_Session__construct__extra_default_session_vars', array());
+		array_merge($this->_default_session_vars, $extra_default_session_vars);
 		// apply default session vars
 		$this->_set_defaults();
          add_action('AHEE__EE_System__initialize', array($this, 'open_session'));
          // check request for 'clear_session' param
-		add_action( 'AHEE__EE_Request_Handler__construct__complete', array( $this, 'wp_loaded' ));
+		add_action('AHEE__EE_Request_Handler__construct__complete', array($this, 'wp_loaded'));
 		// once everything is all said and done,
-		add_action( 'shutdown', array( $this, 'update' ), 100 );
+		add_action('shutdown', array($this, 'update'), 100);
          $this->configure_garbage_collection_filters();
 	}
 
@@ -286,11 +286,11 @@ 
 	 */
 	private function _set_defaults() {
 		// set some defaults
-		foreach ( $this->_default_session_vars as $key => $default_var ) {
-			if ( is_array( $default_var )) {
-				$this->_session_data[ $key ] = array();
+		foreach ($this->_default_session_vars as $key => $default_var) {
+			if (is_array($default_var)) {
+				$this->_session_data[$key] = array();
 			} else {
-				$this->_session_data[ $key ] = '';
+				$this->_session_data[$key] = '';
 			}
 		}
 	}
@@ -345,7 +345,7 @@ 
 	  * @param \EE_Checkout $checkout
 	  * @return bool
 	  */
-	 public function set_checkout( EE_Checkout $checkout ) {
+	 public function set_checkout(EE_Checkout $checkout) {
 		 $this->_session_data['checkout'] = $checkout;
 		 return TRUE;
 	 }
@@ -378,9 +378,9 @@ 
 	  * @return bool
 	  * @throws \EE_Error
 	  */
-	 public function set_transaction( EE_Transaction $transaction ) {
+	 public function set_transaction(EE_Transaction $transaction) {
 		 // first remove the session from the transaction before we save the transaction in the session
-		 $transaction->set_txn_session_data( NULL );
+		 $transaction->set_txn_session_data(NULL);
 		 $this->_session_data['transaction'] = $transaction;
 		 return TRUE;
 	 }
@@ -416,15 +416,15 @@ 
 	  * @param bool $reset_cache
 	  * @return    array
 	  */
-	public function get_session_data( $key = NULL, $reset_cache = FALSE ) {
-		if ( $reset_cache ) {
+	public function get_session_data($key = NULL, $reset_cache = FALSE) {
+		if ($reset_cache) {
 			$this->reset_cart();
 			$this->reset_checkout();
 			$this->reset_transaction();
 		}
-		 if ( ! empty( $key ))  {
-			return  isset( $this->_session_data[ $key ] ) ? $this->_session_data[ $key ] : NULL;
-		}  else  {
+		 if ( ! empty($key)) {
+			return  isset($this->_session_data[$key]) ? $this->_session_data[$key] : NULL;
+		} else {
 			return $this->_session_data;
 		}
 	}
@@ -437,20 +437,20 @@ 
 	  * @param 	array $data
 	  * @return 	TRUE on success, FALSE on fail
 	  */
-	public function set_session_data( $data ) {
+	public function set_session_data($data) {
 
 		// nothing ??? bad data ??? go home!
-		if ( empty( $data ) || ! is_array( $data )) {
-			EE_Error::add_error( __( 'No session data or invalid session data was provided.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
+		if (empty($data) || ! is_array($data)) {
+			EE_Error::add_error(__('No session data or invalid session data was provided.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return FALSE;
 		}
 
-		foreach ( $data as $key =>$value ) {
-			if ( isset( $this->_default_session_vars[ $key ] )) {
-				EE_Error::add_error( sprintf( __( 'Sorry! %s is a default session datum and can not be reset.', 'event_espresso' ), $key ), __FILE__, __FUNCTION__, __LINE__ );
+		foreach ($data as $key =>$value) {
+			if (isset($this->_default_session_vars[$key])) {
+				EE_Error::add_error(sprintf(__('Sorry! %s is a default session datum and can not be reset.', 'event_espresso'), $key), __FILE__, __FUNCTION__, __LINE__);
 				return FALSE;
 			} else {
-				$this->_session_data[ $key ] = $value;
+				$this->_session_data[$key] = $value;
 			}
 		}
 
@@ -468,9 +468,9 @@ 
 	  * @throws \EE_Error
 	  */
 	private function _espresso_session() {
-		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
 		// check that session has started
-		if ( session_id() === '' ) {
+		if (session_id() === '') {
 			//starts a new session if one doesn't already exist, or re-initiates an existing one
 			session_start();
 		}
@@ -479,39 +479,39 @@ 
 		// and the visitors IP
 		$this->_ip_address = $this->_visitor_ip();
 		// set the "user agent"
-		$this->_user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? esc_attr( $_SERVER['HTTP_USER_AGENT'] ) : FALSE;
+		$this->_user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? esc_attr($_SERVER['HTTP_USER_AGENT']) : FALSE;
 		// now let's retrieve what's in the db
         $session_data = $this->_retrieve_session_data();
-        if (! empty($session_data)) {
+        if ( ! empty($session_data)) {
             // get the current time in UTC
-			$this->_time = isset( $this->_time ) ? $this->_time : time();
+			$this->_time = isset($this->_time) ? $this->_time : time();
 			// and reset the session expiration
-			$this->_expiration = isset( $session_data['expiration'] )
+			$this->_expiration = isset($session_data['expiration'])
 				? $session_data['expiration']
 				: $this->_time + $this->_lifespan;
 		} else {
             // set initial site access time and the session expiration
 			$this->_set_init_access_and_expiration();
 			// set referer
-			$this->_session_data[ 'pages_visited' ][ $this->_session_data['init_access'] ] = isset( $_SERVER['HTTP_REFERER'] )
-				? esc_attr( $_SERVER['HTTP_REFERER'] )
+			$this->_session_data['pages_visited'][$this->_session_data['init_access']] = isset($_SERVER['HTTP_REFERER'])
+				? esc_attr($_SERVER['HTTP_REFERER'])
 				: '';
 			// no previous session = go back and create one (on top of the data above)
 			return FALSE;
 		}
         // now the user agent
-		if ( $session_data['user_agent'] !== $this->_user_agent ) {
+		if ($session_data['user_agent'] !== $this->_user_agent) {
 			return FALSE;
 		}
 		// wait a minute... how old are you?
-		if ( $this->_time > $this->_expiration ) {
+		if ($this->_time > $this->_expiration) {
 			// yer too old fer me!
             $this->_expired = true;
 			// wipe out everything that isn't a default session datum
-			$this->clear_session( __CLASS__, __FUNCTION__ );
+			$this->clear_session(__CLASS__, __FUNCTION__);
 		}
 		// make event espresso session data available to plugin
-		$this->_session_data = array_merge( $this->_session_data, $session_data );
+		$this->_session_data = array_merge($this->_session_data, $session_data);
 		return TRUE;
 
 	}
@@ -527,7 +527,7 @@ 
       */
      protected function _retrieve_session_data()
      {
-         $ssn_key = EE_Session::session_id_prefix . $this->_sid;
+         $ssn_key = EE_Session::session_id_prefix.$this->_sid;
          try {
              // we're using WP's Transient API to store session data using the PHP session ID as the option name
              $session_data = $this->cache_storage->get($ssn_key, false);
@@ -536,7 +536,7 @@ 
              }
              if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
                  $hash_check = $this->cache_storage->get(
-                     EE_Session::hash_check_prefix . $this->_sid,
+                     EE_Session::hash_check_prefix.$this->_sid,
                      false
                  );
                  if ($hash_check && $hash_check !== md5($session_data)) {
@@ -546,7 +546,7 @@ 
                                  'The stored data for session %1$s failed to pass a hash check and therefore appears to be invalid.',
                                  'event_espresso'
                              ),
-                             EE_Session::session_id_prefix . $this->_sid
+                             EE_Session::session_id_prefix.$this->_sid
                          ),
                          __FILE__, __FUNCTION__, __LINE__
                      );
@@ -558,17 +558,17 @@ 
              $row = $wpdb->get_row(
                  $wpdb->prepare(
                      "SELECT option_value FROM {$wpdb->options} WHERE option_name = %s LIMIT 1",
-                     '_transient_' . $ssn_key
+                     '_transient_'.$ssn_key
                  )
              );
              $session_data = is_object($row) ? $row->option_value : null;
              if ($session_data) {
                  $session_data = preg_replace_callback(
                      '!s:(d+):"(.*?)";!',
-                     function ($match) {
+                     function($match) {
                          return $match[1] === strlen($match[2])
                              ? $match[0]
-                             : 's:' . strlen($match[2]) . ':"' . $match[2] . '";';
+                             : 's:'.strlen($match[2]).':"'.$match[2].'";';
                      },
                      $session_data
                  );
@@ -589,7 +589,7 @@ 
                      'event_espresso'
                  );
                  $msg .= WP_DEBUG
-                     ? '<br><pre>' . print_r($session_data, true) . '</pre><br>' . $this->find_serialize_error($session_data)
+                     ? '<br><pre>'.print_r($session_data, true).'</pre><br>'.$this->find_serialize_error($session_data)
                      : '';
                  throw new InvalidSessionDataException($msg, 0, $e);
              }
@@ -602,11 +602,11 @@ 
                  'event_espresso'
              );
              $msg .= WP_DEBUG
-                 ? '<br><pre>' . print_r($session_data, true) . '</pre><br>' . $this->find_serialize_error($session_data)
+                 ? '<br><pre>'.print_r($session_data, true).'</pre><br>'.$this->find_serialize_error($session_data)
                  : '';
 	         throw new InvalidSessionDataException($msg);
          }
-	     if ( isset($session_data['transaction'] ) && absint($session_data['transaction'] ) !== 0 ) {
+	     if (isset($session_data['transaction']) && absint($session_data['transaction']) !== 0) {
              $session_data['transaction'] = EEM_Transaction::instance()->get_one_by_ID(
                  $session_data['transaction']
 	         );
@@ -627,12 +627,12 @@ 
 	  */
 	protected function _generate_session_id() {
 		// check if the SID was passed explicitly, otherwise get from session, then add salt and hash it to reduce length
-		if ( isset( $_REQUEST[ 'EESID' ] ) ) {
-			$session_id = sanitize_text_field( $_REQUEST[ 'EESID' ] );
+		if (isset($_REQUEST['EESID'])) {
+			$session_id = sanitize_text_field($_REQUEST['EESID']);
 		} else {
-			$session_id = md5( session_id() . get_current_blog_id() . $this->_get_sid_salt() );
+			$session_id = md5(session_id().get_current_blog_id().$this->_get_sid_salt());
 		}
-		return apply_filters( 'FHEE__EE_Session___generate_session_id__session_id', $session_id );
+		return apply_filters('FHEE__EE_Session___generate_session_id__session_id', $session_id);
 	}
 
 
@@ -644,20 +644,20 @@ 
 	  */
 	protected function _get_sid_salt() {
 		// was session id salt already saved to db ?
-		if ( empty( $this->_sid_salt ) ) {
+		if (empty($this->_sid_salt)) {
 			// no?  then maybe use WP defined constant
-			if ( defined( 'AUTH_SALT' ) ) {
+			if (defined('AUTH_SALT')) {
 				$this->_sid_salt = AUTH_SALT;
 			}
 			// if salt doesn't exist or is too short
-			if ( strlen( $this->_sid_salt ) < 32 ) {
+			if (strlen($this->_sid_salt) < 32) {
 				// create a new one
-				$this->_sid_salt = wp_generate_password( 64 );
+				$this->_sid_salt = wp_generate_password(64);
 			}
 			// and save it as a permanent session setting
-			$session_settings = get_option( 'ee_session_settings' );
-			$session_settings[ 'sid_salt' ] = $this->_sid_salt;
-			update_option( 'ee_session_settings', $session_settings );
+			$session_settings = get_option('ee_session_settings');
+			$session_settings['sid_salt'] = $this->_sid_salt;
+			update_option('ee_session_settings', $session_settings);
 		}
 		return $this->_sid_salt;
 	}
@@ -686,19 +686,19 @@ 
       * @return TRUE on success, FALSE on fail
       * @throws \EE_Error
       */
-	public function update( $new_session = FALSE ) {
-		$this->_session_data = isset( $this->_session_data )
-			&& is_array( $this->_session_data )
-			&& isset( $this->_session_data['id'])
+	public function update($new_session = FALSE) {
+		$this->_session_data = isset($this->_session_data)
+			&& is_array($this->_session_data)
+			&& isset($this->_session_data['id'])
 			? $this->_session_data
 			: array();
-		if ( empty( $this->_session_data )) {
+		if (empty($this->_session_data)) {
 			$this->_set_defaults();
 		}
 		$session_data = array();
-		foreach ( $this->_session_data as $key => $value ) {
+		foreach ($this->_session_data as $key => $value) {
 
-			switch( $key ) {
+			switch ($key) {
 
 				case 'id' :
 					// session ID
@@ -716,7 +716,7 @@ 
 				break;
 
 				case 'init_access' :
-					$session_data['init_access'] = absint( $value );
+					$session_data['init_access'] = absint($value);
 				break;
 
 				case 'last_access' :
@@ -726,7 +726,7 @@ 
 
 				case 'expiration' :
 					// when the session expires
-					$session_data['expiration'] = ! empty( $this->_expiration )
+					$session_data['expiration'] = ! empty($this->_expiration)
 						? $this->_expiration
 						: $session_data['init_access'] + $this->_lifespan;
 				break;
@@ -738,11 +738,11 @@ 
 
 				case 'pages_visited' :
 					$page_visit = $this->_get_page_visit();
-					if ( $page_visit ) {
+					if ($page_visit) {
 						// set pages visited where the first will be the http referrer
-						$this->_session_data[ 'pages_visited' ][ $this->_time ] = $page_visit;
+						$this->_session_data['pages_visited'][$this->_time] = $page_visit;
 						// we'll only save the last 10 page visits.
-						$session_data[ 'pages_visited' ] = array_slice( $this->_session_data['pages_visited'], -10 );
+						$session_data['pages_visited'] = array_slice($this->_session_data['pages_visited'], -10);
 					}
 				break;
 
@@ -756,9 +756,9 @@ 
 
 		$this->_session_data = $session_data;
 		// creating a new session does not require saving to the db just yet
-		if ( ! $new_session ) {
+		if ( ! $new_session) {
 			// ready? let's save
-			if ( $this->_save_session_to_db() ) {
+			if ($this->_save_session_to_db()) {
 				return TRUE;
 			} else {
 				return FALSE;
@@ -778,9 +778,9 @@ 
       * @throws \EE_Error
       */
 	private function _create_espresso_session( ) {
-		do_action( 'AHEE_log', __CLASS__, __FUNCTION__, '' );
+		do_action('AHEE_log', __CLASS__, __FUNCTION__, '');
 		// use the update function for now with $new_session arg set to TRUE
-		return  $this->update( TRUE ) ? TRUE : FALSE;
+		return  $this->update(TRUE) ? TRUE : FALSE;
 	}
 
 
@@ -800,7 +800,7 @@ 
                 EE_Registry::instance()->REQ->front_ajax
                 || (
                     // OR an admin request that is NOT AJAX
-					! ( defined( 'DOING_AJAX' ) && DOING_AJAX )
+					! (defined('DOING_AJAX') && DOING_AJAX)
                     && is_admin()
 				)
                 || (
@@ -813,8 +813,8 @@ 
 			return false;
 		}
 		$transaction = $this->transaction();
-		if ( $transaction instanceof EE_Transaction ) {
-			if ( ! $transaction->ID() ) {
+		if ($transaction instanceof EE_Transaction) {
+			if ( ! $transaction->ID()) {
 				$transaction->save();
 			}
 			$this->_session_data['transaction'] = $transaction->ID();
@@ -823,19 +823,19 @@ 
 		$session_data = serialize($this->_session_data);
 		// do we need to also encode it to avoid corrupted data when saved to the db?
 		$session_data = $this->_use_encryption
-            ? $this->encryption->base64_string_encode( $session_data )
+            ? $this->encryption->base64_string_encode($session_data)
             : $session_data;
 		// maybe save hash check
-		if ( apply_filters( 'FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG ) ) {
+		if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
             $this->cache_storage->add(
-                EE_Session::hash_check_prefix . $this->_sid,
+                EE_Session::hash_check_prefix.$this->_sid,
                 md5($session_data),
                 $this->_lifespan
             );
         }
         // we're using the Transient API for storing session data,
         return $this->cache_storage->add(
-            EE_Session::session_id_prefix . $this->_sid,
+            EE_Session::session_id_prefix.$this->_sid,
             $session_data,
             $this->_lifespan
         );
@@ -864,10 +864,10 @@ 
 			'HTTP_FORWARDED',
 			'REMOTE_ADDR'
 		);
-		foreach ( $server_keys as $key ){
-			if ( isset( $_SERVER[ $key ] )) {
-				foreach ( array_map( 'trim', explode( ',', $_SERVER[ $key ] )) as $ip ) {
-					if ( $ip === '127.0.0.1' || filter_var( $ip, FILTER_VALIDATE_IP ) !== FALSE ) {
+		foreach ($server_keys as $key) {
+			if (isset($_SERVER[$key])) {
+				foreach (array_map('trim', explode(',', $_SERVER[$key])) as $ip) {
+					if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== FALSE) {
 						$visitor_ip = $ip;
 					}
 				}
@@ -886,32 +886,32 @@ 
 	 *			@return string
 	 */
 	public function _get_page_visit() {
-		$page_visit = home_url('/') . 'wp-admin/admin-ajax.php';
+		$page_visit = home_url('/').'wp-admin/admin-ajax.php';
 		// check for request url
-		if ( isset( $_SERVER['REQUEST_URI'] )) {
+		if (isset($_SERVER['REQUEST_URI'])) {
 			$http_host = '';
 			$page_id = '?';
 			$e_reg = '';
-			$request_uri = esc_url( $_SERVER['REQUEST_URI'] );
-			$ru_bits = explode( '?', $request_uri );
+			$request_uri = esc_url($_SERVER['REQUEST_URI']);
+			$ru_bits = explode('?', $request_uri);
 			$request_uri = $ru_bits[0];
 			// check for and grab host as well
-			if ( isset( $_SERVER['HTTP_HOST'] )) {
-				$http_host = esc_url( $_SERVER['HTTP_HOST'] );
+			if (isset($_SERVER['HTTP_HOST'])) {
+				$http_host = esc_url($_SERVER['HTTP_HOST']);
 			}
 			// check for page_id in SERVER REQUEST
-			if ( isset( $_REQUEST['page_id'] )) {
+			if (isset($_REQUEST['page_id'])) {
 				// rebuild $e_reg without any of the extra parameters
-				$page_id = '?page_id=' . esc_attr( $_REQUEST['page_id'] ) . '&amp;';
+				$page_id = '?page_id='.esc_attr($_REQUEST['page_id']).'&amp;';
 			}
 			// check for $e_reg in SERVER REQUEST
-			if ( isset( $_REQUEST['ee'] )) {
+			if (isset($_REQUEST['ee'])) {
 				// rebuild $e_reg without any of the extra parameters
-				$e_reg = 'ee=' . esc_attr( $_REQUEST['ee'] );
+				$e_reg = 'ee='.esc_attr($_REQUEST['ee']);
 			}
-			$page_visit = rtrim( $http_host . $request_uri . $page_id . $e_reg, '?' );
+			$page_visit = rtrim($http_host.$request_uri.$page_id.$e_reg, '?');
 		}
-		return $page_visit !== home_url( '/wp-admin/admin-ajax.php' ) ? $page_visit : '';
+		return $page_visit !== home_url('/wp-admin/admin-ajax.php') ? $page_visit : '';
 
 	}
 
@@ -941,14 +941,14 @@ 
       * @return void
       * @throws \EE_Error
       */
-	public function clear_session( $class = '', $function = '' ) {
+	public function clear_session($class = '', $function = '') {
 		//echo '<h3 style="color:#999;line-height:.9em;"><span style="color:#2EA2CC">' . __CLASS__ . '</span>::<span style="color:#E76700">' . __FUNCTION__ . '( ' . $class . '::' . $function . '() )</span><br/><span style="font-size:9px;font-weight:normal;">' . __FILE__ . '</span>    <b style="font-size:10px;">  ' . __LINE__ . ' </b></h3>';
-        do_action( 'AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : ' . $class . '::' .  $function . '()' );
+        do_action('AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : '.$class.'::'.$function.'()');
 		$this->reset_cart();
 		$this->reset_checkout();
 		$this->reset_transaction();
 		// wipe out everything that isn't a default session datum
-		$this->reset_data( array_keys( $this->_session_data ));
+		$this->reset_data(array_keys($this->_session_data));
 		// reset initial site access time and the session expiration
 		$this->_set_init_access_and_expiration();
 		$this->_save_session_to_db();
@@ -963,42 +963,42 @@ 
 	  * @param bool  $show_all_notices
 	  * @return TRUE on success, FALSE on fail
 	  */
-	public function reset_data( $data_to_reset = array(), $show_all_notices = FALSE ) {
+	public function reset_data($data_to_reset = array(), $show_all_notices = FALSE) {
 		// if $data_to_reset is not in an array, then put it in one
-		if ( ! is_array( $data_to_reset ) ) {
-			$data_to_reset = array ( $data_to_reset );
+		if ( ! is_array($data_to_reset)) {
+			$data_to_reset = array($data_to_reset);
 		}
 		// nothing ??? go home!
-		if ( empty( $data_to_reset )) {
-			EE_Error::add_error( __( 'No session data could be reset, because no session var name was provided.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
+		if (empty($data_to_reset)) {
+			EE_Error::add_error(__('No session data could be reset, because no session var name was provided.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return FALSE;
 		}
 		$return_value = TRUE;
 		// since $data_to_reset is an array, cycle through the values
-		foreach ( $data_to_reset as $reset ) {
+		foreach ($data_to_reset as $reset) {
 
 			// first check to make sure it is a valid session var
-			if ( isset( $this->_session_data[ $reset ] )) {
+			if (isset($this->_session_data[$reset])) {
 				// then check to make sure it is not a default var
-				if ( ! array_key_exists( $reset, $this->_default_session_vars )) {
+				if ( ! array_key_exists($reset, $this->_default_session_vars)) {
 					// remove session var
-					unset( $this->_session_data[ $reset ] );
-					if ( $show_all_notices ) {
-						EE_Error::add_success( sprintf( __( 'The session variable %s was removed.', 'event_espresso' ), $reset ), __FILE__, __FUNCTION__, __LINE__ );
+					unset($this->_session_data[$reset]);
+					if ($show_all_notices) {
+						EE_Error::add_success(sprintf(__('The session variable %s was removed.', 'event_espresso'), $reset), __FILE__, __FUNCTION__, __LINE__);
 					}
-					$return_value = !isset($return_value) ? TRUE : $return_value;
+					$return_value = ! isset($return_value) ? TRUE : $return_value;
 
 				} else {
 					// yeeeeeeeeerrrrrrrrrrr OUT !!!!
-					if ( $show_all_notices ) {
-						EE_Error::add_error( sprintf( __( 'Sorry! %s is a default session datum and can not be reset.', 'event_espresso' ), $reset ), __FILE__, __FUNCTION__, __LINE__ );
+					if ($show_all_notices) {
+						EE_Error::add_error(sprintf(__('Sorry! %s is a default session datum and can not be reset.', 'event_espresso'), $reset), __FILE__, __FUNCTION__, __LINE__);
 					}
 					$return_value = FALSE;
 				}
 
-			} else if ( $show_all_notices ) {
+			} else if ($show_all_notices) {
 				// oops! that session var does not exist!
-				EE_Error::add_error( sprintf( __( 'The session item provided, %s, is invalid or does not exist.', 'event_espresso' ), $reset ), __FILE__, __FUNCTION__, __LINE__ );
+				EE_Error::add_error(sprintf(__('The session item provided, %s, is invalid or does not exist.', 'event_espresso'), $reset), __FILE__, __FUNCTION__, __LINE__);
 				$return_value = FALSE;
 			}
 
@@ -1017,8 +1017,8 @@ 
       * @throws \EE_Error
       */
 	public function wp_loaded() {
-		if ( isset(  EE_Registry::instance()->REQ ) && EE_Registry::instance()->REQ->is_set( 'clear_session' )) {
-			$this->clear_session( __CLASS__, __FUNCTION__ );
+		if (isset(EE_Registry::instance()->REQ) && EE_Registry::instance()->REQ->is_set('clear_session')) {
+			$this->clear_session(__CLASS__, __FUNCTION__);
 		}
 	}
 
@@ -1054,7 +1054,7 @@ 
              // or use that for the new transient cleanup query limit
              add_filter(
                  'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
-                 function () use ($expired_session_transient_delete_query_limit) {
+                 function() use ($expired_session_transient_delete_query_limit) {
                      return $expired_session_transient_delete_query_limit;
                  }
              );
@@ -1068,34 +1068,34 @@ 
 	  * @param $data1
 	  * @return string
 	  */
-	 private function find_serialize_error( $data1 ) {
+	 private function find_serialize_error($data1) {
 		$error = '<pre>';
 		 $data2 = preg_replace_callback(
 			 '!s:(\d+):"(.*?)";!',
-			 function ( $match ) {
-				 return ( $match[1] === strlen( $match[2] ) )
+			 function($match) {
+				 return ($match[1] === strlen($match[2]))
 					 ? $match[0]
 					 : 's:'
-					   . strlen( $match[2] )
+					   . strlen($match[2])
 					   . ':"'
 					   . $match[2]
 					   . '";';
 			 },
 			 $data1
 		 );
-		$max = ( strlen( $data1 ) > strlen( $data2 ) ) ? strlen( $data1 ) : strlen( $data2 );
-		$error .= $data1 . PHP_EOL;
-		$error .= $data2 . PHP_EOL;
-		for ( $i = 0; $i < $max; $i++ ) {
-			if ( @$data1[ $i ] !== @$data2[ $i ] ) {
-				$error .= 'Difference ' . @$data1[ $i ] . ' != ' . @$data2[ $i ] . PHP_EOL;
-				$error .= "\t-> ORD number " . ord( @$data1[ $i ] ) . ' != ' . ord( @$data2[ $i ] ) . PHP_EOL;
-				$error .= "\t-> Line Number = $i" . PHP_EOL;
-				$start = ( $i - 20 );
-				$start = ( $start < 0 ) ? 0 : $start;
+		$max = (strlen($data1) > strlen($data2)) ? strlen($data1) : strlen($data2);
+		$error .= $data1.PHP_EOL;
+		$error .= $data2.PHP_EOL;
+		for ($i = 0; $i < $max; $i++) {
+			if (@$data1[$i] !== @$data2[$i]) {
+				$error .= 'Difference '.@$data1[$i].' != '.@$data2[$i].PHP_EOL;
+				$error .= "\t-> ORD number ".ord(@$data1[$i]).' != '.ord(@$data2[$i]).PHP_EOL;
+				$error .= "\t-> Line Number = $i".PHP_EOL;
+				$start = ($i - 20);
+				$start = ($start < 0) ? 0 : $start;
 				$length = 40;
 				$point = $max - $i;
-				if ( $point < 20 ) {
+				if ($point < 20) {
 					$rlength = 1;
 					$rpoint = -$point;
 				} else {
@@ -1104,16 +1104,16 @@ 
 				}
 				$error .= "\t-> Section Data1  = ";
 				$error .= substr_replace(
-					substr( $data1, $start, $length ),
-					"<b style=\"color:green\">{$data1[ $i ]}</b>",
+					substr($data1, $start, $length),
+					"<b style=\"color:green\">{$data1[$i]}</b>",
 					$rpoint,
 					$rlength
 				);
 				$error .= PHP_EOL;
 				$error .= "\t-> Section Data2  = ";
 				$error .= substr_replace(
-					substr( $data2, $start, $length ),
-					"<b style=\"color:red\">{$data2[ $i ]}</b>",
+					substr($data2, $start, $length),
+					"<b style=\"color:red\">{$data2[$i]}</b>",
 					$rpoint,
 					$rlength
 				);

core/domain/entities/shortcodes/EspressoTicketSelector.php

Indentation +76 added lines, -76 removed lines

@@ -24,82 +24,82 @@
 
 
 
-    /**
-     * the actual shortcode tag that gets registered with WordPress
-     *
-     * @return string
-     */
-    public function getTag()
-    {
-        return 'ESPRESSO_TICKET_SELECTOR';
-    }
-
-
-
-    /**
-     * the time in seconds to cache the results of the processShortcode() method
-     * 0 means the processShortcode() results will NOT be cached at all
-     *
-     * @return int
-     */
-    public function cacheExpiration()
-    {
-        return MINUTE_IN_SECONDS;
-    }
-
-
-    /**
-     * a place for adding any initialization code that needs to run prior to wp_header().
-     * this may be required for shortcodes that utilize a corresponding module,
-     * and need to enqueue assets for that module
-     *
-     * @return void
-     */
-    public function initializeShortcode()
-    {
-        add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
-        $this->shortcodeHasBeenInitialized();
-    }
-
-
-
-    /**
-     * callback that runs when the shortcode is encountered in post content.
-     * IMPORTANT !!!
-     * remember that shortcode content should be RETURNED and NOT echoed out
-     *
-     * @param array $attributes
-     * @return string
-     * @throws InvalidArgumentException
-     */
-    public function processShortcode($attributes = array())
-    {
-        extract($attributes, EXTR_OVERWRITE);
-        $event_id = isset($event_id) ? $event_id : 0;
-        $event = EE_Registry::instance()->load_model('Event')->get_one_by_ID($event_id);
-        if (! $event instanceof EE_Event) {
-            new ExceptionStackTraceDisplay(
-                new InvalidArgumentException(
-                    sprintf(
-                        esc_html__(
-                            'A valid Event ID is required to use the "%1$s" shortcode.%4$sAn Event with an ID of "%2$s" could not be found.%4$sPlease verify that the shortcode added to this post\'s content includes an "%3$s" argument and that it\'s value corresponds to a valid Event ID.',
-                            'event_espresso'
-                        ),
-                        $this->getTag(),
-                        $event_id,
-                        'event_id',
-                        '<br />'
-                    )
-                )
-            );
-            return '';
-        }
-        ob_start();
-        do_action('AHEE_event_details_before_post', $event_id);
-        espresso_ticket_selector($event);
-        do_action('AHEE_event_details_after_post');
-        return ob_get_clean();
-    }
+	/**
+	 * the actual shortcode tag that gets registered with WordPress
+	 *
+	 * @return string
+	 */
+	public function getTag()
+	{
+		return 'ESPRESSO_TICKET_SELECTOR';
+	}
+
+
+
+	/**
+	 * the time in seconds to cache the results of the processShortcode() method
+	 * 0 means the processShortcode() results will NOT be cached at all
+	 *
+	 * @return int
+	 */
+	public function cacheExpiration()
+	{
+		return MINUTE_IN_SECONDS;
+	}
+
+
+	/**
+	 * a place for adding any initialization code that needs to run prior to wp_header().
+	 * this may be required for shortcodes that utilize a corresponding module,
+	 * and need to enqueue assets for that module
+	 *
+	 * @return void
+	 */
+	public function initializeShortcode()
+	{
+		add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
+		$this->shortcodeHasBeenInitialized();
+	}
+
+
+
+	/**
+	 * callback that runs when the shortcode is encountered in post content.
+	 * IMPORTANT !!!
+	 * remember that shortcode content should be RETURNED and NOT echoed out
+	 *
+	 * @param array $attributes
+	 * @return string
+	 * @throws InvalidArgumentException
+	 */
+	public function processShortcode($attributes = array())
+	{
+		extract($attributes, EXTR_OVERWRITE);
+		$event_id = isset($event_id) ? $event_id : 0;
+		$event = EE_Registry::instance()->load_model('Event')->get_one_by_ID($event_id);
+		if (! $event instanceof EE_Event) {
+			new ExceptionStackTraceDisplay(
+				new InvalidArgumentException(
+					sprintf(
+						esc_html__(
+							'A valid Event ID is required to use the "%1$s" shortcode.%4$sAn Event with an ID of "%2$s" could not be found.%4$sPlease verify that the shortcode added to this post\'s content includes an "%3$s" argument and that it\'s value corresponds to a valid Event ID.',
+							'event_espresso'
+						),
+						$this->getTag(),
+						$event_id,
+						'event_id',
+						'<br />'
+					)
+				)
+			);
+			return '';
+		}
+		ob_start();
+		do_action('AHEE_event_details_before_post', $event_id);
+		espresso_ticket_selector($event);
+		do_action('AHEE_event_details_after_post');
+		return ob_get_clean();
+	}
 
 
 }

Spacing +1 added lines, -1 removed lines

@@ -77,7 +77,7 @@
         extract($attributes, EXTR_OVERWRITE);
         $event_id = isset($event_id) ? $event_id : 0;
         $event = EE_Registry::instance()->load_model('Event')->get_one_by_ID($event_id);
-        if (! $event instanceof EE_Event) {
+        if ( ! $event instanceof EE_Event) {
             new ExceptionStackTraceDisplay(
                 new InvalidArgumentException(
                     sprintf(

core/domain/services/session/SessionIdentifierInterface.php

Indentation +4 added lines, -4 removed lines

@@ -5,9 +5,9 @@
 interface SessionIdentifierInterface
 {
 
-    /**
-     * @return    string
-     */
-    public function id();
+	/**
+	 * @return    string
+	 */
+	public function id();
 
 }
\ No newline at end of file

core/services/collections/CollectionLoader.php

Indentation +37 added lines, -37 removed lines

@@ -199,13 +199,13 @@ 
 			);
 			return CollectionLoader::ENTITY_ADDED;
 		}
-        do_action(
-            'FHEE__CollectionLoader__addEntityToCollection__entity_not_added',
-            $this,
-            $this->collection_details->collectionName(),
-            $this->collection_details
-        );
-        return CollectionLoader::ENTITY_NOT_ADDED;
+		do_action(
+			'FHEE__CollectionLoader__addEntityToCollection__entity_not_added',
+			$this,
+			$this->collection_details->collectionName(),
+			$this->collection_details
+		);
+		return CollectionLoader::ENTITY_NOT_ADDED;
 	}
 
 
@@ -220,37 +220,37 @@ 
 	 * @throws \EventEspresso\core\exceptions\InvalidEntityException
 	 */
 	protected function setIdentifier( $entity, $identifier ) {
-	    switch($this->collection_details->identifierType()) {
-	        // every unique object gets added to the collection, but not duplicates of the exact same object
-            case CollectionDetails::ID_OBJECT_HASH :
-                $identifier = spl_object_hash($entity);
-                break;
-            // only one entity per class can be added to collection, like a singleton
-            case CollectionDetails::ID_CLASS_NAME :
-                $identifier = get_class($entity);
-                break;
-            // objects added to the collection based on entity callback, so the entity itself decides
-            case CollectionDetails::ID_CALLBACK_METHOD :
-                $identifier_callback = $this->collection_details->identifierCallback();
-                if ( ! method_exists($entity, $identifier_callback)) {
-                    throw new InvalidEntityException(
-                        $entity,
-                        $this->collection_details->getCollectionInterface(),
-                        sprintf(
-                            __(
-                                'The current collection is configured to use a method named "%1$s" when setting or retrieving objects. The supplied entity is an instance
+		switch($this->collection_details->identifierType()) {
+			// every unique object gets added to the collection, but not duplicates of the exact same object
+			case CollectionDetails::ID_OBJECT_HASH :
+				$identifier = spl_object_hash($entity);
+				break;
+			// only one entity per class can be added to collection, like a singleton
+			case CollectionDetails::ID_CLASS_NAME :
+				$identifier = get_class($entity);
+				break;
+			// objects added to the collection based on entity callback, so the entity itself decides
+			case CollectionDetails::ID_CALLBACK_METHOD :
+				$identifier_callback = $this->collection_details->identifierCallback();
+				if ( ! method_exists($entity, $identifier_callback)) {
+					throw new InvalidEntityException(
+						$entity,
+						$this->collection_details->getCollectionInterface(),
+						sprintf(
+							__(
+								'The current collection is configured to use a method named "%1$s" when setting or retrieving objects. The supplied entity is an instance
                                 of "%2$s", but does not contain this method.',
-                                'event_espresso'
-                            ),
-                            $identifier_callback,
-                            get_class($entity)
-                        )
-                    );
-                }
-                $identifier = $entity->{$identifier_callback}();
-                break;
-
-        }
+								'event_espresso'
+							),
+							$identifier_callback,
+							get_class($entity)
+						)
+					);
+				}
+				$identifier = $entity->{$identifier_callback}();
+				break;
+
+		}
 		return apply_filters(
 			'FHEE__CollectionLoader__addEntityToCollection__identifier',
 			$identifier,

core/services/cache/BasicCacheManager.php

Spacing +4 added lines, -4 removed lines

@@ -140,7 +140,7 @@ 
         // with these parameters
         $cache_id .= filter_input(INPUT_SERVER, 'QUERY_STRING', FILTER_SANITIZE_URL);
         // then md5 the above to control it's length, add all of our prefixes, and truncate
-        return substr($this->cachePrefix() . $id_prefix . '-' . md5($cache_id), 0, 182);
+        return substr($this->cachePrefix().$id_prefix.'-'.md5($cache_id), 0, 182);
     }
 
 
@@ -170,9 +170,9 @@ 
         return '
 <div class="ee-cached-content-notice" style="position:fixed; bottom:0; left: 0;">
     <p style="font-size:9px;font-weight:normal;color:#666;line-height: 12px;margin:0 0 3px 5px">
-        <b>' . $type . '</b><span style="color:#999"> : </span>
-        <span>' . $cache_id . '</span>
-        <span style="margin-left:2em;">' . __FILE__ . '</span>
+        <b>' . $type.'</b><span style="color:#999"> : </span>
+        <span>' . $cache_id.'</span>
+        <span style="margin-left:2em;">' . __FILE__.'</span>
     </p>
 </div>';
     }

Indentation +135 added lines, -135 removed lines

@@ -19,140 +19,140 @@ 
 class BasicCacheManager implements CacheManagerInterface
 {
 
-    /**
-     * @type string
-     */
-    const CACHE_PREFIX = 'ee_cache_';
-
-
-    /**
-     * @var CacheStorageInterface $cache_storage
-     */
-    private $cache_storage;
-
-
-
-    /**
-     * BasicCacheManager constructor.
-     *
-     * @param CacheStorageInterface      $cache_storage [required]
-     */
-    public function __construct(CacheStorageInterface $cache_storage)
-    {
-        $this->cache_storage = $cache_storage;
-    }
-
-
-
-    /**
-     * returns a string that will be prepended to all cache identifiers
-     *
-     * @return string
-     */
-    public function cachePrefix()
-    {
-        return BasicCacheManager::CACHE_PREFIX;
-    }
-
-
-
-    /**
-     * @param string  $id_prefix [required] Prepended to all cache IDs. Can be helpful in finding specific cache types.
-     *                           May also be helpful to include an additional specific identifier,
-     *                           such as a post ID as part of the $id_prefix so that individual caches
-     *                           can be found and/or cleared. ex: "venue-28", or "shortcode-156".
-     *                           BasicCacheManager::CACHE_PREFIX will also be prepended to the cache id.
-     * @param string  $cache_id  [required] Additional identifying details that make this cache unique.
-     *                           It is advisable to use some of the actual data
-     *                           that is used to generate the content being cached,
-     *                           in order to guarantee that the cache id is unique for that content.
-     *                           The cache id will be md5'd before usage to make it more db friendly,
-     *                           and the entire cache id string will be truncated to 190 characters.
-     * @param Closure $callback  [required] since the point of caching is to avoid generating content when not
-     *                           necessary,
-     *                           we wrap our content creation in a Closure so that it is not executed until needed.
-     * @param int     $expiration
-     * @return Closure|mixed
-     */
-    public function get($id_prefix, $cache_id, Closure $callback, $expiration = HOUR_IN_SECONDS)
-    {
-        $content = '';
-        $expiration = absint(
-            apply_filters(
-                'FHEE__CacheManager__get__cache_expiration',
-                $expiration,
-                $id_prefix,
-                $cache_id
-            )
-        );
-        $cache_id = $this->generateCacheIdentifier($id_prefix, $cache_id);
-        // is caching enabled for this content ?
-        if ($expiration) {
-            $content = $this->cache_storage->get($cache_id);
-        }
-        // any existing content ?
-        if (empty($content)) {
-            // nope! let's generate some new stuff
-            $content = $callback();
-            // save the new content if caching is enabled
-            if ($expiration) {
-                $this->cache_storage->add($cache_id, $content, $expiration);
-                if (EE_DEBUG) {
-                    $content .= $this->displayCacheNotice($cache_id, 'REFRESH CACHE');
-                }
-            }
-        } else {
-            if (EE_DEBUG) {
-                $content .= $this->displayCacheNotice($cache_id, 'CACHED CONTENT');
-            }
-        }
-        return $content;
-    }
-
-
-
-    /**
-     * Generates a unique identifier string for the cache
-     *
-     * @param string $id_prefix  [required] see BasicCacheManager::get()
-     * @param string $cache_id   [required] see BasicCacheManager::get()
-     * @return string
-     */
-    private function generateCacheIdentifier($id_prefix, $cache_id)
-    {
-        // let's make the cached content unique for this "page"
-        $cache_id .= filter_input(INPUT_SERVER, 'REQUEST_URI', FILTER_SANITIZE_URL);
-        // with these parameters
-        $cache_id .= filter_input(INPUT_SERVER, 'QUERY_STRING', FILTER_SANITIZE_URL);
-        // then md5 the above to control it's length, add all of our prefixes, and truncate
-        return substr($this->cachePrefix() . $id_prefix . '-' . md5($cache_id), 0, 182);
-    }
-
-
-
-    /**
-     * @param array|string $cache_id [required] Could be an ID prefix affecting many caches
-     *                               or a specific ID targeting a single cache item
-     * @return void
-     */
-    public function clear($cache_id)
-    {
-        // ensure incoming arg is in an array
-        $cache_id = is_array($cache_id) ? $cache_id : array($cache_id);
-        // delete corresponding transients for the supplied id prefix
-        $this->cache_storage->deleteMany($cache_id);
-    }
-
-
-
-    /**
-     * @param array|string $cache_id [required] Could be an ID prefix affecting many caches
-     *                               or a specific ID targeting a single cache item
-     * @param string       $type
-     * @return string
-     */
-    private function displayCacheNotice($cache_id, $type) {
-        return '
+	/**
+	 * @type string
+	 */
+	const CACHE_PREFIX = 'ee_cache_';
+
+
+	/**
+	 * @var CacheStorageInterface $cache_storage
+	 */
+	private $cache_storage;
+
+
+
+	/**
+	 * BasicCacheManager constructor.
+	 *
+	 * @param CacheStorageInterface      $cache_storage [required]
+	 */
+	public function __construct(CacheStorageInterface $cache_storage)
+	{
+		$this->cache_storage = $cache_storage;
+	}
+
+
+
+	/**
+	 * returns a string that will be prepended to all cache identifiers
+	 *
+	 * @return string
+	 */
+	public function cachePrefix()
+	{
+		return BasicCacheManager::CACHE_PREFIX;
+	}
+
+
+
+	/**
+	 * @param string  $id_prefix [required] Prepended to all cache IDs. Can be helpful in finding specific cache types.
+	 *                           May also be helpful to include an additional specific identifier,
+	 *                           such as a post ID as part of the $id_prefix so that individual caches
+	 *                           can be found and/or cleared. ex: "venue-28", or "shortcode-156".
+	 *                           BasicCacheManager::CACHE_PREFIX will also be prepended to the cache id.
+	 * @param string  $cache_id  [required] Additional identifying details that make this cache unique.
+	 *                           It is advisable to use some of the actual data
+	 *                           that is used to generate the content being cached,
+	 *                           in order to guarantee that the cache id is unique for that content.
+	 *                           The cache id will be md5'd before usage to make it more db friendly,
+	 *                           and the entire cache id string will be truncated to 190 characters.
+	 * @param Closure $callback  [required] since the point of caching is to avoid generating content when not
+	 *                           necessary,
+	 *                           we wrap our content creation in a Closure so that it is not executed until needed.
+	 * @param int     $expiration
+	 * @return Closure|mixed
+	 */
+	public function get($id_prefix, $cache_id, Closure $callback, $expiration = HOUR_IN_SECONDS)
+	{
+		$content = '';
+		$expiration = absint(
+			apply_filters(
+				'FHEE__CacheManager__get__cache_expiration',
+				$expiration,
+				$id_prefix,
+				$cache_id
+			)
+		);
+		$cache_id = $this->generateCacheIdentifier($id_prefix, $cache_id);
+		// is caching enabled for this content ?
+		if ($expiration) {
+			$content = $this->cache_storage->get($cache_id);
+		}
+		// any existing content ?
+		if (empty($content)) {
+			// nope! let's generate some new stuff
+			$content = $callback();
+			// save the new content if caching is enabled
+			if ($expiration) {
+				$this->cache_storage->add($cache_id, $content, $expiration);
+				if (EE_DEBUG) {
+					$content .= $this->displayCacheNotice($cache_id, 'REFRESH CACHE');
+				}
+			}
+		} else {
+			if (EE_DEBUG) {
+				$content .= $this->displayCacheNotice($cache_id, 'CACHED CONTENT');
+			}
+		}
+		return $content;
+	}
+
+
+
+	/**
+	 * Generates a unique identifier string for the cache
+	 *
+	 * @param string $id_prefix  [required] see BasicCacheManager::get()
+	 * @param string $cache_id   [required] see BasicCacheManager::get()
+	 * @return string
+	 */
+	private function generateCacheIdentifier($id_prefix, $cache_id)
+	{
+		// let's make the cached content unique for this "page"
+		$cache_id .= filter_input(INPUT_SERVER, 'REQUEST_URI', FILTER_SANITIZE_URL);
+		// with these parameters
+		$cache_id .= filter_input(INPUT_SERVER, 'QUERY_STRING', FILTER_SANITIZE_URL);
+		// then md5 the above to control it's length, add all of our prefixes, and truncate
+		return substr($this->cachePrefix() . $id_prefix . '-' . md5($cache_id), 0, 182);
+	}
+
+
+
+	/**
+	 * @param array|string $cache_id [required] Could be an ID prefix affecting many caches
+	 *                               or a specific ID targeting a single cache item
+	 * @return void
+	 */
+	public function clear($cache_id)
+	{
+		// ensure incoming arg is in an array
+		$cache_id = is_array($cache_id) ? $cache_id : array($cache_id);
+		// delete corresponding transients for the supplied id prefix
+		$this->cache_storage->deleteMany($cache_id);
+	}
+
+
+
+	/**
+	 * @param array|string $cache_id [required] Could be an ID prefix affecting many caches
+	 *                               or a specific ID targeting a single cache item
+	 * @param string       $type
+	 * @return string
+	 */
+	private function displayCacheNotice($cache_id, $type) {
+		return '
 <div class="ee-cached-content-notice" style="position:fixed; bottom:0; left: 0;">
     <p style="font-size:9px;font-weight:normal;color:#666;line-height: 12px;margin:0 0 3px 5px">
         <b>' . $type . '</b><span style="color:#999"> : </span>
@@ -160,7 +160,7 @@ 
         <span style="margin-left:2em;">' . __FILE__ . '</span>
     </p>
 </div>';
-    }
+	}
 
 }
 // End of file BasicCacheManager.php