eventespresso / event-espresso-core

core/Factory.php

Indentation +49 added lines, -49 removed lines

@@ -16,54 +16,54 @@
 class Factory
 {
 
-    /**
-     * @param string $class_name
-     * @param array  $arguments
-     * @return mixed|null
-     * @throws \EE_Error
-     */
-    public static function create($class_name, $arguments = array())
-    {
-        if (empty($class_name)) {
-            throw new \EE_Error(
-                __('You must provide a class name in order to instantiate it.', 'event_espresso')
-            );
-        }
-        // if ( ! class_exists( $class_name ) ) {
-        //     throw new \EE_Error(
-        //         sprintf(
-        //             __('The "%1$s" class was not found. Please include the correct file or set an autoloader for it',
-        //                 'event_espresso'),
-        //             $class_name
-        //         )
-        //     );
-        // }
-        $object = null;
-        switch ($class_name) {
-            case 'EE_Request':
-                $object = new \EE_Request($_GET, $_POST, $_COOKIE);
-                break;
-            case 'Iframe':
-                $title = isset($arguments['title']) ? $arguments['title'] : null;
-                $content = isset($arguments['content']) ? $arguments['content'] : null;
-                $object = new Iframe($title, $content);
-                break;
-            default:
-                $object = new $class_name($arguments);
-        }
+	/**
+	 * @param string $class_name
+	 * @param array  $arguments
+	 * @return mixed|null
+	 * @throws \EE_Error
+	 */
+	public static function create($class_name, $arguments = array())
+	{
+		if (empty($class_name)) {
+			throw new \EE_Error(
+				__('You must provide a class name in order to instantiate it.', 'event_espresso')
+			);
+		}
+		// if ( ! class_exists( $class_name ) ) {
+		//     throw new \EE_Error(
+		//         sprintf(
+		//             __('The "%1$s" class was not found. Please include the correct file or set an autoloader for it',
+		//                 'event_espresso'),
+		//             $class_name
+		//         )
+		//     );
+		// }
+		$object = null;
+		switch ($class_name) {
+			case 'EE_Request':
+				$object = new \EE_Request($_GET, $_POST, $_COOKIE);
+				break;
+			case 'Iframe':
+				$title = isset($arguments['title']) ? $arguments['title'] : null;
+				$content = isset($arguments['content']) ? $arguments['content'] : null;
+				$object = new Iframe($title, $content);
+				break;
+			default:
+				$object = new $class_name($arguments);
+		}
 
-        // if ( ! $object instanceof $class_name ) {
-        //     throw new \EE_Error(
-        //         sprintf(
-        //             __(
-        //                 'An error occurred during class instantiation and the requested object could not be created. The result was: %1$s %2$s',
-        //                 'event_espresso'
-        //             ),
-        //             '<br />',
-        //             var_export($object, true)
-        //         )
-        //     );
-        // }
-        return $object;
-    }
+		// if ( ! $object instanceof $class_name ) {
+		//     throw new \EE_Error(
+		//         sprintf(
+		//             __(
+		//                 'An error occurred during class instantiation and the requested object could not be created. The result was: %1$s %2$s',
+		//                 'event_espresso'
+		//             ),
+		//             '<br />',
+		//             var_export($object, true)
+		//         )
+		//     );
+		// }
+		return $object;
+	}
 }

core/admin/PostShortcodeTracking.php

Indentation +134 added lines, -134 removed lines

@@ -12,138 +12,138 @@
 class PostShortcodeTracking
 {
 
-    /**
-     * @deprecated 4.9.26
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-        \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26');
-    }
-
-
-    /**
-     * @deprecated 4.9.26
-     * @param $post_ID
-     * @param $post
-     * @return void
-     */
-    public static function parse_post_content_on_save($post_ID, $post)
-    {
-        \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26');
-    }
-
-
-    /**
-     * @deprecated 4.9.26
-     * @param $page_for_posts
-     * @return void
-     */
-    protected static function set_post_shortcodes_for_posts_page($page_for_posts)
-    {
-        \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26');
-    }
-
-
-    /**
-     * @deprecated 4.9.26
-     * @param $page_for_posts
-     * @param $EES_Shortcode
-     * @param $post_ID
-     * @return void
-     */
-    protected static function set_post_shortcode_for_posts_page($page_for_posts, $EES_Shortcode, $post_ID)
-    {
-        \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26');
-    }
-
-
-    /**
-     * @deprecated 4.9.26
-     * @param $ID
-     * @return void
-     */
-    public static function unset_post_shortcodes_on_delete($ID)
-    {
-        \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26');
-    }
-
-
-    /**
-     * @deprecated 4.9.26
-     * @param      $ID
-     * @param      $shortcode_class
-     * @param      $shortcode_posts
-     * @param      $page_for_posts
-     * @param bool $update_post_shortcodes
-     * @return void
-     */
-    protected static function unset_posts_page_shortcode_for_post(
-        $ID,
-        $shortcode_class,
-        $shortcode_posts,
-        $page_for_posts,
-        $update_post_shortcodes = false
-    ) {
-        \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26');
-    }
-
-
-    /**
-     * @deprecated 4.9.26
-     * @param string $page_for_posts
-     * @return void
-     */
-    public static function update_post_shortcodes($page_for_posts = '')
-    {
-        \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26');
-    }
-
-
-    /**
-     * @deprecated 4.9.26
-     * @param $option
-     * @param $value
-     * @return void
-     */
-    public static function reset_page_for_posts_on_initial_set($option, $value)
-    {
-        \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26');
-    }
-
-
-    /**
-     * @deprecated 4.9.26
-     * @param        $option
-     * @param string $old_value
-     * @param string $value
-     * @return void
-     */
-    public static function reset_page_for_posts_on_change($option, $old_value = '', $value = '')
-    {
-        \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26');
-    }
-
-
-    /**
-     * @deprecated 4.9.26
-     * @param $option
-     * @return void
-     */
-    public static function reset_page_for_posts_on_delete($option)
-    {
-        \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26');
-    }
-
-
-    /**
-     * @deprecated 4.9.26
-     * @param      $shortcodes
-     * @param bool $index_results
-     * @return void
-     */
-    public static function get_post_ids_for_shortcode($shortcodes, $index_results = true)
-    {
-        \EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26');
-    }
+	/**
+	 * @deprecated 4.9.26
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+		\EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26');
+	}
+
+
+	/**
+	 * @deprecated 4.9.26
+	 * @param $post_ID
+	 * @param $post
+	 * @return void
+	 */
+	public static function parse_post_content_on_save($post_ID, $post)
+	{
+		\EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26');
+	}
+
+
+	/**
+	 * @deprecated 4.9.26
+	 * @param $page_for_posts
+	 * @return void
+	 */
+	protected static function set_post_shortcodes_for_posts_page($page_for_posts)
+	{
+		\EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26');
+	}
+
+
+	/**
+	 * @deprecated 4.9.26
+	 * @param $page_for_posts
+	 * @param $EES_Shortcode
+	 * @param $post_ID
+	 * @return void
+	 */
+	protected static function set_post_shortcode_for_posts_page($page_for_posts, $EES_Shortcode, $post_ID)
+	{
+		\EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26');
+	}
+
+
+	/**
+	 * @deprecated 4.9.26
+	 * @param $ID
+	 * @return void
+	 */
+	public static function unset_post_shortcodes_on_delete($ID)
+	{
+		\EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26');
+	}
+
+
+	/**
+	 * @deprecated 4.9.26
+	 * @param      $ID
+	 * @param      $shortcode_class
+	 * @param      $shortcode_posts
+	 * @param      $page_for_posts
+	 * @param bool $update_post_shortcodes
+	 * @return void
+	 */
+	protected static function unset_posts_page_shortcode_for_post(
+		$ID,
+		$shortcode_class,
+		$shortcode_posts,
+		$page_for_posts,
+		$update_post_shortcodes = false
+	) {
+		\EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26');
+	}
+
+
+	/**
+	 * @deprecated 4.9.26
+	 * @param string $page_for_posts
+	 * @return void
+	 */
+	public static function update_post_shortcodes($page_for_posts = '')
+	{
+		\EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26');
+	}
+
+
+	/**
+	 * @deprecated 4.9.26
+	 * @param $option
+	 * @param $value
+	 * @return void
+	 */
+	public static function reset_page_for_posts_on_initial_set($option, $value)
+	{
+		\EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26');
+	}
+
+
+	/**
+	 * @deprecated 4.9.26
+	 * @param        $option
+	 * @param string $old_value
+	 * @param string $value
+	 * @return void
+	 */
+	public static function reset_page_for_posts_on_change($option, $old_value = '', $value = '')
+	{
+		\EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26');
+	}
+
+
+	/**
+	 * @deprecated 4.9.26
+	 * @param $option
+	 * @return void
+	 */
+	public static function reset_page_for_posts_on_delete($option)
+	{
+		\EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26');
+	}
+
+
+	/**
+	 * @deprecated 4.9.26
+	 * @param      $shortcodes
+	 * @param bool $index_results
+	 * @return void
+	 */
+	public static function get_post_ids_for_shortcode($shortcodes, $index_results = true)
+	{
+		\EE_Error::doing_it_wrong(__METHOD__, __('Usage is deprecated.', 'event_espresso'), '4.9.26');
+	}
 }

core/domain/entities/Context.php

Indentation +47 added lines, -47 removed lines

@@ -14,62 +14,62 @@
 class Context implements ContextInterface
 {
 
-    /**
-     * @var string $slug
-     */
-    private $slug;
+	/**
+	 * @var string $slug
+	 */
+	private $slug;
 
-    /**
-     * @var string $description
-     */
-    private $description;
+	/**
+	 * @var string $description
+	 */
+	private $description;
 
 
-    /**
-     * Context constructor.
-     *
-     * @param string $slug
-     * @param string $description
-     */
-    public function __construct($slug, $description)
-    {
-        $this->setSlug($slug);
-        $this->setDescription($description);
-    }
+	/**
+	 * Context constructor.
+	 *
+	 * @param string $slug
+	 * @param string $description
+	 */
+	public function __construct($slug, $description)
+	{
+		$this->setSlug($slug);
+		$this->setDescription($description);
+	}
 
 
-    /**
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->slug;
-    }
+	/**
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->slug;
+	}
 
 
-    /**
-     * @param string $slug
-     */
-    private function setSlug($slug)
-    {
-        $this->slug = sanitize_key($slug);
-    }
+	/**
+	 * @param string $slug
+	 */
+	private function setSlug($slug)
+	{
+		$this->slug = sanitize_key($slug);
+	}
 
 
-    /**
-     * @return string
-     */
-    public function description()
-    {
-        return $this->description;
-    }
+	/**
+	 * @return string
+	 */
+	public function description()
+	{
+		return $this->description;
+	}
 
 
-    /**
-     * @param string $description
-     */
-    private function setDescription($description)
-    {
-        $this->description = sanitize_text_field($description);
-    }
+	/**
+	 * @param string $description
+	 */
+	private function setDescription($description)
+	{
+		$this->description = sanitize_text_field($description);
+	}
 }

modules/invalid_checkout_access/InvalidCheckoutAccess.php

Indentation +168 added lines, -168 removed lines

@@ -13,178 +13,178 @@
 class InvalidCheckoutAccess
 {
 
-    /**
-     * key used for saving invalid checkout access data to the wp_options table
-     */
-    const OPTION_KEY = 'ee_invalid_checkout_access';
+	/**
+	 * key used for saving invalid checkout access data to the wp_options table
+	 */
+	const OPTION_KEY = 'ee_invalid_checkout_access';
 
 
-    /**
-     * _block_bots
-     * checks that the incoming request has either of the following set:
-     *  a uts (unix timestamp) which indicates that the request was redirected from the Ticket Selector
-     *  a REG URL Link, which indicates that the request is a return visit to SPCO for a valid TXN
-     * so if you're not coming from the Ticket Selector nor returning for a valid IP...
-     * then where you coming from man?
-     *
-     * @param \EE_Checkout $checkout
-     * @return bool true if access to registration checkout appears to be invalid
-     */
-    public function checkoutAccessIsInvalid(\EE_Checkout $checkout)
-    {
-        if (! ($checkout->uts || $checkout->reg_url_link)
-            && ! (defined('DOING_AJAX') && DOING_AJAX)
-            && \EE_Config::instance()->registration->track_invalid_checkout_access()
-        ) {
-            /** @var \EE_Request $request */
-            $request = \EE_Registry::instance()->load_core('EE_Request');
-            $ip_address = $request->ip_address();
-            $ee_bot_checkout = get_option(InvalidCheckoutAccess::OPTION_KEY);
-            if ($ee_bot_checkout === false) {
-                $ee_bot_checkout = array();
-                add_option(InvalidCheckoutAccess::OPTION_KEY, $ee_bot_checkout, '', false);
-            }
-            if (! isset($ee_bot_checkout[ $ip_address ])) {
-                $ee_bot_checkout[ $ip_address ] = array();
-            }
-            $http_referer = isset($_SERVER['HTTP_REFERER'])
-                ? esc_attr($_SERVER['HTTP_REFERER'])
-                : 0;
-            if (! isset($ee_bot_checkout[ $ip_address ][ $http_referer ])) {
-                $ee_bot_checkout[ $ip_address ][ $http_referer ] = 0;
-            }
-            $ee_bot_checkout[ $ip_address ][ $http_referer ]++;
-            update_option(InvalidCheckoutAccess::OPTION_KEY, $ee_bot_checkout);
-            if (WP_DEBUG) {
-                \EE_Error::add_error(
-                    esc_html__('Direct access to the registration checkout page is not allowed.', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-            return true;
-        }
-        return false;
-    }
+	/**
+	 * _block_bots
+	 * checks that the incoming request has either of the following set:
+	 *  a uts (unix timestamp) which indicates that the request was redirected from the Ticket Selector
+	 *  a REG URL Link, which indicates that the request is a return visit to SPCO for a valid TXN
+	 * so if you're not coming from the Ticket Selector nor returning for a valid IP...
+	 * then where you coming from man?
+	 *
+	 * @param \EE_Checkout $checkout
+	 * @return bool true if access to registration checkout appears to be invalid
+	 */
+	public function checkoutAccessIsInvalid(\EE_Checkout $checkout)
+	{
+		if (! ($checkout->uts || $checkout->reg_url_link)
+			&& ! (defined('DOING_AJAX') && DOING_AJAX)
+			&& \EE_Config::instance()->registration->track_invalid_checkout_access()
+		) {
+			/** @var \EE_Request $request */
+			$request = \EE_Registry::instance()->load_core('EE_Request');
+			$ip_address = $request->ip_address();
+			$ee_bot_checkout = get_option(InvalidCheckoutAccess::OPTION_KEY);
+			if ($ee_bot_checkout === false) {
+				$ee_bot_checkout = array();
+				add_option(InvalidCheckoutAccess::OPTION_KEY, $ee_bot_checkout, '', false);
+			}
+			if (! isset($ee_bot_checkout[ $ip_address ])) {
+				$ee_bot_checkout[ $ip_address ] = array();
+			}
+			$http_referer = isset($_SERVER['HTTP_REFERER'])
+				? esc_attr($_SERVER['HTTP_REFERER'])
+				: 0;
+			if (! isset($ee_bot_checkout[ $ip_address ][ $http_referer ])) {
+				$ee_bot_checkout[ $ip_address ][ $http_referer ] = 0;
+			}
+			$ee_bot_checkout[ $ip_address ][ $http_referer ]++;
+			update_option(InvalidCheckoutAccess::OPTION_KEY, $ee_bot_checkout);
+			if (WP_DEBUG) {
+				\EE_Error::add_error(
+					esc_html__('Direct access to the registration checkout page is not allowed.', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+			return true;
+		}
+		return false;
+	}
 
 
-    /**
-     * _invalid_checkout_access_form
-     *
-     * @return \EE_Form_Section_Proper
-     * @throws \EE_Error
-     */
-    public function getForm()
-    {
-        return new \EE_Form_Section_Proper(
-            array(
-                'name'            => 'invalid_checkout_access',
-                'html_id'         => 'invalid_checkout_access',
-                'layout_strategy' => new \EE_Admin_Two_Column_Layout(),
-                'subsections'     => array(
-                    'invalid_checkout_access_hdr'   => new \EE_Form_Section_HTML(
-                        \EEH_HTML::h2(esc_html__('Invalid Checkout Access', 'event_espresso'))
-                    ),
-                    'ee_bot_checkout_data'          => new \EE_Text_Area_Input(
-                        array(
-                            'html_label_text' => esc_html__('Invalid Checkout Data', 'event_espresso'),
-                            'default'         => var_export(
-                                get_option(InvalidCheckoutAccess::OPTION_KEY, array()),
-                                true
-                            ),
-                            'required'        => false,
-                            'html_help_text'  => esc_html__(
-                                'Event Espresso blocks any attempt to directly access the registration checkout page, that is NOT from a Ticket Selector or for a return visit for a valid transaction. These are not valid requests accessing your checkout page, so we track the IP addresses, what web page they just came from, and the number of times that they have attempted to access your registration page. This information may help you with protecting your site by other means, such as firewalls, etc, but please note that IP addresses are almost guaranteed to be spoofed by malicious agents.',
-                                'event_espresso'
-                            ),
-                        )
-                    ),
-                    'track_invalid_checkout_access' => new \EE_Yes_No_Input(
-                        array(
-                            'html_label_text'         => __('Track Invalid Checkout Access?', 'event_espresso'),
-                            'html_help_text'          => esc_html__(
-                                'Controls whether or not invalid attempts to directly access the registration checkout page should be tracked. Setting this to "No" means that the above data will no longer be collected.',
-                                'event_espresso'
-                            ),
-                            'default'                 => \EE_Config::instance()
-                                ->registration
-                                ->track_invalid_checkout_access(),
-                            'display_html_label_text' => false,
-                        )
-                    ),
-                    'delete_invalid_checkout_data'  => new \EE_Yes_No_Input(
-                        array(
-                            'html_label_text'         => __('Reset Invalid Checkout Data', 'event_espresso'),
-                            'html_help_text'          => esc_html__(
-                                'Setting this to "Yes" will delete all existing invalid checkout access data.',
-                                'event_espresso'
-                            ),
-                            'default'                 => false,
-                            'display_html_label_text' => false,
-                        )
-                    ),
-                ),
-            )
-        );
-    }
+	/**
+	 * _invalid_checkout_access_form
+	 *
+	 * @return \EE_Form_Section_Proper
+	 * @throws \EE_Error
+	 */
+	public function getForm()
+	{
+		return new \EE_Form_Section_Proper(
+			array(
+				'name'            => 'invalid_checkout_access',
+				'html_id'         => 'invalid_checkout_access',
+				'layout_strategy' => new \EE_Admin_Two_Column_Layout(),
+				'subsections'     => array(
+					'invalid_checkout_access_hdr'   => new \EE_Form_Section_HTML(
+						\EEH_HTML::h2(esc_html__('Invalid Checkout Access', 'event_espresso'))
+					),
+					'ee_bot_checkout_data'          => new \EE_Text_Area_Input(
+						array(
+							'html_label_text' => esc_html__('Invalid Checkout Data', 'event_espresso'),
+							'default'         => var_export(
+								get_option(InvalidCheckoutAccess::OPTION_KEY, array()),
+								true
+							),
+							'required'        => false,
+							'html_help_text'  => esc_html__(
+								'Event Espresso blocks any attempt to directly access the registration checkout page, that is NOT from a Ticket Selector or for a return visit for a valid transaction. These are not valid requests accessing your checkout page, so we track the IP addresses, what web page they just came from, and the number of times that they have attempted to access your registration page. This information may help you with protecting your site by other means, such as firewalls, etc, but please note that IP addresses are almost guaranteed to be spoofed by malicious agents.',
+								'event_espresso'
+							),
+						)
+					),
+					'track_invalid_checkout_access' => new \EE_Yes_No_Input(
+						array(
+							'html_label_text'         => __('Track Invalid Checkout Access?', 'event_espresso'),
+							'html_help_text'          => esc_html__(
+								'Controls whether or not invalid attempts to directly access the registration checkout page should be tracked. Setting this to "No" means that the above data will no longer be collected.',
+								'event_espresso'
+							),
+							'default'                 => \EE_Config::instance()
+								->registration
+								->track_invalid_checkout_access(),
+							'display_html_label_text' => false,
+						)
+					),
+					'delete_invalid_checkout_data'  => new \EE_Yes_No_Input(
+						array(
+							'html_label_text'         => __('Reset Invalid Checkout Data', 'event_espresso'),
+							'html_help_text'          => esc_html__(
+								'Setting this to "Yes" will delete all existing invalid checkout access data.',
+								'event_espresso'
+							),
+							'default'                 => false,
+							'display_html_label_text' => false,
+						)
+					),
+				),
+			)
+		);
+	}
 
 
-    /**
-     * update_invalid_checkout_access_form
-     *
-     * @param \EE_Registration_Config $EE_Registration_Config
-     * @return \EE_Registration_Config
-     */
-    public function processForm(\EE_Registration_Config $EE_Registration_Config)
-    {
-        try {
-            $invalid_checkout_access_form = $this->getForm();
-            // if not displaying a form, then check for form submission
-            if ($invalid_checkout_access_form->was_submitted()) {
-                // capture form data
-                $invalid_checkout_access_form->receive_form_submission();
-                // validate form data
-                if ($invalid_checkout_access_form->is_valid()) {
-                    // grab validated data from form
-                    $valid_data = $invalid_checkout_access_form->valid_data();
-                    // ensure form inputs we want are set
-                    if (isset(
-                        $valid_data['track_invalid_checkout_access'],
-                        $valid_data['delete_invalid_checkout_data']
-                    )) {
-                        $EE_Registration_Config->set_track_invalid_checkout_access(
-                            $valid_data['track_invalid_checkout_access']
-                        );
-                        // if deleting, then update option with empty array
-                        if (filter_var($valid_data['delete_invalid_checkout_data'], FILTER_VALIDATE_BOOLEAN)) {
-                            update_option(InvalidCheckoutAccess::OPTION_KEY, array());
-                        }
-                    } else {
-                        \EE_Error::add_error(
-                            esc_html__(
-                                'Invalid or missing Invalid Checkout Access form data. Please refresh the form and try again.',
-                                'event_espresso'
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                } else {
-                    if ($invalid_checkout_access_form->submission_error_message() !== '') {
-                        \EE_Error::add_error(
-                            $invalid_checkout_access_form->submission_error_message(),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                }
-            }
-        } catch (\EE_Error $e) {
-            $e->get_error();
-        }
-        return $EE_Registration_Config;
-    }
+	/**
+	 * update_invalid_checkout_access_form
+	 *
+	 * @param \EE_Registration_Config $EE_Registration_Config
+	 * @return \EE_Registration_Config
+	 */
+	public function processForm(\EE_Registration_Config $EE_Registration_Config)
+	{
+		try {
+			$invalid_checkout_access_form = $this->getForm();
+			// if not displaying a form, then check for form submission
+			if ($invalid_checkout_access_form->was_submitted()) {
+				// capture form data
+				$invalid_checkout_access_form->receive_form_submission();
+				// validate form data
+				if ($invalid_checkout_access_form->is_valid()) {
+					// grab validated data from form
+					$valid_data = $invalid_checkout_access_form->valid_data();
+					// ensure form inputs we want are set
+					if (isset(
+						$valid_data['track_invalid_checkout_access'],
+						$valid_data['delete_invalid_checkout_data']
+					)) {
+						$EE_Registration_Config->set_track_invalid_checkout_access(
+							$valid_data['track_invalid_checkout_access']
+						);
+						// if deleting, then update option with empty array
+						if (filter_var($valid_data['delete_invalid_checkout_data'], FILTER_VALIDATE_BOOLEAN)) {
+							update_option(InvalidCheckoutAccess::OPTION_KEY, array());
+						}
+					} else {
+						\EE_Error::add_error(
+							esc_html__(
+								'Invalid or missing Invalid Checkout Access form data. Please refresh the form and try again.',
+								'event_espresso'
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+				} else {
+					if ($invalid_checkout_access_form->submission_error_message() !== '') {
+						\EE_Error::add_error(
+							$invalid_checkout_access_form->submission_error_message(),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+				}
+			}
+		} catch (\EE_Error $e) {
+			$e->get_error();
+		}
+		return $EE_Registration_Config;
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -32,7 +32,7 @@ 
      */
     public function checkoutAccessIsInvalid(\EE_Checkout $checkout)
     {
-        if (! ($checkout->uts || $checkout->reg_url_link)
+        if ( ! ($checkout->uts || $checkout->reg_url_link)
             && ! (defined('DOING_AJAX') && DOING_AJAX)
             && \EE_Config::instance()->registration->track_invalid_checkout_access()
         ) {
@@ -44,16 +44,16 @@ 
                 $ee_bot_checkout = array();
                 add_option(InvalidCheckoutAccess::OPTION_KEY, $ee_bot_checkout, '', false);
             }
-            if (! isset($ee_bot_checkout[ $ip_address ])) {
-                $ee_bot_checkout[ $ip_address ] = array();
+            if ( ! isset($ee_bot_checkout[$ip_address])) {
+                $ee_bot_checkout[$ip_address] = array();
             }
             $http_referer = isset($_SERVER['HTTP_REFERER'])
                 ? esc_attr($_SERVER['HTTP_REFERER'])
                 : 0;
-            if (! isset($ee_bot_checkout[ $ip_address ][ $http_referer ])) {
-                $ee_bot_checkout[ $ip_address ][ $http_referer ] = 0;
+            if ( ! isset($ee_bot_checkout[$ip_address][$http_referer])) {
+                $ee_bot_checkout[$ip_address][$http_referer] = 0;
             }
-            $ee_bot_checkout[ $ip_address ][ $http_referer ]++;
+            $ee_bot_checkout[$ip_address][$http_referer]++;
             update_option(InvalidCheckoutAccess::OPTION_KEY, $ee_bot_checkout);
             if (WP_DEBUG) {
                 \EE_Error::add_error(

modules/ticket_selector/DatetimeSelector.php

Indentation +167 added lines, -167 removed lines

@@ -12,171 +12,171 @@
 class DatetimeSelector
 {
 
-    /**
-     * @var \EE_Event $event
-     */
-    protected $event;
-
-    /**
-     * @var \EE_Ticket[] $tickets
-     */
-    protected $tickets;
-
-    /**
-     * @var \EE_Datetime[] $datetimes
-     */
-    protected $datetimes;
-
-    /**
-     * @var \EE_Datetime[] $unique_dates
-     */
-    protected $unique_dates;
-
-    /**
-     * @var \EE_Ticket_Selector_Config $template_settings
-     */
-    protected $template_settings;
-
-    /**
-     * @var boolean $active
-     */
-    protected $active = false;
-
-
-    /**
-     * DatetimeSelector constructor.
-     *
-     * @param \EE_Event                  $event
-     * @param \EE_Ticket[]               $tickets
-     * @param \EE_Ticket_Selector_Config $template_settings
-     * @param string                     $date_format
-     * @param string                     $time_format
-     * @throws \EE_Error
-     */
-    public function __construct(
-        \EE_Event $event,
-        array $tickets,
-        \EE_Ticket_Selector_Config $template_settings,
-        $date_format = 'Y-m-d',
-        $time_format = 'g:i a'
-    ) {
-        $this->event = $event;
-        $this->tickets = $tickets;
-        $this->template_settings = $template_settings;
-        $this->datetimes = $this->getAllDatetimesForAllTicket($tickets);
-        $this->unique_dates = $this->getUniqueDatetimeOptions($date_format, $time_format);
-        $this->active = $this->template_settings->showDatetimeSelector($this->unique_dates);
-    }
-
-
-    /**
-     * @param \EE_Ticket[] $tickets
-     * @return array
-     * @throws \EE_Error
-     */
-    protected function getAllDatetimesForAllTicket($tickets = array())
-    {
-        $datetimes = array();
-        foreach ($tickets as $ticket) {
-            $datetimes = $this->getTicketDatetimes($ticket, $datetimes);
-        }
-        return $datetimes;
-    }
-
-
-    /**
-     * @param \EE_Ticket      $ticket
-     * @param  \EE_Datetime[] $datetimes
-     * @return \EE_Datetime[]
-     * @throws \EE_Error
-     */
-    protected function getTicketDatetimes(\EE_Ticket $ticket, $datetimes = array())
-    {
-        $ticket_datetimes = $ticket->datetimes(
-            array(
-                'order_by'                 => array(
-                    'DTT_order'     => 'ASC',
-                    'DTT_EVT_start' => 'ASC',
-                ),
-                'default_where_conditions' => 'none',
-            )
-        );
-        foreach ($ticket_datetimes as $ticket_datetime) {
-            if (! $ticket_datetime instanceof \EE_Datetime) {
-                continue;
-            }
-            $datetimes[ $ticket_datetime->ID() ] = $ticket_datetime;
-        }
-        return $datetimes;
-    }
-
-
-    /**
-     * @param \EE_Ticket $ticket
-     * @return string
-     * @throws \EE_Error
-     */
-    public function getTicketDatetimeClasses(\EE_Ticket $ticket)
-    {
-        if (! $this->active) {
-            return '';
-        }
-        $ticket_datetimes = $this->getTicketDatetimes($ticket);
-        $classes = '';
-        foreach ($this->datetimes as $datetime) {
-            if (! $datetime instanceof \EE_Datetime || ! in_array($datetime, $ticket_datetimes, true)) {
-                continue;
-            }
-            $classes .= ' ee-ticket-datetimes-' . $datetime->date_and_time_range('Y_m_d', 'H_i', '-', '_');
-        }
-        return $classes;
-    }
-
-
-    /**
-     * @param string $date_format
-     * @param string $time_format
-     * @return array
-     * @throws \EE_Error
-     */
-    public function getUniqueDatetimeOptions($date_format = 'Y-m-d', $time_format = 'g:i a')
-    {
-        $datetime_options = array();
-        foreach ($this->datetimes as $datetime) {
-            if (! $datetime instanceof \EE_Datetime) {
-                continue;
-            }
-            $datetime_options[ $datetime->date_and_time_range('Y_m_d', 'H_i', '-', '_') ] =
-                $datetime->date_and_time_range($date_format, $time_format, ' - ');
-        }
-        return $datetime_options;
-    }
-
-
-    /**
-     * @return string
-     * @throws \EE_Error
-     */
-    public function getDatetimeSelector()
-    {
-        if (! $this->active) {
-            return '';
-        }
-        $dropdown_selector = new \EE_Checkbox_Dropdown_Selector_Input(
-            $this->unique_dates,
-            array(
-                'html_id'               => 'datetime-selector-' . $this->event->ID(),
-                'html_name'             => 'datetime_selector_' . $this->event->ID(),
-                'html_class'            => 'datetime-selector',
-                'select_button_text'    => '<span class="dashicons dashicons-calendar-alt"></span> '
-                                           . esc_html__('Filter by Date', 'event_espresso'),
-                'other_html_attributes' => ' data-tkt_slctr_evt="' . $this->event->ID() . '"',
-            )
-        );
-        return \EEH_HTML::div(
-            $dropdown_selector->get_html_for_input(),
-            '',
-            'datetime_selector-dv'
-        );
-    }
+	/**
+	 * @var \EE_Event $event
+	 */
+	protected $event;
+
+	/**
+	 * @var \EE_Ticket[] $tickets
+	 */
+	protected $tickets;
+
+	/**
+	 * @var \EE_Datetime[] $datetimes
+	 */
+	protected $datetimes;
+
+	/**
+	 * @var \EE_Datetime[] $unique_dates
+	 */
+	protected $unique_dates;
+
+	/**
+	 * @var \EE_Ticket_Selector_Config $template_settings
+	 */
+	protected $template_settings;
+
+	/**
+	 * @var boolean $active
+	 */
+	protected $active = false;
+
+
+	/**
+	 * DatetimeSelector constructor.
+	 *
+	 * @param \EE_Event                  $event
+	 * @param \EE_Ticket[]               $tickets
+	 * @param \EE_Ticket_Selector_Config $template_settings
+	 * @param string                     $date_format
+	 * @param string                     $time_format
+	 * @throws \EE_Error
+	 */
+	public function __construct(
+		\EE_Event $event,
+		array $tickets,
+		\EE_Ticket_Selector_Config $template_settings,
+		$date_format = 'Y-m-d',
+		$time_format = 'g:i a'
+	) {
+		$this->event = $event;
+		$this->tickets = $tickets;
+		$this->template_settings = $template_settings;
+		$this->datetimes = $this->getAllDatetimesForAllTicket($tickets);
+		$this->unique_dates = $this->getUniqueDatetimeOptions($date_format, $time_format);
+		$this->active = $this->template_settings->showDatetimeSelector($this->unique_dates);
+	}
+
+
+	/**
+	 * @param \EE_Ticket[] $tickets
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	protected function getAllDatetimesForAllTicket($tickets = array())
+	{
+		$datetimes = array();
+		foreach ($tickets as $ticket) {
+			$datetimes = $this->getTicketDatetimes($ticket, $datetimes);
+		}
+		return $datetimes;
+	}
+
+
+	/**
+	 * @param \EE_Ticket      $ticket
+	 * @param  \EE_Datetime[] $datetimes
+	 * @return \EE_Datetime[]
+	 * @throws \EE_Error
+	 */
+	protected function getTicketDatetimes(\EE_Ticket $ticket, $datetimes = array())
+	{
+		$ticket_datetimes = $ticket->datetimes(
+			array(
+				'order_by'                 => array(
+					'DTT_order'     => 'ASC',
+					'DTT_EVT_start' => 'ASC',
+				),
+				'default_where_conditions' => 'none',
+			)
+		);
+		foreach ($ticket_datetimes as $ticket_datetime) {
+			if (! $ticket_datetime instanceof \EE_Datetime) {
+				continue;
+			}
+			$datetimes[ $ticket_datetime->ID() ] = $ticket_datetime;
+		}
+		return $datetimes;
+	}
+
+
+	/**
+	 * @param \EE_Ticket $ticket
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function getTicketDatetimeClasses(\EE_Ticket $ticket)
+	{
+		if (! $this->active) {
+			return '';
+		}
+		$ticket_datetimes = $this->getTicketDatetimes($ticket);
+		$classes = '';
+		foreach ($this->datetimes as $datetime) {
+			if (! $datetime instanceof \EE_Datetime || ! in_array($datetime, $ticket_datetimes, true)) {
+				continue;
+			}
+			$classes .= ' ee-ticket-datetimes-' . $datetime->date_and_time_range('Y_m_d', 'H_i', '-', '_');
+		}
+		return $classes;
+	}
+
+
+	/**
+	 * @param string $date_format
+	 * @param string $time_format
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public function getUniqueDatetimeOptions($date_format = 'Y-m-d', $time_format = 'g:i a')
+	{
+		$datetime_options = array();
+		foreach ($this->datetimes as $datetime) {
+			if (! $datetime instanceof \EE_Datetime) {
+				continue;
+			}
+			$datetime_options[ $datetime->date_and_time_range('Y_m_d', 'H_i', '-', '_') ] =
+				$datetime->date_and_time_range($date_format, $time_format, ' - ');
+		}
+		return $datetime_options;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function getDatetimeSelector()
+	{
+		if (! $this->active) {
+			return '';
+		}
+		$dropdown_selector = new \EE_Checkbox_Dropdown_Selector_Input(
+			$this->unique_dates,
+			array(
+				'html_id'               => 'datetime-selector-' . $this->event->ID(),
+				'html_name'             => 'datetime_selector_' . $this->event->ID(),
+				'html_class'            => 'datetime-selector',
+				'select_button_text'    => '<span class="dashicons dashicons-calendar-alt"></span> '
+										   . esc_html__('Filter by Date', 'event_espresso'),
+				'other_html_attributes' => ' data-tkt_slctr_evt="' . $this->event->ID() . '"',
+			)
+		);
+		return \EEH_HTML::div(
+			$dropdown_selector->get_html_for_input(),
+			'',
+			'datetime_selector-dv'
+		);
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -102,10 +102,10 @@ 
             )
         );
         foreach ($ticket_datetimes as $ticket_datetime) {
-            if (! $ticket_datetime instanceof \EE_Datetime) {
+            if ( ! $ticket_datetime instanceof \EE_Datetime) {
                 continue;
             }
-            $datetimes[ $ticket_datetime->ID() ] = $ticket_datetime;
+            $datetimes[$ticket_datetime->ID()] = $ticket_datetime;
         }
         return $datetimes;
     }
@@ -118,16 +118,16 @@ 
      */
     public function getTicketDatetimeClasses(\EE_Ticket $ticket)
     {
-        if (! $this->active) {
+        if ( ! $this->active) {
             return '';
         }
         $ticket_datetimes = $this->getTicketDatetimes($ticket);
         $classes = '';
         foreach ($this->datetimes as $datetime) {
-            if (! $datetime instanceof \EE_Datetime || ! in_array($datetime, $ticket_datetimes, true)) {
+            if ( ! $datetime instanceof \EE_Datetime || ! in_array($datetime, $ticket_datetimes, true)) {
                 continue;
             }
-            $classes .= ' ee-ticket-datetimes-' . $datetime->date_and_time_range('Y_m_d', 'H_i', '-', '_');
+            $classes .= ' ee-ticket-datetimes-'.$datetime->date_and_time_range('Y_m_d', 'H_i', '-', '_');
         }
         return $classes;
     }
@@ -143,10 +143,10 @@ 
     {
         $datetime_options = array();
         foreach ($this->datetimes as $datetime) {
-            if (! $datetime instanceof \EE_Datetime) {
+            if ( ! $datetime instanceof \EE_Datetime) {
                 continue;
             }
-            $datetime_options[ $datetime->date_and_time_range('Y_m_d', 'H_i', '-', '_') ] =
+            $datetime_options[$datetime->date_and_time_range('Y_m_d', 'H_i', '-', '_')] =
                 $datetime->date_and_time_range($date_format, $time_format, ' - ');
         }
         return $datetime_options;
@@ -159,18 +159,18 @@ 
      */
     public function getDatetimeSelector()
     {
-        if (! $this->active) {
+        if ( ! $this->active) {
             return '';
         }
         $dropdown_selector = new \EE_Checkbox_Dropdown_Selector_Input(
             $this->unique_dates,
             array(
-                'html_id'               => 'datetime-selector-' . $this->event->ID(),
-                'html_name'             => 'datetime_selector_' . $this->event->ID(),
+                'html_id'               => 'datetime-selector-'.$this->event->ID(),
+                'html_name'             => 'datetime_selector_'.$this->event->ID(),
                 'html_class'            => 'datetime-selector',
                 'select_button_text'    => '<span class="dashicons dashicons-calendar-alt"></span> '
                                            . esc_html__('Filter by Date', 'event_espresso'),
-                'other_html_attributes' => ' data-tkt_slctr_evt="' . $this->event->ID() . '"',
+                'other_html_attributes' => ' data-tkt_slctr_evt="'.$this->event->ID().'"',
             )
         );
         return \EEH_HTML::div(

caffeinated/modules/recaptcha/ReCaptcha/Response.php

Indentation +61 added lines, -61 removed lines

@@ -28,74 +28,74 @@
  */
 class Response
 {
-    /**
-     * Succes or failure.
-     *
-     * @var boolean
-     */
-    private $success = false;
+	/**
+	 * Succes or failure.
+	 *
+	 * @var boolean
+	 */
+	private $success = false;
 
-    /**
-     * Error code strings.
-     *
-     * @var array
-     */
-    private $errorCodes = array();
+	/**
+	 * Error code strings.
+	 *
+	 * @var array
+	 */
+	private $errorCodes = array();
 
-    /**
-     * Build the response from the expected JSON returned by the service.
-     *
-     * @param string $json
-     * @return \ReCaptcha\Response
-     */
-    public static function fromJson($json)
-    {
-        $responseData = json_decode($json, true);
+	/**
+	 * Build the response from the expected JSON returned by the service.
+	 *
+	 * @param string $json
+	 * @return \ReCaptcha\Response
+	 */
+	public static function fromJson($json)
+	{
+		$responseData = json_decode($json, true);
 
-        if (! $responseData) {
-            return new Response(false, array('invalid-json'));
-        }
+		if (! $responseData) {
+			return new Response(false, array('invalid-json'));
+		}
 
-        if (isset($responseData['success']) && $responseData['success'] == true) {
-            return new Response(true);
-        }
+		if (isset($responseData['success']) && $responseData['success'] == true) {
+			return new Response(true);
+		}
 
-        if (isset($responseData['error-codes']) && is_array($responseData['error-codes'])) {
-            return new Response(false, $responseData['error-codes']);
-        }
+		if (isset($responseData['error-codes']) && is_array($responseData['error-codes'])) {
+			return new Response(false, $responseData['error-codes']);
+		}
 
-        return new Response(false);
-    }
+		return new Response(false);
+	}
 
-    /**
-     * Constructor.
-     *
-     * @param boolean $success
-     * @param array   $errorCodes
-     */
-    public function __construct($success, array $errorCodes = array())
-    {
-        $this->success = $success;
-        $this->errorCodes = $errorCodes;
-    }
+	/**
+	 * Constructor.
+	 *
+	 * @param boolean $success
+	 * @param array   $errorCodes
+	 */
+	public function __construct($success, array $errorCodes = array())
+	{
+		$this->success = $success;
+		$this->errorCodes = $errorCodes;
+	}
 
-    /**
-     * Is success?
-     *
-     * @return boolean
-     */
-    public function isSuccess()
-    {
-        return $this->success;
-    }
+	/**
+	 * Is success?
+	 *
+	 * @return boolean
+	 */
+	public function isSuccess()
+	{
+		return $this->success;
+	}
 
-    /**
-     * Get error codes.
-     *
-     * @return array
-     */
-    public function getErrorCodes()
-    {
-        return $this->errorCodes;
-    }
+	/**
+	 * Get error codes.
+	 *
+	 * @return array
+	 */
+	public function getErrorCodes()
+	{
+		return $this->errorCodes;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -52,7 +52,7 @@
     {
         $responseData = json_decode($json, true);
 
-        if (! $responseData) {
+        if ( ! $responseData) {
             return new Response(false, array('invalid-json'));
         }
 

core/exceptions/ExceptionStackTraceDisplay.php

Indentation +285 added lines, -285 removed lines

@@ -19,52 +19,52 @@ 
 {
 
 
-    /**
-     * @param Exception $exception
-     * @throws Exception
-     */
-    public function __construct(Exception $exception)
-    {
-        if (WP_DEBUG && ! defined('EE_TESTS_DIR')) {
-            $this->displayException($exception);
-        } else {
-            throw $exception;
-        }
-    }
+	/**
+	 * @param Exception $exception
+	 * @throws Exception
+	 */
+	public function __construct(Exception $exception)
+	{
+		if (WP_DEBUG && ! defined('EE_TESTS_DIR')) {
+			$this->displayException($exception);
+		} else {
+			throw $exception;
+		}
+	}
 
 
-    /**
-     * @access protected
-     * @param Exception $exception
-     * @throws ReflectionException
-     */
-    protected function displayException(Exception $exception)
-    {
-        $error_code = '';
-        $trace_details = '';
-        $time = time();
-        $trace = $exception->getTrace();
-        // get separate user and developer messages if they exist
-        $msg = explode('||', $exception->getMessage());
-        $user_msg = $msg[0];
-        $dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
-        $msg = WP_DEBUG ? $dev_msg : $user_msg;
-        // start gathering output
-        $output = $this->exceptionStyles();
-        $output .= '
+	/**
+	 * @access protected
+	 * @param Exception $exception
+	 * @throws ReflectionException
+	 */
+	protected function displayException(Exception $exception)
+	{
+		$error_code = '';
+		$trace_details = '';
+		$time = time();
+		$trace = $exception->getTrace();
+		// get separate user and developer messages if they exist
+		$msg = explode('||', $exception->getMessage());
+		$user_msg = $msg[0];
+		$dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
+		$msg = WP_DEBUG ? $dev_msg : $user_msg;
+		// start gathering output
+		$output = $this->exceptionStyles();
+		$output .= '
 <div id="ee-error-message" class="error">';
-        if (! WP_DEBUG) {
-            $output .= '
+		if (! WP_DEBUG) {
+			$output .= '
 	<p>';
-        }
-        // process trace info
-        if (empty($trace)) {
-            $trace_details .= __(
-                'Sorry, but no trace information was available for this exception.',
-                'event_espresso'
-            );
-        } else {
-            $trace_details .= '
+		}
+		// process trace info
+		if (empty($trace)) {
+			$trace_details .= __(
+				'Sorry, but no trace information was available for this exception.',
+				'event_espresso'
+			);
+		} else {
+			$trace_details .= '
 			<div id="ee-trace-details">
 			<table width="100%" border="0" cellpadding="5" cellspacing="0">
 				<tr>
@@ -72,263 +72,263 @@ 
 					<th scope="col" align="right" style="width:3.5%;">Line</th>
 					<th scope="col" align="left" style="width:40%;">File</th>
 					<th scope="col" align="left">' . __('Class', 'event_espresso') . '->'
-                              . __(
-                                  'Method( arguments )',
-                                  'event_espresso'
-                              ) . '</th>
+							  . __(
+								  'Method( arguments )',
+								  'event_espresso'
+							  ) . '</th>
 				</tr>';
-            $last_on_stack = count($trace) - 1;
-            // reverse array so that stack is in proper chronological order
-            $sorted_trace = array_reverse($trace);
-            foreach ($sorted_trace as $nmbr => $trace) {
-                $file = isset($trace['file']) ? $trace['file'] : '';
-                $class = isset($trace['class']) ? $trace['class'] : '';
-                $type = isset($trace['type']) ? $trace['type'] : '';
-                $function = isset($trace['function']) ? $trace['function'] : '';
-                $args = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
-                $args = isset($trace['args']) && count($trace['args']) > 4 ? ' <br />' . $args . '<br />' : $args;
-                $line = isset($trace['line']) ? $trace['line'] : '';
-                $zebra = $nmbr % 2 !== 0 ? ' odd' : '';
-                if (empty($file) && ! empty($class)) {
-                    $a = new ReflectionClass($class);
-                    $file = $a->getFileName();
-                    if (empty($line) && ! empty($function)) {
-                        try {
-                            // if $function is a closure, this throws an exception
-                            $b = new ReflectionMethod($class, $function);
-                            $line = $b->getStartLine();
-                        } catch (Exception $closure_exception) {
-                            $line = 'unknown';
-                        }
-                    }
-                }
-                if ($nmbr === $last_on_stack) {
-                    $file = $exception->getFile() !== '' ? $exception->getFile() : $file;
-                    $line = $exception->getLine() !== '' ? $exception->getLine() : $line;
-                    $error_code = $this->generate_error_code($file, $trace['function'], $line);
-                }
-                $file = \EEH_File::standardise_directory_separators($file);
-                $nmbr = ! empty($nmbr) ? $nmbr : '&nbsp;';
-                $line = ! empty($line) ? $line : '&nbsp;';
-                $file = ! empty($file) ? $file : '&nbsp;';
-                $class_display = ! empty($class) ? $class : '';
-                $type = ! empty($type) ? $type : '';
-                $function = ! empty($function) ? $function : '';
-                $args = ! empty($args) ? '( ' . $args . ' )' : '()';
-                $trace_details .= '
+			$last_on_stack = count($trace) - 1;
+			// reverse array so that stack is in proper chronological order
+			$sorted_trace = array_reverse($trace);
+			foreach ($sorted_trace as $nmbr => $trace) {
+				$file = isset($trace['file']) ? $trace['file'] : '';
+				$class = isset($trace['class']) ? $trace['class'] : '';
+				$type = isset($trace['type']) ? $trace['type'] : '';
+				$function = isset($trace['function']) ? $trace['function'] : '';
+				$args = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
+				$args = isset($trace['args']) && count($trace['args']) > 4 ? ' <br />' . $args . '<br />' : $args;
+				$line = isset($trace['line']) ? $trace['line'] : '';
+				$zebra = $nmbr % 2 !== 0 ? ' odd' : '';
+				if (empty($file) && ! empty($class)) {
+					$a = new ReflectionClass($class);
+					$file = $a->getFileName();
+					if (empty($line) && ! empty($function)) {
+						try {
+							// if $function is a closure, this throws an exception
+							$b = new ReflectionMethod($class, $function);
+							$line = $b->getStartLine();
+						} catch (Exception $closure_exception) {
+							$line = 'unknown';
+						}
+					}
+				}
+				if ($nmbr === $last_on_stack) {
+					$file = $exception->getFile() !== '' ? $exception->getFile() : $file;
+					$line = $exception->getLine() !== '' ? $exception->getLine() : $line;
+					$error_code = $this->generate_error_code($file, $trace['function'], $line);
+				}
+				$file = \EEH_File::standardise_directory_separators($file);
+				$nmbr = ! empty($nmbr) ? $nmbr : '&nbsp;';
+				$line = ! empty($line) ? $line : '&nbsp;';
+				$file = ! empty($file) ? $file : '&nbsp;';
+				$class_display = ! empty($class) ? $class : '';
+				$type = ! empty($type) ? $type : '';
+				$function = ! empty($function) ? $function : '';
+				$args = ! empty($args) ? '( ' . $args . ' )' : '()';
+				$trace_details .= '
 					<tr>
 						<td align="right" valign="top" class="'
-                                  . $zebra
-                                  . '">'
-                                  . $nmbr
-                                  . '</td>
+								  . $zebra
+								  . '">'
+								  . $nmbr
+								  . '</td>
 						<td align="right" valign="top" class="'
-                                  . $zebra
-                                  . '">'
-                                  . $line
-                                  . '</td>
+								  . $zebra
+								  . '">'
+								  . $line
+								  . '</td>
 						<td align="left" valign="top" class="'
-                                  . $zebra
-                                  . '">'
-                                  . $file
-                                  . '</td>
+								  . $zebra
+								  . '">'
+								  . $file
+								  . '</td>
 						<td align="left" valign="top" class="'
-                                  . $zebra
-                                  . '">'
-                                  . $class_display
-                                  . $type
-                                  . $function
-                                  . $args
-                                  . '</td>
+								  . $zebra
+								  . '">'
+								  . $class_display
+								  . $type
+								  . $function
+								  . $args
+								  . '</td>
 					</tr>';
-            }
-            $trace_details .= '
+			}
+			$trace_details .= '
 			 </table>
 			</div>';
-        }
-        $code = $exception->getCode() ? $exception->getCode() : $error_code;
-        // add generic non-identifying messages for non-privileged users
-        if (! WP_DEBUG) {
-            $output .= '<span class="ee-error-user-msg-spn">'
-                       . trim($msg)
-                       . '</span> &nbsp; <sup>'
-                       . $code
-                       . '</sup><br />';
-        } else {
-            // or helpful developer messages if debugging is on
-            $output .= '
+		}
+		$code = $exception->getCode() ? $exception->getCode() : $error_code;
+		// add generic non-identifying messages for non-privileged users
+		if (! WP_DEBUG) {
+			$output .= '<span class="ee-error-user-msg-spn">'
+					   . trim($msg)
+					   . '</span> &nbsp; <sup>'
+					   . $code
+					   . '</sup><br />';
+		} else {
+			// or helpful developer messages if debugging is on
+			$output .= '
 		<div class="ee-error-dev-msg-dv">
 			<p class="ee-error-dev-msg-pg">
 				'
-                       . sprintf(
-                           __('%1$sAn %2$s was thrown!%3$s code: %4$s', 'event_espresso'),
-                           '<strong class="ee-error-dev-msg-str">',
-                           get_class($exception),
-                           '</strong>  &nbsp; <span>',
-                           $code . '</span>'
-                       )
-                       . '<br />
+					   . sprintf(
+						   __('%1$sAn %2$s was thrown!%3$s code: %4$s', 'event_espresso'),
+						   '<strong class="ee-error-dev-msg-str">',
+						   get_class($exception),
+						   '</strong>  &nbsp; <span>',
+						   $code . '</span>'
+					   )
+					   . '<br />
 				<span class="big-text">"'
-                       . trim($msg)
-                       . '"</span><br/>
+					   . trim($msg)
+					   . '"</span><br/>
 				<a id="display-ee-error-trace-1'
-                       . $time
-                       . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-1'
-                       . $time
-                       . '">
+					   . $time
+					   . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-1'
+					   . $time
+					   . '">
 					'
-                       . __('click to view backtrace and class/method details', 'event_espresso')
-                       . '
+					   . __('click to view backtrace and class/method details', 'event_espresso')
+					   . '
 				</a><br />
 				'
-                       . $exception->getFile()
-                       . sprintf(
-                           __('%1$s( line no: %2$s )%3$s', 'event_espresso'),
-                           ' &nbsp; <span class="small-text lt-grey-text">',
-                           $exception->getLine(),
-                           '</span>'
-                       )
-                       . '
+					   . $exception->getFile()
+					   . sprintf(
+						   __('%1$s( line no: %2$s )%3$s', 'event_espresso'),
+						   ' &nbsp; <span class="small-text lt-grey-text">',
+						   $exception->getLine(),
+						   '</span>'
+					   )
+					   . '
 			</p>
 			<div id="ee-error-trace-1'
-                       . $time
-                       . '-dv" class="ee-error-trace-dv" style="display: none;">
+					   . $time
+					   . '-dv" class="ee-error-trace-dv" style="display: none;">
 				'
-                       . $trace_details;
-            if (! empty($class)) {
-                $output .= '
+					   . $trace_details;
+			if (! empty($class)) {
+				$output .= '
 				<div style="padding:3px; margin:0 0 1em; border:1px solid #999; background:#fff; border-radius:3px;">
 					<div style="padding:1em 2em; border:1px solid #999; background:#fcfcfc;">
 						<h3>' . __('Class Details', 'event_espresso') . '</h3>';
-                $a = new ReflectionClass($class);
-                $output .= '
+				$a = new ReflectionClass($class);
+				$output .= '
 						<pre>' . $a . '</pre>
 					</div>
 				</div>';
-            }
-            $output .= '
+			}
+			$output .= '
 			</div>
 		</div>
 		<br />';
-        }
-        // remove last linebreak
-        $output = substr($output, 0, -6);
-        if (! WP_DEBUG) {
-            $output .= '
+		}
+		// remove last linebreak
+		$output = substr($output, 0, -6);
+		if (! WP_DEBUG) {
+			$output .= '
 	</p>';
-        }
-        $output .= '
+		}
+		$output .= '
 </div>';
-        $output .= $this->printScripts(true);
-        if (defined('DOING_AJAX')) {
-            echo wp_json_encode(array('error' => $output));
-            exit();
-        }
-        echo $output;
-    }
+		$output .= $this->printScripts(true);
+		if (defined('DOING_AJAX')) {
+			echo wp_json_encode(array('error' => $output));
+			exit();
+		}
+		echo $output;
+	}
 
 
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    // phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	// phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
 
-    /**
-     * generate string from exception trace args
-     *
-     * @param array $arguments
-     * @param int   $indent
-     * @param bool  $array
-     * @return string
-     */
-    private function _convert_args_to_string($arguments = array(), $indent = 0, $array = false)
-    {
-        $args = array();
-        $args_count = count($arguments);
-        if ($args_count > 2) {
-            $indent++;
-            $args[] = '<br />';
-        }
-        $x = 0;
-        foreach ($arguments as $arg) {
-            $x++;
-            for ($i = 0; $i < $indent; $i++) {
-                $args[] = ' &nbsp;&nbsp; ';
-            }
-            if (is_string($arg)) {
-                if (! $array && strlen($arg) > 75) {
-                    $args[] = '<br />';
-                    for ($i = 0; $i <= $indent; $i++) {
-                        $args[] = ' &nbsp;&nbsp; ';
-                    }
-                    $args[] = "'" . $arg . "'<br />";
-                } else {
-                    $args[] = " '" . $arg . "'";
-                }
-            } elseif (is_array($arg)) {
-                $arg_count = count($arg);
-                if ($arg_count > 2) {
-                    $indent++;
-                    $args[] = ' array(' . $this->_convert_args_to_string($arg, $indent, true) . ')';
-                    $indent--;
-                } elseif ($arg_count === 0) {
-                    $args[] = ' array()';
-                } else {
-                    $args[] = ' array( ' . $this->_convert_args_to_string($arg) . ' )';
-                }
-            } elseif ($arg === null) {
-                $args[] = ' null';
-            } elseif (is_bool($arg)) {
-                $args[] = $arg ? ' true' : ' false';
-            } elseif (is_object($arg)) {
-                $args[] = get_class($arg);
-            } elseif (is_resource($arg)) {
-                $args[] = get_resource_type($arg);
-            } else {
-                $args[] = $arg;
-            }
-            if ($x === $args_count) {
-                if ($args_count > 2) {
-                    $args[] = '<br />';
-                    $indent--;
-                    for ($i = 1; $i < $indent; $i++) {
-                        $args[] = ' &nbsp;&nbsp; ';
-                    }
-                }
-            } else {
-                $args[] = $args_count > 2 ? ',<br />' : ', ';
-            }
-        }
-        return implode('', $args);
-    }
+	/**
+	 * generate string from exception trace args
+	 *
+	 * @param array $arguments
+	 * @param int   $indent
+	 * @param bool  $array
+	 * @return string
+	 */
+	private function _convert_args_to_string($arguments = array(), $indent = 0, $array = false)
+	{
+		$args = array();
+		$args_count = count($arguments);
+		if ($args_count > 2) {
+			$indent++;
+			$args[] = '<br />';
+		}
+		$x = 0;
+		foreach ($arguments as $arg) {
+			$x++;
+			for ($i = 0; $i < $indent; $i++) {
+				$args[] = ' &nbsp;&nbsp; ';
+			}
+			if (is_string($arg)) {
+				if (! $array && strlen($arg) > 75) {
+					$args[] = '<br />';
+					for ($i = 0; $i <= $indent; $i++) {
+						$args[] = ' &nbsp;&nbsp; ';
+					}
+					$args[] = "'" . $arg . "'<br />";
+				} else {
+					$args[] = " '" . $arg . "'";
+				}
+			} elseif (is_array($arg)) {
+				$arg_count = count($arg);
+				if ($arg_count > 2) {
+					$indent++;
+					$args[] = ' array(' . $this->_convert_args_to_string($arg, $indent, true) . ')';
+					$indent--;
+				} elseif ($arg_count === 0) {
+					$args[] = ' array()';
+				} else {
+					$args[] = ' array( ' . $this->_convert_args_to_string($arg) . ' )';
+				}
+			} elseif ($arg === null) {
+				$args[] = ' null';
+			} elseif (is_bool($arg)) {
+				$args[] = $arg ? ' true' : ' false';
+			} elseif (is_object($arg)) {
+				$args[] = get_class($arg);
+			} elseif (is_resource($arg)) {
+				$args[] = get_resource_type($arg);
+			} else {
+				$args[] = $arg;
+			}
+			if ($x === $args_count) {
+				if ($args_count > 2) {
+					$args[] = '<br />';
+					$indent--;
+					for ($i = 1; $i < $indent; $i++) {
+						$args[] = ' &nbsp;&nbsp; ';
+					}
+				}
+			} else {
+				$args[] = $args_count > 2 ? ',<br />' : ', ';
+			}
+		}
+		return implode('', $args);
+	}
 
 
-    /**
-     * create error code from filepath, function name,
-     * and line number where exception or error was thrown
-     *
-     * @access protected
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     * @return string
-     */
-    protected function generate_error_code($file = '', $func = '', $line = '')
-    {
-        $file_bits = explode('.', basename($file));
-        $error_code = ! empty($file_bits[0]) ? $file_bits[0] : '';
-        $error_code .= ! empty($func) ? ' - ' . $func : '';
-        $error_code .= ! empty($line) ? ' - ' . $line : '';
-        return $error_code;
-    }
+	/**
+	 * create error code from filepath, function name,
+	 * and line number where exception or error was thrown
+	 *
+	 * @access protected
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 * @return string
+	 */
+	protected function generate_error_code($file = '', $func = '', $line = '')
+	{
+		$file_bits = explode('.', basename($file));
+		$error_code = ! empty($file_bits[0]) ? $file_bits[0] : '';
+		$error_code .= ! empty($func) ? ' - ' . $func : '';
+		$error_code .= ! empty($line) ? ' - ' . $line : '';
+		return $error_code;
+	}
 
 
-    /**
-     * _exception_styles
-     *
-     * @return string
-     */
-    private function exceptionStyles()
-    {
-        return '
+	/**
+	 * _exception_styles
+	 *
+	 * @return string
+	 */
+	private function exceptionStyles()
+	{
+		return '
 <style type="text/css">
 	#ee-error-message {
 		max-width:90% !important;
@@ -385,29 +385,29 @@ 
 		color: #999;
 	}
 </style>';
-    }
+	}
 
 
-    /**
-     * _print_scripts
-     *
-     * @param bool $force_print
-     * @return string
-     */
-    private function printScripts($force_print = false)
-    {
-        if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
-            if (wp_script_is('ee_error_js', 'enqueued')) {
-                return '';
-            }
-            if (wp_script_is('ee_error_js', 'registered')) {
-                wp_enqueue_style('espresso_default');
-                wp_enqueue_style('espresso_custom_css');
-                wp_enqueue_script('ee_error_js');
-                wp_localize_script('ee_error_js', 'ee_settings', array('wp_debug' => WP_DEBUG));
-            }
-        } else {
-            return '
+	/**
+	 * _print_scripts
+	 *
+	 * @param bool $force_print
+	 * @return string
+	 */
+	private function printScripts($force_print = false)
+	{
+		if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
+			if (wp_script_is('ee_error_js', 'enqueued')) {
+				return '';
+			}
+			if (wp_script_is('ee_error_js', 'registered')) {
+				wp_enqueue_style('espresso_default');
+				wp_enqueue_style('espresso_custom_css');
+				wp_enqueue_script('ee_error_js');
+				wp_localize_script('ee_error_js', 'ee_settings', array('wp_debug' => WP_DEBUG));
+			}
+		} else {
+			return '
 <script>
 /* <![CDATA[ */
 var ee_settings = {"wp_debug":"' . WP_DEBUG . '"};
@@ -417,7 +417,7 @@ 
 <script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
 <script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
 ';
-        }
-        return '';
-    }
+		}
+		return '';
+	}
 }

Spacing +23 added lines, -23 removed lines

@@ -53,7 +53,7 @@ 
         $output = $this->exceptionStyles();
         $output .= '
 <div id="ee-error-message" class="error">';
-        if (! WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             $output .= '
 	<p>';
         }
@@ -71,11 +71,11 @@ 
 					<th scope="col" align="right" style="width:2.5%;">#</th>
 					<th scope="col" align="right" style="width:3.5%;">Line</th>
 					<th scope="col" align="left" style="width:40%;">File</th>
-					<th scope="col" align="left">' . __('Class', 'event_espresso') . '->'
+					<th scope="col" align="left">' . __('Class', 'event_espresso').'->'
                               . __(
                                   'Method( arguments )',
                                   'event_espresso'
-                              ) . '</th>
+                              ).'</th>
 				</tr>';
             $last_on_stack = count($trace) - 1;
             // reverse array so that stack is in proper chronological order
@@ -86,7 +86,7 @@ 
                 $type = isset($trace['type']) ? $trace['type'] : '';
                 $function = isset($trace['function']) ? $trace['function'] : '';
                 $args = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
-                $args = isset($trace['args']) && count($trace['args']) > 4 ? ' <br />' . $args . '<br />' : $args;
+                $args = isset($trace['args']) && count($trace['args']) > 4 ? ' <br />'.$args.'<br />' : $args;
                 $line = isset($trace['line']) ? $trace['line'] : '';
                 $zebra = $nmbr % 2 !== 0 ? ' odd' : '';
                 if (empty($file) && ! empty($class)) {
@@ -114,7 +114,7 @@ 
                 $class_display = ! empty($class) ? $class : '';
                 $type = ! empty($type) ? $type : '';
                 $function = ! empty($function) ? $function : '';
-                $args = ! empty($args) ? '( ' . $args . ' )' : '()';
+                $args = ! empty($args) ? '( '.$args.' )' : '()';
                 $trace_details .= '
 					<tr>
 						<td align="right" valign="top" class="'
@@ -148,7 +148,7 @@ 
         }
         $code = $exception->getCode() ? $exception->getCode() : $error_code;
         // add generic non-identifying messages for non-privileged users
-        if (! WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             $output .= '<span class="ee-error-user-msg-spn">'
                        . trim($msg)
                        . '</span> &nbsp; <sup>'
@@ -165,7 +165,7 @@ 
                            '<strong class="ee-error-dev-msg-str">',
                            get_class($exception),
                            '</strong>  &nbsp; <span>',
-                           $code . '</span>'
+                           $code.'</span>'
                        )
                        . '<br />
 				<span class="big-text">"'
@@ -195,14 +195,14 @@ 
                        . '-dv" class="ee-error-trace-dv" style="display: none;">
 				'
                        . $trace_details;
-            if (! empty($class)) {
+            if ( ! empty($class)) {
                 $output .= '
 				<div style="padding:3px; margin:0 0 1em; border:1px solid #999; background:#fff; border-radius:3px;">
 					<div style="padding:1em 2em; border:1px solid #999; background:#fcfcfc;">
-						<h3>' . __('Class Details', 'event_espresso') . '</h3>';
+						<h3>' . __('Class Details', 'event_espresso').'</h3>';
                 $a = new ReflectionClass($class);
                 $output .= '
-						<pre>' . $a . '</pre>
+						<pre>' . $a.'</pre>
 					</div>
 				</div>';
             }
@@ -213,7 +213,7 @@ 
         }
         // remove last linebreak
         $output = substr($output, 0, -6);
-        if (! WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             $output .= '
 	</p>';
         }
@@ -254,25 +254,25 @@ 
                 $args[] = ' &nbsp;&nbsp; ';
             }
             if (is_string($arg)) {
-                if (! $array && strlen($arg) > 75) {
+                if ( ! $array && strlen($arg) > 75) {
                     $args[] = '<br />';
                     for ($i = 0; $i <= $indent; $i++) {
                         $args[] = ' &nbsp;&nbsp; ';
                     }
-                    $args[] = "'" . $arg . "'<br />";
+                    $args[] = "'".$arg."'<br />";
                 } else {
-                    $args[] = " '" . $arg . "'";
+                    $args[] = " '".$arg."'";
                 }
             } elseif (is_array($arg)) {
                 $arg_count = count($arg);
                 if ($arg_count > 2) {
                     $indent++;
-                    $args[] = ' array(' . $this->_convert_args_to_string($arg, $indent, true) . ')';
+                    $args[] = ' array('.$this->_convert_args_to_string($arg, $indent, true).')';
                     $indent--;
                 } elseif ($arg_count === 0) {
                     $args[] = ' array()';
                 } else {
-                    $args[] = ' array( ' . $this->_convert_args_to_string($arg) . ' )';
+                    $args[] = ' array( '.$this->_convert_args_to_string($arg).' )';
                 }
             } elseif ($arg === null) {
                 $args[] = ' null';
@@ -315,8 +315,8 @@ 
     {
         $file_bits = explode('.', basename($file));
         $error_code = ! empty($file_bits[0]) ? $file_bits[0] : '';
-        $error_code .= ! empty($func) ? ' - ' . $func : '';
-        $error_code .= ! empty($line) ? ' - ' . $line : '';
+        $error_code .= ! empty($func) ? ' - '.$func : '';
+        $error_code .= ! empty($line) ? ' - '.$line : '';
         return $error_code;
     }
 
@@ -396,7 +396,7 @@ 
      */
     private function printScripts($force_print = false)
     {
-        if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
+        if ( ! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
             if (wp_script_is('ee_error_js', 'enqueued')) {
                 return '';
             }
@@ -410,12 +410,12 @@ 
             return '
 <script>
 /* <![CDATA[ */
-var ee_settings = {"wp_debug":"' . WP_DEBUG . '"};
+var ee_settings = {"wp_debug":"' . WP_DEBUG.'"};
 /* ]]> */
 </script>
-<script src="' . includes_url() . 'js/jquery/jquery.js" type="text/javascript"></script>
-<script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
-<script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
+<script src="' . includes_url().'js/jquery/jquery.js" type="text/javascript"></script>
+<script src="' . EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js'.'?ver='.espresso_version().'" type="text/javascript"></script>
+<script src="' . EE_GLOBAL_ASSETS_URL.'scripts/EE_Error.js'.'?ver='.espresso_version().'" type="text/javascript"></script>
 ';
         }
         return '';

core/services/cache/PostRelatedCacheManager.php

Indentation +117 added lines, -117 removed lines

@@ -13,121 +13,121 @@
 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
-     */
-    public function __construct(CacheStorageInterface $cache_storage)
-    {
-        parent::__construct($cache_storage);
-        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;
-    }
-
-
-    /**
-     * @return array
-     */
-    protected function getPostRelatedCache()
-    {
-        $post_related_cache = get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
-        // verify that cached data was not truncated or corrupted and no longer an array
-        if (! is_array($post_related_cache)) {
-            // uh-oh... let's get rid of any transients using our cache prefix
-            $this->clear(PostRelatedCacheManager::CACHE_PREFIX);
-            // then update the post related cache tracking option
-            $post_related_cache = array();
-            $this->updatePostRelatedCache($post_related_cache);
-        }
-        return $post_related_cache;
-    }
-
-
-    /**
-     * @param array $post_related_cache
-     */
-    protected function updatePostRelatedCache(array $post_related_cache = array())
-    {
-        update_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, $post_related_cache);
-    }
-
-
-    /**
-     * 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 = $this->getPostRelatedCache();
-        // 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();
-        }
-        if (! in_array($id_prefix, $post_related_cache[ $post_ID ], true)) {
-            // add cache id to be tracked
-            $post_related_cache[ $post_ID ][] = $id_prefix;
-            $this->updatePostRelatedCache($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 = $this->getPostRelatedCache();
-        // if post is not being tracked
-        if (! isset($post_related_cache[ $post_ID ])) {
-            // let's clean up some of the duplicate IDs that were getting added
-            foreach ($post_related_cache as $other_post_ID => $cache_IDs) {
-                // remove duplicates
-                $post_related_cache[ $other_post_ID ] = array_unique($post_related_cache[ $other_post_ID ]);
-            }
-            $this->updatePostRelatedCache($post_related_cache);
-            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 ]);
-        $this->updatePostRelatedCache($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
+	 */
+	public function __construct(CacheStorageInterface $cache_storage)
+	{
+		parent::__construct($cache_storage);
+		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;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	protected function getPostRelatedCache()
+	{
+		$post_related_cache = get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
+		// verify that cached data was not truncated or corrupted and no longer an array
+		if (! is_array($post_related_cache)) {
+			// uh-oh... let's get rid of any transients using our cache prefix
+			$this->clear(PostRelatedCacheManager::CACHE_PREFIX);
+			// then update the post related cache tracking option
+			$post_related_cache = array();
+			$this->updatePostRelatedCache($post_related_cache);
+		}
+		return $post_related_cache;
+	}
+
+
+	/**
+	 * @param array $post_related_cache
+	 */
+	protected function updatePostRelatedCache(array $post_related_cache = array())
+	{
+		update_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, $post_related_cache);
+	}
+
+
+	/**
+	 * 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 = $this->getPostRelatedCache();
+		// 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();
+		}
+		if (! in_array($id_prefix, $post_related_cache[ $post_ID ], true)) {
+			// add cache id to be tracked
+			$post_related_cache[ $post_ID ][] = $id_prefix;
+			$this->updatePostRelatedCache($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 = $this->getPostRelatedCache();
+		// if post is not being tracked
+		if (! isset($post_related_cache[ $post_ID ])) {
+			// let's clean up some of the duplicate IDs that were getting added
+			foreach ($post_related_cache as $other_post_ID => $cache_IDs) {
+				// remove duplicates
+				$post_related_cache[ $other_post_ID ] = array_unique($post_related_cache[ $other_post_ID ]);
+			}
+			$this->updatePostRelatedCache($post_related_cache);
+			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 ]);
+		$this->updatePostRelatedCache($post_related_cache);
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -56,7 +56,7 @@ 
     {
         $post_related_cache = get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
         // verify that cached data was not truncated or corrupted and no longer an array
-        if (! is_array($post_related_cache)) {
+        if ( ! is_array($post_related_cache)) {
             // uh-oh... let's get rid of any transients using our cache prefix
             $this->clear(PostRelatedCacheManager::CACHE_PREFIX);
             // then update the post related cache tracking option
@@ -94,13 +94,13 @@ 
     {
         $post_related_cache = $this->getPostRelatedCache();
         // if post is not already being tracked
-        if (! isset($post_related_cache[ $post_ID ])) {
+        if ( ! isset($post_related_cache[$post_ID])) {
             // add array to add cache ids to
-            $post_related_cache[ $post_ID ] = array();
+            $post_related_cache[$post_ID] = array();
         }
-        if (! in_array($id_prefix, $post_related_cache[ $post_ID ], true)) {
+        if ( ! in_array($id_prefix, $post_related_cache[$post_ID], true)) {
             // add cache id to be tracked
-            $post_related_cache[ $post_ID ][] = $id_prefix;
+            $post_related_cache[$post_ID][] = $id_prefix;
             $this->updatePostRelatedCache($post_related_cache);
         }
     }
@@ -116,18 +116,18 @@ 
     {
         $post_related_cache = $this->getPostRelatedCache();
         // if post is not being tracked
-        if (! isset($post_related_cache[ $post_ID ])) {
+        if ( ! isset($post_related_cache[$post_ID])) {
             // let's clean up some of the duplicate IDs that were getting added
             foreach ($post_related_cache as $other_post_ID => $cache_IDs) {
                 // remove duplicates
-                $post_related_cache[ $other_post_ID ] = array_unique($post_related_cache[ $other_post_ID ]);
+                $post_related_cache[$other_post_ID] = array_unique($post_related_cache[$other_post_ID]);
             }
             $this->updatePostRelatedCache($post_related_cache);
             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 ]);
+        $this->clear($post_related_cache[$post_ID]);
+        unset($post_related_cache[$post_ID]);
         $this->updatePostRelatedCache($post_related_cache);
     }
 }

core/services/cache/TransientCacheStorage.php

Indentation +362 added lines, -362 removed lines

@@ -16,366 +16,366 @@
 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;
-
-    /**
-     * how often to perform transient cleanup
-     *
-     * @var string $transient_cleanup_frequency
-     */
-    private $transient_cleanup_frequency;
-
-    /**
-     * 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;
-
-
-    /**
-     * 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 string
-     */
-    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 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 = (int) 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)
-    {
-        if (isset($this->transients[ $transient_key ])) {
-            // 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
-                && $this->transients[ $transient_key ] - time() <= MINUTE_IN_SECONDS
-            ) {
-                unset($this->transients[ $transient_key ]);
-                $this->updateTransients();
-                return null;
-            }
-
-            // for non standard cache items, remove the key from our tracking,
-            // but proceed to retrieve the transient so that it also gets removed from the db
-            if ($this->transients[ $transient_key ] <= time()) {
-                unset($this->transients[ $transient_key ]);
-                $this->updateTransients();
-            }
-        }
-
-        $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
-     * @param bool  $force_delete   [optional] if true, then will not check incoming keys against those being tracked
-     *                              and proceed directly to deleting those entries from the cache storage
-     */
-    public function deleteMany(array $transient_keys, $force_delete = false)
-    {
-        $full_transient_keys = $force_delete ? $transient_keys : array();
-        if (empty($full_transient_keys)) {
-            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;
-            }
-            // remove any transient prefixes
-            $transient_key = strpos($transient_key, '_transient_timeout_') === 0
-                ? str_replace('_transient_timeout_', '', $transient_key)
-                : $transient_key;
-            $transient_key = strpos($transient_key, '_transient_') === 0
-                ? str_replace('_transient_', '', $transient_key)
-                : $transient_key;
-            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;
+
+	/**
+	 * how often to perform transient cleanup
+	 *
+	 * @var string $transient_cleanup_frequency
+	 */
+	private $transient_cleanup_frequency;
+
+	/**
+	 * 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;
+
+
+	/**
+	 * 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 string
+	 */
+	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 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 = (int) 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)
+	{
+		if (isset($this->transients[ $transient_key ])) {
+			// 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
+				&& $this->transients[ $transient_key ] - time() <= MINUTE_IN_SECONDS
+			) {
+				unset($this->transients[ $transient_key ]);
+				$this->updateTransients();
+				return null;
+			}
+
+			// for non standard cache items, remove the key from our tracking,
+			// but proceed to retrieve the transient so that it also gets removed from the db
+			if ($this->transients[ $transient_key ] <= time()) {
+				unset($this->transients[ $transient_key ]);
+				$this->updateTransients();
+			}
+		}
+
+		$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
+	 * @param bool  $force_delete   [optional] if true, then will not check incoming keys against those being tracked
+	 *                              and proceed directly to deleting those entries from the cache storage
+	 */
+	public function deleteMany(array $transient_keys, $force_delete = false)
+	{
+		$full_transient_keys = $force_delete ? $transient_keys : array();
+		if (empty($full_transient_keys)) {
+			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;
+			}
+			// remove any transient prefixes
+			$transient_key = strpos($transient_key, '_transient_timeout_') === 0
+				? str_replace('_transient_timeout_', '', $transient_key)
+				: $transient_key;
+			$transient_key = strpos($transient_key, '_transient_') === 0
+				? str_replace('_transient_', '', $transient_key)
+				: $transient_key;
+			delete_transient($transient_key);
+			unset($this->transients[ $transient_key ]);
+			$counter++;
+		}
+		return $counter > 0;
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -57,7 +57,7 @@ 
         // 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') {
+        if ( ! (defined('DOING_AJAX') && DOING_AJAX) && $this->transient_cleanup_frequency !== 'off') {
             add_action('shutdown', array($this, 'checkTransientCleanupSchedule'), 999);
         }
     }
@@ -190,7 +190,7 @@ 
      */
     public function get($transient_key, $standard_cache = true)
     {
-        if (isset($this->transients[ $transient_key ])) {
+        if (isset($this->transients[$transient_key])) {
             // 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.
@@ -198,17 +198,17 @@ 
             // while allowing any following requests to still access the existing cache
             // until it gets replaced with the refreshed content
             if ($standard_cache
-                && $this->transients[ $transient_key ] - time() <= MINUTE_IN_SECONDS
+                && $this->transients[$transient_key] - time() <= MINUTE_IN_SECONDS
             ) {
-                unset($this->transients[ $transient_key ]);
+                unset($this->transients[$transient_key]);
                 $this->updateTransients();
                 return null;
             }
 
             // for non standard cache items, remove the key from our tracking,
             // but proceed to retrieve the transient so that it also gets removed from the db
-            if ($this->transients[ $transient_key ] <= time()) {
-                unset($this->transients[ $transient_key ]);
+            if ($this->transients[$transient_key] <= time()) {
+                unset($this->transients[$transient_key]);
                 $this->updateTransients();
             }
         }
@@ -281,7 +281,7 @@ 
         // 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->transients[$transient_key] = $expiration;
         $this->updateTransients();
     }
 
@@ -333,8 +333,8 @@ 
                 if ($expiration > $this->current_time) {
                     continue;
                 }
-                if (! $expiration || ! $transient_key) {
-                    unset($this->transients[ $transient_key ]);
+                if ( ! $expiration || ! $transient_key) {
+                    unset($this->transients[$transient_key]);
                     $update = true;
                     continue;
                 }
@@ -373,7 +373,7 @@ 
                 ? str_replace('_transient_', '', $transient_key)
                 : $transient_key;
             delete_transient($transient_key);
-            unset($this->transients[ $transient_key ]);
+            unset($this->transients[$transient_key]);
             $counter++;
         }
         return $counter > 0;