eventespresso / event-espresso-core

core/CPTs/EE_CPT_Event_Strategy.core.php

Indentation +232 added lines, -232 removed lines

@@ -13,258 +13,258 @@
 class EE_CPT_Event_Strategy
 {
 
-    /**
-     * the current page, if it utilizes CPTs
-     *
-     * @var object $CPT
-     */
-    protected $CPT;
+	/**
+	 * the current page, if it utilizes CPTs
+	 *
+	 * @var object $CPT
+	 */
+	protected $CPT;
 
 
-    /**
-     * @param WP_Query $wp_query
-     * @param array    $CPT
-     */
-    public function __construct($wp_query, $CPT = array())
-    {
-        if ($wp_query instanceof WP_Query) {
-            $WP_Query = $wp_query;
-            $this->CPT = $CPT;
-        } else {
-            $WP_Query = isset($wp_query['WP_Query']) ? $wp_query['WP_Query'] : null;
-            $this->CPT = isset($wp_query['CPT']) ? $wp_query['CPT'] : null;
-        }
-        // !!!!!!!!!!  IMPORTANT !!!!!!!!!!!!
-        // here's the list of available filters in the WP_Query object
-        // 'posts_where'
-        // 'posts_where_paged'
-        // 'posts_groupby'
-        // 'posts_join_paged'
-        // 'posts_orderby'
-        // 'posts_distinct'
-        // 'post_limits'
-        // 'posts_fields'
-        // 'posts_join'
-        $this->_add_filters();
-        if ($WP_Query instanceof WP_Query) {
-            $WP_Query->is_espresso_event_single = is_singular()
-                                                  && isset($WP_Query->query->post_type)
-                                                  && $WP_Query->query->post_type === 'espresso_events';
-            $WP_Query->is_espresso_event_archive = is_post_type_archive('espresso_events');
-            $WP_Query->is_espresso_event_taxonomy = is_tax('espresso_event_categories');
-        }
-    }
+	/**
+	 * @param WP_Query $wp_query
+	 * @param array    $CPT
+	 */
+	public function __construct($wp_query, $CPT = array())
+	{
+		if ($wp_query instanceof WP_Query) {
+			$WP_Query = $wp_query;
+			$this->CPT = $CPT;
+		} else {
+			$WP_Query = isset($wp_query['WP_Query']) ? $wp_query['WP_Query'] : null;
+			$this->CPT = isset($wp_query['CPT']) ? $wp_query['CPT'] : null;
+		}
+		// !!!!!!!!!!  IMPORTANT !!!!!!!!!!!!
+		// here's the list of available filters in the WP_Query object
+		// 'posts_where'
+		// 'posts_where_paged'
+		// 'posts_groupby'
+		// 'posts_join_paged'
+		// 'posts_orderby'
+		// 'posts_distinct'
+		// 'post_limits'
+		// 'posts_fields'
+		// 'posts_join'
+		$this->_add_filters();
+		if ($WP_Query instanceof WP_Query) {
+			$WP_Query->is_espresso_event_single = is_singular()
+												  && isset($WP_Query->query->post_type)
+												  && $WP_Query->query->post_type === 'espresso_events';
+			$WP_Query->is_espresso_event_archive = is_post_type_archive('espresso_events');
+			$WP_Query->is_espresso_event_taxonomy = is_tax('espresso_event_categories');
+		}
+	}
 
 
-    /**
-     * When an instance of this class is created, we add our filters
-     * (which will get removed in case the next call to get_posts ISN'T
-     * for event CPTs)
-     */
-    protected function _add_filters()
-    {
-        add_filter('posts_fields', array($this, 'posts_fields'), 1, 2);
-        add_filter('posts_join', array($this, 'posts_join'), 1, 2);
-        add_filter('posts_where', array($this, 'posts_where'), 10, 2);
-        // add_filter( 'the_posts', array( $this, 'the_posts' ), 1, 2 );
-        add_filter('posts_orderby', array($this, 'posts_orderby'), 1, 2);
-        add_filter('posts_groupby', array($this, 'posts_groupby'), 1, 2);
-        add_action('posts_selection', array($this, 'remove_filters'));
-    }
+	/**
+	 * When an instance of this class is created, we add our filters
+	 * (which will get removed in case the next call to get_posts ISN'T
+	 * for event CPTs)
+	 */
+	protected function _add_filters()
+	{
+		add_filter('posts_fields', array($this, 'posts_fields'), 1, 2);
+		add_filter('posts_join', array($this, 'posts_join'), 1, 2);
+		add_filter('posts_where', array($this, 'posts_where'), 10, 2);
+		// add_filter( 'the_posts', array( $this, 'the_posts' ), 1, 2 );
+		add_filter('posts_orderby', array($this, 'posts_orderby'), 1, 2);
+		add_filter('posts_groupby', array($this, 'posts_groupby'), 1, 2);
+		add_action('posts_selection', array($this, 'remove_filters'));
+	}
 
 
-    /**
-     * public access to _remove_filters()
-     *
-     * @since 4.9.63.p
-     */
-    public function remove_filters()
-    {
-        $this->_remove_filters();
-    }
+	/**
+	 * public access to _remove_filters()
+	 *
+	 * @since 4.9.63.p
+	 */
+	public function remove_filters()
+	{
+		$this->_remove_filters();
+	}
 
 
-    /**
-     * Should eb called when the last filter or hook is fired for this CPT strategy.
-     * This is to avoid applying this CPT strategy for other posts or CPTs (eg,
-     * we don't want to join to the datetime table when querying for venues, do we!?)
-     */
-    protected function _remove_filters()
-    {
-        remove_filter('posts_fields', array($this, 'posts_fields'), 1);
-        remove_filter('posts_join', array($this, 'posts_join'), 1);
-        remove_filter('posts_where', array($this, 'posts_where'), 10);
-        // remove_filter( 'the_posts', array( $this, 'the_posts' ), 1 );
-        remove_filter('posts_orderby', array($this, 'posts_orderby'), 1);
-        remove_filter('posts_groupby', array($this, 'posts_groupby'), 1);
-        remove_action('posts_selection', array($this, 'remove_filters'));
-    }
+	/**
+	 * Should eb called when the last filter or hook is fired for this CPT strategy.
+	 * This is to avoid applying this CPT strategy for other posts or CPTs (eg,
+	 * we don't want to join to the datetime table when querying for venues, do we!?)
+	 */
+	protected function _remove_filters()
+	{
+		remove_filter('posts_fields', array($this, 'posts_fields'), 1);
+		remove_filter('posts_join', array($this, 'posts_join'), 1);
+		remove_filter('posts_where', array($this, 'posts_where'), 10);
+		// remove_filter( 'the_posts', array( $this, 'the_posts' ), 1 );
+		remove_filter('posts_orderby', array($this, 'posts_orderby'), 1);
+		remove_filter('posts_groupby', array($this, 'posts_groupby'), 1);
+		remove_action('posts_selection', array($this, 'remove_filters'));
+	}
 
 
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return    string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function posts_fields($SQL, WP_Query $wp_query)
-    {
-        if (
-            $wp_query instanceof WP_Query
-            &&
-            (
-                $wp_query->is_espresso_event_single
-                || $wp_query->is_espresso_event_archive
-                || $wp_query->is_espresso_event_taxonomy
-            )
-        ) {
-            // adds something like ", wp_esp_datetime.* " to WP Query SELECT statement
-            $SQL .= ', ' . EEM_Datetime::instance()->table() . '.* ';
-            if ($wp_query->is_espresso_event_archive || $wp_query->is_espresso_event_taxonomy) {
-                // because we only want to retrieve the next upcoming datetime for each event:
-                // add something like:
-                // ", MIN( wp_esp_datetime.DTT_EVT_start ) as event_start_date "
-                // to WP Query SELECT statement
-                $SQL .= ', MIN( ' . EEM_Datetime::instance()->table() . '.DTT_EVT_start ) as event_start_date ';
-            }
-        }
-        return $SQL;
-    }
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return    string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function posts_fields($SQL, WP_Query $wp_query)
+	{
+		if (
+			$wp_query instanceof WP_Query
+			&&
+			(
+				$wp_query->is_espresso_event_single
+				|| $wp_query->is_espresso_event_archive
+				|| $wp_query->is_espresso_event_taxonomy
+			)
+		) {
+			// adds something like ", wp_esp_datetime.* " to WP Query SELECT statement
+			$SQL .= ', ' . EEM_Datetime::instance()->table() . '.* ';
+			if ($wp_query->is_espresso_event_archive || $wp_query->is_espresso_event_taxonomy) {
+				// because we only want to retrieve the next upcoming datetime for each event:
+				// add something like:
+				// ", MIN( wp_esp_datetime.DTT_EVT_start ) as event_start_date "
+				// to WP Query SELECT statement
+				$SQL .= ', MIN( ' . EEM_Datetime::instance()->table() . '.DTT_EVT_start ) as event_start_date ';
+			}
+		}
+		return $SQL;
+	}
 
 
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function posts_join($SQL, WP_Query $wp_query)
-    {
-        if (
-            $wp_query instanceof WP_Query
-            &&
-            (
-                $wp_query->is_espresso_event_single
-                || $wp_query->is_espresso_event_archive
-                || $wp_query->is_espresso_event_taxonomy
-            )
-        ) {
-            // adds something like:
-            // " LEFT JOIN wp_esp_datetime ON ( wp_esp_datetime.EVT_ID = wp_posts.ID ) "
-            // to WP Query JOIN statement
-            $SQL .= ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . EEM_Event::instance()->table()
-                    . '.ID = ' . EEM_Datetime::instance()->table() . '.'
-                    . EEM_Event::instance()->primary_key_name() . ' ) ';
-        }
-        return $SQL;
-    }
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function posts_join($SQL, WP_Query $wp_query)
+	{
+		if (
+			$wp_query instanceof WP_Query
+			&&
+			(
+				$wp_query->is_espresso_event_single
+				|| $wp_query->is_espresso_event_archive
+				|| $wp_query->is_espresso_event_taxonomy
+			)
+		) {
+			// adds something like:
+			// " LEFT JOIN wp_esp_datetime ON ( wp_esp_datetime.EVT_ID = wp_posts.ID ) "
+			// to WP Query JOIN statement
+			$SQL .= ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . EEM_Event::instance()->table()
+					. '.ID = ' . EEM_Datetime::instance()->table() . '.'
+					. EEM_Event::instance()->primary_key_name() . ' ) ';
+		}
+		return $SQL;
+	}
 
 
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function posts_where($SQL, WP_Query $wp_query)
-    {
-        if (
-            $wp_query instanceof WP_Query
-            &&
-            (
-                $wp_query->is_espresso_event_archive
-                || $wp_query->is_espresso_event_taxonomy
-            )
-        ) {
-            if (
-                ! isset(EE_Registry::instance()->CFG->template_settings->EED_Events_Archive)
-                || ! isset(EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->display_expired_events)
-                || ! EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->display_expired_events
-            ) {
-                $SQL .= ' AND ' . EEM_Datetime::instance()->table() . ".DTT_EVT_end > '"
-                        . current_time('mysql', true) . "' ";
-            }
-        }
-        return $SQL;
-    }
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function posts_where($SQL, WP_Query $wp_query)
+	{
+		if (
+			$wp_query instanceof WP_Query
+			&&
+			(
+				$wp_query->is_espresso_event_archive
+				|| $wp_query->is_espresso_event_taxonomy
+			)
+		) {
+			if (
+				! isset(EE_Registry::instance()->CFG->template_settings->EED_Events_Archive)
+				|| ! isset(EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->display_expired_events)
+				|| ! EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->display_expired_events
+			) {
+				$SQL .= ' AND ' . EEM_Datetime::instance()->table() . ".DTT_EVT_end > '"
+						. current_time('mysql', true) . "' ";
+			}
+		}
+		return $SQL;
+	}
 
 
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     */
-    public function posts_orderby($SQL, WP_Query $wp_query)
-    {
-        if (
-            $wp_query instanceof WP_Query
-            &&
-            (
-                $wp_query->is_espresso_event_archive
-                || $wp_query->is_espresso_event_taxonomy
-            )
-        ) {
-            $SQL = ' event_start_date ASC ';
-        }
-        return $SQL;
-    }
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 */
+	public function posts_orderby($SQL, WP_Query $wp_query)
+	{
+		if (
+			$wp_query instanceof WP_Query
+			&&
+			(
+				$wp_query->is_espresso_event_archive
+				|| $wp_query->is_espresso_event_taxonomy
+			)
+		) {
+			$SQL = ' event_start_date ASC ';
+		}
+		return $SQL;
+	}
 
 
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     */
-    public function posts_groupby($SQL, WP_Query $wp_query)
-    {
-        if (
-            $wp_query instanceof WP_Query
-            &&
-            (
-                $wp_query->is_espresso_event_archive
-                || $wp_query->is_espresso_event_taxonomy
-            )
-        ) {
-            // TODO: add event list option for displaying ALL datetimes in event list or only primary datetime (default)
-            // we're joining to the datetimes table, where there can be MANY datetimes for a single event,
-            // but we want to only show each event only once
-            // (whereas if we didn't group them by the post's ID, then we would end up with many repeats)
-            global $wpdb;
-            $SQL = $wpdb->posts . '.ID ';
-        }
-        return $SQL;
-    }
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 */
+	public function posts_groupby($SQL, WP_Query $wp_query)
+	{
+		if (
+			$wp_query instanceof WP_Query
+			&&
+			(
+				$wp_query->is_espresso_event_archive
+				|| $wp_query->is_espresso_event_taxonomy
+			)
+		) {
+			// TODO: add event list option for displaying ALL datetimes in event list or only primary datetime (default)
+			// we're joining to the datetimes table, where there can be MANY datetimes for a single event,
+			// but we want to only show each event only once
+			// (whereas if we didn't group them by the post's ID, then we would end up with many repeats)
+			global $wpdb;
+			$SQL = $wpdb->posts . '.ID ';
+		}
+		return $SQL;
+	}
 
 
-    /**
-     * @param array    $posts
-     * @param WP_Query $wp_query
-     * @return array
-     */
-    public function the_posts($posts, WP_Query $wp_query)
-    {
-        return $posts;
-    }
+	/**
+	 * @param array    $posts
+	 * @param WP_Query $wp_query
+	 * @return array
+	 */
+	public function the_posts($posts, WP_Query $wp_query)
+	{
+		return $posts;
+	}
 
 
-    /**
-     * @param null $meta_value
-     * @param      $post_id
-     * @param      $meta_key
-     * @param      $single
-     * @return    string
-     */
-    public function get_EE_post_type_metadata($meta_value = null, $post_id, $meta_key, $single)
-    {
-        return $meta_value;
-    }
+	/**
+	 * @param null $meta_value
+	 * @param      $post_id
+	 * @param      $meta_key
+	 * @param      $single
+	 * @return    string
+	 */
+	public function get_EE_post_type_metadata($meta_value = null, $post_id, $meta_key, $single)
+	{
+		return $meta_value;
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -122,13 +122,13 @@ 
             )
         ) {
             // adds something like ", wp_esp_datetime.* " to WP Query SELECT statement
-            $SQL .= ', ' . EEM_Datetime::instance()->table() . '.* ';
+            $SQL .= ', '.EEM_Datetime::instance()->table().'.* ';
             if ($wp_query->is_espresso_event_archive || $wp_query->is_espresso_event_taxonomy) {
                 // because we only want to retrieve the next upcoming datetime for each event:
                 // add something like:
                 // ", MIN( wp_esp_datetime.DTT_EVT_start ) as event_start_date "
                 // to WP Query SELECT statement
-                $SQL .= ', MIN( ' . EEM_Datetime::instance()->table() . '.DTT_EVT_start ) as event_start_date ';
+                $SQL .= ', MIN( '.EEM_Datetime::instance()->table().'.DTT_EVT_start ) as event_start_date ';
             }
         }
         return $SQL;
@@ -158,9 +158,9 @@ 
             // adds something like:
             // " LEFT JOIN wp_esp_datetime ON ( wp_esp_datetime.EVT_ID = wp_posts.ID ) "
             // to WP Query JOIN statement
-            $SQL .= ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . EEM_Event::instance()->table()
-                    . '.ID = ' . EEM_Datetime::instance()->table() . '.'
-                    . EEM_Event::instance()->primary_key_name() . ' ) ';
+            $SQL .= ' INNER JOIN '.EEM_Datetime::instance()->table().' ON ( '.EEM_Event::instance()->table()
+                    . '.ID = '.EEM_Datetime::instance()->table().'.'
+                    . EEM_Event::instance()->primary_key_name().' ) ';
         }
         return $SQL;
     }
@@ -190,8 +190,8 @@ 
                 || ! isset(EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->display_expired_events)
                 || ! EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->display_expired_events
             ) {
-                $SQL .= ' AND ' . EEM_Datetime::instance()->table() . ".DTT_EVT_end > '"
-                        . current_time('mysql', true) . "' ";
+                $SQL .= ' AND '.EEM_Datetime::instance()->table().".DTT_EVT_end > '"
+                        . current_time('mysql', true)."' ";
             }
         }
         return $SQL;
@@ -239,7 +239,7 @@ 
             // but we want to only show each event only once
             // (whereas if we didn't group them by the post's ID, then we would end up with many repeats)
             global $wpdb;
-            $SQL = $wpdb->posts . '.ID ';
+            $SQL = $wpdb->posts.'.ID ';
         }
         return $SQL;
     }

core/services/progress_steps/ProgressStepInterface.php

Indentation +29 added lines, -29 removed lines

@@ -12,33 +12,33 @@
 interface ProgressStepInterface
 {
 
-    /**
-     * @return boolean
-     */
-    public function isCurrent();
-
-    /**
-     * @param boolean $is_current
-     */
-    public function setIsCurrent($is_current = true);
-
-    /**
-     * @return string
-     */
-    public function id();
-
-    /**
-     * @return int
-     */
-    public function order();
-
-    /**
-     * @return string
-     */
-    public function htmlClass();
-
-    /**
-     * @return string
-     */
-    public function text();
+	/**
+	 * @return boolean
+	 */
+	public function isCurrent();
+
+	/**
+	 * @param boolean $is_current
+	 */
+	public function setIsCurrent($is_current = true);
+
+	/**
+	 * @return string
+	 */
+	public function id();
+
+	/**
+	 * @return int
+	 */
+	public function order();
+
+	/**
+	 * @return string
+	 */
+	public function htmlClass();
+
+	/**
+	 * @return string
+	 */
+	public function text();
 }

core/services/commands/attendee/CreateAttendeeCommandHandler.php

Indentation +121 added lines, -121 removed lines

@@ -21,135 +21,135 @@
 {
 
 
-    /**
-     * @var EEM_Attendee $attendee_model
-     */
-    protected $attendee_model;
+	/**
+	 * @var EEM_Attendee $attendee_model
+	 */
+	protected $attendee_model;
 
 
-    /**
-     * @param EEM_Attendee $attendee_model
-     */
-    public function __construct(EEM_Attendee $attendee_model)
-    {
-        $this->attendee_model = $attendee_model;
-    }
+	/**
+	 * @param EEM_Attendee $attendee_model
+	 */
+	public function __construct(EEM_Attendee $attendee_model)
+	{
+		$this->attendee_model = $attendee_model;
+	}
 
 
-    /**
-     * @param CommandInterface|CreateAttendeeCommand $command
-     * @return EE_Attendee
-     * @throws EE_Error
-     * @throws InvalidEntityException
-     */
-    public function handle(CommandInterface $command)
-    {
-        // have we met before?
-        $attendee = $this->findExistingAttendee(
-            $command->registration(),
-            $command->attendeeDetails()
-        );
-        // did we find an already existing record for this attendee ?
-        if ($attendee instanceof EE_Attendee) {
-            $attendee = $this->updateExistingAttendeeData(
-                $attendee,
-                $command->attendeeDetails()
-            );
-        } else {
-            $attendee = $this->createNewAttendee(
-                $command->registration(),
-                $command->attendeeDetails()
-            );
-        }
-        return $attendee;
-    }
+	/**
+	 * @param CommandInterface|CreateAttendeeCommand $command
+	 * @return EE_Attendee
+	 * @throws EE_Error
+	 * @throws InvalidEntityException
+	 */
+	public function handle(CommandInterface $command)
+	{
+		// have we met before?
+		$attendee = $this->findExistingAttendee(
+			$command->registration(),
+			$command->attendeeDetails()
+		);
+		// did we find an already existing record for this attendee ?
+		if ($attendee instanceof EE_Attendee) {
+			$attendee = $this->updateExistingAttendeeData(
+				$attendee,
+				$command->attendeeDetails()
+			);
+		} else {
+			$attendee = $this->createNewAttendee(
+				$command->registration(),
+				$command->attendeeDetails()
+			);
+		}
+		return $attendee;
+	}
 
 
-    /**
-     * find_existing_attendee
-     *
-     * @param EE_Registration $registration
-     * @param  array          $attendee_data
-     * @return EE_Attendee
-     */
-    private function findExistingAttendee(EE_Registration $registration, array $attendee_data)
-    {
-        $existing_attendee = null;
-        // does this attendee already exist in the db ?
-        // we're searching using a combination of first name, last name, AND email address
-        $ATT_fname = ! empty($attendee_data['ATT_fname'])
-            ? $attendee_data['ATT_fname']
-            : '';
-        $ATT_lname = ! empty($attendee_data['ATT_lname'])
-            ? $attendee_data['ATT_lname']
-            : '';
-        $ATT_email = ! empty($attendee_data['ATT_email'])
-            ? $attendee_data['ATT_email']
-            : '';
-        // but only if those have values
-        if ($ATT_fname && $ATT_lname && $ATT_email) {
-            $existing_attendee = $this->attendee_model->find_existing_attendee(
-                array(
-                    'ATT_fname' => $ATT_fname,
-                    'ATT_lname' => $ATT_lname,
-                    'ATT_email' => $ATT_email,
-                )
-            );
-        }
-        return apply_filters(
-            'FHEE_EventEspresso_core_services_commands_attendee_CreateAttendeeCommandHandler__findExistingAttendee__existing_attendee',
-            $existing_attendee,
-            $registration,
-            $attendee_data
-        );
-    }
+	/**
+	 * find_existing_attendee
+	 *
+	 * @param EE_Registration $registration
+	 * @param  array          $attendee_data
+	 * @return EE_Attendee
+	 */
+	private function findExistingAttendee(EE_Registration $registration, array $attendee_data)
+	{
+		$existing_attendee = null;
+		// does this attendee already exist in the db ?
+		// we're searching using a combination of first name, last name, AND email address
+		$ATT_fname = ! empty($attendee_data['ATT_fname'])
+			? $attendee_data['ATT_fname']
+			: '';
+		$ATT_lname = ! empty($attendee_data['ATT_lname'])
+			? $attendee_data['ATT_lname']
+			: '';
+		$ATT_email = ! empty($attendee_data['ATT_email'])
+			? $attendee_data['ATT_email']
+			: '';
+		// but only if those have values
+		if ($ATT_fname && $ATT_lname && $ATT_email) {
+			$existing_attendee = $this->attendee_model->find_existing_attendee(
+				array(
+					'ATT_fname' => $ATT_fname,
+					'ATT_lname' => $ATT_lname,
+					'ATT_email' => $ATT_email,
+				)
+			);
+		}
+		return apply_filters(
+			'FHEE_EventEspresso_core_services_commands_attendee_CreateAttendeeCommandHandler__findExistingAttendee__existing_attendee',
+			$existing_attendee,
+			$registration,
+			$attendee_data
+		);
+	}
 
 
-    /**
-     * _update_existing_attendee_data
-     * in case it has changed since last time they registered for an event
-     *
-     * @param EE_Attendee $existing_attendee
-     * @param  array      $attendee_data
-     * @return EE_Attendee
-     * @throws EE_Error
-     */
-    private function updateExistingAttendeeData(EE_Attendee $existing_attendee, array $attendee_data)
-    {
-        // first remove fname, lname, and email from attendee data
-        // because these properties will be exactly the same as the returned attendee object,
-        // since they were used in the query to get the attendee object in the first place
-        $dont_set = array('ATT_fname', 'ATT_lname', 'ATT_email');
-        // now loop thru what's left and add to attendee CPT
-        foreach ($attendee_data as $property_name => $property_value) {
-            if (
-                ! in_array($property_name, $dont_set, true)
-                && $this->attendee_model->has_field($property_name)
-            ) {
-                $existing_attendee->set($property_name, $property_value);
-            }
-        }
-        // better save that now
-        $existing_attendee->save();
-        return $existing_attendee;
-    }
+	/**
+	 * _update_existing_attendee_data
+	 * in case it has changed since last time they registered for an event
+	 *
+	 * @param EE_Attendee $existing_attendee
+	 * @param  array      $attendee_data
+	 * @return EE_Attendee
+	 * @throws EE_Error
+	 */
+	private function updateExistingAttendeeData(EE_Attendee $existing_attendee, array $attendee_data)
+	{
+		// first remove fname, lname, and email from attendee data
+		// because these properties will be exactly the same as the returned attendee object,
+		// since they were used in the query to get the attendee object in the first place
+		$dont_set = array('ATT_fname', 'ATT_lname', 'ATT_email');
+		// now loop thru what's left and add to attendee CPT
+		foreach ($attendee_data as $property_name => $property_value) {
+			if (
+				! in_array($property_name, $dont_set, true)
+				&& $this->attendee_model->has_field($property_name)
+			) {
+				$existing_attendee->set($property_name, $property_value);
+			}
+		}
+		// better save that now
+		$existing_attendee->save();
+		return $existing_attendee;
+	}
 
 
-    /**
-     * create_new_attendee
-     *
-     * @param EE_Registration $registration
-     * @param  array          $attendee_data
-     * @return EE_Attendee
-     * @throws EE_Error
-     */
-    private function createNewAttendee(EE_Registration $registration, array $attendee_data)
-    {
-        // create new attendee object
-        $new_attendee = EE_Attendee::new_instance($attendee_data);
-        // set author to event creator
-        $new_attendee->set('ATT_author', $registration->event()->wp_user());
-        $new_attendee->save();
-        return $new_attendee;
-    }
+	/**
+	 * create_new_attendee
+	 *
+	 * @param EE_Registration $registration
+	 * @param  array          $attendee_data
+	 * @return EE_Attendee
+	 * @throws EE_Error
+	 */
+	private function createNewAttendee(EE_Registration $registration, array $attendee_data)
+	{
+		// create new attendee object
+		$new_attendee = EE_Attendee::new_instance($attendee_data);
+		// set author to event creator
+		$new_attendee->set('ATT_author', $registration->event()->wp_user());
+		$new_attendee->save();
+		return $new_attendee;
+	}
 }

core/services/address/CountrySubRegionDao.php

Indentation +227 added lines, -227 removed lines

@@ -26,252 +26,252 @@
 class CountrySubRegionDao
 {
 
-    const REPO_URL = 'https://raw.githubusercontent.com/eventespresso/countries-and-subregions/master/';
+	const REPO_URL = 'https://raw.githubusercontent.com/eventespresso/countries-and-subregions/master/';
 
-    const OPTION_NAME_COUNTRY_DATA_VERSION = 'espresso-country-sub-region-data-version';
+	const OPTION_NAME_COUNTRY_DATA_VERSION = 'espresso-country-sub-region-data-version';
 
-    /**
-     * @var EEM_State $state_model
-     */
-    private $state_model;
+	/**
+	 * @var EEM_State $state_model
+	 */
+	private $state_model;
 
-    /**
-     * @var JsonValidator $json_validator
-     */
-    private $json_validator;
+	/**
+	 * @var JsonValidator $json_validator
+	 */
+	private $json_validator;
 
-    /**
-     * @var string $data_version
-     */
-    private $data_version;
+	/**
+	 * @var string $data_version
+	 */
+	private $data_version;
 
-    /**
-     * @var array $countries
-     */
-    private $countries = array();
+	/**
+	 * @var array $countries
+	 */
+	private $countries = array();
 
 
-    /**
-     * CountrySubRegionDao constructor.
-     *
-     * @param EEM_State     $state_model
-     * @param JsonValidator $json_validator
-     */
-    public function __construct(EEM_State $state_model, JsonValidator $json_validator)
-    {
-        $this->state_model = $state_model;
-        $this->json_validator = $json_validator;
-    }
+	/**
+	 * CountrySubRegionDao constructor.
+	 *
+	 * @param EEM_State     $state_model
+	 * @param JsonValidator $json_validator
+	 */
+	public function __construct(EEM_State $state_model, JsonValidator $json_validator)
+	{
+		$this->state_model = $state_model;
+		$this->json_validator = $json_validator;
+	}
 
 
-    /**
-     * @param EE_Country $country_object
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function saveCountrySubRegions(EE_Country $country_object)
-    {
-        $CNT_ISO = $country_object->ID();
-        $has_sub_regions = $this->state_model->count(array(array('Country.CNT_ISO' => $CNT_ISO)));
-        $data = [];
-        if (empty($this->countries)) {
-            $this->data_version = $this->getCountrySubRegionDataVersion();
-            $data = $this->retrieveJsonData(self::REPO_URL . 'countries.json');
-        }
-        if (empty($data)) {
-            EE_Error::add_error(
-                'Country Subregion Data could not be retrieved',
-                __FILE__,
-                __METHOD__,
-                __LINE__
-            );
-        }
-        if (
-            ! $has_sub_regions
-            || (isset($data->version) && version_compare($data->version, $this->data_version))
-        ) {
-            if (
-                isset($data->countries)
-                && $this->processCountryData($CNT_ISO, $data->countries) > 0
-            ) {
-                $this->countries = $data->countries;
-                $this->updateCountrySubRegionDataVersion($data->version);
-                return true;
-            }
-        }
-        return false;
-    }
+	/**
+	 * @param EE_Country $country_object
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function saveCountrySubRegions(EE_Country $country_object)
+	{
+		$CNT_ISO = $country_object->ID();
+		$has_sub_regions = $this->state_model->count(array(array('Country.CNT_ISO' => $CNT_ISO)));
+		$data = [];
+		if (empty($this->countries)) {
+			$this->data_version = $this->getCountrySubRegionDataVersion();
+			$data = $this->retrieveJsonData(self::REPO_URL . 'countries.json');
+		}
+		if (empty($data)) {
+			EE_Error::add_error(
+				'Country Subregion Data could not be retrieved',
+				__FILE__,
+				__METHOD__,
+				__LINE__
+			);
+		}
+		if (
+			! $has_sub_regions
+			|| (isset($data->version) && version_compare($data->version, $this->data_version))
+		) {
+			if (
+				isset($data->countries)
+				&& $this->processCountryData($CNT_ISO, $data->countries) > 0
+			) {
+				$this->countries = $data->countries;
+				$this->updateCountrySubRegionDataVersion($data->version);
+				return true;
+			}
+		}
+		return false;
+	}
 
 
-    /**
-     * @since 4.9.70.p
-     * @return string
-     */
-    private function getCountrySubRegionDataVersion()
-    {
-        return get_option(self::OPTION_NAME_COUNTRY_DATA_VERSION, null);
-    }
+	/**
+	 * @since 4.9.70.p
+	 * @return string
+	 */
+	private function getCountrySubRegionDataVersion()
+	{
+		return get_option(self::OPTION_NAME_COUNTRY_DATA_VERSION, null);
+	}
 
 
-    /**
-     * @param string $version
-     */
-    private function updateCountrySubRegionDataVersion($version = '')
-    {
-        // add version option if it has never been added before, or update existing
-        if ($this->data_version === null) {
-            add_option(self::OPTION_NAME_COUNTRY_DATA_VERSION, $version, '', false);
-        } else {
-            update_option(self::OPTION_NAME_COUNTRY_DATA_VERSION, $version);
-        }
-    }
+	/**
+	 * @param string $version
+	 */
+	private function updateCountrySubRegionDataVersion($version = '')
+	{
+		// add version option if it has never been added before, or update existing
+		if ($this->data_version === null) {
+			add_option(self::OPTION_NAME_COUNTRY_DATA_VERSION, $version, '', false);
+		} else {
+			update_option(self::OPTION_NAME_COUNTRY_DATA_VERSION, $version);
+		}
+	}
 
 
-    /**
-     * @param string $CNT_ISO
-     * @param array  $countries
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.9.70.p
-     */
-    private function processCountryData($CNT_ISO, $countries = array())
-    {
-        if (! empty($countries)) {
-            foreach ($countries as $key => $country) {
-                if (
-                    $country instanceof stdClass
-                    && $country->code === $CNT_ISO
-                    && empty($country->sub_regions)
-                    && ! empty($country->filename)
-                ) {
-                    $country->sub_regions = $this->retrieveJsonData(
-                        self::REPO_URL . 'countries/' . $country->filename . '.json'
-                    );
-                    return $this->saveSubRegionData($country, $country->sub_regions);
-                }
-            }
-        }
-        return 0;
-    }
+	/**
+	 * @param string $CNT_ISO
+	 * @param array  $countries
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.9.70.p
+	 */
+	private function processCountryData($CNT_ISO, $countries = array())
+	{
+		if (! empty($countries)) {
+			foreach ($countries as $key => $country) {
+				if (
+					$country instanceof stdClass
+					&& $country->code === $CNT_ISO
+					&& empty($country->sub_regions)
+					&& ! empty($country->filename)
+				) {
+					$country->sub_regions = $this->retrieveJsonData(
+						self::REPO_URL . 'countries/' . $country->filename . '.json'
+					);
+					return $this->saveSubRegionData($country, $country->sub_regions);
+				}
+			}
+		}
+		return 0;
+	}
 
 
-    /**
-     * @param string $url
-     * @return array
-     */
-    private function retrieveJsonData($url)
-    {
-        if (empty($url)) {
-            EE_Error::add_error(
-                'No URL was provided!',
-                __FILE__,
-                __METHOD__,
-                __LINE__
-            );
-            return array();
-        }
-        $request = wp_safe_remote_get($url);
-        if ($request instanceof WP_Error) {
-            EE_Error::add_error(
-                $request->get_error_message(),
-                __FILE__,
-                __METHOD__,
-                __LINE__
-            );
-            return array();
-        }
-        $body = wp_remote_retrieve_body($request);
-        $json = json_decode($body);
-        if ($this->json_validator->isValid(__FILE__, __METHOD__, __LINE__)) {
-            return $json;
-        }
-        return array();
-    }
+	/**
+	 * @param string $url
+	 * @return array
+	 */
+	private function retrieveJsonData($url)
+	{
+		if (empty($url)) {
+			EE_Error::add_error(
+				'No URL was provided!',
+				__FILE__,
+				__METHOD__,
+				__LINE__
+			);
+			return array();
+		}
+		$request = wp_safe_remote_get($url);
+		if ($request instanceof WP_Error) {
+			EE_Error::add_error(
+				$request->get_error_message(),
+				__FILE__,
+				__METHOD__,
+				__LINE__
+			);
+			return array();
+		}
+		$body = wp_remote_retrieve_body($request);
+		$json = json_decode($body);
+		if ($this->json_validator->isValid(__FILE__, __METHOD__, __LINE__)) {
+			return $json;
+		}
+		return array();
+	}
 
 
-    /**
-     * @param stdClass $country
-     * @param array    $sub_regions
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function saveSubRegionData(stdClass $country, $sub_regions = array())
-    {
-        $results = 0;
-        if (is_array($sub_regions)) {
-            $existing_sub_regions = $this->getExistingStateAbbreviations($country->code);
-            foreach ($sub_regions as $sub_region) {
-                // remove country code from sub region code
-                $abbrev = str_replace(
-                    $country->code . '-',
-                    '',
-                    sanitize_text_field($sub_region->code)
-                );
-                // but NOT if sub region code results in only a number
-                if (absint($abbrev) !== 0) {
-                    $abbrev = sanitize_text_field($sub_region->code);
-                }
-                if (
-                    ! in_array($abbrev, $existing_sub_regions, true)
-                    && $this->state_model->insert(
-                        [
-                            // STA_ID CNT_ISO STA_abbrev STA_name STA_active
-                            'CNT_ISO'    => $country->code,
-                            'STA_abbrev' => $abbrev,
-                            'STA_name'   => sanitize_text_field($sub_region->name),
-                            'STA_active' => 1,
-                        ]
-                    )
-                ) {
-                    $results++;
-                }
-            }
-        }
-        return $results;
-    }
+	/**
+	 * @param stdClass $country
+	 * @param array    $sub_regions
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function saveSubRegionData(stdClass $country, $sub_regions = array())
+	{
+		$results = 0;
+		if (is_array($sub_regions)) {
+			$existing_sub_regions = $this->getExistingStateAbbreviations($country->code);
+			foreach ($sub_regions as $sub_region) {
+				// remove country code from sub region code
+				$abbrev = str_replace(
+					$country->code . '-',
+					'',
+					sanitize_text_field($sub_region->code)
+				);
+				// but NOT if sub region code results in only a number
+				if (absint($abbrev) !== 0) {
+					$abbrev = sanitize_text_field($sub_region->code);
+				}
+				if (
+					! in_array($abbrev, $existing_sub_regions, true)
+					&& $this->state_model->insert(
+						[
+							// STA_ID CNT_ISO STA_abbrev STA_name STA_active
+							'CNT_ISO'    => $country->code,
+							'STA_abbrev' => $abbrev,
+							'STA_name'   => sanitize_text_field($sub_region->name),
+							'STA_active' => 1,
+						]
+					)
+				) {
+					$results++;
+				}
+			}
+		}
+		return $results;
+	}
 
 
-    /**
-     * @param string $CNT_ISO
-     * @since 4.9.76.p
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function getExistingStateAbbreviations($CNT_ISO)
-    {
-        $existing_sub_region_IDs = [];
-        $existing_sub_regions = $this->state_model->get_all(array(
-            array(
-                'Country.CNT_ISO' => array(
-                    'IN',
-                    [$CNT_ISO]
-                )
-            ),
-            'order_by' => array('Country.CNT_name' => 'ASC', 'STA_name' => 'ASC')
-        ));
-        if (is_array($existing_sub_regions)) {
-            foreach ($existing_sub_regions as $existing_sub_region) {
-                if ($existing_sub_region instanceof EE_State) {
-                    $existing_sub_region_IDs[] = $existing_sub_region->abbrev();
-                }
-            }
-        }
-        return $existing_sub_region_IDs;
-    }
+	/**
+	 * @param string $CNT_ISO
+	 * @since 4.9.76.p
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function getExistingStateAbbreviations($CNT_ISO)
+	{
+		$existing_sub_region_IDs = [];
+		$existing_sub_regions = $this->state_model->get_all(array(
+			array(
+				'Country.CNT_ISO' => array(
+					'IN',
+					[$CNT_ISO]
+				)
+			),
+			'order_by' => array('Country.CNT_name' => 'ASC', 'STA_name' => 'ASC')
+		));
+		if (is_array($existing_sub_regions)) {
+			foreach ($existing_sub_regions as $existing_sub_region) {
+				if ($existing_sub_region instanceof EE_State) {
+					$existing_sub_region_IDs[] = $existing_sub_region->abbrev();
+				}
+			}
+		}
+		return $existing_sub_region_IDs;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -80,7 +80,7 @@ 
         $data = [];
         if (empty($this->countries)) {
             $this->data_version = $this->getCountrySubRegionDataVersion();
-            $data = $this->retrieveJsonData(self::REPO_URL . 'countries.json');
+            $data = $this->retrieveJsonData(self::REPO_URL.'countries.json');
         }
         if (empty($data)) {
             EE_Error::add_error(
@@ -144,7 +144,7 @@ 
      */
     private function processCountryData($CNT_ISO, $countries = array())
     {
-        if (! empty($countries)) {
+        if ( ! empty($countries)) {
             foreach ($countries as $key => $country) {
                 if (
                     $country instanceof stdClass
@@ -153,7 +153,7 @@ 
                     && ! empty($country->filename)
                 ) {
                     $country->sub_regions = $this->retrieveJsonData(
-                        self::REPO_URL . 'countries/' . $country->filename . '.json'
+                        self::REPO_URL.'countries/'.$country->filename.'.json'
                     );
                     return $this->saveSubRegionData($country, $country->sub_regions);
                 }
@@ -215,7 +215,7 @@ 
             foreach ($sub_regions as $sub_region) {
                 // remove country code from sub region code
                 $abbrev = str_replace(
-                    $country->code . '-',
+                    $country->code.'-',
                     '',
                     sanitize_text_field($sub_region->code)
                 );

core/services/payment_methods/forms/PayPalSettingsForm.php

Indentation +191 added lines, -191 removed lines

@@ -20,202 +20,202 @@
  */
 class PayPalSettingsForm extends EE_Payment_Method_Form
 {
-    /**
-     * @var string of HTML being the help tab link
-     */
-    protected $helpTabLink;
+	/**
+	 * @var string of HTML being the help tab link
+	 */
+	protected $helpTabLink;
 
-    public function __construct(array $options_array = array(), $help_tab_link = '')
-    {
-        $this->helpTabLink = $help_tab_link;
-        $options_array = array_replace_recursive(
-            array(
-                'extra_meta_inputs' => array(
-                    'api_username' => new EE_Text_Input(
-                        array(
-                            'html_label_text' => sprintf(
-                                // translators: %s link to help doc
-                                esc_html__('API Username %s', 'event_espresso'),
-                                $help_tab_link
-                            ),
-                            'required'        => true,
-                        )
-                    ),
-                    'api_password' => new EE_Text_Input(
-                        array(
-                            'html_label_text' => sprintf(
-                                // translators: %s link to help doc
-                                esc_html__('API Password %s', 'event_espresso'),
-                                $help_tab_link
-                            ),
-                            'required'        => true,
-                        )
-                    ),
-                    'api_signature' => new EE_Text_Input(
-                        array(
-                            'html_label_text' => sprintf(
-                                // translators: %s link to help doc
-                                esc_html__('API Signature %s', 'event_espresso'),
-                                $help_tab_link
-                            ),
-                            'required'        => true,
-                        )
-                    ),
-                )
-            ),
-            $options_array
-        );
-        parent::__construct($options_array);
-    }
+	public function __construct(array $options_array = array(), $help_tab_link = '')
+	{
+		$this->helpTabLink = $help_tab_link;
+		$options_array = array_replace_recursive(
+			array(
+				'extra_meta_inputs' => array(
+					'api_username' => new EE_Text_Input(
+						array(
+							'html_label_text' => sprintf(
+								// translators: %s link to help doc
+								esc_html__('API Username %s', 'event_espresso'),
+								$help_tab_link
+							),
+							'required'        => true,
+						)
+					),
+					'api_password' => new EE_Text_Input(
+						array(
+							'html_label_text' => sprintf(
+								// translators: %s link to help doc
+								esc_html__('API Password %s', 'event_espresso'),
+								$help_tab_link
+							),
+							'required'        => true,
+						)
+					),
+					'api_signature' => new EE_Text_Input(
+						array(
+							'html_label_text' => sprintf(
+								// translators: %s link to help doc
+								esc_html__('API Signature %s', 'event_espresso'),
+								$help_tab_link
+							),
+							'required'        => true,
+						)
+					),
+				)
+			),
+			$options_array
+		);
+		parent::__construct($options_array);
+	}
 
-    /**
-     * Tests the the PayPal API credentials work ok
-     * @return string of an error using the credentials, otherwise, if the credentials work, returns a blank string
-     * @throws EE_Error
-     */
-    protected function checkForCredentialsErrors()
-    {
-        $request_params = array(
-            'METHOD'    => 'GetBalance',
-            'VERSION'   => '204.0',
-            'USER'      => $this->get_input_value('api_username'),
-            'PWD'       => $this->get_input_value('api_password'),
-            'SIGNATURE' => $this->get_input_value('api_signature'),
-        );
-        $gateway_url = $this->get_input_value('PMD_debug_mode')
-            ? 'https://api-3t.sandbox.paypal.com/nvp'
-            : 'https://api-3t.paypal.com/nvp';
-        // Request Customer Details.
-        $response = wp_remote_post(
-            $gateway_url,
-            array(
-                'method'      => 'POST',
-                'timeout'     => 45,
-                'httpversion' => '1.1',
-                'cookies'     => array(),
-                'headers'     => array(),
-                'body'        => http_build_query($request_params, '', '&'),
-            )
-        );
-        if (is_wp_error($response) || empty($response['body'])) {
-            // If we got here then there was an error in this request.
-            // maybe is turned off. We don't know the credentials are invalid
-            EE_Error::add_error(
-                sprintf(
-                    // translators: %1$s Error message received from PayPal
-                    esc_html__(
-                        // @codingStandardsIgnoreStart
-                        'Your PayPal credentials could not be verified. The following error occurred while communicating with PayPal: %1$s',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    $response->get_error_message()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        $response_args = array();
-        parse_str(urldecode($response['body']), $response_args);
+	/**
+	 * Tests the the PayPal API credentials work ok
+	 * @return string of an error using the credentials, otherwise, if the credentials work, returns a blank string
+	 * @throws EE_Error
+	 */
+	protected function checkForCredentialsErrors()
+	{
+		$request_params = array(
+			'METHOD'    => 'GetBalance',
+			'VERSION'   => '204.0',
+			'USER'      => $this->get_input_value('api_username'),
+			'PWD'       => $this->get_input_value('api_password'),
+			'SIGNATURE' => $this->get_input_value('api_signature'),
+		);
+		$gateway_url = $this->get_input_value('PMD_debug_mode')
+			? 'https://api-3t.sandbox.paypal.com/nvp'
+			: 'https://api-3t.paypal.com/nvp';
+		// Request Customer Details.
+		$response = wp_remote_post(
+			$gateway_url,
+			array(
+				'method'      => 'POST',
+				'timeout'     => 45,
+				'httpversion' => '1.1',
+				'cookies'     => array(),
+				'headers'     => array(),
+				'body'        => http_build_query($request_params, '', '&'),
+			)
+		);
+		if (is_wp_error($response) || empty($response['body'])) {
+			// If we got here then there was an error in this request.
+			// maybe is turned off. We don't know the credentials are invalid
+			EE_Error::add_error(
+				sprintf(
+					// translators: %1$s Error message received from PayPal
+					esc_html__(
+						// @codingStandardsIgnoreStart
+						'Your PayPal credentials could not be verified. The following error occurred while communicating with PayPal: %1$s',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					$response->get_error_message()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		$response_args = array();
+		parse_str(urldecode($response['body']), $response_args);
 
-        if (empty($response_args['ACK'])) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Your PayPal credentials could not be verified. Part of their response was missing.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        if (
-            in_array(
-                $response_args['ACK'],
-                array(
-                'Success',
-                'SuccessWithWarning'
-                ),
-                true
-            )
-        ) {
-            return '';
-        } else {
-            return sprintf(
-                // translators: %1$s: PayPal response message, %2$s: PayPal response code
-                esc_html__(
-                    // @codingStandardsIgnoreStart
-                    'Your PayPal API credentials appear to be invalid. PayPal said "%1$s (%2$s)". Please see tips below.',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                ),
-                isset($response_args['L_LONGMESSAGE0'])
-                    ? $response_args['L_LONGMESSAGE0']
-                    : esc_html__('No error message received from PayPal', 'event_espresso'),
-                isset($response_args['L_ERRORCODE0']) ? $response_args['L_ERRORCODE0'] : 0
-            );
-        }
-    }
+		if (empty($response_args['ACK'])) {
+			EE_Error::add_error(
+				esc_html__(
+					'Your PayPal credentials could not be verified. Part of their response was missing.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		if (
+			in_array(
+				$response_args['ACK'],
+				array(
+				'Success',
+				'SuccessWithWarning'
+				),
+				true
+			)
+		) {
+			return '';
+		} else {
+			return sprintf(
+				// translators: %1$s: PayPal response message, %2$s: PayPal response code
+				esc_html__(
+					// @codingStandardsIgnoreStart
+					'Your PayPal API credentials appear to be invalid. PayPal said "%1$s (%2$s)". Please see tips below.',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				),
+				isset($response_args['L_LONGMESSAGE0'])
+					? $response_args['L_LONGMESSAGE0']
+					: esc_html__('No error message received from PayPal', 'event_espresso'),
+				isset($response_args['L_ERRORCODE0']) ? $response_args['L_ERRORCODE0'] : 0
+			);
+		}
+	}
 
-    /**
-     * Gets the HTML to show the link to the help tab
-     * @return string
-     */
-    protected function helpTabLink()
-    {
-        return $this->helpTabLink;
-    }
+	/**
+	 * Gets the HTML to show the link to the help tab
+	 * @return string
+	 */
+	protected function helpTabLink()
+	{
+		return $this->helpTabLink;
+	}
 
-    /**
-     * Does the normal validation, but also verifies the PayPal API credentials work.
-     * If they don't, sets a validation error on the entire form, and adds validation errors (which are really more
-     * tips) on each of the inputs that could be the cause of the problem.
-     * @throws EE_Error
-     */
-    public function _validate()
-    {
-        parent::_validate();
-        $credentials_message = $this->checkForCredentialsErrors();
-        if ($credentials_message !== '') {
-            $this->add_validation_error($credentials_message);
-            $this->get_input('PMD_debug_mode')->add_validation_error(
-                esc_html__(
-                    // @codingStandardsIgnoreStart
-                    'If you are using PayPal Sandbox (test) credentials, Debug mode should be set to "Yes". Otherwise, if you are using live PayPal credentials, set this to "No".',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                )
-            );
-            $this->get_input('api_username')->add_validation_error(
-                sprintf(
-                    // translators: $1$s HTML for a link to the help tab
-                    esc_html__(
-                        'Are you sure this is your API username, not your login username? %1$s',
-                        'event_espresso'
-                    ),
-                    $this->helpTabLink()
-                )
-            );
-            $this->get_input('api_password')->add_validation_error(
-                sprintf(
-                    // translators: $1$s HTML for a link to the help tab
-                    esc_html__(
-                        'Are you sure this is your API password, not your login password? %1$s',
-                        'event_espresso'
-                    ),
-                    $this->helpTabLink()
-                )
-            );
-            $this->get_input('api_signature')->add_validation_error(
-                sprintf(
-                    // translators: $1$s HTML for a link to the help tab
-                    esc_html__('Please verify your API signature is correct. %1$s', 'event_espresso'),
-                    $this->helpTabLink()
-                )
-            );
-        }
-    }
+	/**
+	 * Does the normal validation, but also verifies the PayPal API credentials work.
+	 * If they don't, sets a validation error on the entire form, and adds validation errors (which are really more
+	 * tips) on each of the inputs that could be the cause of the problem.
+	 * @throws EE_Error
+	 */
+	public function _validate()
+	{
+		parent::_validate();
+		$credentials_message = $this->checkForCredentialsErrors();
+		if ($credentials_message !== '') {
+			$this->add_validation_error($credentials_message);
+			$this->get_input('PMD_debug_mode')->add_validation_error(
+				esc_html__(
+					// @codingStandardsIgnoreStart
+					'If you are using PayPal Sandbox (test) credentials, Debug mode should be set to "Yes". Otherwise, if you are using live PayPal credentials, set this to "No".',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				)
+			);
+			$this->get_input('api_username')->add_validation_error(
+				sprintf(
+					// translators: $1$s HTML for a link to the help tab
+					esc_html__(
+						'Are you sure this is your API username, not your login username? %1$s',
+						'event_espresso'
+					),
+					$this->helpTabLink()
+				)
+			);
+			$this->get_input('api_password')->add_validation_error(
+				sprintf(
+					// translators: $1$s HTML for a link to the help tab
+					esc_html__(
+						'Are you sure this is your API password, not your login password? %1$s',
+						'event_espresso'
+					),
+					$this->helpTabLink()
+				)
+			);
+			$this->get_input('api_signature')->add_validation_error(
+				sprintf(
+					// translators: $1$s HTML for a link to the help tab
+					esc_html__('Please verify your API signature is correct. %1$s', 'event_espresso'),
+					$this->helpTabLink()
+				)
+			);
+		}
+	}
 }
 // End of file PayPalSettingsForm.php
 // Location: ${NAMESPACE}/PayPalSettingsForm.php

core/services/collections/CollectionDetails.php

Indentation +349 added lines, -349 removed lines

@@ -43,353 +43,353 @@
 class CollectionDetails implements CollectionDetailsInterface
 {
 
-    /**
-     * if $identifier_type is set to this,
-     * then the collection will use each object's spl_object_hash() as it's identifier
-     */
-    const ID_OBJECT_HASH = 'identifier-uses-spl-object-hash';
-
-    /**
-     * if $identifier_type is set to this,
-     * then the collection will use each object's class name as it's identifier
-     */
-    const ID_CLASS_NAME = 'identifier-uses-object-class-name';
-
-    /**
-     * if $identifier_type is set to this,
-     * then the collection will use the return value from a specified callback method on each object
-     */
-    const ID_CALLBACK_METHOD = 'identifier-uses-callback-method';
-
-    /**
-     * The interface used for controlling what gets added to the collection
-     *
-     * @var string $collection_interface
-     */
-    protected $collection_interface = '';
-
-    /**
-     * a unique name used to identify the collection in filter names
-     * supplied value is run through sanitize_title_with_dashes(),
-     * but then also converts dashes to underscores
-     *
-     * @var string $collection_name
-     */
-    protected $collection_name = '';
-
-    /**
-     * what the collection uses for the object identifier.
-     * corresponds to one of the class constants above.
-     * CollectionDetails::ID_OBJECT_HASH will use spl_object_hash( object ) for the identifier
-     * CollectionDetails::ID_CLASS_NAME will use get_class( object ) for the identifier
-     * CollectionDetails::ID_CALLBACK_METHOD will use a callback for the identifier
-     * defaults to using spl_object_hash() so that multiple objects of the same class can be added
-     *
-     * @var string $identifier_type
-     */
-    protected $identifier_type = CollectionDetails::ID_OBJECT_HASH;
-
-    /**
-     * the pattern applied to paths when searching for class files to add to the collection
-     * ie: "My_Awesome_*.class.php"
-     * defaults to "*.php"
-     *
-     * @var string $file_mask
-     */
-    protected $file_mask = '';
-
-    /**
-     * if the $identifier_type above is set to CollectionDetails::ID_CALLBACK_METHOD,
-     * then this specifies the method to use on each entity.
-     * If the callback method does not exist, then an exception will be thrown
-     *
-     * @var string $identifier_callback
-     */
-    protected $identifier_callback = '';
-
-    /**
-     * an array of Fully Qualified Class Names
-     *  for example:
-     *  $FQCNs = array(
-     *      '/Fully/Qualified/ClassNameA'
-     *      '/Fully/Qualified/Other/ClassNameB'
-     *  );
-     *
-     * @var array $collection_FQCNs
-     */
-    protected $collection_FQCNs = array();
-
-    /**
-     * an array of full server paths to folders containing files to be loaded into collection
-     *  for example:
-     *  $paths = array(
-     *      '/full/server/path/to/ClassNameA.ext.php' // for class ClassNameA
-     *      '/full/server/path/to/other/ClassNameB.php' // for class ClassNameB
-     *  );
-     *
-     * @var array $collection_paths
-     */
-    protected $collection_paths = array();
-
-    /**
-     * @var LocatorInterface $file_locator
-     */
-    protected $file_locator;
-
-
-    /**
-     * CollectionDetails constructor.
-     *
-     * @access public
-     * @param string           $collection_name
-     * @param string           $collection_interface
-     * @param array            $collection_FQCNs
-     * @param array            $collection_paths
-     * @param string           $file_mask
-     * @param string           $identifier_type
-     * @param string           $identifier_callback
-     * @param LocatorInterface $file_locator
-     * @throws CollectionDetailsException
-     */
-    public function __construct(
-        $collection_name,
-        $collection_interface,
-        array $collection_FQCNs = array(),
-        array $collection_paths = array(),
-        $file_mask = '',
-        $identifier_type = CollectionDetails::ID_OBJECT_HASH,
-        $identifier_callback = '',
-        LocatorInterface $file_locator = null
-    ) {
-        try {
-            $this->setCollectionName($collection_name);
-            $this->setCollectionInterface($collection_interface);
-            $this->setCollectionFQCNs($collection_FQCNs);
-            $this->setCollectionPaths($collection_paths);
-            $this->setFileMasks($file_mask);
-            $this->setIdentifierType($identifier_type);
-            $this->setIdentifierCallback($identifier_callback);
-            $this->file_locator = $file_locator;
-        } catch (Exception $exception) {
-            throw new CollectionDetailsException($exception);
-        }
-    }
-
-
-    /**
-     * @access public
-     * @return mixed
-     */
-    public function getCollectionInterface()
-    {
-        return $this->collection_interface;
-    }
-
-
-    /**
-     * @access protected
-     * @param string $collection_interface
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function setCollectionInterface($collection_interface)
-    {
-        if (! (interface_exists($collection_interface) || class_exists($collection_interface))) {
-            throw new InvalidInterfaceException($collection_interface);
-        }
-        $this->collection_interface = $collection_interface;
-    }
-
-
-    /**
-     * the collection name will be used for creating dynamic filters
-     *
-     * @access public
-     * @return string
-     */
-    public function collectionName()
-    {
-        return $this->collection_name;
-    }
-
-
-    /**
-     * sanitizes collection name and converts spaces and dashes to underscores
-     *
-     * @access protected
-     * @param string $collection_name
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    protected function setCollectionName($collection_name)
-    {
-        if (! is_string($collection_name)) {
-            throw new InvalidDataTypeException('$collection_name', $collection_name, 'string');
-        }
-        $this->collection_name = str_replace(
-            '-',
-            '_',
-            sanitize_title_with_dashes($collection_name, '', 'save')
-        );
-    }
-
-
-    /**
-     * @access public
-     * @return string
-     */
-    public function identifierType()
-    {
-        return $this->identifier_type;
-    }
-
-
-    /**
-     * @access protected
-     * @param string $identifier_type
-     * @throws InvalidIdentifierException
-     */
-    protected function setIdentifierType($identifier_type)
-    {
-        if (
-            ! ($identifier_type === CollectionDetails::ID_CLASS_NAME
-               || $identifier_type === CollectionDetails::ID_OBJECT_HASH
-               || $identifier_type === CollectionDetails::ID_CALLBACK_METHOD
-            )
-        ) {
-            throw new InvalidIdentifierException(
-                $identifier_type,
-                'CollectionDetails::ID_CLASS_NAME or CollectionDetails::ID_OBJECT_HASH or CollectionDetails::ID_CALLBACK_METHOD'
-            );
-        }
-        $this->identifier_type = $identifier_type;
-    }
-
-
-    /**
-     * @access public
-     * @return string
-     */
-    public function identifierCallback()
-    {
-        return $this->identifier_callback;
-    }
-
-
-    /**
-     * @access protected
-     * @param string $identifier_callback
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    protected function setIdentifierCallback($identifier_callback = 'identifier')
-    {
-        if (! is_string($identifier_callback)) {
-            throw new InvalidDataTypeException('$identifier_callback', $identifier_callback, 'string');
-        }
-        $this->identifier_callback = $identifier_callback;
-    }
-
-
-    /**
-     * @access public
-     * @return string
-     */
-    public function getFileMask()
-    {
-        return $this->file_mask;
-    }
-
-
-    /**
-     * sets the file mask which is then used to filter what files get loaded
-     * when searching for classes to add to the collection. Defaults to '*.php'
-     *
-     * @access protected
-     * @param string $file_mask
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    protected function setFileMasks($file_mask)
-    {
-        $this->file_mask = ! empty($file_mask) ? $file_mask : '*.php';
-        // we know our default is a string, so if it's not a string now,
-        // then that means the incoming parameter was something else
-        if (! is_string($this->file_mask)) {
-            throw new InvalidDataTypeException('$file_mask', $this->file_mask, 'string');
-        }
-    }
-
-
-    /**
-     * @access public
-     * @return array
-     */
-    public function getCollectionFQCNs()
-    {
-        return $this->collection_FQCNs;
-    }
-
-
-    /**
-     * @access public
-     * @param string|array $collection_FQCNs
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    public function setCollectionFQCNs($collection_FQCNs)
-    {
-        foreach ((array) $collection_FQCNs as $collection_FQCN) {
-            if (! empty($collection_FQCN)) {
-                if (class_exists($collection_FQCN)) {
-                    $this->collection_FQCNs[] = $collection_FQCN;
-                } else {
-                    foreach ($this->getFQCNsFromPartialNamespace($collection_FQCN) as $FQCN) {
-                        $this->collection_FQCNs[] = $FQCN;
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @access protected
-     * @param  string $partial_FQCN
-     * @return array
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     */
-    protected function getFQCNsFromPartialNamespace($partial_FQCN)
-    {
-        if (! $this->file_locator instanceof FqcnLocator) {
-            $this->file_locator = new FqcnLocator();
-        }
-        $this->file_locator->locate($partial_FQCN);
-        return $this->file_locator->getFQCNs();
-    }
-
-
-    /**
-     * @access public
-     * @return array
-     */
-    public function getCollectionPaths()
-    {
-        return $this->collection_paths;
-    }
-
-
-    /**
-     * @access public
-     * @param string|array $collection_paths
-     * @throws \EventEspresso\core\exceptions\InvalidFilePathException
-     */
-    public function setCollectionPaths($collection_paths)
-    {
-        foreach ((array) $collection_paths as $collection_path) {
-            if (! empty($collection_path)) {
-                if (! is_readable($collection_path)) {
-                    throw new InvalidFilePathException($collection_path);
-                }
-                $this->collection_paths[] = $collection_path;
-            }
-        }
-    }
+	/**
+	 * if $identifier_type is set to this,
+	 * then the collection will use each object's spl_object_hash() as it's identifier
+	 */
+	const ID_OBJECT_HASH = 'identifier-uses-spl-object-hash';
+
+	/**
+	 * if $identifier_type is set to this,
+	 * then the collection will use each object's class name as it's identifier
+	 */
+	const ID_CLASS_NAME = 'identifier-uses-object-class-name';
+
+	/**
+	 * if $identifier_type is set to this,
+	 * then the collection will use the return value from a specified callback method on each object
+	 */
+	const ID_CALLBACK_METHOD = 'identifier-uses-callback-method';
+
+	/**
+	 * The interface used for controlling what gets added to the collection
+	 *
+	 * @var string $collection_interface
+	 */
+	protected $collection_interface = '';
+
+	/**
+	 * a unique name used to identify the collection in filter names
+	 * supplied value is run through sanitize_title_with_dashes(),
+	 * but then also converts dashes to underscores
+	 *
+	 * @var string $collection_name
+	 */
+	protected $collection_name = '';
+
+	/**
+	 * what the collection uses for the object identifier.
+	 * corresponds to one of the class constants above.
+	 * CollectionDetails::ID_OBJECT_HASH will use spl_object_hash( object ) for the identifier
+	 * CollectionDetails::ID_CLASS_NAME will use get_class( object ) for the identifier
+	 * CollectionDetails::ID_CALLBACK_METHOD will use a callback for the identifier
+	 * defaults to using spl_object_hash() so that multiple objects of the same class can be added
+	 *
+	 * @var string $identifier_type
+	 */
+	protected $identifier_type = CollectionDetails::ID_OBJECT_HASH;
+
+	/**
+	 * the pattern applied to paths when searching for class files to add to the collection
+	 * ie: "My_Awesome_*.class.php"
+	 * defaults to "*.php"
+	 *
+	 * @var string $file_mask
+	 */
+	protected $file_mask = '';
+
+	/**
+	 * if the $identifier_type above is set to CollectionDetails::ID_CALLBACK_METHOD,
+	 * then this specifies the method to use on each entity.
+	 * If the callback method does not exist, then an exception will be thrown
+	 *
+	 * @var string $identifier_callback
+	 */
+	protected $identifier_callback = '';
+
+	/**
+	 * an array of Fully Qualified Class Names
+	 *  for example:
+	 *  $FQCNs = array(
+	 *      '/Fully/Qualified/ClassNameA'
+	 *      '/Fully/Qualified/Other/ClassNameB'
+	 *  );
+	 *
+	 * @var array $collection_FQCNs
+	 */
+	protected $collection_FQCNs = array();
+
+	/**
+	 * an array of full server paths to folders containing files to be loaded into collection
+	 *  for example:
+	 *  $paths = array(
+	 *      '/full/server/path/to/ClassNameA.ext.php' // for class ClassNameA
+	 *      '/full/server/path/to/other/ClassNameB.php' // for class ClassNameB
+	 *  );
+	 *
+	 * @var array $collection_paths
+	 */
+	protected $collection_paths = array();
+
+	/**
+	 * @var LocatorInterface $file_locator
+	 */
+	protected $file_locator;
+
+
+	/**
+	 * CollectionDetails constructor.
+	 *
+	 * @access public
+	 * @param string           $collection_name
+	 * @param string           $collection_interface
+	 * @param array            $collection_FQCNs
+	 * @param array            $collection_paths
+	 * @param string           $file_mask
+	 * @param string           $identifier_type
+	 * @param string           $identifier_callback
+	 * @param LocatorInterface $file_locator
+	 * @throws CollectionDetailsException
+	 */
+	public function __construct(
+		$collection_name,
+		$collection_interface,
+		array $collection_FQCNs = array(),
+		array $collection_paths = array(),
+		$file_mask = '',
+		$identifier_type = CollectionDetails::ID_OBJECT_HASH,
+		$identifier_callback = '',
+		LocatorInterface $file_locator = null
+	) {
+		try {
+			$this->setCollectionName($collection_name);
+			$this->setCollectionInterface($collection_interface);
+			$this->setCollectionFQCNs($collection_FQCNs);
+			$this->setCollectionPaths($collection_paths);
+			$this->setFileMasks($file_mask);
+			$this->setIdentifierType($identifier_type);
+			$this->setIdentifierCallback($identifier_callback);
+			$this->file_locator = $file_locator;
+		} catch (Exception $exception) {
+			throw new CollectionDetailsException($exception);
+		}
+	}
+
+
+	/**
+	 * @access public
+	 * @return mixed
+	 */
+	public function getCollectionInterface()
+	{
+		return $this->collection_interface;
+	}
+
+
+	/**
+	 * @access protected
+	 * @param string $collection_interface
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function setCollectionInterface($collection_interface)
+	{
+		if (! (interface_exists($collection_interface) || class_exists($collection_interface))) {
+			throw new InvalidInterfaceException($collection_interface);
+		}
+		$this->collection_interface = $collection_interface;
+	}
+
+
+	/**
+	 * the collection name will be used for creating dynamic filters
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function collectionName()
+	{
+		return $this->collection_name;
+	}
+
+
+	/**
+	 * sanitizes collection name and converts spaces and dashes to underscores
+	 *
+	 * @access protected
+	 * @param string $collection_name
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	protected function setCollectionName($collection_name)
+	{
+		if (! is_string($collection_name)) {
+			throw new InvalidDataTypeException('$collection_name', $collection_name, 'string');
+		}
+		$this->collection_name = str_replace(
+			'-',
+			'_',
+			sanitize_title_with_dashes($collection_name, '', 'save')
+		);
+	}
+
+
+	/**
+	 * @access public
+	 * @return string
+	 */
+	public function identifierType()
+	{
+		return $this->identifier_type;
+	}
+
+
+	/**
+	 * @access protected
+	 * @param string $identifier_type
+	 * @throws InvalidIdentifierException
+	 */
+	protected function setIdentifierType($identifier_type)
+	{
+		if (
+			! ($identifier_type === CollectionDetails::ID_CLASS_NAME
+			   || $identifier_type === CollectionDetails::ID_OBJECT_HASH
+			   || $identifier_type === CollectionDetails::ID_CALLBACK_METHOD
+			)
+		) {
+			throw new InvalidIdentifierException(
+				$identifier_type,
+				'CollectionDetails::ID_CLASS_NAME or CollectionDetails::ID_OBJECT_HASH or CollectionDetails::ID_CALLBACK_METHOD'
+			);
+		}
+		$this->identifier_type = $identifier_type;
+	}
+
+
+	/**
+	 * @access public
+	 * @return string
+	 */
+	public function identifierCallback()
+	{
+		return $this->identifier_callback;
+	}
+
+
+	/**
+	 * @access protected
+	 * @param string $identifier_callback
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	protected function setIdentifierCallback($identifier_callback = 'identifier')
+	{
+		if (! is_string($identifier_callback)) {
+			throw new InvalidDataTypeException('$identifier_callback', $identifier_callback, 'string');
+		}
+		$this->identifier_callback = $identifier_callback;
+	}
+
+
+	/**
+	 * @access public
+	 * @return string
+	 */
+	public function getFileMask()
+	{
+		return $this->file_mask;
+	}
+
+
+	/**
+	 * sets the file mask which is then used to filter what files get loaded
+	 * when searching for classes to add to the collection. Defaults to '*.php'
+	 *
+	 * @access protected
+	 * @param string $file_mask
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	protected function setFileMasks($file_mask)
+	{
+		$this->file_mask = ! empty($file_mask) ? $file_mask : '*.php';
+		// we know our default is a string, so if it's not a string now,
+		// then that means the incoming parameter was something else
+		if (! is_string($this->file_mask)) {
+			throw new InvalidDataTypeException('$file_mask', $this->file_mask, 'string');
+		}
+	}
+
+
+	/**
+	 * @access public
+	 * @return array
+	 */
+	public function getCollectionFQCNs()
+	{
+		return $this->collection_FQCNs;
+	}
+
+
+	/**
+	 * @access public
+	 * @param string|array $collection_FQCNs
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	public function setCollectionFQCNs($collection_FQCNs)
+	{
+		foreach ((array) $collection_FQCNs as $collection_FQCN) {
+			if (! empty($collection_FQCN)) {
+				if (class_exists($collection_FQCN)) {
+					$this->collection_FQCNs[] = $collection_FQCN;
+				} else {
+					foreach ($this->getFQCNsFromPartialNamespace($collection_FQCN) as $FQCN) {
+						$this->collection_FQCNs[] = $FQCN;
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @access protected
+	 * @param  string $partial_FQCN
+	 * @return array
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 */
+	protected function getFQCNsFromPartialNamespace($partial_FQCN)
+	{
+		if (! $this->file_locator instanceof FqcnLocator) {
+			$this->file_locator = new FqcnLocator();
+		}
+		$this->file_locator->locate($partial_FQCN);
+		return $this->file_locator->getFQCNs();
+	}
+
+
+	/**
+	 * @access public
+	 * @return array
+	 */
+	public function getCollectionPaths()
+	{
+		return $this->collection_paths;
+	}
+
+
+	/**
+	 * @access public
+	 * @param string|array $collection_paths
+	 * @throws \EventEspresso\core\exceptions\InvalidFilePathException
+	 */
+	public function setCollectionPaths($collection_paths)
+	{
+		foreach ((array) $collection_paths as $collection_path) {
+			if (! empty($collection_path)) {
+				if (! is_readable($collection_path)) {
+					throw new InvalidFilePathException($collection_path);
+				}
+				$this->collection_paths[] = $collection_path;
+			}
+		}
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -193,7 +193,7 @@ 
      */
     protected function setCollectionInterface($collection_interface)
     {
-        if (! (interface_exists($collection_interface) || class_exists($collection_interface))) {
+        if ( ! (interface_exists($collection_interface) || class_exists($collection_interface))) {
             throw new InvalidInterfaceException($collection_interface);
         }
         $this->collection_interface = $collection_interface;
@@ -221,7 +221,7 @@ 
      */
     protected function setCollectionName($collection_name)
     {
-        if (! is_string($collection_name)) {
+        if ( ! is_string($collection_name)) {
             throw new InvalidDataTypeException('$collection_name', $collection_name, 'string');
         }
         $this->collection_name = str_replace(
@@ -281,7 +281,7 @@ 
      */
     protected function setIdentifierCallback($identifier_callback = 'identifier')
     {
-        if (! is_string($identifier_callback)) {
+        if ( ! is_string($identifier_callback)) {
             throw new InvalidDataTypeException('$identifier_callback', $identifier_callback, 'string');
         }
         $this->identifier_callback = $identifier_callback;
@@ -311,7 +311,7 @@ 
         $this->file_mask = ! empty($file_mask) ? $file_mask : '*.php';
         // we know our default is a string, so if it's not a string now,
         // then that means the incoming parameter was something else
-        if (! is_string($this->file_mask)) {
+        if ( ! is_string($this->file_mask)) {
             throw new InvalidDataTypeException('$file_mask', $this->file_mask, 'string');
         }
     }
@@ -336,7 +336,7 @@ 
     public function setCollectionFQCNs($collection_FQCNs)
     {
         foreach ((array) $collection_FQCNs as $collection_FQCN) {
-            if (! empty($collection_FQCN)) {
+            if ( ! empty($collection_FQCN)) {
                 if (class_exists($collection_FQCN)) {
                     $this->collection_FQCNs[] = $collection_FQCN;
                 } else {
@@ -358,7 +358,7 @@ 
      */
     protected function getFQCNsFromPartialNamespace($partial_FQCN)
     {
-        if (! $this->file_locator instanceof FqcnLocator) {
+        if ( ! $this->file_locator instanceof FqcnLocator) {
             $this->file_locator = new FqcnLocator();
         }
         $this->file_locator->locate($partial_FQCN);
@@ -384,8 +384,8 @@ 
     public function setCollectionPaths($collection_paths)
     {
         foreach ((array) $collection_paths as $collection_path) {
-            if (! empty($collection_path)) {
-                if (! is_readable($collection_path)) {
+            if ( ! empty($collection_path)) {
+                if ( ! is_readable($collection_path)) {
                     throw new InvalidFilePathException($collection_path);
                 }
                 $this->collection_paths[] = $collection_path;

core/services/notifications/PersistentAdminNoticeManager.php

Spacing +9 added lines, -9 removed lines

@@ -85,7 +85,7 @@ 
      */
     public function setReturnUrl($return_url)
     {
-        if (! is_string($return_url)) {
+        if ( ! is_string($return_url)) {
             throw new InvalidDataTypeException('$return_url', $return_url, 'string');
         }
         $this->return_url = $return_url;
@@ -102,7 +102,7 @@ 
      */
     protected function getPersistentAdminNoticeCollection()
     {
-        if (! $this->notice_collection instanceof Collection) {
+        if ( ! $this->notice_collection instanceof Collection) {
             $this->notice_collection = new Collection(
                 'EventEspresso\core\domain\entities\notifications\PersistentAdminNotice'
             );
@@ -125,7 +125,7 @@ 
     protected function retrieveStoredNotices()
     {
         $persistent_admin_notices = get_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array());
-        if (! empty($persistent_admin_notices)) {
+        if ( ! empty($persistent_admin_notices)) {
             foreach ($persistent_admin_notices as $name => $details) {
                 if (is_array($details)) {
                     if (
@@ -247,14 +247,14 @@ 
     {
         wp_register_script(
             'espresso_core',
-            EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+            EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js',
             array('jquery'),
             EVENT_ESPRESSO_VERSION,
             true
         );
         wp_register_script(
             'ee_error_js',
-            EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
+            EE_GLOBAL_ASSETS_URL.'scripts/EE_Error.js',
             array('espresso_core'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -285,7 +285,7 @@ 
         // used in template
         $persistent_admin_notice_name = $persistent_admin_notice->getName();
         $persistent_admin_notice_message = $persistent_admin_notice->getMessage();
-        require EE_TEMPLATES . '/notifications/persistent_admin_notice.template.php';
+        require EE_TEMPLATES.'/notifications/persistent_admin_notice.template.php';
     }
 
 
@@ -310,7 +310,7 @@ 
     {
         $pan_name = $this->request->getRequestParam('ee_nag_notice', $pan_name);
         $this->notice_collection = $this->getPersistentAdminNoticeCollection();
-        if (! empty($pan_name) && $this->notice_collection->has($pan_name)) {
+        if ( ! empty($pan_name) && $this->notice_collection->has($pan_name)) {
             /** @var PersistentAdminNotice $persistent_admin_notice */
             $persistent_admin_notice = $this->notice_collection->get($pan_name);
             $persistent_admin_notice->setDismissed(true);
@@ -360,10 +360,10 @@ 
             foreach ($this->notice_collection as $persistent_admin_notice) {
                 // are we deleting this notice ?
                 if ($persistent_admin_notice->getPurge()) {
-                    unset($persistent_admin_notices[ $persistent_admin_notice->getName() ]);
+                    unset($persistent_admin_notices[$persistent_admin_notice->getName()]);
                 } else {
                     /** @var PersistentAdminNotice $persistent_admin_notice */
-                    $persistent_admin_notices[ $persistent_admin_notice->getName() ] = array(
+                    $persistent_admin_notices[$persistent_admin_notice->getName()] = array(
                         'message'     => $persistent_admin_notice->getMessage(),
                         'capability'  => $persistent_admin_notice->getCapability(),
                         'cap_context' => $persistent_admin_notice->getCapContext(),

Indentation +385 added lines, -385 removed lines

@@ -31,389 +31,389 @@
 class PersistentAdminNoticeManager
 {
 
-    const WP_OPTION_KEY = 'ee_pers_admin_notices';
-
-    /**
-     * @var Collection|PersistentAdminNotice[] $notice_collection
-     */
-    private $notice_collection;
-
-    /**
-     * if AJAX is not enabled, then the return URL will be used for redirecting back to the admin page where the
-     * persistent admin notice was displayed, and ultimately dismissed from.
-     *
-     * @var string $return_url
-     */
-    private $return_url;
-
-    /**
-     * @var CapabilitiesChecker $capabilities_checker
-     */
-    private $capabilities_checker;
-
-    /**
-     * @var RequestInterface $request
-     */
-    private $request;
-
-
-    /**
-     * PersistentAdminNoticeManager constructor
-     *
-     * @param string              $return_url where to  redirect to after dismissing notices
-     * @param CapabilitiesChecker $capabilities_checker
-     * @param RequestInterface          $request
-     * @throws InvalidDataTypeException
-     */
-    public function __construct($return_url = '', CapabilitiesChecker $capabilities_checker, RequestInterface $request)
-    {
-        $this->setReturnUrl($return_url);
-        $this->capabilities_checker = $capabilities_checker;
-        $this->request = $request;
-        // setup up notices at priority 9 because `EE_Admin::display_admin_notices()` runs at priority 10,
-        // and we want to retrieve and generate any nag notices at the last possible moment
-        add_action('admin_notices', array($this, 'displayNotices'), 9);
-        add_action('network_admin_notices', array($this, 'displayNotices'), 9);
-        add_action('wp_ajax_dismiss_ee_nag_notice', array($this, 'dismissNotice'));
-        add_action('shutdown', array($this, 'registerAndSaveNotices'), 998);
-    }
-
-
-    /**
-     * @param string $return_url
-     * @throws InvalidDataTypeException
-     */
-    public function setReturnUrl($return_url)
-    {
-        if (! is_string($return_url)) {
-            throw new InvalidDataTypeException('$return_url', $return_url, 'string');
-        }
-        $this->return_url = $return_url;
-    }
-
-
-    /**
-     * @return Collection
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    protected function getPersistentAdminNoticeCollection()
-    {
-        if (! $this->notice_collection instanceof Collection) {
-            $this->notice_collection = new Collection(
-                'EventEspresso\core\domain\entities\notifications\PersistentAdminNotice'
-            );
-            $this->retrieveStoredNotices();
-            $this->registerNotices();
-        }
-        return $this->notice_collection;
-    }
-
-
-    /**
-     * generates PersistentAdminNotice objects for all non-dismissed notices saved to the db
-     *
-     * @return void
-     * @throws InvalidEntityException
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    protected function retrieveStoredNotices()
-    {
-        $persistent_admin_notices = get_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array());
-        if (! empty($persistent_admin_notices)) {
-            foreach ($persistent_admin_notices as $name => $details) {
-                if (is_array($details)) {
-                    if (
-                        ! isset(
-                            $details['message'],
-                            $details['capability'],
-                            $details['cap_context'],
-                            $details['dismissed']
-                        )
-                    ) {
-                        throw new DomainException(
-                            sprintf(
-                                esc_html__(
-                                    'The "%1$s" PersistentAdminNotice could not be retrieved from the database.',
-                                    'event_espresso'
-                                ),
-                                $name
-                            )
-                        );
-                    }
-                    // new format for nag notices
-                    $this->notice_collection->add(
-                        new PersistentAdminNotice(
-                            $name,
-                            $details['message'],
-                            false,
-                            $details['capability'],
-                            $details['cap_context'],
-                            $details['dismissed']
-                        ),
-                        sanitize_key($name)
-                    );
-                } else {
-                    try {
-                        // old nag notices, that we want to convert to the new format
-                        $this->notice_collection->add(
-                            new PersistentAdminNotice(
-                                $name,
-                                (string) $details,
-                                false,
-                                '',
-                                '',
-                                empty($details)
-                            ),
-                            sanitize_key($name)
-                        );
-                    } catch (Exception $e) {
-                        EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-                    }
-                }
-                // each notice will self register when the action hook in registerNotices is triggered
-            }
-        }
-    }
-
-
-    /**
-     * exposes the Persistent Admin Notice Collection via an action
-     * so that PersistentAdminNotice objects can be added and/or removed
-     * without compromising the actual collection like a filter would
-     */
-    protected function registerNotices()
-    {
-        do_action(
-            'AHEE__EventEspresso_core_services_notifications_PersistentAdminNoticeManager__registerNotices',
-            $this->notice_collection
-        );
-    }
-
-
-    /**
-     * @throws DomainException
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidEntityException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    public function displayNotices()
-    {
-        $this->notice_collection = $this->getPersistentAdminNoticeCollection();
-        if ($this->notice_collection->hasObjects()) {
-            $enqueue_assets = false;
-            // and display notices
-            foreach ($this->notice_collection as $persistent_admin_notice) {
-                /** @var PersistentAdminNotice $persistent_admin_notice */
-                // don't display notices that have already been dismissed
-                if ($persistent_admin_notice->getDismissed()) {
-                    continue;
-                }
-                try {
-                    $this->capabilities_checker->processCapCheck(
-                        $persistent_admin_notice->getCapCheck()
-                    );
-                } catch (InsufficientPermissionsException $e) {
-                    // user does not have required cap, so skip to next notice
-                    // and just eat the exception - nom nom nom nom
-                    continue;
-                }
-                if ($persistent_admin_notice->getMessage() === '') {
-                    continue;
-                }
-                $this->displayPersistentAdminNotice($persistent_admin_notice);
-                $enqueue_assets = true;
-            }
-            if ($enqueue_assets) {
-                $this->enqueueAssets();
-            }
-        }
-    }
-
-
-    /**
-     * does what it's named
-     *
-     * @return void
-     */
-    public function enqueueAssets()
-    {
-        wp_register_script(
-            'espresso_core',
-            EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
-            array('jquery'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_register_script(
-            'ee_error_js',
-            EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
-            array('espresso_core'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_localize_script(
-            'ee_error_js',
-            'ee_dismiss',
-            array(
-                'return_url'    => urlencode($this->return_url),
-                'ajax_url'      => WP_AJAX_URL,
-                'unknown_error' => wp_strip_all_tags(
-                    __(
-                        'An unknown error has occurred on the server while attempting to dismiss this notice.',
-                        'event_espresso'
-                    )
-                ),
-            )
-        );
-        wp_enqueue_script('ee_error_js');
-    }
-
-
-    /**
-     * displayPersistentAdminNoticeHtml
-     *
-     * @param  PersistentAdminNotice $persistent_admin_notice
-     */
-    protected function displayPersistentAdminNotice(PersistentAdminNotice $persistent_admin_notice)
-    {
-        // used in template
-        $persistent_admin_notice_name = $persistent_admin_notice->getName();
-        $persistent_admin_notice_message = $persistent_admin_notice->getMessage();
-        require EE_TEMPLATES . '/notifications/persistent_admin_notice.template.php';
-    }
-
-
-    /**
-     * dismissNotice
-     *
-     * @param string $pan_name the name, or key of the Persistent Admin Notice to be dismissed
-     * @param bool   $purge    if true, then delete it from the db
-     * @param bool   $return   forget all of this AJAX or redirect nonsense, and just return
-     * @return void
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidArgumentException
-     * @throws InvalidArgumentException
-     * @throws InvalidArgumentException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    public function dismissNotice($pan_name = '', $purge = false, $return = false)
-    {
-        $pan_name = $this->request->getRequestParam('ee_nag_notice', $pan_name);
-        $this->notice_collection = $this->getPersistentAdminNoticeCollection();
-        if (! empty($pan_name) && $this->notice_collection->has($pan_name)) {
-            /** @var PersistentAdminNotice $persistent_admin_notice */
-            $persistent_admin_notice = $this->notice_collection->get($pan_name);
-            $persistent_admin_notice->setDismissed(true);
-            $persistent_admin_notice->setPurge($purge);
-            $this->saveNotices();
-        }
-        if ($return) {
-            return;
-        }
-        if ($this->request->isAjax()) {
-            // grab any notices and concatenate into string
-            echo wp_json_encode(
-                array(
-                    'errors' => implode('<br />', EE_Error::get_notices(false)),
-                )
-            );
-            exit();
-        }
-        // save errors to a transient to be displayed on next request (after redirect)
-        EE_Error::get_notices(false, true);
-        wp_safe_redirect(
-            urldecode(
-                $this->request->getRequestParam('return_url', '')
-            )
-        );
-    }
-
-
-    /**
-     * saveNotices
-     *
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidEntityException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    public function saveNotices()
-    {
-        $this->notice_collection = $this->getPersistentAdminNoticeCollection();
-        if ($this->notice_collection->hasObjects()) {
-            $persistent_admin_notices = get_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array());
-            // maybe initialize persistent_admin_notices
-            if (empty($persistent_admin_notices)) {
-                add_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array(), '', 'no');
-            }
-            foreach ($this->notice_collection as $persistent_admin_notice) {
-                // are we deleting this notice ?
-                if ($persistent_admin_notice->getPurge()) {
-                    unset($persistent_admin_notices[ $persistent_admin_notice->getName() ]);
-                } else {
-                    /** @var PersistentAdminNotice $persistent_admin_notice */
-                    $persistent_admin_notices[ $persistent_admin_notice->getName() ] = array(
-                        'message'     => $persistent_admin_notice->getMessage(),
-                        'capability'  => $persistent_admin_notice->getCapability(),
-                        'cap_context' => $persistent_admin_notice->getCapContext(),
-                        'dismissed'   => $persistent_admin_notice->getDismissed(),
-                    );
-                }
-            }
-            update_option(PersistentAdminNoticeManager::WP_OPTION_KEY, $persistent_admin_notices);
-        }
-    }
-
-
-    /**
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    public function registerAndSaveNotices()
-    {
-        $this->getPersistentAdminNoticeCollection();
-        $this->registerNotices();
-        $this->saveNotices();
-        add_filter(
-            'PersistentAdminNoticeManager__registerAndSaveNotices__complete',
-            '__return_true'
-        );
-    }
-
-
-    /**
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    public static function loadRegisterAndSaveNotices()
-    {
-        /** @var PersistentAdminNoticeManager $persistent_admin_notice_manager */
-        $persistent_admin_notice_manager = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-        );
-        // if shutdown has already run, then call registerAndSaveNotices() manually
-        if (did_action('shutdown')) {
-            $persistent_admin_notice_manager->registerAndSaveNotices();
-        }
-    }
+	const WP_OPTION_KEY = 'ee_pers_admin_notices';
+
+	/**
+	 * @var Collection|PersistentAdminNotice[] $notice_collection
+	 */
+	private $notice_collection;
+
+	/**
+	 * if AJAX is not enabled, then the return URL will be used for redirecting back to the admin page where the
+	 * persistent admin notice was displayed, and ultimately dismissed from.
+	 *
+	 * @var string $return_url
+	 */
+	private $return_url;
+
+	/**
+	 * @var CapabilitiesChecker $capabilities_checker
+	 */
+	private $capabilities_checker;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	private $request;
+
+
+	/**
+	 * PersistentAdminNoticeManager constructor
+	 *
+	 * @param string              $return_url where to  redirect to after dismissing notices
+	 * @param CapabilitiesChecker $capabilities_checker
+	 * @param RequestInterface          $request
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct($return_url = '', CapabilitiesChecker $capabilities_checker, RequestInterface $request)
+	{
+		$this->setReturnUrl($return_url);
+		$this->capabilities_checker = $capabilities_checker;
+		$this->request = $request;
+		// setup up notices at priority 9 because `EE_Admin::display_admin_notices()` runs at priority 10,
+		// and we want to retrieve and generate any nag notices at the last possible moment
+		add_action('admin_notices', array($this, 'displayNotices'), 9);
+		add_action('network_admin_notices', array($this, 'displayNotices'), 9);
+		add_action('wp_ajax_dismiss_ee_nag_notice', array($this, 'dismissNotice'));
+		add_action('shutdown', array($this, 'registerAndSaveNotices'), 998);
+	}
+
+
+	/**
+	 * @param string $return_url
+	 * @throws InvalidDataTypeException
+	 */
+	public function setReturnUrl($return_url)
+	{
+		if (! is_string($return_url)) {
+			throw new InvalidDataTypeException('$return_url', $return_url, 'string');
+		}
+		$this->return_url = $return_url;
+	}
+
+
+	/**
+	 * @return Collection
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	protected function getPersistentAdminNoticeCollection()
+	{
+		if (! $this->notice_collection instanceof Collection) {
+			$this->notice_collection = new Collection(
+				'EventEspresso\core\domain\entities\notifications\PersistentAdminNotice'
+			);
+			$this->retrieveStoredNotices();
+			$this->registerNotices();
+		}
+		return $this->notice_collection;
+	}
+
+
+	/**
+	 * generates PersistentAdminNotice objects for all non-dismissed notices saved to the db
+	 *
+	 * @return void
+	 * @throws InvalidEntityException
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	protected function retrieveStoredNotices()
+	{
+		$persistent_admin_notices = get_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array());
+		if (! empty($persistent_admin_notices)) {
+			foreach ($persistent_admin_notices as $name => $details) {
+				if (is_array($details)) {
+					if (
+						! isset(
+							$details['message'],
+							$details['capability'],
+							$details['cap_context'],
+							$details['dismissed']
+						)
+					) {
+						throw new DomainException(
+							sprintf(
+								esc_html__(
+									'The "%1$s" PersistentAdminNotice could not be retrieved from the database.',
+									'event_espresso'
+								),
+								$name
+							)
+						);
+					}
+					// new format for nag notices
+					$this->notice_collection->add(
+						new PersistentAdminNotice(
+							$name,
+							$details['message'],
+							false,
+							$details['capability'],
+							$details['cap_context'],
+							$details['dismissed']
+						),
+						sanitize_key($name)
+					);
+				} else {
+					try {
+						// old nag notices, that we want to convert to the new format
+						$this->notice_collection->add(
+							new PersistentAdminNotice(
+								$name,
+								(string) $details,
+								false,
+								'',
+								'',
+								empty($details)
+							),
+							sanitize_key($name)
+						);
+					} catch (Exception $e) {
+						EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+					}
+				}
+				// each notice will self register when the action hook in registerNotices is triggered
+			}
+		}
+	}
+
+
+	/**
+	 * exposes the Persistent Admin Notice Collection via an action
+	 * so that PersistentAdminNotice objects can be added and/or removed
+	 * without compromising the actual collection like a filter would
+	 */
+	protected function registerNotices()
+	{
+		do_action(
+			'AHEE__EventEspresso_core_services_notifications_PersistentAdminNoticeManager__registerNotices',
+			$this->notice_collection
+		);
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidEntityException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	public function displayNotices()
+	{
+		$this->notice_collection = $this->getPersistentAdminNoticeCollection();
+		if ($this->notice_collection->hasObjects()) {
+			$enqueue_assets = false;
+			// and display notices
+			foreach ($this->notice_collection as $persistent_admin_notice) {
+				/** @var PersistentAdminNotice $persistent_admin_notice */
+				// don't display notices that have already been dismissed
+				if ($persistent_admin_notice->getDismissed()) {
+					continue;
+				}
+				try {
+					$this->capabilities_checker->processCapCheck(
+						$persistent_admin_notice->getCapCheck()
+					);
+				} catch (InsufficientPermissionsException $e) {
+					// user does not have required cap, so skip to next notice
+					// and just eat the exception - nom nom nom nom
+					continue;
+				}
+				if ($persistent_admin_notice->getMessage() === '') {
+					continue;
+				}
+				$this->displayPersistentAdminNotice($persistent_admin_notice);
+				$enqueue_assets = true;
+			}
+			if ($enqueue_assets) {
+				$this->enqueueAssets();
+			}
+		}
+	}
+
+
+	/**
+	 * does what it's named
+	 *
+	 * @return void
+	 */
+	public function enqueueAssets()
+	{
+		wp_register_script(
+			'espresso_core',
+			EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+			array('jquery'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_register_script(
+			'ee_error_js',
+			EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
+			array('espresso_core'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_localize_script(
+			'ee_error_js',
+			'ee_dismiss',
+			array(
+				'return_url'    => urlencode($this->return_url),
+				'ajax_url'      => WP_AJAX_URL,
+				'unknown_error' => wp_strip_all_tags(
+					__(
+						'An unknown error has occurred on the server while attempting to dismiss this notice.',
+						'event_espresso'
+					)
+				),
+			)
+		);
+		wp_enqueue_script('ee_error_js');
+	}
+
+
+	/**
+	 * displayPersistentAdminNoticeHtml
+	 *
+	 * @param  PersistentAdminNotice $persistent_admin_notice
+	 */
+	protected function displayPersistentAdminNotice(PersistentAdminNotice $persistent_admin_notice)
+	{
+		// used in template
+		$persistent_admin_notice_name = $persistent_admin_notice->getName();
+		$persistent_admin_notice_message = $persistent_admin_notice->getMessage();
+		require EE_TEMPLATES . '/notifications/persistent_admin_notice.template.php';
+	}
+
+
+	/**
+	 * dismissNotice
+	 *
+	 * @param string $pan_name the name, or key of the Persistent Admin Notice to be dismissed
+	 * @param bool   $purge    if true, then delete it from the db
+	 * @param bool   $return   forget all of this AJAX or redirect nonsense, and just return
+	 * @return void
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidArgumentException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	public function dismissNotice($pan_name = '', $purge = false, $return = false)
+	{
+		$pan_name = $this->request->getRequestParam('ee_nag_notice', $pan_name);
+		$this->notice_collection = $this->getPersistentAdminNoticeCollection();
+		if (! empty($pan_name) && $this->notice_collection->has($pan_name)) {
+			/** @var PersistentAdminNotice $persistent_admin_notice */
+			$persistent_admin_notice = $this->notice_collection->get($pan_name);
+			$persistent_admin_notice->setDismissed(true);
+			$persistent_admin_notice->setPurge($purge);
+			$this->saveNotices();
+		}
+		if ($return) {
+			return;
+		}
+		if ($this->request->isAjax()) {
+			// grab any notices and concatenate into string
+			echo wp_json_encode(
+				array(
+					'errors' => implode('<br />', EE_Error::get_notices(false)),
+				)
+			);
+			exit();
+		}
+		// save errors to a transient to be displayed on next request (after redirect)
+		EE_Error::get_notices(false, true);
+		wp_safe_redirect(
+			urldecode(
+				$this->request->getRequestParam('return_url', '')
+			)
+		);
+	}
+
+
+	/**
+	 * saveNotices
+	 *
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidEntityException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	public function saveNotices()
+	{
+		$this->notice_collection = $this->getPersistentAdminNoticeCollection();
+		if ($this->notice_collection->hasObjects()) {
+			$persistent_admin_notices = get_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array());
+			// maybe initialize persistent_admin_notices
+			if (empty($persistent_admin_notices)) {
+				add_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array(), '', 'no');
+			}
+			foreach ($this->notice_collection as $persistent_admin_notice) {
+				// are we deleting this notice ?
+				if ($persistent_admin_notice->getPurge()) {
+					unset($persistent_admin_notices[ $persistent_admin_notice->getName() ]);
+				} else {
+					/** @var PersistentAdminNotice $persistent_admin_notice */
+					$persistent_admin_notices[ $persistent_admin_notice->getName() ] = array(
+						'message'     => $persistent_admin_notice->getMessage(),
+						'capability'  => $persistent_admin_notice->getCapability(),
+						'cap_context' => $persistent_admin_notice->getCapContext(),
+						'dismissed'   => $persistent_admin_notice->getDismissed(),
+					);
+				}
+			}
+			update_option(PersistentAdminNoticeManager::WP_OPTION_KEY, $persistent_admin_notices);
+		}
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	public function registerAndSaveNotices()
+	{
+		$this->getPersistentAdminNoticeCollection();
+		$this->registerNotices();
+		$this->saveNotices();
+		add_filter(
+			'PersistentAdminNoticeManager__registerAndSaveNotices__complete',
+			'__return_true'
+		);
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	public static function loadRegisterAndSaveNotices()
+	{
+		/** @var PersistentAdminNoticeManager $persistent_admin_notice_manager */
+		$persistent_admin_notice_manager = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+		);
+		// if shutdown has already run, then call registerAndSaveNotices() manually
+		if (did_action('shutdown')) {
+			$persistent_admin_notice_manager->registerAndSaveNotices();
+		}
+	}
 }

core/services/database/TableAnalysis.php

Spacing +2 added lines, -2 removed lines

@@ -32,7 +32,7 @@ 
     public function ensureTableNameHasPrefix($table_name)
     {
         global $wpdb;
-        return strpos($table_name, $wpdb->base_prefix) === 0 ? $table_name : $wpdb->prefix . $table_name;
+        return strpos($table_name, $wpdb->base_prefix) === 0 ? $table_name : $wpdb->prefix.$table_name;
     }
 
 
@@ -81,7 +81,7 @@ 
         $wpdb->last_error = $old_error;
         $EZSQL_ERROR = $ezsql_error_cache;
         // if there was a table doesn't exist error
-        if (! empty($new_error)) {
+        if ( ! empty($new_error)) {
             if (
                 in_array(
                     \EEH_Activation::last_wpdb_error_code(),

Indentation +121 added lines, -121 removed lines

@@ -14,132 +14,132 @@
 class TableAnalysis extends \EE_Base
 {
 
-    /**
-     * The maximum number of characters that can be indexed on a column using utf8mb4 collation,
-     * see https://events.codebasehq.com/redirect?https://make.wordpress.org/core/2015/04/02/the-utf8mb4-upgrade/
-     */
-    const INDEX_COLUMN_SIZE = 191;
+	/**
+	 * The maximum number of characters that can be indexed on a column using utf8mb4 collation,
+	 * see https://events.codebasehq.com/redirect?https://make.wordpress.org/core/2015/04/02/the-utf8mb4-upgrade/
+	 */
+	const INDEX_COLUMN_SIZE = 191;
 
-    /**
-     * Returns the table name which will definitely have the wpdb prefix on the front,
-     * except if it currently has the wpdb->base_prefix on the front, in which case
-     * it will have the wpdb->base_prefix on it
-     *
-     * @global \wpdb $wpdb
-     * @param string $table_name
-     * @return string $tableName, having ensured it has the wpdb prefix on the front
-     */
-    public function ensureTableNameHasPrefix($table_name)
-    {
-        global $wpdb;
-        return strpos($table_name, $wpdb->base_prefix) === 0 ? $table_name : $wpdb->prefix . $table_name;
-    }
+	/**
+	 * Returns the table name which will definitely have the wpdb prefix on the front,
+	 * except if it currently has the wpdb->base_prefix on the front, in which case
+	 * it will have the wpdb->base_prefix on it
+	 *
+	 * @global \wpdb $wpdb
+	 * @param string $table_name
+	 * @return string $tableName, having ensured it has the wpdb prefix on the front
+	 */
+	public function ensureTableNameHasPrefix($table_name)
+	{
+		global $wpdb;
+		return strpos($table_name, $wpdb->base_prefix) === 0 ? $table_name : $wpdb->prefix . $table_name;
+	}
 
 
-    /**
-     * Indicates whether or not the table has any entries. $table_name can
-     * optionally start with $wpdb->prefix or not
-     *
-     * @global \wpdb $wpdb
-     * @param string $table_name
-     * @return bool
-     */
-    public function tableIsEmpty($table_name)
-    {
-        global $wpdb;
-        $table_name = $this->ensureTableNameHasPrefix($table_name);
-        if ($this->tableExists($table_name)) {
-            $count = $wpdb->get_var("SELECT COUNT(*) FROM $table_name");
-            return absint($count) === 0 ? true : false;
-        }
-        return false;
-    }
+	/**
+	 * Indicates whether or not the table has any entries. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
+	 * @global \wpdb $wpdb
+	 * @param string $table_name
+	 * @return bool
+	 */
+	public function tableIsEmpty($table_name)
+	{
+		global $wpdb;
+		$table_name = $this->ensureTableNameHasPrefix($table_name);
+		if ($this->tableExists($table_name)) {
+			$count = $wpdb->get_var("SELECT COUNT(*) FROM $table_name");
+			return absint($count) === 0 ? true : false;
+		}
+		return false;
+	}
 
 
-    /**
-     * Indicates whether or not the table exists. $table_name can optionally
-     * have the $wpdb->prefix on the beginning, or not.
-     *
-     * @global \wpdb $wpdb
-     * @global array EZSQL_Error
-     * @param        $table_name
-     * @return bool
-     */
-    public function tableExists($table_name)
-    {
-        global $wpdb, $EZSQL_ERROR;
-        $table_name = $this->ensureTableNameHasPrefix($table_name);
-        // ignore if this causes an sql error
-        $old_error = $wpdb->last_error;
-        $old_suppress_errors = $wpdb->suppress_errors();
-        $old_show_errors_value = $wpdb->show_errors(false);
-        $ezsql_error_cache = $EZSQL_ERROR;
-        $wpdb->get_results("SELECT * from $table_name LIMIT 1");
-        $wpdb->show_errors($old_show_errors_value);
-        $wpdb->suppress_errors($old_suppress_errors);
-        $new_error = $wpdb->last_error;
-        $wpdb->last_error = $old_error;
-        $EZSQL_ERROR = $ezsql_error_cache;
-        // if there was a table doesn't exist error
-        if (! empty($new_error)) {
-            if (
-                in_array(
-                    \EEH_Activation::last_wpdb_error_code(),
-                    array(
-                    1051, // bad table
-                    1109, // unknown table
-                    117, // no such table
-                    )
-                )
-                ||
-                preg_match(
-                    '~^Table .* doesn\'t exist~',
-                    $new_error
-                ) // in case not using mysql and error codes aren't reliable, just check for this error string
-            ) {
-                return false;
-            } else {
-                // log this because that's weird. Just use the normal PHP error log
-                error_log(
-                    sprintf(
-                        esc_html__(
-                            'Event Espresso error detected when checking if table existed: %1$s (it wasn\'t just that the table didn\'t exist either)',
-                            'event_espresso'
-                        ),
-                        $new_error
-                    )
-                );
-            }
-        }
-        return true;
-    }
+	/**
+	 * Indicates whether or not the table exists. $table_name can optionally
+	 * have the $wpdb->prefix on the beginning, or not.
+	 *
+	 * @global \wpdb $wpdb
+	 * @global array EZSQL_Error
+	 * @param        $table_name
+	 * @return bool
+	 */
+	public function tableExists($table_name)
+	{
+		global $wpdb, $EZSQL_ERROR;
+		$table_name = $this->ensureTableNameHasPrefix($table_name);
+		// ignore if this causes an sql error
+		$old_error = $wpdb->last_error;
+		$old_suppress_errors = $wpdb->suppress_errors();
+		$old_show_errors_value = $wpdb->show_errors(false);
+		$ezsql_error_cache = $EZSQL_ERROR;
+		$wpdb->get_results("SELECT * from $table_name LIMIT 1");
+		$wpdb->show_errors($old_show_errors_value);
+		$wpdb->suppress_errors($old_suppress_errors);
+		$new_error = $wpdb->last_error;
+		$wpdb->last_error = $old_error;
+		$EZSQL_ERROR = $ezsql_error_cache;
+		// if there was a table doesn't exist error
+		if (! empty($new_error)) {
+			if (
+				in_array(
+					\EEH_Activation::last_wpdb_error_code(),
+					array(
+					1051, // bad table
+					1109, // unknown table
+					117, // no such table
+					)
+				)
+				||
+				preg_match(
+					'~^Table .* doesn\'t exist~',
+					$new_error
+				) // in case not using mysql and error codes aren't reliable, just check for this error string
+			) {
+				return false;
+			} else {
+				// log this because that's weird. Just use the normal PHP error log
+				error_log(
+					sprintf(
+						esc_html__(
+							'Event Espresso error detected when checking if table existed: %1$s (it wasn\'t just that the table didn\'t exist either)',
+							'event_espresso'
+						),
+						$new_error
+					)
+				);
+			}
+		}
+		return true;
+	}
 
 
-    /**
-     * @param $table_name
-     * @param $index_name
-     * @return array of columns used on that index, Each entry is an object with the following properties {
-     * @type string Table
-     * @type string Non_unique "0" or "1"
-     * @type string Key_name
-     * @type string Seq_in_index
-     * @type string Column_name
-     * @type string Collation
-     * @type string Cardinality
-     * @type string Sub_part on a column, usually this is just the number of characters from this column to use in
-     *       indexing
-     * @type string|null Packed
-     * @type string Null
-     * @type string Index_type
-     * @type string Comment
-     * @type string Index_comment
-     * }
-     */
-    public function showIndexes($table_name, $index_name)
-    {
-        global $wpdb;
-        $table_name = $this->ensureTableNameHasPrefix($table_name);
-        $index_exists_query = "SHOW INDEX FROM {$table_name} WHERE Key_name = '{$index_name}'";
-        return $wpdb->get_results($index_exists_query);
-    }
+	/**
+	 * @param $table_name
+	 * @param $index_name
+	 * @return array of columns used on that index, Each entry is an object with the following properties {
+	 * @type string Table
+	 * @type string Non_unique "0" or "1"
+	 * @type string Key_name
+	 * @type string Seq_in_index
+	 * @type string Column_name
+	 * @type string Collation
+	 * @type string Cardinality
+	 * @type string Sub_part on a column, usually this is just the number of characters from this column to use in
+	 *       indexing
+	 * @type string|null Packed
+	 * @type string Null
+	 * @type string Index_type
+	 * @type string Comment
+	 * @type string Index_comment
+	 * }
+	 */
+	public function showIndexes($table_name, $index_name)
+	{
+		global $wpdb;
+		$table_name = $this->ensureTableNameHasPrefix($table_name);
+		$index_exists_query = "SHOW INDEX FROM {$table_name} WHERE Key_name = '{$index_name}'";
+		return $wpdb->get_results($index_exists_query);
+	}
 }

core/services/cache/TransientCacheStorage.php

Indentation +363 added lines, -363 removed lines

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

Spacing +10 added lines, -10 removed lines

@@ -57,7 +57,7 @@ 
         // round current time down to closest 5 minutes to simplify scheduling
         $this->current_time = $this->roundTimestamp(time(), '5-minutes', false);
         $this->transients = (array) get_option(TransientCacheStorage::TRANSIENT_SCHEDULE_OPTIONS_KEY, array());
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && $this->transient_cleanup_frequency !== 'off') {
+        if ( ! (defined('DOING_AJAX') && DOING_AJAX) && $this->transient_cleanup_frequency !== 'off') {
             add_action('shutdown', array($this, 'checkTransientCleanupSchedule'), 999);
         }
     }
@@ -190,7 +190,7 @@ 
      */
     public function get($transient_key, $standard_cache = true)
     {
-        if (isset($this->transients[ $transient_key ])) {
+        if (isset($this->transients[$transient_key])) {
             // to avoid cache stampedes (AKA:dogpiles) for standard cache items,
             // check if known cache expires within the next minute,
             // and if so, remove it from our tracking and and return nothing.
@@ -199,17 +199,17 @@ 
             // until it gets replaced with the refreshed content
             if (
                 $standard_cache
-                && $this->transients[ $transient_key ] - time() <= MINUTE_IN_SECONDS
+                && $this->transients[$transient_key] - time() <= MINUTE_IN_SECONDS
             ) {
-                unset($this->transients[ $transient_key ]);
+                unset($this->transients[$transient_key]);
                 $this->updateTransients();
                 return null;
             }
 
             // for non standard cache items, remove the key from our tracking,
             // but proceed to retrieve the transient so that it also gets removed from the db
-            if ($this->transients[ $transient_key ] <= time()) {
-                unset($this->transients[ $transient_key ]);
+            if ($this->transients[$transient_key] <= time()) {
+                unset($this->transients[$transient_key]);
                 $this->updateTransients();
             }
         }
@@ -282,7 +282,7 @@ 
         // and round to the closest 15 minutes
         $expiration = $this->roundTimestamp($expiration);
         // save transients to clear using their ID as the key to avoid duplicates
-        $this->transients[ $transient_key ] = $expiration;
+        $this->transients[$transient_key] = $expiration;
         $this->updateTransients();
     }
 
@@ -334,8 +334,8 @@ 
                 if ($expiration > $this->current_time) {
                     continue;
                 }
-                if (! $expiration || ! $transient_key) {
-                    unset($this->transients[ $transient_key ]);
+                if ( ! $expiration || ! $transient_key) {
+                    unset($this->transients[$transient_key]);
                     $update = true;
                     continue;
                 }
@@ -374,7 +374,7 @@ 
                 ? str_replace('_transient_', '', $transient_key)
                 : $transient_key;
             delete_transient($transient_key);
-            unset($this->transients[ $transient_key ]);
+            unset($this->transients[$transient_key]);
             $counter++;
         }
         return $counter > 0;