eventespresso / event-espresso-core

core/EE_Session.core.php

Doc Comments +5 added lines, -5 removed lines

@@ -433,7 +433,7 @@ 
 	  * set session data
 	  * @access 	public
 	  * @param 	array $data
-	  * @return 	TRUE on success, FALSE on fail
+	  * @return 	boolean on success, FALSE on fail
 	  */
 	public function set_session_data( $data ) {
 
@@ -461,7 +461,7 @@ 
 	 /**
 	  * @initiate session
 	  * @access   private
-	  * @return TRUE on success, FALSE on fail
+	  * @return boolean on success, FALSE on fail
 	  * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
 	  * @throws \EE_Error
 	  */
@@ -681,7 +681,7 @@ 
       * @update session data  prior to saving to the db
       * @access public
       * @param bool $new_session
-      * @return TRUE on success, FALSE on fail
+      * @return boolean on success, FALSE on fail
       * @throws \EE_Error
       */
 	public function update( $new_session = FALSE ) {
@@ -787,7 +787,7 @@ 
 	  * _save_session_to_db
 	  *
 	  * @access public
-	  * @return string
+	  * @return boolean
 	  * @throws \EE_Error
 	  */
 	private function _save_session_to_db() {
@@ -959,7 +959,7 @@ 
 	  * @access public
 	  * @param array $data_to_reset
 	  * @param bool  $show_all_notices
-	  * @return TRUE on success, FALSE on fail
+	  * @return boolean on success, FALSE on fail
 	  */
 	public function reset_data( $data_to_reset = array(), $show_all_notices = FALSE ) {
 		// if $data_to_reset is not in an array, then put it in one

Indentation +293 added lines, -293 removed lines

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

Spacing +148 added lines, -148 removed lines

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

core/admin/EE_Admin.core.php

Braces +3 added lines, -1 removed lines

@@ -1,7 +1,9 @@
 <?php
 use EventEspresso\core\interfaces\InterminableInterface;
 
-if ( ! defined( 'EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
+if ( ! defined( 'EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
+}
 /**
  * Event Espresso
  *

Spacing +133 added lines, -133 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 use EventEspresso\core\interfaces\InterminableInterface;
 
-if ( ! defined( 'EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
+if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
 /**
  * Event Espresso
  *
@@ -43,7 +43,7 @@ 
 	 */
 	public static function instance() {
 		// check if class object is instantiated
-		if (  ! self::$_instance instanceof EE_Admin ) {
+		if ( ! self::$_instance instanceof EE_Admin) {
 			self::$_instance = new self();
 		}
 		return self::$_instance;
@@ -70,25 +70,25 @@ 
 		// define global EE_Admin constants
 		$this->_define_all_constants();
 		// set autoloaders for our admin page classes based on included path information
-		EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder( EE_ADMIN );
+		EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_ADMIN);
 		// admin hooks
-		add_filter( 'plugin_action_links', array( $this, 'filter_plugin_actions' ), 10, 2 );
+		add_filter('plugin_action_links', array($this, 'filter_plugin_actions'), 10, 2);
 		// load EE_Request_Handler early
-		add_action( 'AHEE__EE_System__core_loaded_and_ready', array( $this, 'get_request' ));
-		add_action( 'AHEE__EE_System__initialize_last', array( $this, 'init' ));
-		add_action( 'AHEE__EE_Admin_Page__route_admin_request', array( $this, 'route_admin_request' ), 100, 2 );
-		add_action( 'wp_loaded', array( $this, 'wp_loaded' ), 100 );
-		add_action( 'admin_init', array( $this, 'admin_init' ), 100 );
-		add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_scripts' ), 20 );
-		add_action( 'admin_notices', array( $this, 'display_admin_notices' ), 10 );
-		add_action( 'network_admin_notices', array( $this, 'display_admin_notices' ), 10 );
-		add_filter( 'pre_update_option', array( $this, 'check_for_invalid_datetime_formats' ), 100, 2 );
-		add_filter('admin_footer_text', array( $this, 'espresso_admin_footer' ));
+		add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'get_request'));
+		add_action('AHEE__EE_System__initialize_last', array($this, 'init'));
+		add_action('AHEE__EE_Admin_Page__route_admin_request', array($this, 'route_admin_request'), 100, 2);
+		add_action('wp_loaded', array($this, 'wp_loaded'), 100);
+		add_action('admin_init', array($this, 'admin_init'), 100);
+		add_action('admin_enqueue_scripts', array($this, 'enqueue_admin_scripts'), 20);
+		add_action('admin_notices', array($this, 'display_admin_notices'), 10);
+		add_action('network_admin_notices', array($this, 'display_admin_notices'), 10);
+		add_filter('pre_update_option', array($this, 'check_for_invalid_datetime_formats'), 100, 2);
+		add_filter('admin_footer_text', array($this, 'espresso_admin_footer'));
 
 		//reset Environment config (we only do this on admin page loads);
 		EE_Registry::instance()->CFG->environment->recheck_values();
 
-		do_action( 'AHEE__EE_Admin__loaded' );
+		do_action('AHEE__EE_Admin__loaded');
 	}
 
 
@@ -103,12 +103,12 @@ 
 	 * @return void
 	 */
 	private function _define_all_constants() {
-		if ( ! defined( 'EE_ADMIN_URL' ) ) {
-			define( 'EE_ADMIN_URL', EE_PLUGIN_DIR_URL . 'core/admin/' );
-			define( 'EE_ADMIN_PAGES_URL', EE_PLUGIN_DIR_URL . 'admin_pages/' );
-			define( 'EE_ADMIN_TEMPLATE', EE_ADMIN . 'templates' . DS );
-			define( 'WP_ADMIN_PATH', ABSPATH . 'wp-admin/' );
-			define( 'WP_AJAX_URL', admin_url( 'admin-ajax.php' ) );
+		if ( ! defined('EE_ADMIN_URL')) {
+			define('EE_ADMIN_URL', EE_PLUGIN_DIR_URL.'core/admin/');
+			define('EE_ADMIN_PAGES_URL', EE_PLUGIN_DIR_URL.'admin_pages/');
+			define('EE_ADMIN_TEMPLATE', EE_ADMIN.'templates'.DS);
+			define('WP_ADMIN_PATH', ABSPATH.'wp-admin/');
+			define('WP_AJAX_URL', admin_url('admin-ajax.php'));
 		}
 	}
 
@@ -122,23 +122,23 @@ 
 	 * @param 	string 	$plugin
 	 * @return 	array
 	 */
-	public function filter_plugin_actions( $links, $plugin ) {
+	public function filter_plugin_actions($links, $plugin) {
 		// set $main_file in stone
 		static $main_file;
 		// if $main_file is not set yet
-		if ( ! $main_file ) {
-			$main_file = plugin_basename( EVENT_ESPRESSO_MAIN_FILE );
+		if ( ! $main_file) {
+			$main_file = plugin_basename(EVENT_ESPRESSO_MAIN_FILE);
 		}
-		 if ( $plugin === $main_file ) {
+		 if ($plugin === $main_file) {
 		 	// compare current plugin to this one
-			if ( EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance ) {
-				$maintenance_link = '<a href="admin.php?page=espresso_maintenance_settings" title="Event Espresso is in maintenance mode.  Click this link to learn why.">' . __('Maintenance Mode Active', 'event_espresso' ) . '</a>';
-				array_unshift( $links, $maintenance_link );
+			if (EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance) {
+				$maintenance_link = '<a href="admin.php?page=espresso_maintenance_settings" title="Event Espresso is in maintenance mode.  Click this link to learn why.">'.__('Maintenance Mode Active', 'event_espresso').'</a>';
+				array_unshift($links, $maintenance_link);
 			} else {
-				$org_settings_link = '<a href="admin.php?page=espresso_general_settings">' . __( 'Settings', 'event_espresso' ) . '</a>';
-				$events_link = '<a href="admin.php?page=espresso_events">' . __( 'Events', 'event_espresso' ) . '</a>';
+				$org_settings_link = '<a href="admin.php?page=espresso_general_settings">'.__('Settings', 'event_espresso').'</a>';
+				$events_link = '<a href="admin.php?page=espresso_events">'.__('Events', 'event_espresso').'</a>';
 				// add before other links
-				array_unshift( $links, $org_settings_link, $events_link );
+				array_unshift($links, $org_settings_link, $events_link);
 			}
 		}
 		return $links;
@@ -153,8 +153,8 @@ 
 	 *	@return void
 	 */
 	public function get_request() {
-		EE_Registry::instance()->load_core( 'Request_Handler' );
-		EE_Registry::instance()->load_core( 'CPT_Strategy' );
+		EE_Registry::instance()->load_core('Request_Handler');
+		EE_Registry::instance()->load_core('CPT_Strategy');
 	}
 
 
@@ -166,11 +166,11 @@ 
 	 * @param array $admin_page_folder_names
 	 * @return array
 	 */
-	public function hide_admin_pages_except_maintenance_mode( $admin_page_folder_names = array() ){
+	public function hide_admin_pages_except_maintenance_mode($admin_page_folder_names = array()) {
 		return array(
-			'maintenance' => EE_ADMIN_PAGES . 'maintenance' . DS,
-			'about' => EE_ADMIN_PAGES . 'about' . DS,
-			'support' => EE_ADMIN_PAGES . 'support' . DS
+			'maintenance' => EE_ADMIN_PAGES.'maintenance'.DS,
+			'about' => EE_ADMIN_PAGES.'about'.DS,
+			'support' => EE_ADMIN_PAGES.'support'.DS
 		);
 	}
 
@@ -184,31 +184,31 @@ 
 	*/
 	public function init() {
 		//only enable most of the EE_Admin IF we're not in full maintenance mode
-		if ( EE_Maintenance_Mode::instance()->models_can_query() ){
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
 			//ok so we want to enable the entire admin
-			add_action( 'wp_ajax_dismiss_ee_nag_notice', array( $this, 'dismiss_ee_nag_notice_callback' ));
-			add_action( 'admin_notices', array( $this, 'get_persistent_admin_notices' ), 9 );
-			add_action( 'network_admin_notices', array( $this, 'get_persistent_admin_notices' ), 9 );
+			add_action('wp_ajax_dismiss_ee_nag_notice', array($this, 'dismiss_ee_nag_notice_callback'));
+			add_action('admin_notices', array($this, 'get_persistent_admin_notices'), 9);
+			add_action('network_admin_notices', array($this, 'get_persistent_admin_notices'), 9);
 			//at a glance dashboard widget
-			add_filter( 'dashboard_glance_items', array( $this, 'dashboard_glance_items' ), 10 );
+			add_filter('dashboard_glance_items', array($this, 'dashboard_glance_items'), 10);
 			//filter for get_edit_post_link used on comments for custom post types
-			add_filter( 'get_edit_post_link', array( $this, 'modify_edit_post_link' ), 10, 2 );
+			add_filter('get_edit_post_link', array($this, 'modify_edit_post_link'), 10, 2);
 		}
 		// run the admin page factory but ONLY if we are doing an ee admin ajax request
-		if ( !defined('DOING_AJAX') || EE_ADMIN_AJAX ) {
+		if ( ! defined('DOING_AJAX') || EE_ADMIN_AJAX) {
 			try {
 				//this loads the controller for the admin pages which will setup routing etc
-				EE_Registry::instance()->load_core( 'Admin_Page_Loader' );
-			} catch ( EE_Error $e ) {
+				EE_Registry::instance()->load_core('Admin_Page_Loader');
+			} catch (EE_Error $e) {
 				$e->get_error();
 			}
 		}
-		add_filter( 'content_save_pre', array( $this, 'its_eSpresso' ), 10, 1 );
+		add_filter('content_save_pre', array($this, 'its_eSpresso'), 10, 1);
 		//make sure our CPTs and custom taxonomy metaboxes get shown for first time users
-		add_action('admin_head', array($this, 'enable_hidden_ee_nav_menu_metaboxes' ), 10 );
-		add_action('admin_head', array( $this, 'register_custom_nav_menu_boxes' ), 10 );
+		add_action('admin_head', array($this, 'enable_hidden_ee_nav_menu_metaboxes'), 10);
+		add_action('admin_head', array($this, 'register_custom_nav_menu_boxes'), 10);
 		//exclude EE critical pages from all nav menus and wp_list_pages
-		add_filter('nav_menu_meta_box_object', array( $this, 'remove_pages_from_nav_menu'), 10 );
+		add_filter('nav_menu_meta_box_object', array($this, 'remove_pages_from_nav_menu'), 10);
 	}
 
 
@@ -221,9 +221,9 @@ 
 	 * @param  object $post_type WP post type object
 	 * @return object            WP post type object
 	 */
-	public function remove_pages_from_nav_menu( $post_type ) {
+	public function remove_pages_from_nav_menu($post_type) {
 		//if this isn't the "pages" post type let's get out
-		if ( $post_type->name !== 'page' ) {
+		if ($post_type->name !== 'page') {
 			return $post_type;
 		}
 		$critical_pages = EE_Registry::instance()->CFG->core->get_critical_pages_array();
@@ -243,28 +243,28 @@ 
 	 */
 	public function enable_hidden_ee_nav_menu_metaboxes() {
 		global $wp_meta_boxes, $pagenow;
-		if ( ! is_array($wp_meta_boxes) || $pagenow !== 'nav-menus.php' ) {
+		if ( ! is_array($wp_meta_boxes) || $pagenow !== 'nav-menus.php') {
 			return;
 		}
 		$user = wp_get_current_user();
 		//has this been done yet?
-		if ( get_user_option( 'ee_nav_menu_initialized', $user->ID ) ) {
+		if (get_user_option('ee_nav_menu_initialized', $user->ID)) {
 			return;
 		}
 
-		$hidden_meta_boxes = get_user_option( 'metaboxhidden_nav-menus', $user->ID );
-		$initial_meta_boxes = apply_filters( 'FHEE__EE_Admin__enable_hidden_ee_nav_menu_boxes__initial_meta_boxes', array( 'nav-menu-theme-locations', 'add-page', 'add-custom-links', 'add-category', 'add-espresso_events', 'add-espresso_venues', 'add-espresso_event_categories', 'add-espresso_venue_categories', 'add-post-type-post', 'add-post-type-page' ) );
+		$hidden_meta_boxes = get_user_option('metaboxhidden_nav-menus', $user->ID);
+		$initial_meta_boxes = apply_filters('FHEE__EE_Admin__enable_hidden_ee_nav_menu_boxes__initial_meta_boxes', array('nav-menu-theme-locations', 'add-page', 'add-custom-links', 'add-category', 'add-espresso_events', 'add-espresso_venues', 'add-espresso_event_categories', 'add-espresso_venue_categories', 'add-post-type-post', 'add-post-type-page'));
 
-		if ( is_array( $hidden_meta_boxes ) ) {
-			foreach ( $hidden_meta_boxes as $key => $meta_box_id ) {
-				if ( in_array( $meta_box_id, $initial_meta_boxes ) ) {
-					unset( $hidden_meta_boxes[ $key ] );
+		if (is_array($hidden_meta_boxes)) {
+			foreach ($hidden_meta_boxes as $key => $meta_box_id) {
+				if (in_array($meta_box_id, $initial_meta_boxes)) {
+					unset($hidden_meta_boxes[$key]);
 				}
 			}
 		}
 
-		update_user_option( $user->ID, 'metaboxhidden_nav-menus', $hidden_meta_boxes, true );
-		update_user_option( $user->ID, 'ee_nav_menu_initialized', 1, true );
+		update_user_option($user->ID, 'metaboxhidden_nav-menus', $hidden_meta_boxes, true);
+		update_user_option($user->ID, 'ee_nav_menu_initialized', 1, true);
 	}
 
 
@@ -283,7 +283,7 @@ 
 	 * @return void
 	 */
 	public function register_custom_nav_menu_boxes() {
-		add_meta_box( 'add-extra-nav-menu-pages', __('Event Espresso Pages', 'event_espresso'), array( $this, 'ee_cpt_archive_pages' ), 'nav-menus', 'side', 'core' );
+		add_meta_box('add-extra-nav-menu-pages', __('Event Espresso Pages', 'event_espresso'), array($this, 'ee_cpt_archive_pages'), 'nav-menus', 'side', 'core');
 	}
 
 
@@ -299,16 +299,16 @@ 
 	 *
 	 * @return string  the (maybe) modified link
 	 */
-	public function modify_edit_post_link( $link, $id ) {
-		if ( ! $post = get_post( $id ) ){
+	public function modify_edit_post_link($link, $id) {
+		if ( ! $post = get_post($id)) {
 			return $link;
 		}
-		if ( $post->post_type === 'espresso_attendees' ) {
+		if ($post->post_type === 'espresso_attendees') {
 			$query_args = array(
 				'action' => 'edit_attendee',
 				'post' => $id
 			);
-			return EEH_URL::add_query_args_and_nonce( $query_args, admin_url('admin.php?page=espresso_registrations') );
+			return EEH_URL::add_query_args_and_nonce($query_args, admin_url('admin.php?page=espresso_registrations'));
 		}
 		return $link;
 	}
@@ -320,7 +320,7 @@ 
 		global $nav_menu_selected_id;
 
 		$db_fields = false;
-		$walker = new Walker_Nav_Menu_Checklist( $db_fields );
+		$walker = new Walker_Nav_Menu_Checklist($db_fields);
 		$current_tab = 'event-archives';
 
 		/*if ( ! empty( $_REQUEST['quick-search-posttype-' . $post_type_name] ) ) {
@@ -339,9 +339,9 @@ 
 		?>
 		<div id="posttype-extra-nav-menu-pages" class="posttypediv">
 			<ul id="posttype-extra-nav-menu-pages-tabs" class="posttype-tabs add-menu-item-tabs">
-				<li <?php echo ( 'event-archives' === $current_tab ? ' class="tabs"' : '' ); ?>>
-					<a class="nav-tab-link" data-type="tabs-panel-posttype-extra-nav-menu-pages-event-archives" href="<?php if ( $nav_menu_selected_id ) {echo esc_url(add_query_arg('extra-nav-menu-pages-tab', 'event-archives', remove_query_arg($removed_args)));} ?>#tabs-panel-posttype-extra-nav-menu-pages-event-archives">
-						<?php _e( 'Event Archive Pages', 'event_espresso' ); ?>
+				<li <?php echo ('event-archives' === $current_tab ? ' class="tabs"' : ''); ?>>
+					<a class="nav-tab-link" data-type="tabs-panel-posttype-extra-nav-menu-pages-event-archives" href="<?php if ($nav_menu_selected_id) {echo esc_url(add_query_arg('extra-nav-menu-pages-tab', 'event-archives', remove_query_arg($removed_args))); } ?>#tabs-panel-posttype-extra-nav-menu-pages-event-archives">
+						<?php _e('Event Archive Pages', 'event_espresso'); ?>
 					</a>
 				</li>
 			<?php /* // temporarily removing but leaving skeleton in place in case we ever decide to add more tabs.
@@ -359,13 +359,13 @@ 
  			<?php */ ?>
 
 			<div id="tabs-panel-posttype-extra-nav-menu-pages-event-archives" class="tabs-panel <?php
-			echo ( 'event-archives' === $current_tab ? 'tabs-panel-active' : 'tabs-panel-inactive' );
+			echo ('event-archives' === $current_tab ? 'tabs-panel-active' : 'tabs-panel-inactive');
 			?>">
 				<ul id="extra-nav-menu-pageschecklist-event-archives" class="categorychecklist form-no-clear">
 					<?php
 					$pages = $this->_get_extra_nav_menu_pages_items();
 					$args['walker'] = $walker;
-					echo walk_nav_menu_tree( array_map( array( $this, '_setup_extra_nav_menu_pages_items' ), $pages), 0, (object) $args );
+					echo walk_nav_menu_tree(array_map(array($this, '_setup_extra_nav_menu_pages_items'), $pages), 0, (object) $args);
 					?>
 				</ul>
 			</div><!-- /.tabs-panel -->
@@ -373,18 +373,18 @@ 
 			<p class="button-controls">
 				<span class="list-controls">
 					<a href="<?php
-						echo esc_url( add_query_arg(
+						echo esc_url(add_query_arg(
 							array(
 								'extra-nav-menu-pages-tab' => 'event-archives',
 								'selectall' => 1,
 							),
-							remove_query_arg( $removed_args )
+							remove_query_arg($removed_args)
 						));
 					?>#posttype-extra-nav-menu-pages>" class="select-all"><?php _e('Select All'); ?></a>
 				</span>
 
 				<span class="add-to-menu">
-					<input type="submit"<?php wp_nav_menu_disabled_check( $nav_menu_selected_id ); ?> class="button-secondary submit-add-to-menu right" value="<?php esc_attr_e( __( 'Add to Menu' ) ); ?>" name="add-post-type-menu-item" id="<?php esc_attr_e( 'submit-posttype-extra-nav-menu-pages' ); ?>" />
+					<input type="submit"<?php wp_nav_menu_disabled_check($nav_menu_selected_id); ?> class="button-secondary submit-add-to-menu right" value="<?php esc_attr_e(__('Add to Menu')); ?>" name="add-post-type-menu-item" id="<?php esc_attr_e('submit-posttype-extra-nav-menu-pages'); ?>" />
 					<span class="spinner"></span>
 				</span>
 			</p>
@@ -405,10 +405,10 @@ 
 	private function _get_extra_nav_menu_pages_items() {
 		$menuitems[] = array(
 			'title' => __('Event List', 'event_espresso'),
-			'url' => get_post_type_archive_link( 'espresso_events' ),
+			'url' => get_post_type_archive_link('espresso_events'),
 			'description' => __('Archive page for all events.', 'event_espresso')
 		);
-		return apply_filters( 'FHEE__EE_Admin__get_extra_nav_menu_pages_items', $menuitems );
+		return apply_filters('FHEE__EE_Admin__get_extra_nav_menu_pages_items', $menuitems);
 	}
 
 
@@ -420,7 +420,7 @@ 
 	 * @param $menu_item_values
 	 * @return stdClass
 	 */
-	private function _setup_extra_nav_menu_pages_items( $menu_item_values ) {
+	private function _setup_extra_nav_menu_pages_items($menu_item_values) {
 		$menu_item = new stdClass();
 		$keys = array(
 			'ID' => 0,
@@ -440,8 +440,8 @@ 
 			'xfn' => ''
 		);
 
-		foreach ( $keys as $key => $value) {
-			$menu_item->{$key} = isset( $menu_item_values[ $key]) ? $menu_item_values[ $key] : $value;
+		foreach ($keys as $key => $value) {
+			$menu_item->{$key} = isset($menu_item_values[$key]) ? $menu_item_values[$key] : $value;
 		}
 		return $menu_item;
 	}
@@ -480,9 +480,9 @@ 
 		 * - check if doing post processing of one of EE CPTs
 		 * - instantiate the corresponding EE CPT model for the post_type being processed.
 		 */
-		if ( isset( $_POST['action'], $_POST['post_type'] ) && $_POST['action'] === 'editpost' ) {
-			EE_Registry::instance()->load_core( 'Register_CPTs' );
-			EE_Register_CPTs::instantiate_cpt_models( $_POST['post_type'] );
+		if (isset($_POST['action'], $_POST['post_type']) && $_POST['action'] === 'editpost') {
+			EE_Registry::instance()->load_core('Register_CPTs');
+			EE_Register_CPTs::instantiate_cpt_models($_POST['post_type']);
 		}
 
 
@@ -492,7 +492,7 @@ 
          * tab in the EE General Settings Admin page.
          * This is for user-proofing.
 		 */
-        add_filter( 'wp_dropdown_pages', array( $this, 'modify_dropdown_pages' ) );
+        add_filter('wp_dropdown_pages', array($this, 'modify_dropdown_pages'));
 
 	}
 
@@ -503,25 +503,25 @@ 
 	 * @param string $output  Current output.
 	 * @return string
 	 */
-	public function modify_dropdown_pages( $output ) {
+	public function modify_dropdown_pages($output) {
 		//get critical pages
 		$critical_pages = EE_Registry::instance()->CFG->core->get_critical_pages_array();
 
 		//split current output by line break for easier parsing.
-		$split_output = explode( "\n", $output );
+		$split_output = explode("\n", $output);
 
 		//loop through to remove any critical pages from the array.
-		foreach ( $critical_pages as $page_id ) {
-			$needle = 'value="' . $page_id . '"';
-			foreach( $split_output as $key => $haystack ) {
-				if( strpos( $haystack, $needle ) !== false ) {
-					unset( $split_output[$key] );
+		foreach ($critical_pages as $page_id) {
+			$needle = 'value="'.$page_id.'"';
+			foreach ($split_output as $key => $haystack) {
+				if (strpos($haystack, $needle) !== false) {
+					unset($split_output[$key]);
 				}
 			}
 		}
 
 		//replace output with the new contents
-		return implode( "\n", $split_output );
+		return implode("\n", $split_output);
 	}
 
 
@@ -535,17 +535,17 @@ 
 	public function enqueue_admin_scripts() {
 		// this javascript is loaded on every admin page to catch any injections ee needs to add to wp run js.
 		// Note: the intention of this script is to only do TARGETED injections.  I.E, only injecting on certain script calls.
-		wp_enqueue_script('ee-inject-wp', EE_ADMIN_URL . 'assets/ee-cpt-wp-injects.js', array('jquery'), EVENT_ESPRESSO_VERSION, TRUE);
+		wp_enqueue_script('ee-inject-wp', EE_ADMIN_URL.'assets/ee-cpt-wp-injects.js', array('jquery'), EVENT_ESPRESSO_VERSION, TRUE);
 		// register cookie script for future dependencies
-		wp_register_script('jquery-cookie', EE_THIRD_PARTY_URL . 'joyride/jquery.cookie.js', array('jquery'), '2.1', TRUE );
+		wp_register_script('jquery-cookie', EE_THIRD_PARTY_URL.'joyride/jquery.cookie.js', array('jquery'), '2.1', TRUE);
 		//joyride is turned OFF by default, but prior to the admin_enqueue_scripts hook, can be turned back on again vai: add_filter('FHEE_load_joyride', '__return_true' );
-		if ( apply_filters( 'FHEE_load_joyride', FALSE ) ) {
+		if (apply_filters('FHEE_load_joyride', FALSE)) {
 			//joyride style
-			wp_register_style('joyride-css', EE_THIRD_PARTY_URL . 'joyride/joyride-2.1.css', array(), '2.1');
-			wp_register_style('ee-joyride-css', EE_GLOBAL_ASSETS_URL . 'css/ee-joyride-styles.css', array('joyride-css'), EVENT_ESPRESSO_VERSION );
-			wp_register_script('joyride-modernizr', EE_THIRD_PARTY_URL . 'joyride/modernizr.mq.js', array(), '2.1', TRUE );
+			wp_register_style('joyride-css', EE_THIRD_PARTY_URL.'joyride/joyride-2.1.css', array(), '2.1');
+			wp_register_style('ee-joyride-css', EE_GLOBAL_ASSETS_URL.'css/ee-joyride-styles.css', array('joyride-css'), EVENT_ESPRESSO_VERSION);
+			wp_register_script('joyride-modernizr', EE_THIRD_PARTY_URL.'joyride/modernizr.mq.js', array(), '2.1', TRUE);
 			//joyride JS
-			wp_register_script('jquery-joyride', EE_THIRD_PARTY_URL . 'joyride/jquery.joyride-2.1.js', array('jquery-cookie', 'joyride-modernizr'), '2.1', TRUE );
+			wp_register_script('jquery-joyride', EE_THIRD_PARTY_URL.'joyride/jquery.joyride-2.1.js', array('jquery-cookie', 'joyride-modernizr'), '2.1', TRUE);
 			// wanna go for a joyride?
 			wp_enqueue_style('ee-joyride-css');
 			wp_enqueue_script('jquery-joyride');
@@ -575,11 +575,11 @@ 
 	public function get_persistent_admin_notices() {
 		// http://www.example.com/wp-admin/admin.php?page=espresso_general_settings&action=critical_pages&critical_pages_nonce=2831ce0f30
 		$args = array(
-			'page' => EE_Registry::instance()->REQ->is_set( 'page' ) ? EE_Registry::instance()->REQ->get( 'page' ) : '',
-			'action' => EE_Registry::instance()->REQ->is_set( 'action' ) ? EE_Registry::instance()->REQ->get( 'action' ) : '',
+			'page' => EE_Registry::instance()->REQ->is_set('page') ? EE_Registry::instance()->REQ->get('page') : '',
+			'action' => EE_Registry::instance()->REQ->is_set('action') ? EE_Registry::instance()->REQ->get('action') : '',
 		);
-		$return_url = EE_Admin_Page::add_query_args_and_nonce( $args, EE_ADMIN_URL );
-		echo EE_Error::get_persistent_admin_notices( $return_url );
+		$return_url = EE_Admin_Page::add_query_args_and_nonce($args, EE_ADMIN_URL);
+		echo EE_Error::get_persistent_admin_notices($return_url);
 	}
 
 
@@ -604,24 +604,24 @@ 
 	public function dashboard_glance_items($elements) {
         $elements = is_array($elements) ? $elements : array($elements);
 		$events = EEM_Event::instance()->count();
-		$items['events']['url'] = EE_Admin_Page::add_query_args_and_nonce( array('page' => 'espresso_events'), admin_url('admin.php') );
-		$items['events']['text'] = sprintf( _n( '%s Event', '%s Events', $events ), number_format_i18n( $events ) );
+		$items['events']['url'] = EE_Admin_Page::add_query_args_and_nonce(array('page' => 'espresso_events'), admin_url('admin.php'));
+		$items['events']['text'] = sprintf(_n('%s Event', '%s Events', $events), number_format_i18n($events));
 		$items['events']['title'] = __('Click to view all Events', 'event_espresso');
 		$registrations = EEM_Registration::instance()->count(
 			array(
 				array(
-					'STS_ID' => array( '!=', EEM_Registration::status_id_incomplete )
+					'STS_ID' => array('!=', EEM_Registration::status_id_incomplete)
 				)
 			)
 		);
-		$items['registrations']['url'] = EE_Admin_Page::add_query_args_and_nonce( array('page' => 'espresso_registrations' ), admin_url('admin.php') );
-		$items['registrations']['text'] = sprintf( _n( '%s Registration', '%s Registrations', $registrations ), number_format_i18n($registrations) );
+		$items['registrations']['url'] = EE_Admin_Page::add_query_args_and_nonce(array('page' => 'espresso_registrations'), admin_url('admin.php'));
+		$items['registrations']['text'] = sprintf(_n('%s Registration', '%s Registrations', $registrations), number_format_i18n($registrations));
 		$items['registrations']['title'] = __('Click to view all registrations', 'event_espresso');
 
-		$items = (array) apply_filters( 'FHEE__EE_Admin__dashboard_glance_items__items', $items );
+		$items = (array) apply_filters('FHEE__EE_Admin__dashboard_glance_items__items', $items);
 
-		foreach ( $items as $type => $item_properties ) {
-			$elements[] = sprintf( '<a class="ee-dashboard-link-' . $type . '" href="%s" title="%s">%s</a>', $item_properties['url'], $item_properties['title'], $item_properties['text'] );
+		foreach ($items as $type => $item_properties) {
+			$elements[] = sprintf('<a class="ee-dashboard-link-'.$type.'" href="%s" title="%s">%s</a>', $item_properties['url'], $item_properties['title'], $item_properties['text']);
 		}
 		return $elements;
 	}
@@ -638,31 +638,31 @@ 
 	 * @throws EE_Error
 	 * @return    string
 	 */
-	public function check_for_invalid_datetime_formats( $value, $option ) {
+	public function check_for_invalid_datetime_formats($value, $option) {
 		// check for date_format or time_format
-		switch ( $option ) {
+		switch ($option) {
 			case 'date_format' :
-				$date_time_format = $value . ' ' . get_option('time_format');
+				$date_time_format = $value.' '.get_option('time_format');
 				break;
 			case 'time_format' :
-				$date_time_format = get_option('date_format') . ' ' . $value;
+				$date_time_format = get_option('date_format').' '.$value;
 				break;
 			default :
 				$date_time_format = FALSE;
 		}
 		// do we have a date_time format to check ?
-		if ( $date_time_format ) {
-			$error_msg = EEH_DTT_Helper::validate_format_string( $date_time_format );
+		if ($date_time_format) {
+			$error_msg = EEH_DTT_Helper::validate_format_string($date_time_format);
 
-			if ( is_array( $error_msg ) ) {
-				$msg = '<p>' . sprintf( __( 'The following date time "%s" ( %s ) is difficult to be properly parsed by PHP for the following reasons:', 'event_espresso' ), date( $date_time_format ) , $date_time_format  ) . '</p><p><ul>';
+			if (is_array($error_msg)) {
+				$msg = '<p>'.sprintf(__('The following date time "%s" ( %s ) is difficult to be properly parsed by PHP for the following reasons:', 'event_espresso'), date($date_time_format), $date_time_format).'</p><p><ul>';
 
 
-				foreach ( $error_msg as $error ) {
-					$msg .= '<li>' . $error . '</li>';
+				foreach ($error_msg as $error) {
+					$msg .= '<li>'.$error.'</li>';
 				}
 
-				$msg .= '</ul></p><p>' . sprintf( __( '%sPlease note that your date and time formats have been reset to "F j, Y" and "g:i a" respectively.%s', 'event_espresso' ), '<span style="color:#D54E21;">', '</span>' ) . '</p>';
+				$msg .= '</ul></p><p>'.sprintf(__('%sPlease note that your date and time formats have been reset to "F j, Y" and "g:i a" respectively.%s', 'event_espresso'), '<span style="color:#D54E21;">', '</span>').'</p>';
 
 				// trigger WP settings error
 				add_settings_error(
@@ -672,7 +672,7 @@ 
 				);
 
 				// set format to something valid
-				switch ( $option ) {
+				switch ($option) {
 					case 'date_format' :
 						$value = 'F j, Y';
 						break;
@@ -694,8 +694,8 @@ 
 	 * @param $content
 	 * @return    string
 	 */
-	public function its_eSpresso( $content ) {
-		return str_replace( '[EXPRESSO_', '[ESPRESSO_', $content );
+	public function its_eSpresso($content) {
+		return str_replace('[EXPRESSO_', '[ESPRESSO_', $content);
 	}
 
 
@@ -707,7 +707,7 @@ 
 	 *  @return 	string
 	 */
 	public function espresso_admin_footer() {
-		return \EEH_Template::powered_by_event_espresso( 'aln-cntr', '', array( 'utm_content' => 'admin_footer' ));
+		return \EEH_Template::powered_by_event_espresso('aln-cntr', '', array('utm_content' => 'admin_footer'));
 	}
 
 
@@ -726,12 +726,12 @@ 
 	 * @param array $config
 	 * @return void
 	 */
-	public static function register_ee_admin_page( $page_basename, $page_path, $config = array() ) {
-		EE_Error::doing_it_wrong( __METHOD__, sprintf( __('Usage is deprecated.  Use EE_Register_Admin_Page::register() for registering the %s admin page.', 'event_espresso'), $page_basename), '4.3' );
-		if ( class_exists( 'EE_Register_Admin_Page' ) ) {
+	public static function register_ee_admin_page($page_basename, $page_path, $config = array()) {
+		EE_Error::doing_it_wrong(__METHOD__, sprintf(__('Usage is deprecated.  Use EE_Register_Admin_Page::register() for registering the %s admin page.', 'event_espresso'), $page_basename), '4.3');
+		if (class_exists('EE_Register_Admin_Page')) {
 			$config['page_path'] = $page_path;
 		}
-		EE_Register_Admin_Page::register( $page_basename, $config );
+		EE_Register_Admin_Page::register($page_basename, $config);
 
 	}
 
@@ -744,7 +744,7 @@ 
 	 * @param  \WP_Post $post
 	 * @return void
 	 */
-	public static function parse_post_content_on_save( $post_ID, $post ) {
+	public static function parse_post_content_on_save($post_ID, $post) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			__('Usage is deprecated', 'event_espresso'),
@@ -762,7 +762,7 @@ 
 	 * @param  $value
 	 * @return void
 	 */
-	public function reset_page_for_posts_on_change( $option, $old_value, $value ) {
+	public function reset_page_for_posts_on_change($option, $old_value, $value) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			__('Usage is deprecated', 'event_espresso'),

core/interfaces/InterminableInterface.php

Spacing +2 added lines, -2 removed lines

@@ -1,8 +1,8 @@
 <?php
 namespace EventEspresso\core\interfaces;
 
-if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 

core/request_stack/EE_Request.core.php

Indentation +226 added lines, -226 removed lines

@@ -2,7 +2,7 @@ 
 use EventEspresso\core\interfaces\InterminableInterface;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -18,231 +18,231 @@ 
 class EE_Request implements InterminableInterface
 {
 
-    /**
-     * @access private
-     * @var    array $_get $_GET parameters
-     */
-    private $_get = array();
-
-    /**
-     * @access private
-     * @var    array $_post $_POST parameters
-     */
-    private $_post = array();
-
-    /**
-     * @access private
-     * @var    array $_cookie $_COOKIE parameters
-     */
-    private $_cookie = array();
-
-    /**
-     * @access private
-     * @var    array $_params $_REQUEST parameters
-     */
-    private $_params = array();
-
-    /**
-     * whether current request is via AJAX
-     *
-     * @var    boolean
-     * @access public
-     */
-    public $ajax = false;
-
-    /**
-     * whether current request is via AJAX from the frontend of the site
-     *
-     * @var    boolean
-     * @access public
-     */
-    public $front_ajax = false;
-
-    /**
-     * IP address for request
-     *
-     * @var string $_ip_address
-     */
-    private $_ip_address = '';
-
-
-
-    /**
-     * class constructor
-     *
-     * @access    public
-     * @param array $get
-     * @param array $post
-     * @param array $cookie
-     */
-    public function __construct($get, $post, $cookie)
-    {
-        // grab request vars
-        $this->_get = (array)$get;
-        $this->_post = (array)$post;
-        $this->_cookie = (array)$cookie;
-        $this->_params = array_merge($this->_get, $this->_post);
-        // AJAX ???
-        $this->ajax = defined('DOING_AJAX') ? true : false;
-        $this->front_ajax = $this->is_set('ee_front_ajax') && (int)$this->get('ee_front_ajax') === 1;
-        // grab user IP
-        $this->_ip_address = $this->_visitor_ip();
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function get_params()
-    {
-        return $this->_get;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function post_params()
-    {
-        return $this->_post;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function cookie_params()
-    {
-        return $this->_cookie;
-    }
-
-
-
-    /**
-     * returns contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function params()
-    {
-        return $this->_params;
-    }
-
-
-
-    /**
-     *    setter
-     *
-     * @access    public
-     * @param      $key
-     * @param      $value
-     * @param bool $override_ee
-     * @return    void
-     */
-    public function set($key, $value, $override_ee = false)
-    {
-        // don't allow "ee" to be overwritten unless explicitly instructed to do so
-        if (
-            $key !== 'ee'
-            || ($key === 'ee' && empty($this->_params['ee']))
-            || ($key === 'ee' && ! empty($this->_params['ee']) && $override_ee)
-        ) {
-            $this->_params[$key] = $value;
-        }
-    }
-
-
-
-    /**
-     *    getter
-     *
-     * @access    public
-     * @param      $key
-     * @param null $default
-     * @return    mixed
-     */
-    public function get($key, $default = null)
-    {
-        return isset($this->_params[$key]) ? $this->_params[$key] : $default;
-    }
-
-
-
-    /**
-     *    check if param exists
-     *
-     * @access    public
-     * @param $key
-     * @return    boolean
-     */
-    public function is_set($key)
-    {
-        return isset($this->_params[$key]) ? true : false;
-    }
-
-
-
-    /**
-     *    remove param
-     *
-     * @access    public
-     * @param      $key
-     * @param bool $unset_from_global_too
-     */
-    public function un_set($key, $unset_from_global_too = false)
-    {
-        unset($this->_params[$key]);
-        if ($unset_from_global_too) {
-            unset($_REQUEST[$key]);
-        }
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function ip_address()
-    {
-        return $this->_ip_address;
-    }
-
-
-
-    /**
-     * _visitor_ip
-     *    attempt to get IP address of current visitor from server
-     * plz see: http://stackoverflow.com/a/2031935/1475279
-     *
-     * @access public
-     * @return string
-     */
-    private function _visitor_ip()
-    {
-        $visitor_ip = '0.0.0.0';
-        $server_keys = array(
-            'HTTP_CLIENT_IP',
-            'HTTP_X_FORWARDED_FOR',
-            'HTTP_X_FORWARDED',
-            'HTTP_X_CLUSTER_CLIENT_IP',
-            'HTTP_FORWARDED_FOR',
-            'HTTP_FORWARDED',
-            'REMOTE_ADDR',
-        );
-        foreach ($server_keys as $key) {
-            if (isset($_SERVER[$key])) {
-                foreach (array_map('trim', explode(',', $_SERVER[$key])) as $ip) {
-                    if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
-                        $visitor_ip = $ip;
-                    }
-                }
-            }
-        }
-        return $visitor_ip;
-    }
+	/**
+	 * @access private
+	 * @var    array $_get $_GET parameters
+	 */
+	private $_get = array();
+
+	/**
+	 * @access private
+	 * @var    array $_post $_POST parameters
+	 */
+	private $_post = array();
+
+	/**
+	 * @access private
+	 * @var    array $_cookie $_COOKIE parameters
+	 */
+	private $_cookie = array();
+
+	/**
+	 * @access private
+	 * @var    array $_params $_REQUEST parameters
+	 */
+	private $_params = array();
+
+	/**
+	 * whether current request is via AJAX
+	 *
+	 * @var    boolean
+	 * @access public
+	 */
+	public $ajax = false;
+
+	/**
+	 * whether current request is via AJAX from the frontend of the site
+	 *
+	 * @var    boolean
+	 * @access public
+	 */
+	public $front_ajax = false;
+
+	/**
+	 * IP address for request
+	 *
+	 * @var string $_ip_address
+	 */
+	private $_ip_address = '';
+
+
+
+	/**
+	 * class constructor
+	 *
+	 * @access    public
+	 * @param array $get
+	 * @param array $post
+	 * @param array $cookie
+	 */
+	public function __construct($get, $post, $cookie)
+	{
+		// grab request vars
+		$this->_get = (array)$get;
+		$this->_post = (array)$post;
+		$this->_cookie = (array)$cookie;
+		$this->_params = array_merge($this->_get, $this->_post);
+		// AJAX ???
+		$this->ajax = defined('DOING_AJAX') ? true : false;
+		$this->front_ajax = $this->is_set('ee_front_ajax') && (int)$this->get('ee_front_ajax') === 1;
+		// grab user IP
+		$this->_ip_address = $this->_visitor_ip();
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function get_params()
+	{
+		return $this->_get;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function post_params()
+	{
+		return $this->_post;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function cookie_params()
+	{
+		return $this->_cookie;
+	}
+
+
+
+	/**
+	 * returns contents of $_REQUEST
+	 *
+	 * @return array
+	 */
+	public function params()
+	{
+		return $this->_params;
+	}
+
+
+
+	/**
+	 *    setter
+	 *
+	 * @access    public
+	 * @param      $key
+	 * @param      $value
+	 * @param bool $override_ee
+	 * @return    void
+	 */
+	public function set($key, $value, $override_ee = false)
+	{
+		// don't allow "ee" to be overwritten unless explicitly instructed to do so
+		if (
+			$key !== 'ee'
+			|| ($key === 'ee' && empty($this->_params['ee']))
+			|| ($key === 'ee' && ! empty($this->_params['ee']) && $override_ee)
+		) {
+			$this->_params[$key] = $value;
+		}
+	}
+
+
+
+	/**
+	 *    getter
+	 *
+	 * @access    public
+	 * @param      $key
+	 * @param null $default
+	 * @return    mixed
+	 */
+	public function get($key, $default = null)
+	{
+		return isset($this->_params[$key]) ? $this->_params[$key] : $default;
+	}
+
+
+
+	/**
+	 *    check if param exists
+	 *
+	 * @access    public
+	 * @param $key
+	 * @return    boolean
+	 */
+	public function is_set($key)
+	{
+		return isset($this->_params[$key]) ? true : false;
+	}
+
+
+
+	/**
+	 *    remove param
+	 *
+	 * @access    public
+	 * @param      $key
+	 * @param bool $unset_from_global_too
+	 */
+	public function un_set($key, $unset_from_global_too = false)
+	{
+		unset($this->_params[$key]);
+		if ($unset_from_global_too) {
+			unset($_REQUEST[$key]);
+		}
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function ip_address()
+	{
+		return $this->_ip_address;
+	}
+
+
+
+	/**
+	 * _visitor_ip
+	 *    attempt to get IP address of current visitor from server
+	 * plz see: http://stackoverflow.com/a/2031935/1475279
+	 *
+	 * @access public
+	 * @return string
+	 */
+	private function _visitor_ip()
+	{
+		$visitor_ip = '0.0.0.0';
+		$server_keys = array(
+			'HTTP_CLIENT_IP',
+			'HTTP_X_FORWARDED_FOR',
+			'HTTP_X_FORWARDED',
+			'HTTP_X_CLUSTER_CLIENT_IP',
+			'HTTP_FORWARDED_FOR',
+			'HTTP_FORWARDED',
+			'REMOTE_ADDR',
+		);
+		foreach ($server_keys as $key) {
+			if (isset($_SERVER[$key])) {
+				foreach (array_map('trim', explode(',', $_SERVER[$key])) as $ip) {
+					if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
+						$visitor_ip = $ip;
+					}
+				}
+			}
+		}
+		return $visitor_ip;
+	}
 
 
 

core/EE_Psr4AutoloaderInit.core.php

Spacing +5 added lines, -5 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 use EventEspresso\core\Psr4Autoloader;
 
-if ( ! defined( 'EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); }
+if ( ! defined('EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); }
 
 /**
  * Class EE_Psr4AutoloaderInit
@@ -37,15 +37,15 @@ 
 	 */
 	public static function initialize_psr4_loader() {
 		static $initialized = false;
-		if ( ! $initialized ) {
+		if ( ! $initialized) {
 			// instantiate PSR4 autoloader
-			espresso_load_required( 'Psr4Autoloader', EE_CORE . 'Psr4Autoloader.php' );
+			espresso_load_required('Psr4Autoloader', EE_CORE.'Psr4Autoloader.php');
 			EE_Psr4AutoloaderInit::$psr4_loader = new Psr4Autoloader();
 			// register the autoloader
 			EE_Psr4AutoloaderInit::$psr4_loader->register();
 			// register the base directories for the namespace prefix
-			EE_Psr4AutoloaderInit::$psr4_loader->addNamespace( 'EventEspresso', EE_PLUGIN_DIR_PATH );
-			EE_Psr4AutoloaderInit::$psr4_loader->addNamespace( 'EventEspressoBatchRequest', EE_LIBRARIES . 'batch' );
+			EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspresso', EE_PLUGIN_DIR_PATH);
+			EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspressoBatchRequest', EE_LIBRARIES.'batch');
 			$initialized = true;
 		}
 	}

core/services/cache/TransientCacheStorage.php

Doc Comments +1 added lines, -1 removed lines

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

Unused Use Statements -4 removed lines

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

Indentation +355 added lines, -355 removed lines

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

Spacing +8 added lines, -8 removed lines

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

core/services/container/CoffeeShop.php

Indentation +497 added lines, -497 removed lines

@@ -13,7 +13,7 @@ 
 use OutOfBoundsException;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -32,502 +32,502 @@ 
 {
 
 
-    /**
-     * This was the best coffee related name I could think of to represent class name "aliases"
-     * So classes can be found via an alias identifier,
-     * that is revealed when it is run through... the filters... eh? get it?
-     *
-     * @var array $filters
-     */
-    private $filters = array();
-
-    /**
-     * These are the classes that will actually build the objects (to order of course)
-     *
-     * @var array $coffee_makers
-     */
-    private $coffee_makers = array();
-
-    /**
-     * where the instantiated "singleton" objects are stored
-     *
-     * @var CollectionInterface $carafe
-     */
-    private $carafe;
-
-    /**
-     * collection of Recipes that instruct us how to brew objects
-     *
-     * @var CollectionInterface $recipes
-     */
-    private $recipes;
-
-    /**
-     * collection of closures for brewing objects
-     *
-     * @var CollectionInterface $reservoir
-     */
-    private $reservoir;
-
-
-
-    /**
-     * CoffeeShop constructor
-     */
-    public function __construct()
-    {
-        // array for storing class aliases
-        $this->filters = array();
-        // create collection for storing shared services
-        $this->carafe = new LooseCollection( '' );
-        // create collection for storing recipes that tell how to build services and entities
-        $this->recipes = new Collection('EventEspresso\core\services\container\RecipeInterface');
-        // create collection for storing closures for constructing new entities
-        $this->reservoir = new Collection('Closure');
-        // create collection for storing the generators that build our services and entity closures
-        $this->coffee_makers = new Collection('EventEspresso\core\services\container\CoffeeMakerInterface');
-    }
-
-
-
-    /**
-     * Returns true if the container can return an entry for the given identifier.
-     * Returns false otherwise.
-     * `has($identifier)` returning true does not mean that `get($identifier)` will not throw an exception.
-     * It does however mean that `get($identifier)` will not throw a `ServiceNotFoundException`.
-     *
-     * @param string $identifier  Identifier of the entry to look for.
-     *                            Typically a Fully Qualified Class Name
-     * @return boolean
-     */
-    public function has($identifier)
-    {
-        $identifier = $this->filterIdentifier($identifier);
-        return $this->carafe->has($identifier);
-    }
-
-
-
-    /**
-     * finds a previously brewed (SHARED) service and returns it
-     *
-     * @param  string $identifier Identifier for the entity class to be constructed.
-     *                            Typically a Fully Qualified Class Name
-     * @return mixed
-     * @throws ServiceNotFoundException No service was found for this identifier.
-     */
-    public function get($identifier)
-    {
-        $identifier = $this->filterIdentifier($identifier);
-        if ($this->carafe->has($identifier)) {
-            return $this->carafe->get($identifier);
-        }
-        throw new ServiceNotFoundException($identifier);
-    }
-
-
-
-    /**
-     * returns an instance of the requested entity type using the supplied arguments.
-     * If a shared service is requested and an instance is already in the carafe, then it will be returned.
-     * If it is not already in the carafe, then the service will be constructed, added to the carafe, and returned
-     * If the request is for a new entity and a closure exists in the reservoir for creating it,
-     * then a new entity will be instantiated from the closure and returned.
-     * If a closure does not exist, then one will be built and added to the reservoir
-     * before instantiating the requested entity.
-     *
-     * @param  string $identifier Identifier for the entity class to be constructed.
-     *                            Typically a Fully Qualified Class Name
-     * @param array   $arguments  an array of arguments to be passed to the entity constructor
-     * @param string  $type
-     * @return mixed
-     * @throws ServiceNotFoundException No service was found for this identifier.
-     */
-    public function brew($identifier, $arguments = array(), $type = '')
-    {
-        // resolve any class aliases that may exist
-        $identifier = $this->filterIdentifier($identifier);
-        try {
-            // is a shared service being requested?
-            if (empty($type) || $type === CoffeeMaker::BREW_SHARED) {
-                // if a shared service was requested and an instance is in the carafe, then return it
-                return $this->get($identifier);
-            }
-        } catch (ServiceNotFoundException $e) {
-            // if not then we'll just catch the ServiceNotFoundException but not do anything just yet,
-            // and instead, attempt to build whatever was requested
-        }
-        $brewed = false;
-        // if the reservoir doesn't have a closure already for the requested identifier,
-        // then neither a shared service nor a closure for making entities has been built yet
-        if ( ! $this->reservoir->has($identifier)) {
-            // so let's brew something up and add it to the proper collection
-            $brewed = $this->makeCoffee($identifier, $arguments, $type);
-        }
-        // was the brewed item a callable factory function ?
-        if (is_callable($brewed)) {
-            // then instantiate a new entity from the cached closure
-            $entity = $brewed($arguments);
-        } else if ($brewed) {
-            // requested object was a shared entity, so attempt to get it from the carafe again
-            // because if it wasn't there before, then it should have just been brewed and added,
-            // but if it still isn't there, then this time
-            // the thrown ServiceNotFoundException will not be caught
-            $entity = $this->get($identifier);
-        } else {
-            // if identifier is for a non-shared entity,
-            // then either a cached closure already existed, or was just brewed
-            $closure = $this->reservoir->get($identifier);
-            $entity = $closure($arguments);
-        }
-        return $entity;
-    }
-
-
-
-    /**
-     * @param CoffeeMakerInterface $coffee_maker
-     * @param string               $type
-     * @return bool
-     */
-    public function addCoffeeMaker(CoffeeMakerInterface $coffee_maker, $type)
-    {
-        $type = CoffeeMaker::validateType($type);
-        return $this->coffee_makers->add($coffee_maker, $type);
-    }
-
-
-
-    /**
-     * @param string   $identifier
-     * @param callable $closure
-     * @return callable|null
-     */
-    public function addClosure($identifier, $closure)
-    {
-        if ( ! is_callable($closure)) {
-            throw new InvalidDataTypeException('$closure', $closure, 'Closure');
-        }
-        $identifier = $this->processIdentifier($identifier);
-        if ($this->reservoir->add($closure, $identifier)) {
-            return $closure;
-        }
-        return null;
-    }
-
-
-
-    /**
-     * @param string   $identifier
-     * @return boolean
-     */
-    public function removeClosure($identifier)
-    {
-        $identifier = $this->processIdentifier($identifier);
-        if ($this->reservoir->has($identifier)) {
-            $this->reservoir->remove($this->reservoir->get($identifier));
-            if ( ! $this->reservoir->has($identifier)) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * @param  string $identifier Identifier for the entity class that the service applies to
-     *                            Typically a Fully Qualified Class Name
-     * @param mixed  $service
-     * @return bool
-     */
-    public function addService($identifier, $service)
-    {
-        $identifier = $this->processIdentifier($identifier);
-        $service = $this->validateService($identifier, $service);
-        return $this->carafe->add($service, $identifier);
-    }
-
-
-
-    /**
-     * @param string $identifier
-     * @return boolean
-     */
-    public function removeService($identifier)
-    {
-        $identifier = $this->processIdentifier($identifier);
-        if ($this->carafe->has($identifier)) {
-            $this->carafe->remove($this->carafe->get($identifier));
-            if ( ! $this->carafe->has($identifier)) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Adds instructions on how to brew objects
-     *
-     * @param RecipeInterface $recipe
-     * @return mixed
-     */
-    public function addRecipe(RecipeInterface $recipe)
-    {
-        $this->addAliases($recipe->identifier(), $recipe->filters());
-        $identifier = $this->processIdentifier($recipe->identifier());
-        return $this->recipes->add($recipe, $identifier);
-    }
-
-
-
-    /**
-     * @param string $identifier The Recipe's identifier
-     * @return boolean
-     */
-    public function removeRecipe($identifier)
-    {
-        $identifier = $this->processIdentifier($identifier);
-        if ($this->recipes->has($identifier)) {
-            $this->recipes->remove(
-                $this->recipes->get($identifier)
-            );
-            if ( ! $this->recipes->has($identifier)) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Get instructions on how to brew objects
-     *
-     * @param  string $identifier Identifier for the entity class that the recipe applies to
-     *                            Typically a Fully Qualified Class Name
-     * @param string $type
-     * @return RecipeInterface
-     */
-    public function getRecipe($identifier, $type = '')
-    {
-        $identifier = $this->processIdentifier($identifier);
-        if ($this->recipes->has($identifier)) {
-            return $this->recipes->get($identifier);
-        }
-        $default_recipes = $this->getDefaultRecipes();
-        $matches = array();
-        foreach ($default_recipes as $wildcard => $default_recipe) {
-            // is the wildcard recipe prefix in the identifier ?
-            if (strpos($identifier, $wildcard) !== false) {
-                // track matches and use the number of wildcard characters matched for the key
-                $matches[strlen($wildcard)] = $default_recipe;
-            }
-        }
-        if (count($matches) > 0) {
-            // sort our recipes by the number of wildcard characters matched
-            ksort($matches);
-            // then grab the last recipe form the list, since it had the most matching characters
-            $match = array_pop($matches);
-            // since we are using a default recipe, we need to set it's identifier and fqcn
-            return $this->copyDefaultRecipe($match, $identifier, $type);
-        }
-        if ($this->recipes->has(Recipe::DEFAULT_ID)) {
-            // since we are using a default recipe, we need to set it's identifier and fqcn
-            return $this->copyDefaultRecipe($this->recipes->get(Recipe::DEFAULT_ID), $identifier, $type);
-        }
-        throw new OutOfBoundsException(
-            sprintf(
-                __('Could not brew coffee because no recipes were found for class "%1$s".', 'event_espresso'),
-                $identifier
-            )
-        );
-    }
-
-
-
-    /**
-     * adds class name aliases to list of filters
-     *
-     * @param  string       $identifier Identifier for the entity class that the alias applies to
-     *                                  Typically a Fully Qualified Class Name
-     * @param  array|string $aliases
-     * @return void
-     * @throws InvalidIdentifierException
-     */
-    public function addAliases($identifier, $aliases)
-    {
-        if (empty($aliases)) {
-            return;
-        }
-        $identifier = $this->processIdentifier($identifier);
-        foreach ((array)$aliases as $alias) {
-            $this->filters[$this->processIdentifier($alias)] = $identifier;
-        }
-    }
-
-
-
-    /**
-     * Adds a service to one of the internal collections
-     *
-     * @param        $identifier
-     * @param array  $arguments
-     * @param string $type
-     * @return mixed
-     * @throws ServiceExistsException
-     */
-    private function makeCoffee($identifier, $arguments = array(), $type = '')
-    {
-        if ((empty($type) || $type === CoffeeMaker::BREW_SHARED) && $this->has($identifier)) {
-            throw new ServiceExistsException($identifier);
-        }
-        $identifier = $this->filterIdentifier($identifier);
-        $recipe = $this->getRecipe($identifier, $type);
-        $type = ! empty($type) ? $type : $recipe->type();
-        $coffee_maker = $this->getCoffeeMaker($type);
-        return $coffee_maker->brew($recipe, $arguments);
-    }
-
-
-
-    /**
-     * filters alias identifiers to find the real class name
-     *
-     * @param  string $identifier Identifier for the entity class that the filter applies to
-     *                            Typically a Fully Qualified Class Name
-     * @return string
-     * @throws InvalidIdentifierException
-     */
-    private function filterIdentifier($identifier)
-    {
-        $identifier = $this->processIdentifier($identifier);
-        return isset($this->filters[$identifier]) && ! empty($this->filters[$identifier])
-            ? $this->filters[$identifier]
-            : $identifier;
-    }
-
-
-
-    /**
-     * verifies and standardizes identifiers
-     *
-     * @param  string $identifier Identifier for the entity class
-     *                            Typically a Fully Qualified Class Name
-     * @return string
-     * @throws InvalidIdentifierException
-     */
-    private function processIdentifier($identifier)
-    {
-        if ( ! is_string($identifier)) {
-            throw new InvalidIdentifierException(
-                is_object($identifier) ? get_class($identifier) : gettype($identifier),
-                '\Fully\Qualified\ClassName'
-            );
-        }
-        return ltrim($identifier, '\\');
-    }
-
-
-
-    /**
-     * @param string $type
-     * @return CoffeeMakerInterface
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     */
-    private function getCoffeeMaker($type)
-    {
-        if ( ! $this->coffee_makers->has($type)) {
-            throw new OutOfBoundsException(
-                __('The requested coffee maker is either missing or invalid.', 'event_espresso')
-            );
-        }
-        return $this->coffee_makers->get($type);
-    }
-
-
-
-    /**
-     * Retrieves all recipes that use a wildcard "*" in their identifier
-     * This allows recipes to be set up for handling
-     * legacy classes that do not support PSR-4 autoloading.
-     * for example:
-     * using "EEM_*" for a recipe identifier would target all legacy models like EEM_Attendee
-     *
-     * @return array
-     */
-    private function getDefaultRecipes()
-    {
-        $default_recipes = array();
-        $this->recipes->rewind();
-        while ($this->recipes->valid()) {
-            $identifier = $this->recipes->getInfo();
-            // does this recipe use a wildcard ? (but is NOT the global default)
-            if ($identifier !== Recipe::DEFAULT_ID && strpos($identifier, '*') !== false) {
-                // strip the wildcard and use identifier as key
-                $default_recipes[str_replace('*', '', $identifier)] = $this->recipes->current();
-            }
-            $this->recipes->next();
-        }
-        return $default_recipes;
-    }
-
-
-
-    /**
-     * clones a default recipe and then copies details
-     * from the incoming request to it so that it can be used
-     *
-     * @param RecipeInterface $default_recipe
-     * @param string          $identifier
-     * @param string          $type
-     * @return RecipeInterface
-     */
-    private function copyDefaultRecipe(RecipeInterface $default_recipe, $identifier, $type = '')
-    {
-        $recipe = clone $default_recipe;
-        if ( ! empty($type)) {
-            $recipe->setType($type);
-        }
-        // is this the base default recipe ?
-        if ($default_recipe->identifier() === Recipe::DEFAULT_ID) {
-            $recipe->setIdentifier($identifier);
-            $recipe->setFqcn($identifier);
-            return $recipe;
-        }
-        $recipe->setIdentifier($identifier);
-        foreach ($default_recipe->paths() as $path) {
-            $path = str_replace('*', $identifier, $path);
-            if (is_readable($path)) {
-                $recipe->setPaths($path);
-            }
-        }
-        $recipe->setFqcn($identifier);
-        return $recipe;
-    }
-
-
-
-    /**
-     * @param  string $identifier Identifier for the entity class that the service applies to
-     *                            Typically a Fully Qualified Class Name
-     * @param mixed  $service
-     * @return object
-     * @throws InvalidServiceException
-     */
-    private function validateService($identifier, $service)
-    {
-        if ( ! is_object($service)) {
-            throw new InvalidServiceException(
-                $identifier,
-                $service
-            );
-        }
-        return $service;
-    }
+	/**
+	 * This was the best coffee related name I could think of to represent class name "aliases"
+	 * So classes can be found via an alias identifier,
+	 * that is revealed when it is run through... the filters... eh? get it?
+	 *
+	 * @var array $filters
+	 */
+	private $filters = array();
+
+	/**
+	 * These are the classes that will actually build the objects (to order of course)
+	 *
+	 * @var array $coffee_makers
+	 */
+	private $coffee_makers = array();
+
+	/**
+	 * where the instantiated "singleton" objects are stored
+	 *
+	 * @var CollectionInterface $carafe
+	 */
+	private $carafe;
+
+	/**
+	 * collection of Recipes that instruct us how to brew objects
+	 *
+	 * @var CollectionInterface $recipes
+	 */
+	private $recipes;
+
+	/**
+	 * collection of closures for brewing objects
+	 *
+	 * @var CollectionInterface $reservoir
+	 */
+	private $reservoir;
+
+
+
+	/**
+	 * CoffeeShop constructor
+	 */
+	public function __construct()
+	{
+		// array for storing class aliases
+		$this->filters = array();
+		// create collection for storing shared services
+		$this->carafe = new LooseCollection( '' );
+		// create collection for storing recipes that tell how to build services and entities
+		$this->recipes = new Collection('EventEspresso\core\services\container\RecipeInterface');
+		// create collection for storing closures for constructing new entities
+		$this->reservoir = new Collection('Closure');
+		// create collection for storing the generators that build our services and entity closures
+		$this->coffee_makers = new Collection('EventEspresso\core\services\container\CoffeeMakerInterface');
+	}
+
+
+
+	/**
+	 * Returns true if the container can return an entry for the given identifier.
+	 * Returns false otherwise.
+	 * `has($identifier)` returning true does not mean that `get($identifier)` will not throw an exception.
+	 * It does however mean that `get($identifier)` will not throw a `ServiceNotFoundException`.
+	 *
+	 * @param string $identifier  Identifier of the entry to look for.
+	 *                            Typically a Fully Qualified Class Name
+	 * @return boolean
+	 */
+	public function has($identifier)
+	{
+		$identifier = $this->filterIdentifier($identifier);
+		return $this->carafe->has($identifier);
+	}
+
+
+
+	/**
+	 * finds a previously brewed (SHARED) service and returns it
+	 *
+	 * @param  string $identifier Identifier for the entity class to be constructed.
+	 *                            Typically a Fully Qualified Class Name
+	 * @return mixed
+	 * @throws ServiceNotFoundException No service was found for this identifier.
+	 */
+	public function get($identifier)
+	{
+		$identifier = $this->filterIdentifier($identifier);
+		if ($this->carafe->has($identifier)) {
+			return $this->carafe->get($identifier);
+		}
+		throw new ServiceNotFoundException($identifier);
+	}
+
+
+
+	/**
+	 * returns an instance of the requested entity type using the supplied arguments.
+	 * If a shared service is requested and an instance is already in the carafe, then it will be returned.
+	 * If it is not already in the carafe, then the service will be constructed, added to the carafe, and returned
+	 * If the request is for a new entity and a closure exists in the reservoir for creating it,
+	 * then a new entity will be instantiated from the closure and returned.
+	 * If a closure does not exist, then one will be built and added to the reservoir
+	 * before instantiating the requested entity.
+	 *
+	 * @param  string $identifier Identifier for the entity class to be constructed.
+	 *                            Typically a Fully Qualified Class Name
+	 * @param array   $arguments  an array of arguments to be passed to the entity constructor
+	 * @param string  $type
+	 * @return mixed
+	 * @throws ServiceNotFoundException No service was found for this identifier.
+	 */
+	public function brew($identifier, $arguments = array(), $type = '')
+	{
+		// resolve any class aliases that may exist
+		$identifier = $this->filterIdentifier($identifier);
+		try {
+			// is a shared service being requested?
+			if (empty($type) || $type === CoffeeMaker::BREW_SHARED) {
+				// if a shared service was requested and an instance is in the carafe, then return it
+				return $this->get($identifier);
+			}
+		} catch (ServiceNotFoundException $e) {
+			// if not then we'll just catch the ServiceNotFoundException but not do anything just yet,
+			// and instead, attempt to build whatever was requested
+		}
+		$brewed = false;
+		// if the reservoir doesn't have a closure already for the requested identifier,
+		// then neither a shared service nor a closure for making entities has been built yet
+		if ( ! $this->reservoir->has($identifier)) {
+			// so let's brew something up and add it to the proper collection
+			$brewed = $this->makeCoffee($identifier, $arguments, $type);
+		}
+		// was the brewed item a callable factory function ?
+		if (is_callable($brewed)) {
+			// then instantiate a new entity from the cached closure
+			$entity = $brewed($arguments);
+		} else if ($brewed) {
+			// requested object was a shared entity, so attempt to get it from the carafe again
+			// because if it wasn't there before, then it should have just been brewed and added,
+			// but if it still isn't there, then this time
+			// the thrown ServiceNotFoundException will not be caught
+			$entity = $this->get($identifier);
+		} else {
+			// if identifier is for a non-shared entity,
+			// then either a cached closure already existed, or was just brewed
+			$closure = $this->reservoir->get($identifier);
+			$entity = $closure($arguments);
+		}
+		return $entity;
+	}
+
+
+
+	/**
+	 * @param CoffeeMakerInterface $coffee_maker
+	 * @param string               $type
+	 * @return bool
+	 */
+	public function addCoffeeMaker(CoffeeMakerInterface $coffee_maker, $type)
+	{
+		$type = CoffeeMaker::validateType($type);
+		return $this->coffee_makers->add($coffee_maker, $type);
+	}
+
+
+
+	/**
+	 * @param string   $identifier
+	 * @param callable $closure
+	 * @return callable|null
+	 */
+	public function addClosure($identifier, $closure)
+	{
+		if ( ! is_callable($closure)) {
+			throw new InvalidDataTypeException('$closure', $closure, 'Closure');
+		}
+		$identifier = $this->processIdentifier($identifier);
+		if ($this->reservoir->add($closure, $identifier)) {
+			return $closure;
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * @param string   $identifier
+	 * @return boolean
+	 */
+	public function removeClosure($identifier)
+	{
+		$identifier = $this->processIdentifier($identifier);
+		if ($this->reservoir->has($identifier)) {
+			$this->reservoir->remove($this->reservoir->get($identifier));
+			if ( ! $this->reservoir->has($identifier)) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * @param  string $identifier Identifier for the entity class that the service applies to
+	 *                            Typically a Fully Qualified Class Name
+	 * @param mixed  $service
+	 * @return bool
+	 */
+	public function addService($identifier, $service)
+	{
+		$identifier = $this->processIdentifier($identifier);
+		$service = $this->validateService($identifier, $service);
+		return $this->carafe->add($service, $identifier);
+	}
+
+
+
+	/**
+	 * @param string $identifier
+	 * @return boolean
+	 */
+	public function removeService($identifier)
+	{
+		$identifier = $this->processIdentifier($identifier);
+		if ($this->carafe->has($identifier)) {
+			$this->carafe->remove($this->carafe->get($identifier));
+			if ( ! $this->carafe->has($identifier)) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Adds instructions on how to brew objects
+	 *
+	 * @param RecipeInterface $recipe
+	 * @return mixed
+	 */
+	public function addRecipe(RecipeInterface $recipe)
+	{
+		$this->addAliases($recipe->identifier(), $recipe->filters());
+		$identifier = $this->processIdentifier($recipe->identifier());
+		return $this->recipes->add($recipe, $identifier);
+	}
+
+
+
+	/**
+	 * @param string $identifier The Recipe's identifier
+	 * @return boolean
+	 */
+	public function removeRecipe($identifier)
+	{
+		$identifier = $this->processIdentifier($identifier);
+		if ($this->recipes->has($identifier)) {
+			$this->recipes->remove(
+				$this->recipes->get($identifier)
+			);
+			if ( ! $this->recipes->has($identifier)) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Get instructions on how to brew objects
+	 *
+	 * @param  string $identifier Identifier for the entity class that the recipe applies to
+	 *                            Typically a Fully Qualified Class Name
+	 * @param string $type
+	 * @return RecipeInterface
+	 */
+	public function getRecipe($identifier, $type = '')
+	{
+		$identifier = $this->processIdentifier($identifier);
+		if ($this->recipes->has($identifier)) {
+			return $this->recipes->get($identifier);
+		}
+		$default_recipes = $this->getDefaultRecipes();
+		$matches = array();
+		foreach ($default_recipes as $wildcard => $default_recipe) {
+			// is the wildcard recipe prefix in the identifier ?
+			if (strpos($identifier, $wildcard) !== false) {
+				// track matches and use the number of wildcard characters matched for the key
+				$matches[strlen($wildcard)] = $default_recipe;
+			}
+		}
+		if (count($matches) > 0) {
+			// sort our recipes by the number of wildcard characters matched
+			ksort($matches);
+			// then grab the last recipe form the list, since it had the most matching characters
+			$match = array_pop($matches);
+			// since we are using a default recipe, we need to set it's identifier and fqcn
+			return $this->copyDefaultRecipe($match, $identifier, $type);
+		}
+		if ($this->recipes->has(Recipe::DEFAULT_ID)) {
+			// since we are using a default recipe, we need to set it's identifier and fqcn
+			return $this->copyDefaultRecipe($this->recipes->get(Recipe::DEFAULT_ID), $identifier, $type);
+		}
+		throw new OutOfBoundsException(
+			sprintf(
+				__('Could not brew coffee because no recipes were found for class "%1$s".', 'event_espresso'),
+				$identifier
+			)
+		);
+	}
+
+
+
+	/**
+	 * adds class name aliases to list of filters
+	 *
+	 * @param  string       $identifier Identifier for the entity class that the alias applies to
+	 *                                  Typically a Fully Qualified Class Name
+	 * @param  array|string $aliases
+	 * @return void
+	 * @throws InvalidIdentifierException
+	 */
+	public function addAliases($identifier, $aliases)
+	{
+		if (empty($aliases)) {
+			return;
+		}
+		$identifier = $this->processIdentifier($identifier);
+		foreach ((array)$aliases as $alias) {
+			$this->filters[$this->processIdentifier($alias)] = $identifier;
+		}
+	}
+
+
+
+	/**
+	 * Adds a service to one of the internal collections
+	 *
+	 * @param        $identifier
+	 * @param array  $arguments
+	 * @param string $type
+	 * @return mixed
+	 * @throws ServiceExistsException
+	 */
+	private function makeCoffee($identifier, $arguments = array(), $type = '')
+	{
+		if ((empty($type) || $type === CoffeeMaker::BREW_SHARED) && $this->has($identifier)) {
+			throw new ServiceExistsException($identifier);
+		}
+		$identifier = $this->filterIdentifier($identifier);
+		$recipe = $this->getRecipe($identifier, $type);
+		$type = ! empty($type) ? $type : $recipe->type();
+		$coffee_maker = $this->getCoffeeMaker($type);
+		return $coffee_maker->brew($recipe, $arguments);
+	}
+
+
+
+	/**
+	 * filters alias identifiers to find the real class name
+	 *
+	 * @param  string $identifier Identifier for the entity class that the filter applies to
+	 *                            Typically a Fully Qualified Class Name
+	 * @return string
+	 * @throws InvalidIdentifierException
+	 */
+	private function filterIdentifier($identifier)
+	{
+		$identifier = $this->processIdentifier($identifier);
+		return isset($this->filters[$identifier]) && ! empty($this->filters[$identifier])
+			? $this->filters[$identifier]
+			: $identifier;
+	}
+
+
+
+	/**
+	 * verifies and standardizes identifiers
+	 *
+	 * @param  string $identifier Identifier for the entity class
+	 *                            Typically a Fully Qualified Class Name
+	 * @return string
+	 * @throws InvalidIdentifierException
+	 */
+	private function processIdentifier($identifier)
+	{
+		if ( ! is_string($identifier)) {
+			throw new InvalidIdentifierException(
+				is_object($identifier) ? get_class($identifier) : gettype($identifier),
+				'\Fully\Qualified\ClassName'
+			);
+		}
+		return ltrim($identifier, '\\');
+	}
+
+
+
+	/**
+	 * @param string $type
+	 * @return CoffeeMakerInterface
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 */
+	private function getCoffeeMaker($type)
+	{
+		if ( ! $this->coffee_makers->has($type)) {
+			throw new OutOfBoundsException(
+				__('The requested coffee maker is either missing or invalid.', 'event_espresso')
+			);
+		}
+		return $this->coffee_makers->get($type);
+	}
+
+
+
+	/**
+	 * Retrieves all recipes that use a wildcard "*" in their identifier
+	 * This allows recipes to be set up for handling
+	 * legacy classes that do not support PSR-4 autoloading.
+	 * for example:
+	 * using "EEM_*" for a recipe identifier would target all legacy models like EEM_Attendee
+	 *
+	 * @return array
+	 */
+	private function getDefaultRecipes()
+	{
+		$default_recipes = array();
+		$this->recipes->rewind();
+		while ($this->recipes->valid()) {
+			$identifier = $this->recipes->getInfo();
+			// does this recipe use a wildcard ? (but is NOT the global default)
+			if ($identifier !== Recipe::DEFAULT_ID && strpos($identifier, '*') !== false) {
+				// strip the wildcard and use identifier as key
+				$default_recipes[str_replace('*', '', $identifier)] = $this->recipes->current();
+			}
+			$this->recipes->next();
+		}
+		return $default_recipes;
+	}
+
+
+
+	/**
+	 * clones a default recipe and then copies details
+	 * from the incoming request to it so that it can be used
+	 *
+	 * @param RecipeInterface $default_recipe
+	 * @param string          $identifier
+	 * @param string          $type
+	 * @return RecipeInterface
+	 */
+	private function copyDefaultRecipe(RecipeInterface $default_recipe, $identifier, $type = '')
+	{
+		$recipe = clone $default_recipe;
+		if ( ! empty($type)) {
+			$recipe->setType($type);
+		}
+		// is this the base default recipe ?
+		if ($default_recipe->identifier() === Recipe::DEFAULT_ID) {
+			$recipe->setIdentifier($identifier);
+			$recipe->setFqcn($identifier);
+			return $recipe;
+		}
+		$recipe->setIdentifier($identifier);
+		foreach ($default_recipe->paths() as $path) {
+			$path = str_replace('*', $identifier, $path);
+			if (is_readable($path)) {
+				$recipe->setPaths($path);
+			}
+		}
+		$recipe->setFqcn($identifier);
+		return $recipe;
+	}
+
+
+
+	/**
+	 * @param  string $identifier Identifier for the entity class that the service applies to
+	 *                            Typically a Fully Qualified Class Name
+	 * @param mixed  $service
+	 * @return object
+	 * @throws InvalidServiceException
+	 */
+	private function validateService($identifier, $service)
+	{
+		if ( ! is_object($service)) {
+			throw new InvalidServiceException(
+				$identifier,
+				$service
+			);
+		}
+		return $service;
+	}
 
 }
 // End of file CoffeeShop.php

modules/events_archive/EventsArchiveIframe.php

Indentation +52 added lines, -52 removed lines

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

Spacing +9 added lines, -9 removed lines

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

core/services/cache/PostRelatedCacheManager.php

Spacing +2 added lines, -2 removed lines

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

Indentation +86 added lines, -86 removed lines

@@ -18,92 +18,92 @@
 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;
-    }
-
-
-
-    /**
-     * If you are caching content that pertains to a Post of any type,
-     * then it is recommended to pass the post id and cache id prefix to this method
-     * so that it can be added to the post related cache tracking.
-     * Then, whenever that post is updated, the cache will automatically be deleted,
-     * which helps to ensure that outdated cache content will not be served
-     *
-     * @param int    $post_ID    [required]
-     * @param string $id_prefix  [required] Appended to all cache IDs. Can be helpful in finding specific cache types.
-     *                           May also be helpful to include an additional specific identifier,
-     *                           such as a post ID as part of the $id_prefix so that individual caches
-     *                           can be found and/or cleared. ex: "venue-28", or "shortcode-156".
-     *                           BasicCacheManager::CACHE_PREFIX will also be prepended to the cache id.
-     */
-    public function clearPostRelatedCacheOnUpdate($post_ID, $id_prefix)
-    {
-        $post_related_cache = (array)get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
-        // if post is not already being tracked
-        if ( ! isset($post_related_cache[$post_ID])) {
-            // add array to add cache ids to
-            $post_related_cache[$post_ID] = array();
-        }
-        // add cache id to be tracked
-        $post_related_cache[$post_ID][] = $id_prefix;
-        update_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, $post_related_cache);
-    }
-
-
-
-    /**
-     * callback hooked into the WordPress "save_post" action
-     * deletes any cache content associated with the post
-     *
-     * @param int $post_ID [required]
-     */
-    public function clearPostRelatedCache($post_ID)
-    {
-        $post_related_cache = (array)get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
-        // if post is not being tracked
-        if ( ! isset($post_related_cache[$post_ID])) {
-            return;
-        }
-        // get cache id prefixes for post, and delete their corresponding transients
-        $this->clear($post_related_cache[$post_ID]);
-        unset($post_related_cache[$post_ID]);
-        update_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, $post_related_cache);
-    }
+	/**
+	 * @type string
+	 */
+	const POST_CACHE_PREFIX = 'ee_cache_post_';
+
+	/**
+	 * wp-option option_name for tracking post related cache
+	 *
+	 * @type string
+	 */
+	const POST_CACHE_OPTIONS_KEY = 'ee_post_cache';
+
+
+
+	/**
+	 * PostRelatedCacheManager constructor.
+	 *
+	 * @param CacheStorageInterface      $cache_storage
+	 */
+	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;
+	}
+
+
+
+	/**
+	 * If you are caching content that pertains to a Post of any type,
+	 * then it is recommended to pass the post id and cache id prefix to this method
+	 * so that it can be added to the post related cache tracking.
+	 * Then, whenever that post is updated, the cache will automatically be deleted,
+	 * which helps to ensure that outdated cache content will not be served
+	 *
+	 * @param int    $post_ID    [required]
+	 * @param string $id_prefix  [required] Appended to all cache IDs. Can be helpful in finding specific cache types.
+	 *                           May also be helpful to include an additional specific identifier,
+	 *                           such as a post ID as part of the $id_prefix so that individual caches
+	 *                           can be found and/or cleared. ex: "venue-28", or "shortcode-156".
+	 *                           BasicCacheManager::CACHE_PREFIX will also be prepended to the cache id.
+	 */
+	public function clearPostRelatedCacheOnUpdate($post_ID, $id_prefix)
+	{
+		$post_related_cache = (array)get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
+		// if post is not already being tracked
+		if ( ! isset($post_related_cache[$post_ID])) {
+			// add array to add cache ids to
+			$post_related_cache[$post_ID] = array();
+		}
+		// add cache id to be tracked
+		$post_related_cache[$post_ID][] = $id_prefix;
+		update_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, $post_related_cache);
+	}
+
+
+
+	/**
+	 * callback hooked into the WordPress "save_post" action
+	 * deletes any cache content associated with the post
+	 *
+	 * @param int $post_ID [required]
+	 */
+	public function clearPostRelatedCache($post_ID)
+	{
+		$post_related_cache = (array)get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
+		// if post is not being tracked
+		if ( ! isset($post_related_cache[$post_ID])) {
+			return;
+		}
+		// get cache id prefixes for post, and delete their corresponding transients
+		$this->clear($post_related_cache[$post_ID]);
+		unset($post_related_cache[$post_ID]);
+		update_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, $post_related_cache);
+	}
 
 
 }