eventespresso / event-espresso-core

core/services/shortcodes/LegacyShortcodesManager.php

Spacing +13 added lines, -13 removed lines

@@ -117,44 +117,44 @@ 
             // remove last segment
             array_pop($shortcode_path);
             // glue it back together
-            $shortcode_path = implode(DS, $shortcode_path) . DS;
+            $shortcode_path = implode(DS, $shortcode_path).DS;
         } else {
             // we need to generate the filename based off of the folder name
             // grab and sanitize shortcode directory name
             $shortcode = sanitize_key(basename($shortcode_path));
-            $shortcode_path = rtrim($shortcode_path, DS) . DS;
+            $shortcode_path = rtrim($shortcode_path, DS).DS;
         }
         // create classname from shortcode directory or file name
         $shortcode = str_replace(' ', '_', ucwords(str_replace('_', ' ', $shortcode)));
         // add class prefix
-        $shortcode_class = 'EES_' . $shortcode;
+        $shortcode_class = 'EES_'.$shortcode;
         // does the shortcode exist ?
-        if ( ! is_readable($shortcode_path . DS . $shortcode_class . $shortcode_ext)) {
+        if ( ! is_readable($shortcode_path.DS.$shortcode_class.$shortcode_ext)) {
             $msg = sprintf(
                 esc_html__(
                     'The requested %s shortcode file could not be found or is not readable due to file permissions. It should be in %s',
                     'event_espresso'
                 ),
                 $shortcode_class,
-                $shortcode_path . DS . $shortcode_class . $shortcode_ext
+                $shortcode_path.DS.$shortcode_class.$shortcode_ext
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // load the shortcode class file
-        require_once($shortcode_path . $shortcode_class . $shortcode_ext);
+        require_once($shortcode_path.$shortcode_class.$shortcode_ext);
         // verify that class exists
         if ( ! class_exists($shortcode_class)) {
             $msg = sprintf(
                 esc_html__('The requested %s shortcode class does not exist.', 'event_espresso'),
                 $shortcode_class
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         $shortcode = strtoupper($shortcode);
         // add to array of registered shortcodes
-        $this->registry->shortcodes->{$shortcode} = $shortcode_path . $shortcode_class . $shortcode_ext;
+        $this->registry->shortcodes->{$shortcode} = $shortcode_path.$shortcode_class.$shortcode_ext;
         return true;
     }
 
@@ -172,7 +172,7 @@ 
         // cycle thru shortcode folders
         foreach ($this->registry->shortcodes as $shortcode => $shortcode_path) {
             // add class prefix
-            $shortcode_class = 'EES_' . $shortcode;
+            $shortcode_class = 'EES_'.$shortcode;
             // fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system
             // which set hooks ?
             if (is_admin()) {
@@ -290,7 +290,7 @@ 
     {
         $has_shortcode = false;
         foreach ($this->registry->shortcodes as $shortcode_class => $shortcode) {
-            if ($load_all || has_shortcode($content, $shortcode_class) ) {
+            if ($load_all || has_shortcode($content, $shortcode_class)) {
                 // load up the shortcode
                 $this->initializeShortcode($shortcode_class);
                 $has_shortcode = true;
@@ -402,7 +402,7 @@ 
      */
     public static function addShortcodeClassPrefix($class_name)
     {
-        return strpos($class_name, 'EES_') === 0 ? $class_name : 'EES_' . $class_name;
+        return strpos($class_name, 'EES_') === 0 ? $class_name : 'EES_'.$class_name;
     }
 
 
@@ -414,7 +414,7 @@ 
     {
         static $shortcode_tags = array();
         if (empty($shortcode_tags)) {
-            $shortcode_tags = array_keys((array)$this->registry->shortcodes);
+            $shortcode_tags = array_keys((array) $this->registry->shortcodes);
         }
         return $shortcode_tags;
     }

Indentation +423 added lines, -423 removed lines

@@ -25,429 +25,429 @@
 class LegacyShortcodesManager
 {
 
-    /**
-     * @var EE_Registry $registry
-     */
-    private $registry;
-
-
-
-
-    /**
-     * LegacyShortcodesManager constructor.
-     *
-     * @param \EE_Registry $registry
-     */
-    public function __construct(EE_Registry $registry)
-    {
-        $this->registry = $registry;
-    }
-
-
-
-    /**
-     * @return EE_Registry
-     */
-    public function registry()
-    {
-        return $this->registry;
-    }
-
-
-
-    /**
-     * registerShortcodes
-     *
-     * @return void
-     */
-    public function registerShortcodes()
-    {
-        $this->registry->shortcodes = $this->getShortcodes();
-    }
-
-
-
-    /**
-     * getShortcodes
-     *
-     * @return array
-     */
-    public function getShortcodes()
-    {
-        // previously this method would glob the shortcodes directory
-        // then filter that list of shortcodes to register,
-        // but now we are going to just supply an empty array.
-        // this allows any shortcodes that have not yet been converted to the new system
-        // to still get loaded and processed, albeit using the same legacy logic as before
-        $shortcodes_to_register = apply_filters(
-            'FHEE__EE_Config__register_shortcodes__shortcodes_to_register',
-            array()
-        );
-        if ( ! empty($shortcodes_to_register)) {
-            // cycle thru shortcode folders
-            foreach ($shortcodes_to_register as $shortcode_path) {
-                // add to list of installed shortcode modules
-                $this->registerShortcode($shortcode_path);
-            }
-        }
-        // filter list of installed modules
-        return apply_filters(
-            'FHEE__EE_Config___register_shortcodes__installed_shortcodes',
-            ! empty($this->registry->shortcodes)
-                ? $this->registry->shortcodes
-                : array()
-        );
-    }
-
-
-
-    /**
-     *    register_shortcode - makes core aware of this shortcode
-     *
-     * @access    public
-     * @param    string $shortcode_path - full path up to and including shortcode folder
-     * @return    bool
-     */
-    public function registerShortcode($shortcode_path = null)
-    {
-        do_action('AHEE__EE_Config__register_shortcode__begin', $shortcode_path);
-        $shortcode_ext = '.shortcode.php';
-        // make all separators match
-        $shortcode_path = str_replace(array('\\', '/'), DS, $shortcode_path);
-        // does the file path INCLUDE the actual file name as part of the path ?
-        if (strpos($shortcode_path, $shortcode_ext) !== false) {
-            // grab shortcode file name from directory name and break apart at dots
-            $shortcode_file = explode('.', basename($shortcode_path));
-            // take first segment from file name pieces and remove class prefix if it exists
-            $shortcode = strpos($shortcode_file[0], 'EES_') === 0
-                ? substr($shortcode_file[0], 4)
-                : $shortcode_file[0];
-            // sanitize shortcode directory name
-            $shortcode = sanitize_key($shortcode);
-            // now we need to rebuild the shortcode path
-            $shortcode_path = explode(DS, $shortcode_path);
-            // remove last segment
-            array_pop($shortcode_path);
-            // glue it back together
-            $shortcode_path = implode(DS, $shortcode_path) . DS;
-        } else {
-            // we need to generate the filename based off of the folder name
-            // grab and sanitize shortcode directory name
-            $shortcode = sanitize_key(basename($shortcode_path));
-            $shortcode_path = rtrim($shortcode_path, DS) . DS;
-        }
-        // create classname from shortcode directory or file name
-        $shortcode = str_replace(' ', '_', ucwords(str_replace('_', ' ', $shortcode)));
-        // add class prefix
-        $shortcode_class = 'EES_' . $shortcode;
-        // does the shortcode exist ?
-        if ( ! is_readable($shortcode_path . DS . $shortcode_class . $shortcode_ext)) {
-            $msg = sprintf(
-                esc_html__(
-                    'The requested %s shortcode file could not be found or is not readable due to file permissions. It should be in %s',
-                    'event_espresso'
-                ),
-                $shortcode_class,
-                $shortcode_path . DS . $shortcode_class . $shortcode_ext
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // load the shortcode class file
-        require_once($shortcode_path . $shortcode_class . $shortcode_ext);
-        // verify that class exists
-        if ( ! class_exists($shortcode_class)) {
-            $msg = sprintf(
-                esc_html__('The requested %s shortcode class does not exist.', 'event_espresso'),
-                $shortcode_class
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        $shortcode = strtoupper($shortcode);
-        // add to array of registered shortcodes
-        $this->registry->shortcodes->{$shortcode} = $shortcode_path . $shortcode_class . $shortcode_ext;
-        return true;
-    }
-
-
-
-    /**
-     *    _initialize_shortcodes
-     *    allow shortcodes to set hooks for the rest of the system
-     *
-     * @access private
-     * @return void
-     */
-    public function addShortcodes()
-    {
-        // cycle thru shortcode folders
-        foreach ($this->registry->shortcodes as $shortcode => $shortcode_path) {
-            // add class prefix
-            $shortcode_class = 'EES_' . $shortcode;
-            // fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system
-            // which set hooks ?
-            if (is_admin()) {
-                // fire immediately
-                call_user_func(array($shortcode_class, 'set_hooks_admin'));
-            } else {
-                // delay until other systems are online
-                add_action(
-                    'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons',
-                    array($shortcode_class, 'set_hooks')
-                );
-                // convert classname to UPPERCASE and create WP shortcode.
-                $shortcode_tag = strtoupper($shortcode);
-                // but first check if the shortcode has already
-                // been added before assigning 'fallback_shortcode_processor'
-                if ( ! shortcode_exists($shortcode_tag)) {
-                    // NOTE: this shortcode declaration will get overridden if the shortcode
-                    // is successfully detected in the post content in initializeShortcode()
-                    add_shortcode($shortcode_tag, array($shortcode_class, 'fallback_shortcode_processor'));
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * callback for the WP "get_header" hook point
-     * checks posts for EE shortcodes, and initializes them,
-     * then toggles filter switch that loads core default assets
-     *
-     * @param \WP_Query $wp_query
-     * @return void
-     */
-    public function initializeShortcodes(WP_Query $wp_query)
-    {
-        if (empty($this->registry->shortcodes) || ! $wp_query->is_main_query() || is_admin()) {
-            return;
-        }
-        global $wp;
-        /** @var EE_Front_controller $Front_Controller */
-        $Front_Controller = $this->registry->load_core('Front_Controller', array(), false);
-        do_action('AHEE__EE_Front_Controller__initialize_shortcodes__begin', $wp, $Front_Controller);
-        $Front_Controller->Request_Handler()->set_request_vars();
-        // grab post_name from request
-        $current_post = apply_filters(
-            'FHEE__EE_Front_Controller__initialize_shortcodes__current_post_name',
-            $Front_Controller->Request_Handler()->get('post_name')
-        );
-        $show_on_front = get_option('show_on_front');
-        // if it's not set, then check if frontpage is blog
-        if (empty($current_post)) {
-            // yup.. this is the posts page, prepare to load all shortcode modules
-            $current_post = 'posts';
-            // unless..
-            if ($show_on_front === 'page') {
-                // some other page is set as the homepage
-                $page_on_front = get_option('page_on_front');
-                if ($page_on_front) {
-                    // k now we need to find the post_name for this page
-                    global $wpdb;
-                    $page_on_front = $wpdb->get_var(
-                        $wpdb->prepare(
-                            "SELECT post_name from {$wpdb->posts} WHERE post_type='page' AND post_status='publish' AND ID=%d",
-                            $page_on_front
-                        )
-                    );
-                    // set the current post slug to what it actually is
-                    $current_post = $page_on_front ? $page_on_front : $current_post;
-                }
-            }
-        }
-        // in case $current_post is hierarchical like: /parent-page/current-page
-        $current_post = basename($current_post);
-        if (
-            // is current page/post the "blog" page ?
-            $current_post === EE_Config::get_page_for_posts()
-            // or are we on a category page?
-            || (
-                is_array(term_exists($current_post, 'category'))
-                || array_key_exists('category_name', $wp->query_vars)
-            )
-        ) {
-            // initialize all legacy shortcodes
-            $load_assets = $this->parseContentForShortcodes('', true);
-        } else {
-            global $wpdb;
-            $post_content = $wpdb->get_var(
-                $wpdb->prepare(
-                    "SELECT post_content from {$wpdb->posts} WHERE post_status='publish' AND post_name=%s",
-                    $current_post
-                )
-            );
-            $load_assets = $this->parseContentForShortcodes($post_content);
-        }
-        if ($load_assets) {
-            $this->registry->REQ->set_espresso_page(true);
-            add_filter('FHEE_load_css', '__return_true');
-            add_filter('FHEE_load_js', '__return_true');
-        }
-        do_action('AHEE__EE_Front_Controller__initialize_shortcodes__end', $Front_Controller);
-    }
-
-
-
-    /**
-     * checks supplied content against list of legacy shortcodes,
-     * then initializes any found shortcodes, and returns true.
-     * returns false if no shortcodes found.
-     *
-     * @param string $content
-     * @param bool   $load_all if true, then ALL active legacy shortcodes will be initialized
-     * @return bool
-     */
-    public function parseContentForShortcodes($content = '', $load_all = false)
-    {
-        $has_shortcode = false;
-        foreach ($this->registry->shortcodes as $shortcode_class => $shortcode) {
-            if ($load_all || has_shortcode($content, $shortcode_class) ) {
-                // load up the shortcode
-                $this->initializeShortcode($shortcode_class);
-                $has_shortcode = true;
-            }
-        }
-        return $has_shortcode;
-    }
-
-
-
-    /**
-     * given a shortcode name, will instantiate the shortcode and call it's run() method
-     *
-     * @param string $shortcode_class
-     * @param WP     $wp
-     */
-    public function initializeShortcode($shortcode_class = '', WP $wp = null)
-    {
-        // don't do anything if shortcode is already initialized
-        if (
-            empty($this->registry->shortcodes->{$shortcode_class})
-            || ! is_string($this->registry->shortcodes->{$shortcode_class})
-        ) {
-            return;
-        }
-        // let's pause to reflect on this...
-        $sc_reflector = new ReflectionClass(LegacyShortcodesManager::addShortcodeClassPrefix($shortcode_class));
-        // ensure that class is actually a shortcode
-        if (
-            defined('WP_DEBUG')
-            && WP_DEBUG === true
-            && ! $sc_reflector->isSubclassOf('EES_Shortcode')
-        ) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The requested %s shortcode is not of the class "EES_Shortcode". Please check your files.',
-                        'event_espresso'
-                    ),
-                    $shortcode_class
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            add_filter('FHEE_run_EE_the_content', '__return_true');
-            return;
-        }
-        global $wp;
-        // and pass the request object to the run method
-        $this->registry->shortcodes->{$shortcode_class} = $sc_reflector->newInstance();
-        // fire the shortcode class's run method, so that it can activate resources
-        $this->registry->shortcodes->{$shortcode_class}->run($wp);
-    }
-
-
-
-    /**
-     * get classname, remove EES_prefix, and convert to UPPERCASE
-     *
-     * @param string $class_name
-     * @return string
-     */
-    public static function generateShortcodeTagFromClassName($class_name)
-    {
-        return strtoupper(str_replace('EES_', '', $class_name));
-    }
-
-
-
-    /**
-     * add EES_prefix and Capitalize words
-     *
-     * @param string $tag
-     * @return string
-     */
-    public static function generateShortcodeClassNameFromTag($tag)
-    {
-        // order of operation runs from inside to out
-        // 5) maybe add prefix
-        return LegacyShortcodesManager::addShortcodeClassPrefix(
-        // 4) find spaces, replace with underscores
-            str_replace(
-                ' ',
-                '_',
-                // 3) capitalize first letter of each word
-                ucwords(
-                // 2) also change to lowercase so ucwords() will work
-                    strtolower(
-                    // 1) find underscores, replace with spaces so ucwords() will work
-                        str_replace(
-                            '_',
-                            ' ',
-                            $tag
-                        )
-                    )
-                )
-            )
-        );
-    }
-
-
-
-    /**
-     * maybe add EES_prefix
-     *
-     * @param string $class_name
-     * @return string
-     */
-    public static function addShortcodeClassPrefix($class_name)
-    {
-        return strpos($class_name, 'EES_') === 0 ? $class_name : 'EES_' . $class_name;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function getEspressoShortcodeTags()
-    {
-        static $shortcode_tags = array();
-        if (empty($shortcode_tags)) {
-            $shortcode_tags = array_keys((array)$this->registry->shortcodes);
-        }
-        return $shortcode_tags;
-    }
-
-
-
-    /**
-     * @param string $content
-     * @return string
-     */
-    public function doShortcode($content)
-    {
-        foreach ($this->getEspressoShortcodeTags() as $shortcode_tag) {
-            if (strpos($content, $shortcode_tag) !== false) {
-                $shortcode_class = LegacyShortcodesManager::generateShortcodeClassNameFromTag($shortcode_tag);
-                $this->initializeShortcode($shortcode_class);
-            }
-        }
-        return do_shortcode($content);
-    }
+	/**
+	 * @var EE_Registry $registry
+	 */
+	private $registry;
+
+
+
+
+	/**
+	 * LegacyShortcodesManager constructor.
+	 *
+	 * @param \EE_Registry $registry
+	 */
+	public function __construct(EE_Registry $registry)
+	{
+		$this->registry = $registry;
+	}
+
+
+
+	/**
+	 * @return EE_Registry
+	 */
+	public function registry()
+	{
+		return $this->registry;
+	}
+
+
+
+	/**
+	 * registerShortcodes
+	 *
+	 * @return void
+	 */
+	public function registerShortcodes()
+	{
+		$this->registry->shortcodes = $this->getShortcodes();
+	}
+
+
+
+	/**
+	 * getShortcodes
+	 *
+	 * @return array
+	 */
+	public function getShortcodes()
+	{
+		// previously this method would glob the shortcodes directory
+		// then filter that list of shortcodes to register,
+		// but now we are going to just supply an empty array.
+		// this allows any shortcodes that have not yet been converted to the new system
+		// to still get loaded and processed, albeit using the same legacy logic as before
+		$shortcodes_to_register = apply_filters(
+			'FHEE__EE_Config__register_shortcodes__shortcodes_to_register',
+			array()
+		);
+		if ( ! empty($shortcodes_to_register)) {
+			// cycle thru shortcode folders
+			foreach ($shortcodes_to_register as $shortcode_path) {
+				// add to list of installed shortcode modules
+				$this->registerShortcode($shortcode_path);
+			}
+		}
+		// filter list of installed modules
+		return apply_filters(
+			'FHEE__EE_Config___register_shortcodes__installed_shortcodes',
+			! empty($this->registry->shortcodes)
+				? $this->registry->shortcodes
+				: array()
+		);
+	}
+
+
+
+	/**
+	 *    register_shortcode - makes core aware of this shortcode
+	 *
+	 * @access    public
+	 * @param    string $shortcode_path - full path up to and including shortcode folder
+	 * @return    bool
+	 */
+	public function registerShortcode($shortcode_path = null)
+	{
+		do_action('AHEE__EE_Config__register_shortcode__begin', $shortcode_path);
+		$shortcode_ext = '.shortcode.php';
+		// make all separators match
+		$shortcode_path = str_replace(array('\\', '/'), DS, $shortcode_path);
+		// does the file path INCLUDE the actual file name as part of the path ?
+		if (strpos($shortcode_path, $shortcode_ext) !== false) {
+			// grab shortcode file name from directory name and break apart at dots
+			$shortcode_file = explode('.', basename($shortcode_path));
+			// take first segment from file name pieces and remove class prefix if it exists
+			$shortcode = strpos($shortcode_file[0], 'EES_') === 0
+				? substr($shortcode_file[0], 4)
+				: $shortcode_file[0];
+			// sanitize shortcode directory name
+			$shortcode = sanitize_key($shortcode);
+			// now we need to rebuild the shortcode path
+			$shortcode_path = explode(DS, $shortcode_path);
+			// remove last segment
+			array_pop($shortcode_path);
+			// glue it back together
+			$shortcode_path = implode(DS, $shortcode_path) . DS;
+		} else {
+			// we need to generate the filename based off of the folder name
+			// grab and sanitize shortcode directory name
+			$shortcode = sanitize_key(basename($shortcode_path));
+			$shortcode_path = rtrim($shortcode_path, DS) . DS;
+		}
+		// create classname from shortcode directory or file name
+		$shortcode = str_replace(' ', '_', ucwords(str_replace('_', ' ', $shortcode)));
+		// add class prefix
+		$shortcode_class = 'EES_' . $shortcode;
+		// does the shortcode exist ?
+		if ( ! is_readable($shortcode_path . DS . $shortcode_class . $shortcode_ext)) {
+			$msg = sprintf(
+				esc_html__(
+					'The requested %s shortcode file could not be found or is not readable due to file permissions. It should be in %s',
+					'event_espresso'
+				),
+				$shortcode_class,
+				$shortcode_path . DS . $shortcode_class . $shortcode_ext
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// load the shortcode class file
+		require_once($shortcode_path . $shortcode_class . $shortcode_ext);
+		// verify that class exists
+		if ( ! class_exists($shortcode_class)) {
+			$msg = sprintf(
+				esc_html__('The requested %s shortcode class does not exist.', 'event_espresso'),
+				$shortcode_class
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		$shortcode = strtoupper($shortcode);
+		// add to array of registered shortcodes
+		$this->registry->shortcodes->{$shortcode} = $shortcode_path . $shortcode_class . $shortcode_ext;
+		return true;
+	}
+
+
+
+	/**
+	 *    _initialize_shortcodes
+	 *    allow shortcodes to set hooks for the rest of the system
+	 *
+	 * @access private
+	 * @return void
+	 */
+	public function addShortcodes()
+	{
+		// cycle thru shortcode folders
+		foreach ($this->registry->shortcodes as $shortcode => $shortcode_path) {
+			// add class prefix
+			$shortcode_class = 'EES_' . $shortcode;
+			// fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system
+			// which set hooks ?
+			if (is_admin()) {
+				// fire immediately
+				call_user_func(array($shortcode_class, 'set_hooks_admin'));
+			} else {
+				// delay until other systems are online
+				add_action(
+					'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons',
+					array($shortcode_class, 'set_hooks')
+				);
+				// convert classname to UPPERCASE and create WP shortcode.
+				$shortcode_tag = strtoupper($shortcode);
+				// but first check if the shortcode has already
+				// been added before assigning 'fallback_shortcode_processor'
+				if ( ! shortcode_exists($shortcode_tag)) {
+					// NOTE: this shortcode declaration will get overridden if the shortcode
+					// is successfully detected in the post content in initializeShortcode()
+					add_shortcode($shortcode_tag, array($shortcode_class, 'fallback_shortcode_processor'));
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * callback for the WP "get_header" hook point
+	 * checks posts for EE shortcodes, and initializes them,
+	 * then toggles filter switch that loads core default assets
+	 *
+	 * @param \WP_Query $wp_query
+	 * @return void
+	 */
+	public function initializeShortcodes(WP_Query $wp_query)
+	{
+		if (empty($this->registry->shortcodes) || ! $wp_query->is_main_query() || is_admin()) {
+			return;
+		}
+		global $wp;
+		/** @var EE_Front_controller $Front_Controller */
+		$Front_Controller = $this->registry->load_core('Front_Controller', array(), false);
+		do_action('AHEE__EE_Front_Controller__initialize_shortcodes__begin', $wp, $Front_Controller);
+		$Front_Controller->Request_Handler()->set_request_vars();
+		// grab post_name from request
+		$current_post = apply_filters(
+			'FHEE__EE_Front_Controller__initialize_shortcodes__current_post_name',
+			$Front_Controller->Request_Handler()->get('post_name')
+		);
+		$show_on_front = get_option('show_on_front');
+		// if it's not set, then check if frontpage is blog
+		if (empty($current_post)) {
+			// yup.. this is the posts page, prepare to load all shortcode modules
+			$current_post = 'posts';
+			// unless..
+			if ($show_on_front === 'page') {
+				// some other page is set as the homepage
+				$page_on_front = get_option('page_on_front');
+				if ($page_on_front) {
+					// k now we need to find the post_name for this page
+					global $wpdb;
+					$page_on_front = $wpdb->get_var(
+						$wpdb->prepare(
+							"SELECT post_name from {$wpdb->posts} WHERE post_type='page' AND post_status='publish' AND ID=%d",
+							$page_on_front
+						)
+					);
+					// set the current post slug to what it actually is
+					$current_post = $page_on_front ? $page_on_front : $current_post;
+				}
+			}
+		}
+		// in case $current_post is hierarchical like: /parent-page/current-page
+		$current_post = basename($current_post);
+		if (
+			// is current page/post the "blog" page ?
+			$current_post === EE_Config::get_page_for_posts()
+			// or are we on a category page?
+			|| (
+				is_array(term_exists($current_post, 'category'))
+				|| array_key_exists('category_name', $wp->query_vars)
+			)
+		) {
+			// initialize all legacy shortcodes
+			$load_assets = $this->parseContentForShortcodes('', true);
+		} else {
+			global $wpdb;
+			$post_content = $wpdb->get_var(
+				$wpdb->prepare(
+					"SELECT post_content from {$wpdb->posts} WHERE post_status='publish' AND post_name=%s",
+					$current_post
+				)
+			);
+			$load_assets = $this->parseContentForShortcodes($post_content);
+		}
+		if ($load_assets) {
+			$this->registry->REQ->set_espresso_page(true);
+			add_filter('FHEE_load_css', '__return_true');
+			add_filter('FHEE_load_js', '__return_true');
+		}
+		do_action('AHEE__EE_Front_Controller__initialize_shortcodes__end', $Front_Controller);
+	}
+
+
+
+	/**
+	 * checks supplied content against list of legacy shortcodes,
+	 * then initializes any found shortcodes, and returns true.
+	 * returns false if no shortcodes found.
+	 *
+	 * @param string $content
+	 * @param bool   $load_all if true, then ALL active legacy shortcodes will be initialized
+	 * @return bool
+	 */
+	public function parseContentForShortcodes($content = '', $load_all = false)
+	{
+		$has_shortcode = false;
+		foreach ($this->registry->shortcodes as $shortcode_class => $shortcode) {
+			if ($load_all || has_shortcode($content, $shortcode_class) ) {
+				// load up the shortcode
+				$this->initializeShortcode($shortcode_class);
+				$has_shortcode = true;
+			}
+		}
+		return $has_shortcode;
+	}
+
+
+
+	/**
+	 * given a shortcode name, will instantiate the shortcode and call it's run() method
+	 *
+	 * @param string $shortcode_class
+	 * @param WP     $wp
+	 */
+	public function initializeShortcode($shortcode_class = '', WP $wp = null)
+	{
+		// don't do anything if shortcode is already initialized
+		if (
+			empty($this->registry->shortcodes->{$shortcode_class})
+			|| ! is_string($this->registry->shortcodes->{$shortcode_class})
+		) {
+			return;
+		}
+		// let's pause to reflect on this...
+		$sc_reflector = new ReflectionClass(LegacyShortcodesManager::addShortcodeClassPrefix($shortcode_class));
+		// ensure that class is actually a shortcode
+		if (
+			defined('WP_DEBUG')
+			&& WP_DEBUG === true
+			&& ! $sc_reflector->isSubclassOf('EES_Shortcode')
+		) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The requested %s shortcode is not of the class "EES_Shortcode". Please check your files.',
+						'event_espresso'
+					),
+					$shortcode_class
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			add_filter('FHEE_run_EE_the_content', '__return_true');
+			return;
+		}
+		global $wp;
+		// and pass the request object to the run method
+		$this->registry->shortcodes->{$shortcode_class} = $sc_reflector->newInstance();
+		// fire the shortcode class's run method, so that it can activate resources
+		$this->registry->shortcodes->{$shortcode_class}->run($wp);
+	}
+
+
+
+	/**
+	 * get classname, remove EES_prefix, and convert to UPPERCASE
+	 *
+	 * @param string $class_name
+	 * @return string
+	 */
+	public static function generateShortcodeTagFromClassName($class_name)
+	{
+		return strtoupper(str_replace('EES_', '', $class_name));
+	}
+
+
+
+	/**
+	 * add EES_prefix and Capitalize words
+	 *
+	 * @param string $tag
+	 * @return string
+	 */
+	public static function generateShortcodeClassNameFromTag($tag)
+	{
+		// order of operation runs from inside to out
+		// 5) maybe add prefix
+		return LegacyShortcodesManager::addShortcodeClassPrefix(
+		// 4) find spaces, replace with underscores
+			str_replace(
+				' ',
+				'_',
+				// 3) capitalize first letter of each word
+				ucwords(
+				// 2) also change to lowercase so ucwords() will work
+					strtolower(
+					// 1) find underscores, replace with spaces so ucwords() will work
+						str_replace(
+							'_',
+							' ',
+							$tag
+						)
+					)
+				)
+			)
+		);
+	}
+
+
+
+	/**
+	 * maybe add EES_prefix
+	 *
+	 * @param string $class_name
+	 * @return string
+	 */
+	public static function addShortcodeClassPrefix($class_name)
+	{
+		return strpos($class_name, 'EES_') === 0 ? $class_name : 'EES_' . $class_name;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function getEspressoShortcodeTags()
+	{
+		static $shortcode_tags = array();
+		if (empty($shortcode_tags)) {
+			$shortcode_tags = array_keys((array)$this->registry->shortcodes);
+		}
+		return $shortcode_tags;
+	}
+
+
+
+	/**
+	 * @param string $content
+	 * @return string
+	 */
+	public function doShortcode($content)
+	{
+		foreach ($this->getEspressoShortcodeTags() as $shortcode_tag) {
+			if (strpos($content, $shortcode_tag) !== false) {
+				$shortcode_class = LegacyShortcodesManager::generateShortcodeClassNameFromTag($shortcode_tag);
+				$this->initializeShortcode($shortcode_class);
+			}
+		}
+		return do_shortcode($content);
+	}
 
 
 

core/EES_Shortcode.shortcode.php

Indentation +68 added lines, -68 removed lines

@@ -20,17 +20,17 @@ 
 
 
 
-    /**
-     * class constructor - should ONLY be instantiated by EE_Front_Controller
-     */
-    final public function __construct()
-    {
-        $shortcode = LegacyShortcodesManager::generateShortcodeTagFromClassName(get_class($this));
-        // assign shortcode to the preferred callback, which overwrites the "fallback shortcode processor" assigned earlier
-        add_shortcode($shortcode, array($this, 'process_shortcode'));
-        // make sure system knows this is an EE page
-        EE_Registry::instance()->REQ->set_espresso_page(true);
-    }
+	/**
+	 * class constructor - should ONLY be instantiated by EE_Front_Controller
+	 */
+	final public function __construct()
+	{
+		$shortcode = LegacyShortcodesManager::generateShortcodeTagFromClassName(get_class($this));
+		// assign shortcode to the preferred callback, which overwrites the "fallback shortcode processor" assigned earlier
+		add_shortcode($shortcode, array($this, 'process_shortcode'));
+		// make sure system knows this is an EE page
+		EE_Registry::instance()->REQ->set_espresso_page(true);
+	}
 
 
 
@@ -77,11 +77,11 @@ 
 		}
 		$shortcode = str_replace( 'EES_', '', strtoupper( $shortcode_class ));
 		$shortcode_obj = isset( EE_Registry::instance()->shortcodes->{$shortcode} )
-            ? EE_Registry::instance()->shortcodes->{$shortcode}
-            : null;
+			? EE_Registry::instance()->shortcodes->{$shortcode}
+			: null;
 		return $shortcode_obj instanceof $shortcode_class || $shortcode_class === 'self'
-            ? $shortcode_obj
-            : new $shortcode_class();
+			? $shortcode_obj
+			: new $shortcode_class();
 	}
 
 
@@ -135,59 +135,59 @@ 
 
 
 
-    /**
-     * 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 by supplying an array for the $custom_sanitization param,
-     * 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 pass the following for your $custom_sanitization array:
-     *      array('event_id' => 'absint')
-     * all other attributes would be sanitized using the defaults in the switch statement below
-     *
-     * @param array $attributes
-     * @param array $custom_sanitization
-     * @return array
-     */
-    public static function sanitize_attributes(array $attributes, $custom_sanitization = array())
-    {
-        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;
-                } else 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] = \EES_Shortcode::sanitize_attributes($value);
-                    break;
-                default :
-                    // only remaining data types are Object and Resource
-                    // which are not allowed as shortcode attributes
-                    $attributes[$key] = null;
-                    break;
-            }
-        }
-        return $attributes;
+	/**
+	 * 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 by supplying an array for the $custom_sanitization param,
+	 * 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 pass the following for your $custom_sanitization array:
+	 *      array('event_id' => 'absint')
+	 * all other attributes would be sanitized using the defaults in the switch statement below
+	 *
+	 * @param array $attributes
+	 * @param array $custom_sanitization
+	 * @return array
+	 */
+	public static function sanitize_attributes(array $attributes, $custom_sanitization = array())
+	{
+		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;
+				} else 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] = \EES_Shortcode::sanitize_attributes($value);
+					break;
+				default :
+					// only remaining data types are Object and Resource
+					// which are not allowed as shortcode attributes
+					$attributes[$key] = null;
+					break;
+			}
+		}
+		return $attributes;
 	}
 
 

Spacing +18 added lines, -18 removed lines

@@ -47,7 +47,7 @@ 
 	 * @param WP $WP
 	 * @return    void
 	 */
-	public abstract function run( WP $WP );
+	public abstract function run(WP $WP);
 
 
 
@@ -59,7 +59,7 @@ 
 	 *  @param		array 	$attributes
 	 *  @return 	mixed
 	 */
-	public abstract function process_shortcode( $attributes = array() );
+	public abstract function process_shortcode($attributes = array());
 
 
 
@@ -70,13 +70,13 @@ 
 	 * @param 	string $shortcode_class
 	 * @return 	\EES_Shortcode
 	 */
-	final public static function instance( $shortcode_class = null ) {
-		$shortcode_class = ! empty( $shortcode_class ) ? $shortcode_class : get_called_class();
-		if ( $shortcode_class === 'EES_Shortcode' || empty( $shortcode_class )) {
+	final public static function instance($shortcode_class = null) {
+		$shortcode_class = ! empty($shortcode_class) ? $shortcode_class : get_called_class();
+		if ($shortcode_class === 'EES_Shortcode' || empty($shortcode_class)) {
 			return null;
 		}
-		$shortcode = str_replace( 'EES_', '', strtoupper( $shortcode_class ));
-		$shortcode_obj = isset( EE_Registry::instance()->shortcodes->{$shortcode} )
+		$shortcode = str_replace('EES_', '', strtoupper($shortcode_class));
+		$shortcode_obj = isset(EE_Registry::instance()->shortcodes->{$shortcode} )
             ? EE_Registry::instance()->shortcodes->{$shortcode}
             : null;
 		return $shortcode_obj instanceof $shortcode_class || $shortcode_class === 'self'
@@ -95,23 +95,23 @@ 
 	 * @param 	$attributes
 	 * @return 	mixed
 	 */
-	final public static function fallback_shortcode_processor( $attributes ) {
-		if ( EE_Maintenance_Mode::disable_frontend_for_maintenance() ) {
+	final public static function fallback_shortcode_processor($attributes) {
+		if (EE_Maintenance_Mode::disable_frontend_for_maintenance()) {
 			return null;
 		}
 		// what shortcode was actually parsed ?
 		$shortcode_class = get_called_class();
 		// notify rest of system that fallback processor was triggered
-		add_filter( 'FHEE__fallback_shortcode_processor__' . $shortcode_class, '__return_true' );
+		add_filter('FHEE__fallback_shortcode_processor__'.$shortcode_class, '__return_true');
 		// get instance of actual shortcode
-		$shortcode_obj = self::instance( $shortcode_class );
+		$shortcode_obj = self::instance($shortcode_class);
 		// verify class
-		if ( $shortcode_obj instanceof EES_Shortcode ) {
+		if ($shortcode_obj instanceof EES_Shortcode) {
 			global $wp;
-			$shortcode_obj->run( $wp );
+			$shortcode_obj->run($wp);
 			// set attributes and run the shortcode
-			$shortcode_obj->_attributes = (array)$attributes;
-			return $shortcode_obj->process_shortcode( $shortcode_obj->_attributes );
+			$shortcode_obj->_attributes = (array) $attributes;
+			return $shortcode_obj->process_shortcode($shortcode_obj->_attributes);
 		} else {
 			return null;
 		}
@@ -127,7 +127,7 @@ 
 	 * @param 	$attributes
 	 * @return 	string
 	 */
-	final public static function invalid_shortcode_processor( $attributes ) {
+	final public static function invalid_shortcode_processor($attributes) {
 		return '';
 	}
 
@@ -156,12 +156,12 @@ 
     {
         foreach ($attributes as $key => $value) {
             // is a custom sanitization callback specified ?
-            if ( isset($custom_sanitization[$key])) {
+            if (isset($custom_sanitization[$key])) {
                 $callback = $custom_sanitization[$key];
                 if ($callback === 'skip_sanitization') {
                     $attributes[$key] = $value;
                     continue;
-                } else if (function_exists($callback)){
+                } else if (function_exists($callback)) {
                     $attributes[$key] = $callback($value);
                     continue;
                 }

core/domain/entities/shortcodes/EspressoEvents.php

Spacing +1 added lines, -1 removed lines

@@ -108,7 +108,7 @@
     private function getAttributes(array $attributes)
     {
         return array_merge(
-            (array)apply_filters(
+            (array) apply_filters(
                 'EES_Espresso_Events__process_shortcode__default_espresso_events_shortcode_atts',
                 array(
                     'title'         => '',

Indentation +133 added lines, -133 removed lines

@@ -34,139 +34,139 @@
 
 
 
-    /**
-     * the actual shortcode tag that gets registered with WordPress
-     *
-     * @return string
-     */
-    public function getTag()
-    {
-        return 'ESPRESSO_EVENTS';
-    }
-
-
-
-    /**
-     * 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 0;
-    }
-
-
-
-    /**
-     * 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()
-    {
-        EED_Events_Archive::instance()->event_list();
-        $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
-     */
-    public function processShortcode($attributes = array())
-    {
-        // grab attributes and merge with defaults
-        $attributes = $this->getAttributes($attributes);
-        // make sure we use the_excerpt()
-        add_filter('FHEE__EES_Espresso_Events__process_shortcode__true', '__return_true');
-        // apply query filters
-        add_filter('FHEE__EEH_Event_Query__apply_query_filters', '__return_true');
-        // run the query
-        global $wp_query;
-        // yes we have to overwrite the main wp query, but it's ok...
-        // we're going to reset it again below, so everything will be Hunky Dory (amazing album)
-        $wp_query = new EventListQuery($attributes);
-        // check what template is loaded and load filters accordingly
-        EED_Events_Archive::instance()->template_include('loop-espresso_events.php');
-        // load our template
-        $event_list = EEH_Template::locate_template(
-            'loop-espresso_events.php',
-            array(),
-            true,
-            true
-        );
-        // now reset the query and post data
-        wp_reset_query();
-        wp_reset_postdata();
-        EED_Events_Archive::remove_all_events_archive_filters();
-        // remove query filters
-        remove_filter('FHEE__EEH_Event_Query__apply_query_filters', '__return_true');
-        // pull our content from the output buffer and return it
-        return $event_list;
-    }
-
-
-
-    /**
-     * merge incoming attributes with filtered defaults
-     *
-     * @param array $attributes
-     * @return array
-     */
-    private function getAttributes(array $attributes)
-    {
-        return array_merge(
-            (array)apply_filters(
-                'EES_Espresso_Events__process_shortcode__default_espresso_events_shortcode_atts',
-                array(
-                    'title'         => '',
-                    'limit'         => 10,
-                    'css_class'     => '',
-                    'show_expired'  => false,
-                    'month'         => '',
-                    'category_slug' => '',
-                    'order_by'      => 'start_date',
-                    'sort'          => 'ASC',
-                    'show_title'    => true,
-                )
-            ),
-            $attributes
-        );
-    }
-
-
-
-    /**
-     * 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 pass the following for your $custom_sanitization array:
-     *      array('event_id' => 'absint')
-     *
-     * @return array
-     */
-    protected function customAttributeSanitizationMap()
-    {
-        // the following get sanitized/whitelisted in EEH_Event_Query
-        return array(
-            'category_slug' => 'skip_sanitization',
-            'show_expired'  => 'skip_sanitization',
-            'order_by'      => 'skip_sanitization',
-            'month'         => 'skip_sanitization',
-            'sort'          => 'skip_sanitization',
-        );
-    }
+	/**
+	 * the actual shortcode tag that gets registered with WordPress
+	 *
+	 * @return string
+	 */
+	public function getTag()
+	{
+		return 'ESPRESSO_EVENTS';
+	}
+
+
+
+	/**
+	 * 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 0;
+	}
+
+
+
+	/**
+	 * 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()
+	{
+		EED_Events_Archive::instance()->event_list();
+		$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
+	 */
+	public function processShortcode($attributes = array())
+	{
+		// grab attributes and merge with defaults
+		$attributes = $this->getAttributes($attributes);
+		// make sure we use the_excerpt()
+		add_filter('FHEE__EES_Espresso_Events__process_shortcode__true', '__return_true');
+		// apply query filters
+		add_filter('FHEE__EEH_Event_Query__apply_query_filters', '__return_true');
+		// run the query
+		global $wp_query;
+		// yes we have to overwrite the main wp query, but it's ok...
+		// we're going to reset it again below, so everything will be Hunky Dory (amazing album)
+		$wp_query = new EventListQuery($attributes);
+		// check what template is loaded and load filters accordingly
+		EED_Events_Archive::instance()->template_include('loop-espresso_events.php');
+		// load our template
+		$event_list = EEH_Template::locate_template(
+			'loop-espresso_events.php',
+			array(),
+			true,
+			true
+		);
+		// now reset the query and post data
+		wp_reset_query();
+		wp_reset_postdata();
+		EED_Events_Archive::remove_all_events_archive_filters();
+		// remove query filters
+		remove_filter('FHEE__EEH_Event_Query__apply_query_filters', '__return_true');
+		// pull our content from the output buffer and return it
+		return $event_list;
+	}
+
+
+
+	/**
+	 * merge incoming attributes with filtered defaults
+	 *
+	 * @param array $attributes
+	 * @return array
+	 */
+	private function getAttributes(array $attributes)
+	{
+		return array_merge(
+			(array)apply_filters(
+				'EES_Espresso_Events__process_shortcode__default_espresso_events_shortcode_atts',
+				array(
+					'title'         => '',
+					'limit'         => 10,
+					'css_class'     => '',
+					'show_expired'  => false,
+					'month'         => '',
+					'category_slug' => '',
+					'order_by'      => 'start_date',
+					'sort'          => 'ASC',
+					'show_title'    => true,
+				)
+			),
+			$attributes
+		);
+	}
+
+
+
+	/**
+	 * 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 pass the following for your $custom_sanitization array:
+	 *      array('event_id' => 'absint')
+	 *
+	 * @return array
+	 */
+	protected function customAttributeSanitizationMap()
+	{
+		// the following get sanitized/whitelisted in EEH_Event_Query
+		return array(
+			'category_slug' => 'skip_sanitization',
+			'show_expired'  => 'skip_sanitization',
+			'order_by'      => 'skip_sanitization',
+			'month'         => 'skip_sanitization',
+			'sort'          => 'skip_sanitization',
+		);
+	}
 
 
 

core/EE_Session.core.php

Doc Comments +5 added lines, -5 removed lines

@@ -433,7 +433,7 @@ 
 	  * set session data
 	  * @access 	public
 	  * @param 	array $data
-	  * @return 	TRUE on success, FALSE on fail
+	  * @return 	boolean on success, FALSE on fail
 	  */
 	public function set_session_data( $data ) {
 
@@ -461,7 +461,7 @@ 
 	 /**
 	  * @initiate session
 	  * @access   private
-	  * @return TRUE on success, FALSE on fail
+	  * @return boolean on success, FALSE on fail
 	  * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
 	  * @throws \EE_Error
 	  */
@@ -681,7 +681,7 @@ 
       * @update session data  prior to saving to the db
       * @access public
       * @param bool $new_session
-      * @return TRUE on success, FALSE on fail
+      * @return boolean on success, FALSE on fail
       * @throws \EE_Error
       */
 	public function update( $new_session = FALSE ) {
@@ -787,7 +787,7 @@ 
 	  * _save_session_to_db
 	  *
 	  * @access public
-	  * @return string
+	  * @return boolean
 	  * @throws \EE_Error
 	  */
 	private function _save_session_to_db() {
@@ -959,7 +959,7 @@ 
 	  * @access public
 	  * @param array $data_to_reset
 	  * @param bool  $show_all_notices
-	  * @return TRUE on success, FALSE on fail
+	  * @return boolean on success, FALSE on fail
 	  */
 	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

Indentation +293 added lines, -293 removed lines

@@ -22,19 +22,19 @@ 
 	  */
 	 private static $_instance;
 
-     /**
-      * @var CacheStorageInterface $cache_storage
-      */
-     protected $cache_storage;
-
-     /**
-      * EE_Encryption object
-      *
-      * @var EE_Encryption
-      */
-     protected $encryption;
-
-     /**
+	 /**
+	  * @var CacheStorageInterface $cache_storage
+	  */
+	 protected $cache_storage;
+
+	 /**
+	  * EE_Encryption object
+	  *
+	  * @var EE_Encryption
+	  */
+	 protected $encryption;
+
+	 /**
 	  * the session id
 	  * @var string
 	  */
@@ -65,12 +65,12 @@ 
 	  */
 	 private $_expiration;
 
-    /**
-     * whether or not session has expired at some point
-     *
-     * @var boolean
-     */
-    private $_expired = false;
+	/**
+	 * whether or not session has expired at some point
+	 *
+	 * @var boolean
+	 */
+	private $_expired = false;
 
 	 /**
 	  * current time as Unix timestamp in GMT
@@ -107,30 +107,30 @@ 
 	  * @var array
 	  */
 	 private $_default_session_vars = array (
-        'id'            => null,
-        'user_id'       => null,
-        'ip_address'    => null,
-        'user_agent'    => null,
-        'init_access'   => null,
-        'last_access'   => null,
-        'expiration'    => null,
-        'pages_visited' => array(),
+		'id'            => null,
+		'user_id'       => null,
+		'ip_address'    => null,
+		'user_agent'    => null,
+		'init_access'   => null,
+		'last_access'   => null,
+		'expiration'    => null,
+		'pages_visited' => array(),
 	);
 
 
 
 	 /**
 	  * @singleton method used to instantiate class object
-      * @param CacheStorageInterface $cache_storage
-      * @param \EE_Encryption        $encryption
+	  * @param CacheStorageInterface $cache_storage
+	  * @param \EE_Encryption        $encryption
 	  * @return EE_Session
 	  * @throws InvalidSessionDataException
 	  * @throws \EE_Error
 	  */
 	public static function instance(
-        CacheStorageInterface $cache_storage = null,
-        EE_Encryption $encryption = null
-    ) {
+		CacheStorageInterface $cache_storage = null,
+		EE_Encryption $encryption = null
+	) {
 		// 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' );
@@ -143,10 +143,10 @@ 
 
 
 	 /**
-      * protected constructor to prevent direct creation
-      *
-      * @param CacheStorageInterface $cache_storage
-      * @param \EE_Encryption $encryption
+	  * protected constructor to prevent direct creation
+	  *
+	  * @param CacheStorageInterface $cache_storage
+	  * @param \EE_Encryption $encryption
 	  * @throws \EE_Error
 	  * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
 	  */
@@ -181,59 +181,59 @@ 
 				$this->{$var_name} = $session_setting;
 			}
 		}
-         $this->cache_storage = $cache_storage;
-         // are we using encryption?
-         $this->_use_encryption = $encryption instanceof EE_Encryption && EE_Registry::instance()->CFG->admin->encode_session_data();
-         // \EEH_Debug_Tools::printr($this->_use_encryption, '$this->_use_encryption', __FILE__, __LINE__);
-        // encrypt data via: $this->encryption->encrypt();
-        $this->encryption = $encryption;
+		 $this->cache_storage = $cache_storage;
+		 // are we using encryption?
+		 $this->_use_encryption = $encryption instanceof EE_Encryption && EE_Registry::instance()->CFG->admin->encode_session_data();
+		 // \EEH_Debug_Tools::printr($this->_use_encryption, '$this->_use_encryption', __FILE__, __LINE__);
+		// 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 );
 		// 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_System__initialize', array($this, 'open_session'));
+		 // check request for 'clear_session' param
 		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 );
-         $this->configure_garbage_collection_filters();
+		 $this->configure_garbage_collection_filters();
 	}
 
 
 
-     /**
-      * @return void
-      * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
-      * @throws \EE_Error
-      */
+	 /**
+	  * @return void
+	  * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
+	  * @throws \EE_Error
+	  */
 	 public function open_session() {
-         // check for existing session and retrieve it from db
-         if ( ! $this->_espresso_session()) {
-             // or just start a new one
-             $this->_create_espresso_session();
-         }
-     }
+		 // check for existing session and retrieve it from db
+		 if ( ! $this->_espresso_session()) {
+			 // or just start a new one
+			 $this->_create_espresso_session();
+		 }
+	 }
 
 
 
-    /**
-     * @return bool
-     */
-    public function expired()
-    {
-        return $this->_expired;
-    }
+	/**
+	 * @return bool
+	 */
+	public function expired()
+	{
+		return $this->_expired;
+	}
 
 
 
-    /**
-     * @return void
-     */
-    public function reset_expired()
-    {
-        $this->_expired = false;
-    }
+	/**
+	 * @return void
+	 */
+	public function reset_expired()
+	{
+		$this->_expired = false;
+	}
 
 
 	 /**
@@ -245,24 +245,24 @@ 
 
 
 
-    /**
-     * @return int
-     */
-    public function extension()
-    {
-        return apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', (10 * MINUTE_IN_SECONDS));
-    }
+	/**
+	 * @return int
+	 */
+	public function extension()
+	{
+		return apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', (10 * MINUTE_IN_SECONDS));
+	}
 
 
 
-    /**
-     * @param int $time number of seconds to add to session expiration
-     */
-    public function extend_expiration($time = 0)
-    {
-        $time = $time ? $time : $this->extension();
-        $this->_expiration += absint($time);
-    }
+	/**
+	 * @param int $time number of seconds to add to session expiration
+	 */
+	public function extend_expiration($time = 0)
+	{
+		$time = $time ? $time : $this->extension();
+		$this->_expiration += absint($time);
+	}
 
 
 
@@ -306,15 +306,15 @@ 
 
 
 
-    /**
-     * @param \EE_Cart $cart
-     * @return bool
-     */
-    public function set_cart(EE_Cart $cart)
-    {
-        $this->_session_data['cart'] = $cart;
-        return true;
-    }
+	/**
+	 * @param \EE_Cart $cart
+	 * @return bool
+	 */
+	public function set_cart(EE_Cart $cart)
+	{
+		$this->_session_data['cart'] = $cart;
+		return true;
+	}
 
 
 
@@ -322,7 +322,7 @@ 
 	  * reset_cart
 	  */
 	 public function reset_cart() {
-        do_action('AHEE__EE_Session__reset_cart__before_reset', $this);
+		do_action('AHEE__EE_Session__reset_cart__before_reset', $this);
 		 $this->_session_data['cart'] = NULL;
 	 }
 
@@ -332,9 +332,9 @@ 
 	  * @return \EE_Cart
 	  */
 	 public function cart() {
-        return isset($this->_session_data['cart']) && $this->_session_data['cart'] instanceof EE_Cart
-            ? $this->_session_data['cart']
-            : null;
+		return isset($this->_session_data['cart']) && $this->_session_data['cart'] instanceof EE_Cart
+			? $this->_session_data['cart']
+			: null;
 	 }
 
 
@@ -354,7 +354,7 @@ 
 	  * reset_checkout
 	  */
 	 public function reset_checkout() {
-        do_action('AHEE__EE_Session__reset_checkout__before_reset', $this);
+		do_action('AHEE__EE_Session__reset_checkout__before_reset', $this);
 		 $this->_session_data['checkout'] = NULL;
 	 }
 
@@ -364,9 +364,9 @@ 
 	  * @return \EE_Checkout
 	  */
 	 public function checkout() {
-        return isset($this->_session_data['checkout']) && $this->_session_data['checkout'] instanceof EE_Checkout
-            ? $this->_session_data['checkout']
-            : null;
+		return isset($this->_session_data['checkout']) && $this->_session_data['checkout'] instanceof EE_Checkout
+			? $this->_session_data['checkout']
+			: null;
 	 }
 
 
@@ -389,7 +389,7 @@ 
 	  * reset_transaction
 	  */
 	 public function reset_transaction() {
-        do_action('AHEE__EE_Session__reset_transaction__before_reset', $this);
+		do_action('AHEE__EE_Session__reset_transaction__before_reset', $this);
 		 $this->_session_data['transaction'] = NULL;
 	 }
 
@@ -399,10 +399,10 @@ 
 	  * @return \EE_Transaction
 	  */
 	 public function transaction() {
-        return isset($this->_session_data['transaction'])
-               && $this->_session_data['transaction'] instanceof EE_Transaction
-           ? $this->_session_data['transaction']
-           : null;
+		return isset($this->_session_data['transaction'])
+			   && $this->_session_data['transaction'] instanceof EE_Transaction
+		   ? $this->_session_data['transaction']
+		   : null;
 	 }
 
 
@@ -479,16 +479,16 @@ 
 		// set the "user agent"
 		$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)) {
-            // get the current time in UTC
+		$session_data = $this->_retrieve_session_data();
+		if (! empty($session_data)) {
+			// get the current time in UTC
 			$this->_time = isset( $this->_time ) ? $this->_time : time();
 			// and reset the session expiration
 			$this->_expiration = isset( $session_data['expiration'] )
 				? $session_data['expiration']
 				: $this->_time + $this->_lifespan;
 		} else {
-            // set initial site access time and the session expiration
+			// 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'] )
@@ -497,14 +497,14 @@ 
 			// no previous session = go back and create one (on top of the data above)
 			return FALSE;
 		}
-        // now the user agent
+		// now the user agent
 		if ( $session_data['user_agent'] !== $this->_user_agent ) {
 			return FALSE;
 		}
 		// wait a minute... how old are you?
 		if ( $this->_time > $this->_expiration ) {
 			// yer too old fer me!
-            $this->_expired = true;
+			$this->_expired = true;
 			// wipe out everything that isn't a default session datum
 			$this->clear_session( __CLASS__, __FUNCTION__ );
 		}
@@ -516,101 +516,101 @@ 
 
 
 
-     /**
-      * _get_session_data
-      * Retrieves the session data, and attempts to correct any encoding issues that can occur due to improperly setup databases
-      *
-      * @return array
-      * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
-      */
-     protected function _retrieve_session_data()
-     {
-         $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);
-	         if (empty($session_data)) {
-		         return array();
-             }
-             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,
-                     false
-                 );
-                 if ($hash_check && $hash_check !== md5($session_data)) {
-	                 EE_Error::add_error(
-                         sprintf(
-                             __(
-                                 '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
-                         ),
-                         __FILE__, __FUNCTION__, __LINE__
-                     );
-                 }
-             }
-         } catch (Exception $e) {
-             // let's just eat that error for now and attempt to correct any corrupted data
-             global $wpdb;
-             $row = $wpdb->get_row(
-                 $wpdb->prepare(
-                     "SELECT option_value FROM {$wpdb->options} WHERE option_name = %s LIMIT 1",
-                     '_transient_' . $ssn_key
-                 )
-             );
-             $session_data = is_object($row) ? $row->option_value : null;
-             if ($session_data) {
-                 $session_data = preg_replace_callback(
-                     '!s:(d+):"(.*?)";!',
-                     function ($match) {
-                         return $match[1] === strlen($match[2])
-                             ? $match[0]
-                             : 's:' . strlen($match[2]) . ':"' . $match[2] . '";';
-                     },
-                     $session_data
-                 );
-             }
-	         $session_data = maybe_unserialize($session_data);
-         }
-	     // in case the data is encoded... try to decode it
-         $session_data = $this->encryption instanceof EE_Encryption
-             ? $this->encryption->base64_string_decode($session_data)
-             : $session_data;
-
-         if ( ! is_array($session_data)) {
-             try {
-	             $session_data = maybe_unserialize($session_data);
-             } catch (Exception $e) {
-                 $msg = esc_html__(
-                     'An error occurred while attempting to unserialize the session data.',
-                     'event_espresso'
-                 );
-                 $msg .= WP_DEBUG
-                     ? '<br><pre>' . print_r($session_data, true) . '</pre><br>' . $this->find_serialize_error($session_data)
-                     : '';
-                 throw new InvalidSessionDataException($msg, 0, $e);
-             }
-         }
-         // just a check to make sure the session array is indeed an array
-         if ( ! is_array($session_data)) {
-             // no?!?! then something is wrong
-             $msg = esc_html__(
-                 'The session data is missing, invalid, or corrupted.',
-                 'event_espresso'
-             );
-             $msg .= WP_DEBUG
-                 ? '<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 ) {
-             $session_data['transaction'] = EEM_Transaction::instance()->get_one_by_ID(
-                 $session_data['transaction']
-	         );
-	     }
-         return $session_data;
-     }
+	 /**
+	  * _get_session_data
+	  * Retrieves the session data, and attempts to correct any encoding issues that can occur due to improperly setup databases
+	  *
+	  * @return array
+	  * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
+	  */
+	 protected function _retrieve_session_data()
+	 {
+		 $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);
+			 if (empty($session_data)) {
+				 return array();
+			 }
+			 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,
+					 false
+				 );
+				 if ($hash_check && $hash_check !== md5($session_data)) {
+					 EE_Error::add_error(
+						 sprintf(
+							 __(
+								 '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
+						 ),
+						 __FILE__, __FUNCTION__, __LINE__
+					 );
+				 }
+			 }
+		 } catch (Exception $e) {
+			 // let's just eat that error for now and attempt to correct any corrupted data
+			 global $wpdb;
+			 $row = $wpdb->get_row(
+				 $wpdb->prepare(
+					 "SELECT option_value FROM {$wpdb->options} WHERE option_name = %s LIMIT 1",
+					 '_transient_' . $ssn_key
+				 )
+			 );
+			 $session_data = is_object($row) ? $row->option_value : null;
+			 if ($session_data) {
+				 $session_data = preg_replace_callback(
+					 '!s:(d+):"(.*?)";!',
+					 function ($match) {
+						 return $match[1] === strlen($match[2])
+							 ? $match[0]
+							 : 's:' . strlen($match[2]) . ':"' . $match[2] . '";';
+					 },
+					 $session_data
+				 );
+			 }
+			 $session_data = maybe_unserialize($session_data);
+		 }
+		 // in case the data is encoded... try to decode it
+		 $session_data = $this->encryption instanceof EE_Encryption
+			 ? $this->encryption->base64_string_decode($session_data)
+			 : $session_data;
+
+		 if ( ! is_array($session_data)) {
+			 try {
+				 $session_data = maybe_unserialize($session_data);
+			 } catch (Exception $e) {
+				 $msg = esc_html__(
+					 'An error occurred while attempting to unserialize the session data.',
+					 'event_espresso'
+				 );
+				 $msg .= WP_DEBUG
+					 ? '<br><pre>' . print_r($session_data, true) . '</pre><br>' . $this->find_serialize_error($session_data)
+					 : '';
+				 throw new InvalidSessionDataException($msg, 0, $e);
+			 }
+		 }
+		 // just a check to make sure the session array is indeed an array
+		 if ( ! is_array($session_data)) {
+			 // no?!?! then something is wrong
+			 $msg = esc_html__(
+				 'The session data is missing, invalid, or corrupted.',
+				 'event_espresso'
+			 );
+			 $msg .= WP_DEBUG
+				 ? '<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 ) {
+			 $session_data['transaction'] = EEM_Transaction::instance()->get_one_by_ID(
+				 $session_data['transaction']
+			 );
+		 }
+		 return $session_data;
+	 }
 
 
 
@@ -677,13 +677,13 @@ 
 
 
 
-     /**
-      * @update session data  prior to saving to the db
-      * @access public
-      * @param bool $new_session
-      * @return TRUE on success, FALSE on fail
-      * @throws \EE_Error
-      */
+	 /**
+	  * @update session data  prior to saving to the db
+	  * @access public
+	  * @param bool $new_session
+	  * @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 )
@@ -769,12 +769,12 @@ 
 
 
 
-     /**
-      * @create session data array
-      * @access public
-      * @return bool
-      * @throws \EE_Error
-      */
+	 /**
+	  * @create session data array
+	  * @access public
+	  * @return bool
+	  * @throws \EE_Error
+	  */
 	private function _create_espresso_session( ) {
 		do_action( 'AHEE_log', __CLASS__, __FUNCTION__, '' );
 		// use the update function for now with $new_session arg set to TRUE
@@ -794,19 +794,19 @@ 
 		if (
 			// if the current request is NOT one of the following
 			! (
-                // an an AJAX request from the frontend
-                EE_Registry::instance()->REQ->front_ajax
-                || (
-                    // OR an admin request that is NOT AJAX
+				// an an AJAX request from the frontend
+				EE_Registry::instance()->REQ->front_ajax
+				|| (
+					// OR an admin request that is NOT AJAX
 					! ( defined( 'DOING_AJAX' ) && DOING_AJAX )
-                    && is_admin()
+					&& is_admin()
 				)
-                || (
-                    // OR an espresso page
-                    EE_Registry::instance()->REQ instanceof EE_Request_Handler
-                    && EE_Registry::instance()->REQ->is_espresso_page()
-                )
-            )
+				|| (
+					// OR an espresso page
+					EE_Registry::instance()->REQ instanceof EE_Request_Handler
+					&& EE_Registry::instance()->REQ->is_espresso_page()
+				)
+			)
 		) {
 			return false;
 		}
@@ -817,27 +817,27 @@ 
 			}
 			$this->_session_data['transaction'] = $transaction->ID();
 		}
-        // then serialize all of our session data
+		// then serialize all of our session data
 		$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 )
-            : $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 ) ) {
-            $this->cache_storage->add(
-                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,
-            $session_data,
-            $this->_lifespan
-        );
-    }
+			$this->cache_storage->add(
+				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,
+			$session_data,
+			$this->_lifespan
+		);
+	}
 
 
 
@@ -930,18 +930,18 @@ 
 
 
 
-     /**
-      * Clear EE_Session data
-      *
-      * @access public
-      * @param string $class
-      * @param string $function
-      * @return void
-      * @throws \EE_Error
-      */
+	 /**
+	  * Clear EE_Session data
+	  *
+	  * @access public
+	  * @param string $class
+	  * @param string $function
+	  * @return void
+	  * @throws \EE_Error
+	  */
 	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();
@@ -1008,12 +1008,12 @@ 
 
 
 
-     /**
-      *   wp_loaded
-      *
-      * @access public
-      * @throws \EE_Error
-      */
+	 /**
+	  *   wp_loaded
+	  *
+	  * @access public
+	  * @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__ );
@@ -1022,12 +1022,12 @@ 
 
 
 
-     /**
-      * Used to reset the entire object (for tests).
-      *
-      * @since 4.3.0
-      * @throws \EE_Error
-      */
+	 /**
+	  * Used to reset the entire object (for tests).
+	  *
+	  * @since 4.3.0
+	  * @throws \EE_Error
+	  */
 	public function reset_instance() {
 		$this->clear_session();
 		self::$_instance = NULL;
@@ -1035,29 +1035,29 @@ 
 
 
 
-     public function configure_garbage_collection_filters()
-     {
-         // run old filter we had for controlling session cleanup
-         $expired_session_transient_delete_query_limit = absint(
-             apply_filters(
-                 'FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit',
-                 50
-             )
-         );
-         // is there a value? or one that is different than the default 50 records?
-         if ($expired_session_transient_delete_query_limit === 0) {
-             // hook into TransientCacheStorage in case Session cleanup was turned off
-             add_filter('FHEE__TransientCacheStorage__transient_cleanup_schedule', '__return_zero');
-         } else if ($expired_session_transient_delete_query_limit !== 50) {
-             // or use that for the new transient cleanup query limit
-             add_filter(
-                 'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
-                 function () use ($expired_session_transient_delete_query_limit) {
-                     return $expired_session_transient_delete_query_limit;
-                 }
-             );
-         }
-     }
+	 public function configure_garbage_collection_filters()
+	 {
+		 // run old filter we had for controlling session cleanup
+		 $expired_session_transient_delete_query_limit = absint(
+			 apply_filters(
+				 'FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit',
+				 50
+			 )
+		 );
+		 // is there a value? or one that is different than the default 50 records?
+		 if ($expired_session_transient_delete_query_limit === 0) {
+			 // hook into TransientCacheStorage in case Session cleanup was turned off
+			 add_filter('FHEE__TransientCacheStorage__transient_cleanup_schedule', '__return_zero');
+		 } else if ($expired_session_transient_delete_query_limit !== 50) {
+			 // or use that for the new transient cleanup query limit
+			 add_filter(
+				 'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
+				 function () use ($expired_session_transient_delete_query_limit) {
+					 return $expired_session_transient_delete_query_limit;
+				 }
+			 );
+		 }
+	 }
 
 
 

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/services/cache/TransientCacheStorage.php

Doc Comments +1 added lines, -1 removed lines

@@ -234,7 +234,7 @@
     /**
      * delete multiple transients and remove tracking
      *
-     * @param array $transient_keys [required] array of full or partial transient keys to be deleted
+     * @param string[] $transient_keys [required] array of full or partial transient keys to be deleted
      */
     public function deleteMany(array $transient_keys)
     {

Unused Use Statements -4 removed lines

@@ -1,10 +1,6 @@
 <?php
 namespace EventEspresso\core\services\cache;
 
-use EE_Error;
-use WP_Error;
-use wpdb;
-
 defined('EVENT_ESPRESSO_VERSION') || exit;
 
 

Indentation +355 added lines, -355 removed lines

@@ -23,361 +23,361 @@
 class TransientCacheStorage implements CacheStorageInterface
 {
 
-    /**
-     * wp-option option_name for tracking transients
-     *
-     * @type string
-     */
-    const TRANSIENT_SCHEDULE_OPTIONS_KEY = 'ee_transient_schedule';
-
-    /**
-     * @var int $current_time
-     */
-    private $current_time = 0;
-
-    /**
-     * how often to perform transient cleanup
-     *
-     * @var string $transient_cleanup_frequency
-     */
-    private $transient_cleanup_frequency = 'hour';
-
-    /**
-     * options for how often to perform transient cleanup
-     *
-     * @var array $transient_cleanup_frequency_options
-     */
-    private $transient_cleanup_frequency_options = array();
-
-    /**
-     * @var array $transients
-     */
-    private $transients = array();
-
-
-
-    /**
-     * TransientCacheStorage constructor.
-     */
-    public function __construct()
-    {
-        $this->transient_cleanup_frequency = $this->setTransientCleanupFrequency();
-        // round current time down to closest 5 minutes to simplify scheduling
-        $this->current_time = $this->roundTimestamp(time(), '5-minutes', false);
-        $this->transients = (array)get_option(TransientCacheStorage::TRANSIENT_SCHEDULE_OPTIONS_KEY, array());
-        if ( ! (defined('DOING_AJAX') && DOING_AJAX) && $this->transient_cleanup_frequency !== 'off') {
-            add_action('shutdown', array($this, 'checkTransientCleanupSchedule'), 999);
-        }
-    }
-
-
-
-    /**
-     * Sets how often transient cleanup occurs
-     *
-     * @return int
-     */
-    private function setTransientCleanupFrequency()
-    {
-        // sets how often transients are cleaned up
-        $this->transient_cleanup_frequency_options = apply_filters(
-            'FHEE__TransientCacheStorage__transient_cleanup_schedule_options',
-            array(
-                'off',
-                '15-minutes',
-                'hour',
-                '12-hours',
-                'day',
-            )
-        );
-        $transient_cleanup_frequency = apply_filters(
-            'FHEE__TransientCacheStorage__transient_cleanup_schedule',
-            'hour'
-        );
-        return in_array(
-            $transient_cleanup_frequency,
-            $this->transient_cleanup_frequency_options,
-            true
-        )
-            ? $transient_cleanup_frequency
-            : 'hour';
-    }
-
-
-
-    /**
-     * we need to be able to round timestamps off to match the set transient cleanup frequency
-     * so if a transient is set to expire at 1:17 pm for example, and our cleanup schedule is every hour,
-     * then that timestamp needs to be rounded up to 2:00 pm so that it is removed
-     * during the next scheduled cleanup after its expiration.
-     * We also round off the current time timestamp to the closest 5 minutes
-     * just to make the timestamps a little easier to round which helps with debugging.
-     *
-     * @param int    $timestamp [required]
-     * @param string $cleanup_frequency
-     * @param bool   $round_up
-     * @return false|int
-     */
-    private function roundTimestamp($timestamp, $cleanup_frequency = 'hour', $round_up = true)
-    {
-        $cleanup_frequency = $cleanup_frequency ? $cleanup_frequency : $this->transient_cleanup_frequency;
-        // in order to round the time to the closest xx minutes (or hours),
-        // we take the minutes (or hours) portion of the timestamp and divide it by xx,
-        // round down to a whole number, then multiply by xx to bring us almost back up to where we were
-        // why round down ? so the minutes (or hours) don't go over 60 (or 24)
-        // and bump the hour, which could bump the day, which could bump the month, etc,
-        // which would be bad because we don't always want to round up,
-        // but when we do we can easily achieve that by simply adding the desired offset,
-        $minutes = '00';
-        $hours = 'H';
-        switch ($cleanup_frequency) {
-            case '5-minutes' :
-                $minutes = floor((int)date('i', $timestamp) / 5) * 5;
-                $minutes = str_pad($minutes, 2, '0', STR_PAD_LEFT);
-                $offset = MINUTE_IN_SECONDS * 5;
-                break;
-            case '15-minutes' :
-                $minutes = floor((int)date('i', $timestamp) / 15) * 15;
-                $minutes = str_pad($minutes, 2, '0', STR_PAD_LEFT);
-                $offset = MINUTE_IN_SECONDS * 15;
-                break;
-            case '12-hours' :
-                $hours = floor((int)date('H', $timestamp) / 12) * 12;
-                $hours = str_pad($hours, 2, '0', STR_PAD_LEFT);
-                $offset = HOUR_IN_SECONDS * 12;
-                break;
-            case 'day' :
-                $hours = '03'; // run cleanup at 3:00 am (or first site hit after that)
-                $offset = DAY_IN_SECONDS;
-                break;
-            case 'hour' :
-            default :
-                $offset = HOUR_IN_SECONDS;
-                break;
-        }
-        $rounded_timestamp = strtotime(date("Y-m-d {$hours}:{$minutes}:00", $timestamp));
-        $rounded_timestamp += $round_up ? $offset : 0;
-        return apply_filters(
-            'FHEE__TransientCacheStorage__roundTimestamp__timestamp',
-            $rounded_timestamp,
-            $timestamp,
-            $cleanup_frequency,
-            $round_up
-        );
-    }
-
-
-
-    /**
-     * Saves supplied data to a transient
-     * if an expiration is set, then it automatically schedules the transient for cleanup
-     *
-     * @param string $transient_key [required]
-     * @param string $data          [required]
-     * @param int    $expiration    number of seconds until the cache expires
-     * @return bool
-     */
-    public function add($transient_key, $data, $expiration = 0)
-    {
-        $expiration = (int)abs($expiration);
-        $saved = set_transient($transient_key, $data, $expiration);
-        if ($saved && $expiration) {
-            $this->scheduleTransientCleanup($transient_key, $expiration);
-        }
-        return $saved;
-    }
-
-
-
-    /**
-     * retrieves transient data
-     * automatically triggers early cache refresh for standard cache items
-     * in order to avoid cache stampedes on busy sites.
-     * For non-standard cache items like PHP Session data where early refreshing is not wanted,
-     * the $standard_cache parameter should be set to false when retrieving data
-     *
-     * @param string $transient_key [required]
-     * @param bool   $standard_cache
-     * @return mixed|null
-     */
-    public function get($transient_key, $standard_cache = true)
-    {
-        // to avoid cache stampedes (AKA:dogpiles) for standard cache items,
-        // check if known cache expires within the next minute,
-        // and if so, remove it from our tracking and and return nothing.
-        // this should trigger the cache content to be regenerated during this request,
-        // while allowing any following requests to still access the existing cache
-        // until it gets replaced with the refreshed content
-        if (
-            $standard_cache
-            && isset($this->transients[$transient_key])
-            && $this->transients[$transient_key] - time() <= MINUTE_IN_SECONDS
-        ) {
-            unset($this->transients[$transient_key]);
-            $this->updateTransients();
-            return null;
-        }
-        $content = get_transient($transient_key);
-        return $content !== false ? $content : null;
-    }
-
-
-
-    /**
-     * delete a single transient and remove tracking
-     *
-     * @param string $transient_key [required] full or partial transient key to be deleted
-     */
-    public function delete($transient_key)
-    {
-        $this->deleteMany(array($transient_key));
-    }
-
-
-
-    /**
-     * delete multiple transients and remove tracking
-     *
-     * @param array $transient_keys [required] array of full or partial transient keys to be deleted
-     */
-    public function deleteMany(array $transient_keys)
-    {
-        $full_transient_keys = array();
-        foreach ($this->transients as $transient_key => $expiration) {
-            foreach ($transient_keys as $transient_key_to_delete) {
-                if (strpos($transient_key, $transient_key_to_delete) !== false) {
-                    $full_transient_keys[] = $transient_key;
-                }
-            }
-        }
-        if ($this->deleteTransientKeys($full_transient_keys)) {
-            $this->updateTransients();
-        }
-    }
-
-
-
-    /**
-     * sorts transients numerically by timestamp
-     * then saves the transient schedule to a WP option
-     */
-    private function updateTransients()
-    {
-        asort($this->transients, SORT_NUMERIC);
-        update_option(
-            TransientCacheStorage::TRANSIENT_SCHEDULE_OPTIONS_KEY,
-            $this->transients
-        );
-    }
-
-
-
-    /**
-     * schedules a transient for cleanup by adding it to the transient tracking
-     *
-     * @param string $transient_key [required]
-     * @param int    $expiration    [required]
-     */
-    private function scheduleTransientCleanup($transient_key, $expiration)
-    {
-        // make sure a valid future timestamp is set
-        $expiration += $expiration < time() ? time() : 0;
-        // and round to the closest 15 minutes
-        $expiration = $this->roundTimestamp($expiration);
-        // save transients to clear using their ID as the key to avoid duplicates
-        $this->transients[$transient_key] = $expiration;
-        $this->updateTransients();
-    }
-
-
-
-    /**
-     * Since our tracked transients are sorted by their timestamps
-     * we can grab the first transient and see when it is scheduled for cleanup.
-     * If that timestamp is less than or equal to the current time,
-     * then cleanup is triggered
-     */
-    public function checkTransientCleanupSchedule()
-    {
-        if (empty($this->transients)) {
-            return;
-        }
-        // when do we run the next cleanup job?
-        reset($this->transients);
-        $next_scheduled_cleanup = current($this->transients);
-        // if the next cleanup job is scheduled for the current hour
-        if ($next_scheduled_cleanup <= $this->current_time) {
-            if ($this->cleanupExpiredTransients()) {
-                $this->updateTransients();
-            }
-        }
-    }
-
-
-
-    /**
-     * loops through the array of tracked transients,
-     * compiles a list of those that have expired, and sends that list off for deletion.
-     * Also removes any bad records from the transients array
-     *
-     * @return bool
-     */
-    private function cleanupExpiredTransients()
-    {
-        $update = false;
-        // filter the query limit. Set to 0 to turn off garbage collection
-        $limit = (int)abs(
-            apply_filters(
-                'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
-                50
-            )
-        );
-        // non-zero LIMIT means take out the trash
-        if ($limit) {
-            $transient_keys = array();
-            foreach ($this->transients as $transient_key => $expiration) {
-                if ($expiration > $this->current_time) {
-                    continue;
-                }
-                if ( ! $expiration || ! $transient_key) {
-                    unset($this->transients[$transient_key]);
-                    $update = true;
-                    continue;
-                }
-                $transient_keys[] = $transient_key;
-            }
-            // delete expired keys, but maintain value of $update if nothing is deleted
-            $update = $this->deleteTransientKeys($transient_keys, $limit) ? true : $update;
-            do_action( 'FHEE__TransientCacheStorage__clearExpiredTransients__end', $this);
-        }
-        return $update;
-    }
-
-
-
-    /**
-     * calls delete_transient() on each transient key provided, up to the specified limit
-     *
-     * @param array $transient_keys [required]
-     * @param int   $limit
-     * @return bool
-     */
-    private function deleteTransientKeys(array $transient_keys, $limit = 50)
-    {
-        if (empty($transient_keys)) {
-            return false;
-        }
-        $counter = 0;
-        foreach ($transient_keys as $transient_key) {
-            if($counter === $limit){
-                break;
-            }
-            delete_transient($transient_key);
-            unset($this->transients[$transient_key]);
-            $counter++;
-        }
-        return $counter > 0;
-    }
+	/**
+	 * wp-option option_name for tracking transients
+	 *
+	 * @type string
+	 */
+	const TRANSIENT_SCHEDULE_OPTIONS_KEY = 'ee_transient_schedule';
+
+	/**
+	 * @var int $current_time
+	 */
+	private $current_time = 0;
+
+	/**
+	 * how often to perform transient cleanup
+	 *
+	 * @var string $transient_cleanup_frequency
+	 */
+	private $transient_cleanup_frequency = 'hour';
+
+	/**
+	 * options for how often to perform transient cleanup
+	 *
+	 * @var array $transient_cleanup_frequency_options
+	 */
+	private $transient_cleanup_frequency_options = array();
+
+	/**
+	 * @var array $transients
+	 */
+	private $transients = array();
+
+
+
+	/**
+	 * TransientCacheStorage constructor.
+	 */
+	public function __construct()
+	{
+		$this->transient_cleanup_frequency = $this->setTransientCleanupFrequency();
+		// round current time down to closest 5 minutes to simplify scheduling
+		$this->current_time = $this->roundTimestamp(time(), '5-minutes', false);
+		$this->transients = (array)get_option(TransientCacheStorage::TRANSIENT_SCHEDULE_OPTIONS_KEY, array());
+		if ( ! (defined('DOING_AJAX') && DOING_AJAX) && $this->transient_cleanup_frequency !== 'off') {
+			add_action('shutdown', array($this, 'checkTransientCleanupSchedule'), 999);
+		}
+	}
+
+
+
+	/**
+	 * Sets how often transient cleanup occurs
+	 *
+	 * @return int
+	 */
+	private function setTransientCleanupFrequency()
+	{
+		// sets how often transients are cleaned up
+		$this->transient_cleanup_frequency_options = apply_filters(
+			'FHEE__TransientCacheStorage__transient_cleanup_schedule_options',
+			array(
+				'off',
+				'15-minutes',
+				'hour',
+				'12-hours',
+				'day',
+			)
+		);
+		$transient_cleanup_frequency = apply_filters(
+			'FHEE__TransientCacheStorage__transient_cleanup_schedule',
+			'hour'
+		);
+		return in_array(
+			$transient_cleanup_frequency,
+			$this->transient_cleanup_frequency_options,
+			true
+		)
+			? $transient_cleanup_frequency
+			: 'hour';
+	}
+
+
+
+	/**
+	 * we need to be able to round timestamps off to match the set transient cleanup frequency
+	 * so if a transient is set to expire at 1:17 pm for example, and our cleanup schedule is every hour,
+	 * then that timestamp needs to be rounded up to 2:00 pm so that it is removed
+	 * during the next scheduled cleanup after its expiration.
+	 * We also round off the current time timestamp to the closest 5 minutes
+	 * just to make the timestamps a little easier to round which helps with debugging.
+	 *
+	 * @param int    $timestamp [required]
+	 * @param string $cleanup_frequency
+	 * @param bool   $round_up
+	 * @return false|int
+	 */
+	private function roundTimestamp($timestamp, $cleanup_frequency = 'hour', $round_up = true)
+	{
+		$cleanup_frequency = $cleanup_frequency ? $cleanup_frequency : $this->transient_cleanup_frequency;
+		// in order to round the time to the closest xx minutes (or hours),
+		// we take the minutes (or hours) portion of the timestamp and divide it by xx,
+		// round down to a whole number, then multiply by xx to bring us almost back up to where we were
+		// why round down ? so the minutes (or hours) don't go over 60 (or 24)
+		// and bump the hour, which could bump the day, which could bump the month, etc,
+		// which would be bad because we don't always want to round up,
+		// but when we do we can easily achieve that by simply adding the desired offset,
+		$minutes = '00';
+		$hours = 'H';
+		switch ($cleanup_frequency) {
+			case '5-minutes' :
+				$minutes = floor((int)date('i', $timestamp) / 5) * 5;
+				$minutes = str_pad($minutes, 2, '0', STR_PAD_LEFT);
+				$offset = MINUTE_IN_SECONDS * 5;
+				break;
+			case '15-minutes' :
+				$minutes = floor((int)date('i', $timestamp) / 15) * 15;
+				$minutes = str_pad($minutes, 2, '0', STR_PAD_LEFT);
+				$offset = MINUTE_IN_SECONDS * 15;
+				break;
+			case '12-hours' :
+				$hours = floor((int)date('H', $timestamp) / 12) * 12;
+				$hours = str_pad($hours, 2, '0', STR_PAD_LEFT);
+				$offset = HOUR_IN_SECONDS * 12;
+				break;
+			case 'day' :
+				$hours = '03'; // run cleanup at 3:00 am (or first site hit after that)
+				$offset = DAY_IN_SECONDS;
+				break;
+			case 'hour' :
+			default :
+				$offset = HOUR_IN_SECONDS;
+				break;
+		}
+		$rounded_timestamp = strtotime(date("Y-m-d {$hours}:{$minutes}:00", $timestamp));
+		$rounded_timestamp += $round_up ? $offset : 0;
+		return apply_filters(
+			'FHEE__TransientCacheStorage__roundTimestamp__timestamp',
+			$rounded_timestamp,
+			$timestamp,
+			$cleanup_frequency,
+			$round_up
+		);
+	}
+
+
+
+	/**
+	 * Saves supplied data to a transient
+	 * if an expiration is set, then it automatically schedules the transient for cleanup
+	 *
+	 * @param string $transient_key [required]
+	 * @param string $data          [required]
+	 * @param int    $expiration    number of seconds until the cache expires
+	 * @return bool
+	 */
+	public function add($transient_key, $data, $expiration = 0)
+	{
+		$expiration = (int)abs($expiration);
+		$saved = set_transient($transient_key, $data, $expiration);
+		if ($saved && $expiration) {
+			$this->scheduleTransientCleanup($transient_key, $expiration);
+		}
+		return $saved;
+	}
+
+
+
+	/**
+	 * retrieves transient data
+	 * automatically triggers early cache refresh for standard cache items
+	 * in order to avoid cache stampedes on busy sites.
+	 * For non-standard cache items like PHP Session data where early refreshing is not wanted,
+	 * the $standard_cache parameter should be set to false when retrieving data
+	 *
+	 * @param string $transient_key [required]
+	 * @param bool   $standard_cache
+	 * @return mixed|null
+	 */
+	public function get($transient_key, $standard_cache = true)
+	{
+		// to avoid cache stampedes (AKA:dogpiles) for standard cache items,
+		// check if known cache expires within the next minute,
+		// and if so, remove it from our tracking and and return nothing.
+		// this should trigger the cache content to be regenerated during this request,
+		// while allowing any following requests to still access the existing cache
+		// until it gets replaced with the refreshed content
+		if (
+			$standard_cache
+			&& isset($this->transients[$transient_key])
+			&& $this->transients[$transient_key] - time() <= MINUTE_IN_SECONDS
+		) {
+			unset($this->transients[$transient_key]);
+			$this->updateTransients();
+			return null;
+		}
+		$content = get_transient($transient_key);
+		return $content !== false ? $content : null;
+	}
+
+
+
+	/**
+	 * delete a single transient and remove tracking
+	 *
+	 * @param string $transient_key [required] full or partial transient key to be deleted
+	 */
+	public function delete($transient_key)
+	{
+		$this->deleteMany(array($transient_key));
+	}
+
+
+
+	/**
+	 * delete multiple transients and remove tracking
+	 *
+	 * @param array $transient_keys [required] array of full or partial transient keys to be deleted
+	 */
+	public function deleteMany(array $transient_keys)
+	{
+		$full_transient_keys = array();
+		foreach ($this->transients as $transient_key => $expiration) {
+			foreach ($transient_keys as $transient_key_to_delete) {
+				if (strpos($transient_key, $transient_key_to_delete) !== false) {
+					$full_transient_keys[] = $transient_key;
+				}
+			}
+		}
+		if ($this->deleteTransientKeys($full_transient_keys)) {
+			$this->updateTransients();
+		}
+	}
+
+
+
+	/**
+	 * sorts transients numerically by timestamp
+	 * then saves the transient schedule to a WP option
+	 */
+	private function updateTransients()
+	{
+		asort($this->transients, SORT_NUMERIC);
+		update_option(
+			TransientCacheStorage::TRANSIENT_SCHEDULE_OPTIONS_KEY,
+			$this->transients
+		);
+	}
+
+
+
+	/**
+	 * schedules a transient for cleanup by adding it to the transient tracking
+	 *
+	 * @param string $transient_key [required]
+	 * @param int    $expiration    [required]
+	 */
+	private function scheduleTransientCleanup($transient_key, $expiration)
+	{
+		// make sure a valid future timestamp is set
+		$expiration += $expiration < time() ? time() : 0;
+		// and round to the closest 15 minutes
+		$expiration = $this->roundTimestamp($expiration);
+		// save transients to clear using their ID as the key to avoid duplicates
+		$this->transients[$transient_key] = $expiration;
+		$this->updateTransients();
+	}
+
+
+
+	/**
+	 * Since our tracked transients are sorted by their timestamps
+	 * we can grab the first transient and see when it is scheduled for cleanup.
+	 * If that timestamp is less than or equal to the current time,
+	 * then cleanup is triggered
+	 */
+	public function checkTransientCleanupSchedule()
+	{
+		if (empty($this->transients)) {
+			return;
+		}
+		// when do we run the next cleanup job?
+		reset($this->transients);
+		$next_scheduled_cleanup = current($this->transients);
+		// if the next cleanup job is scheduled for the current hour
+		if ($next_scheduled_cleanup <= $this->current_time) {
+			if ($this->cleanupExpiredTransients()) {
+				$this->updateTransients();
+			}
+		}
+	}
+
+
+
+	/**
+	 * loops through the array of tracked transients,
+	 * compiles a list of those that have expired, and sends that list off for deletion.
+	 * Also removes any bad records from the transients array
+	 *
+	 * @return bool
+	 */
+	private function cleanupExpiredTransients()
+	{
+		$update = false;
+		// filter the query limit. Set to 0 to turn off garbage collection
+		$limit = (int)abs(
+			apply_filters(
+				'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
+				50
+			)
+		);
+		// non-zero LIMIT means take out the trash
+		if ($limit) {
+			$transient_keys = array();
+			foreach ($this->transients as $transient_key => $expiration) {
+				if ($expiration > $this->current_time) {
+					continue;
+				}
+				if ( ! $expiration || ! $transient_key) {
+					unset($this->transients[$transient_key]);
+					$update = true;
+					continue;
+				}
+				$transient_keys[] = $transient_key;
+			}
+			// delete expired keys, but maintain value of $update if nothing is deleted
+			$update = $this->deleteTransientKeys($transient_keys, $limit) ? true : $update;
+			do_action( 'FHEE__TransientCacheStorage__clearExpiredTransients__end', $this);
+		}
+		return $update;
+	}
+
+
+
+	/**
+	 * calls delete_transient() on each transient key provided, up to the specified limit
+	 *
+	 * @param array $transient_keys [required]
+	 * @param int   $limit
+	 * @return bool
+	 */
+	private function deleteTransientKeys(array $transient_keys, $limit = 50)
+	{
+		if (empty($transient_keys)) {
+			return false;
+		}
+		$counter = 0;
+		foreach ($transient_keys as $transient_key) {
+			if($counter === $limit){
+				break;
+			}
+			delete_transient($transient_key);
+			unset($this->transients[$transient_key]);
+			$counter++;
+		}
+		return $counter > 0;
+	}
 
 
 }

Spacing +8 added lines, -8 removed lines

@@ -64,7 +64,7 @@ 
         $this->transient_cleanup_frequency = $this->setTransientCleanupFrequency();
         // round current time down to closest 5 minutes to simplify scheduling
         $this->current_time = $this->roundTimestamp(time(), '5-minutes', false);
-        $this->transients = (array)get_option(TransientCacheStorage::TRANSIENT_SCHEDULE_OPTIONS_KEY, array());
+        $this->transients = (array) get_option(TransientCacheStorage::TRANSIENT_SCHEDULE_OPTIONS_KEY, array());
         if ( ! (defined('DOING_AJAX') && DOING_AJAX) && $this->transient_cleanup_frequency !== 'off') {
             add_action('shutdown', array($this, 'checkTransientCleanupSchedule'), 999);
         }
@@ -132,17 +132,17 @@ 
         $hours = 'H';
         switch ($cleanup_frequency) {
             case '5-minutes' :
-                $minutes = floor((int)date('i', $timestamp) / 5) * 5;
+                $minutes = floor((int) date('i', $timestamp) / 5) * 5;
                 $minutes = str_pad($minutes, 2, '0', STR_PAD_LEFT);
                 $offset = MINUTE_IN_SECONDS * 5;
                 break;
             case '15-minutes' :
-                $minutes = floor((int)date('i', $timestamp) / 15) * 15;
+                $minutes = floor((int) date('i', $timestamp) / 15) * 15;
                 $minutes = str_pad($minutes, 2, '0', STR_PAD_LEFT);
                 $offset = MINUTE_IN_SECONDS * 15;
                 break;
             case '12-hours' :
-                $hours = floor((int)date('H', $timestamp) / 12) * 12;
+                $hours = floor((int) date('H', $timestamp) / 12) * 12;
                 $hours = str_pad($hours, 2, '0', STR_PAD_LEFT);
                 $offset = HOUR_IN_SECONDS * 12;
                 break;
@@ -179,7 +179,7 @@ 
      */
     public function add($transient_key, $data, $expiration = 0)
     {
-        $expiration = (int)abs($expiration);
+        $expiration = (int) abs($expiration);
         $saved = set_transient($transient_key, $data, $expiration);
         if ($saved && $expiration) {
             $this->scheduleTransientCleanup($transient_key, $expiration);
@@ -326,7 +326,7 @@ 
     {
         $update = false;
         // filter the query limit. Set to 0 to turn off garbage collection
-        $limit = (int)abs(
+        $limit = (int) abs(
             apply_filters(
                 'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
                 50
@@ -348,7 +348,7 @@ 
             }
             // delete expired keys, but maintain value of $update if nothing is deleted
             $update = $this->deleteTransientKeys($transient_keys, $limit) ? true : $update;
-            do_action( 'FHEE__TransientCacheStorage__clearExpiredTransients__end', $this);
+            do_action('FHEE__TransientCacheStorage__clearExpiredTransients__end', $this);
         }
         return $update;
     }
@@ -369,7 +369,7 @@ 
         }
         $counter = 0;
         foreach ($transient_keys as $transient_key) {
-            if($counter === $limit){
+            if ($counter === $limit) {
                 break;
             }
             delete_transient($transient_key);

modules/events_archive/EventsArchiveIframe.php

Indentation +52 added lines, -52 removed lines

@@ -4,7 +4,7 @@ 
 use EventEspresso\core\libraries\iframe_display\Iframe;
 
 if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-    exit( 'No direct script access allowed' );
+	exit( 'No direct script access allowed' );
 }
 
 
@@ -21,57 +21,57 @@ 
 
 
 
-    /**
-     * EventsArchiveIframe constructor.
-     *
-     * @param \EED_Events_Archive $EED_Events_Archive
-     * @throws \DomainException
-     */
-    public function __construct( $EED_Events_Archive )
-    {
-        \EE_Registry::instance()->REQ->set_espresso_page( true );
-        add_filter('FHEE__EED_Events_Archive__event_list_iframe', '__return_true');
-        $EED_Events_Archive->event_list();
-        /** @var \EventEspresso\core\domain\entities\shortcodes\EspressoEvents $event_list */
-        $event_list = \EE_Registry::instance()->create('EventEspresso\core\domain\entities\shortcodes\EspressoEvents');
-        parent::__construct(
-            esc_html__( 'Event List', 'event_espresso' ),
-            $event_list->processShortcode()
-        );
-        $this->addStylesheets(
-            apply_filters(
-                'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
-                array(
-                    'espresso_default'           => is_readable( EVENT_ESPRESSO_UPLOAD_DIR . 'css/style.css' )
-                        ? EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION
-                        : EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION,
-                ),
-                $this
-            )
-        );
-        $this->addScripts(
-            apply_filters(
-                'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
-                array(
-                    'gmap_api' => sprintf(
-                        'https://maps.googleapis.com/maps/api/js?key=%s',
-                        apply_filters(
-                            'FHEE__EEH_Maps__espresso_google_maps_js__api_key',
-                            \EE_Registry::instance()->CFG->map_settings->google_map_api_key
-                        )
-                    ),
-                    'ee_gmap'  => EE_HELPERS_ASSETS . 'ee_gmap.js?ver=1.0',
-                ),
-                $this
-            )
-        );
-        $this->addLocalizedVars(
-            array(
-                'ee_gmap' => \EEH_Maps::$gmap_vars,
-            ),
-            'ee_gmap_vars'
-        );
-    }
+	/**
+	 * EventsArchiveIframe constructor.
+	 *
+	 * @param \EED_Events_Archive $EED_Events_Archive
+	 * @throws \DomainException
+	 */
+	public function __construct( $EED_Events_Archive )
+	{
+		\EE_Registry::instance()->REQ->set_espresso_page( true );
+		add_filter('FHEE__EED_Events_Archive__event_list_iframe', '__return_true');
+		$EED_Events_Archive->event_list();
+		/** @var \EventEspresso\core\domain\entities\shortcodes\EspressoEvents $event_list */
+		$event_list = \EE_Registry::instance()->create('EventEspresso\core\domain\entities\shortcodes\EspressoEvents');
+		parent::__construct(
+			esc_html__( 'Event List', 'event_espresso' ),
+			$event_list->processShortcode()
+		);
+		$this->addStylesheets(
+			apply_filters(
+				'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
+				array(
+					'espresso_default'           => is_readable( EVENT_ESPRESSO_UPLOAD_DIR . 'css/style.css' )
+						? EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION
+						: EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION,
+				),
+				$this
+			)
+		);
+		$this->addScripts(
+			apply_filters(
+				'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
+				array(
+					'gmap_api' => sprintf(
+						'https://maps.googleapis.com/maps/api/js?key=%s',
+						apply_filters(
+							'FHEE__EEH_Maps__espresso_google_maps_js__api_key',
+							\EE_Registry::instance()->CFG->map_settings->google_map_api_key
+						)
+					),
+					'ee_gmap'  => EE_HELPERS_ASSETS . 'ee_gmap.js?ver=1.0',
+				),
+				$this
+			)
+		);
+		$this->addLocalizedVars(
+			array(
+				'ee_gmap' => \EEH_Maps::$gmap_vars,
+			),
+			'ee_gmap_vars'
+		);
+	}
 
 
 

Spacing +9 added lines, -9 removed lines

@@ -3,8 +3,8 @@ 
 
 use EventEspresso\core\libraries\iframe_display\Iframe;
 
-if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-    exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+    exit('No direct script access allowed');
 }
 
 
@@ -27,24 +27,24 @@ 
      * @param \EED_Events_Archive $EED_Events_Archive
      * @throws \DomainException
      */
-    public function __construct( $EED_Events_Archive )
+    public function __construct($EED_Events_Archive)
     {
-        \EE_Registry::instance()->REQ->set_espresso_page( true );
+        \EE_Registry::instance()->REQ->set_espresso_page(true);
         add_filter('FHEE__EED_Events_Archive__event_list_iframe', '__return_true');
         $EED_Events_Archive->event_list();
         /** @var \EventEspresso\core\domain\entities\shortcodes\EspressoEvents $event_list */
         $event_list = \EE_Registry::instance()->create('EventEspresso\core\domain\entities\shortcodes\EspressoEvents');
         parent::__construct(
-            esc_html__( 'Event List', 'event_espresso' ),
+            esc_html__('Event List', 'event_espresso'),
             $event_list->processShortcode()
         );
         $this->addStylesheets(
             apply_filters(
                 'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
                 array(
-                    'espresso_default'           => is_readable( EVENT_ESPRESSO_UPLOAD_DIR . 'css/style.css' )
-                        ? EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION
-                        : EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION,
+                    'espresso_default'           => is_readable(EVENT_ESPRESSO_UPLOAD_DIR.'css/style.css')
+                        ? EVENT_ESPRESSO_UPLOAD_DIR.'css/espresso_default.css?ver='.EVENT_ESPRESSO_VERSION
+                        : EE_GLOBAL_ASSETS_URL.'css/espresso_default.css?ver='.EVENT_ESPRESSO_VERSION,
                 ),
                 $this
             )
@@ -60,7 +60,7 @@ 
                             \EE_Registry::instance()->CFG->map_settings->google_map_api_key
                         )
                     ),
-                    'ee_gmap'  => EE_HELPERS_ASSETS . 'ee_gmap.js?ver=1.0',
+                    'ee_gmap'  => EE_HELPERS_ASSETS.'ee_gmap.js?ver=1.0',
                 ),
                 $this
             )

core/services/cache/PostRelatedCacheManager.php

Spacing +2 added lines, -2 removed lines

@@ -71,7 +71,7 @@ 
      */
     public function clearPostRelatedCacheOnUpdate($post_ID, $id_prefix)
     {
-        $post_related_cache = (array)get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
+        $post_related_cache = (array) get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
         // if post is not already being tracked
         if ( ! isset($post_related_cache[$post_ID])) {
             // add array to add cache ids to
@@ -92,7 +92,7 @@ 
      */
     public function clearPostRelatedCache($post_ID)
     {
-        $post_related_cache = (array)get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
+        $post_related_cache = (array) get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
         // if post is not being tracked
         if ( ! isset($post_related_cache[$post_ID])) {
             return;

Indentation +87 added lines, -87 removed lines

@@ -18,93 +18,93 @@
 class PostRelatedCacheManager extends BasicCacheManager
 {
 
-    /**
-     * @type string
-     */
-    const POST_CACHE_PREFIX = 'ee_cache_post_';
-
-    /**
-     * wp-option option_name for tracking post related cache
-     *
-     * @type string
-     */
-    const POST_CACHE_OPTIONS_KEY = 'ee_post_cache';
-
-
-
-    /**
-     * PostRelatedCacheManager constructor.
-     *
-     * @param CacheStorageInterface      $cache_storage
-     * @param SessionIdentifierInterface $session
-     */
-    public function __construct(CacheStorageInterface $cache_storage, SessionIdentifierInterface $session)
-    {
-        parent::__construct($cache_storage, $session);
-        add_action('save_post', array($this, 'clearPostRelatedCache'));
-    }
-
-
-
-    /**
-     * returns a string that will be prepended to all cache identifiers
-     *
-     * @return string
-     */
-    public function cachePrefix()
-    {
-        return PostRelatedCacheManager::POST_CACHE_PREFIX;
-    }
-
-
-
-    /**
-     * If you are caching content that pertains to a Post of any type,
-     * then it is recommended to pass the post id and cache id prefix to this method
-     * so that it can be added to the post related cache tracking.
-     * Then, whenever that post is updated, the cache will automatically be deleted,
-     * which helps to ensure that outdated cache content will not be served
-     *
-     * @param int    $post_ID    [required]
-     * @param string $id_prefix  [required] Appended 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.
-     */
-    public function clearPostRelatedCacheOnUpdate($post_ID, $id_prefix)
-    {
-        $post_related_cache = (array)get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
-        // if post is not already being tracked
-        if ( ! isset($post_related_cache[$post_ID])) {
-            // add array to add cache ids to
-            $post_related_cache[$post_ID] = array();
-        }
-        // add cache id to be tracked
-        $post_related_cache[$post_ID][] = $id_prefix;
-        update_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, $post_related_cache);
-    }
-
-
-
-    /**
-     * callback hooked into the WordPress "save_post" action
-     * deletes any cache content associated with the post
-     *
-     * @param int $post_ID [required]
-     */
-    public function clearPostRelatedCache($post_ID)
-    {
-        $post_related_cache = (array)get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
-        // if post is not being tracked
-        if ( ! isset($post_related_cache[$post_ID])) {
-            return;
-        }
-        // get cache id prefixes for post, and delete their corresponding transients
-        $this->clear($post_related_cache[$post_ID]);
-        unset($post_related_cache[$post_ID]);
-        update_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, $post_related_cache);
-    }
+	/**
+	 * @type string
+	 */
+	const POST_CACHE_PREFIX = 'ee_cache_post_';
+
+	/**
+	 * wp-option option_name for tracking post related cache
+	 *
+	 * @type string
+	 */
+	const POST_CACHE_OPTIONS_KEY = 'ee_post_cache';
+
+
+
+	/**
+	 * PostRelatedCacheManager constructor.
+	 *
+	 * @param CacheStorageInterface      $cache_storage
+	 * @param SessionIdentifierInterface $session
+	 */
+	public function __construct(CacheStorageInterface $cache_storage, SessionIdentifierInterface $session)
+	{
+		parent::__construct($cache_storage, $session);
+		add_action('save_post', array($this, 'clearPostRelatedCache'));
+	}
+
+
+
+	/**
+	 * returns a string that will be prepended to all cache identifiers
+	 *
+	 * @return string
+	 */
+	public function cachePrefix()
+	{
+		return PostRelatedCacheManager::POST_CACHE_PREFIX;
+	}
+
+
+
+	/**
+	 * If you are caching content that pertains to a Post of any type,
+	 * then it is recommended to pass the post id and cache id prefix to this method
+	 * so that it can be added to the post related cache tracking.
+	 * Then, whenever that post is updated, the cache will automatically be deleted,
+	 * which helps to ensure that outdated cache content will not be served
+	 *
+	 * @param int    $post_ID    [required]
+	 * @param string $id_prefix  [required] Appended 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.
+	 */
+	public function clearPostRelatedCacheOnUpdate($post_ID, $id_prefix)
+	{
+		$post_related_cache = (array)get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
+		// if post is not already being tracked
+		if ( ! isset($post_related_cache[$post_ID])) {
+			// add array to add cache ids to
+			$post_related_cache[$post_ID] = array();
+		}
+		// add cache id to be tracked
+		$post_related_cache[$post_ID][] = $id_prefix;
+		update_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, $post_related_cache);
+	}
+
+
+
+	/**
+	 * callback hooked into the WordPress "save_post" action
+	 * deletes any cache content associated with the post
+	 *
+	 * @param int $post_ID [required]
+	 */
+	public function clearPostRelatedCache($post_ID)
+	{
+		$post_related_cache = (array)get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
+		// if post is not being tracked
+		if ( ! isset($post_related_cache[$post_ID])) {
+			return;
+		}
+		// get cache id prefixes for post, and delete their corresponding transients
+		$this->clear($post_related_cache[$post_ID]);
+		unset($post_related_cache[$post_ID]);
+		update_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, $post_related_cache);
+	}
 
 
 }

core/services/cache/CacheManagerInterface.php

Indentation +37 added lines, -37 removed lines

@@ -18,43 +18,43 @@
 interface CacheManagerInterface
 {
 
-    /**
-     * returns a string that will be prepended to all cache identifiers
-     *
-     * @return string
-     */
-    public function cachePrefix();
-
-
-
-    /**
-     * @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);
-
-
-
-    /**
-     * @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);
+	/**
+	 * returns a string that will be prepended to all cache identifiers
+	 *
+	 * @return string
+	 */
+	public function cachePrefix();
+
+
+
+	/**
+	 * @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);
+
+
+
+	/**
+	 * @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);
 
 }
 // End of file CacheManagerInterface.php

core/services/cache/CacheStorageInterface.php

Indentation +34 added lines, -34 removed lines

@@ -15,49 +15,49 @@
 interface CacheStorageInterface
 {
 
-    /**
-     * Saves supplied data
-     * if an expiration is set, then it automatically schedules the cache for deletion
-     *
-     * @param string $key        [required]
-     * @param string $data       [required]
-     * @param int    $expiration number of seconds until the cache expires
-     * @return bool
-     */
-    public function add($key, $data, $expiration = 0);
+	/**
+	 * Saves supplied data
+	 * if an expiration is set, then it automatically schedules the cache for deletion
+	 *
+	 * @param string $key        [required]
+	 * @param string $data       [required]
+	 * @param int    $expiration number of seconds until the cache expires
+	 * @return bool
+	 */
+	public function add($key, $data, $expiration = 0);
 
 
 
-    /**
-     * retrieves cache data
-     * should automatically trigger early cache refresh for standard cache items
-     * in order to avoid cache stampedes on busy sites.
-     * For non-standard cache items like PHP Session data where early refreshing is not wanted,
-     * the $standard_cache parameter should be set to false when retrieving data
-     *
-     * @param string $key [required]
-     * @param bool   $standard_cache
-     * @return mixed
-     */
-    public function get($key, $standard_cache = true);
+	/**
+	 * retrieves cache data
+	 * should automatically trigger early cache refresh for standard cache items
+	 * in order to avoid cache stampedes on busy sites.
+	 * For non-standard cache items like PHP Session data where early refreshing is not wanted,
+	 * the $standard_cache parameter should be set to false when retrieving data
+	 *
+	 * @param string $key [required]
+	 * @param bool   $standard_cache
+	 * @return mixed
+	 */
+	public function get($key, $standard_cache = true);
 
 
 
-    /**
-     * delete a single cached item
-     *
-     * @param string $key [required] full or partial cache key to be deleted
-     */
-    public function delete($key);
+	/**
+	 * delete a single cached item
+	 *
+	 * @param string $key [required] full or partial cache key to be deleted
+	 */
+	public function delete($key);
 
 
 
-    /**
-     * delete multiple cached items
-     *
-     * @param array $keys [required] array of full or partial cache keys to be deleted
-     */
-    public function deleteMany(array $keys);
+	/**
+	 * delete multiple cached items
+	 *
+	 * @param array $keys [required] array of full or partial cache keys to be deleted
+	 */
+	public function deleteMany(array $keys);
 
 }
 // End of file CacheStorageInterface.php