eventespresso / event-espresso-core

core/db_classes/EE_Ticket.class.php

Indentation +626 added lines, -626 removed lines

@@ -61,15 +61,15 @@ 
 
 
 
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Ticket
-     * @throws \EE_Error
-     */
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Ticket
+	 * @throws \EE_Error
+	 */
 	public static function new_instance( $props_n_values = array(), $timezone = null, $date_formats = array() ) {
 		$has_object = parent::_check_for_object( $props_n_values, __CLASS__, $timezone, $date_formats );
 		return $has_object ? $has_object : new self( $props_n_values, false, $timezone, $date_formats );
@@ -77,36 +77,36 @@ 
 
 
 
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Ticket
-     * @throws \EE_Error
-     */
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Ticket
+	 * @throws \EE_Error
+	 */
 	public static function new_instance_from_db( $props_n_values = array(), $timezone = null ) {
 		return new self( $props_n_values, TRUE, $timezone );
 	}
 
 
 
-    /**
-     * @return bool
-     * @throws \EE_Error
-     */
+	/**
+	 * @return bool
+	 * @throws \EE_Error
+	 */
 	public function parent() {
 		return $this->get( 'TKT_parent' );
 	}
 
 
 
-    /**
-     * return if a ticket has quantities available for purchase
-     *
-     * @param  int $DTT_ID the primary key for a particular datetime
-     * @return boolean
-     * @throws \EE_Error
-     */
+	/**
+	 * return if a ticket has quantities available for purchase
+	 *
+	 * @param  int $DTT_ID the primary key for a particular datetime
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
 	public function available( $DTT_ID = 0 ) {
 		// are we checking availability for a particular datetime ?
 		if ( $DTT_ID ) {
@@ -123,14 +123,14 @@ 
 
 
 
-    /**
-     * Using the start date and end date this method calculates whether the ticket is On Sale, Pending, or Expired
-     *
-     * @param bool        $display   true = we'll return a localized string, otherwise we just return the value of the relevant status const
-     * @param bool | null $remaining if it is already known that tickets are available, then simply pass a bool to save further processing
-     * @return mixed status int if the display string isn't requested
-     * @throws \EE_Error
-     */
+	/**
+	 * Using the start date and end date this method calculates whether the ticket is On Sale, Pending, or Expired
+	 *
+	 * @param bool        $display   true = we'll return a localized string, otherwise we just return the value of the relevant status const
+	 * @param bool | null $remaining if it is already known that tickets are available, then simply pass a bool to save further processing
+	 * @return mixed status int if the display string isn't requested
+	 * @throws \EE_Error
+	 */
 	public function ticket_status( $display = FALSE, $remaining = null ) {
 		$remaining = is_bool( $remaining ) ? $remaining : $this->is_remaining();
 		if ( ! $remaining ) {
@@ -153,14 +153,14 @@ 
 
 
 
-    /**
-     * The purpose of this method is to simply return a boolean for whether there are any tickets remaining for sale considering ALL the factors used for figuring that out.
-     *
-     * @access public
-     * @param  int $DTT_ID if an int above 0 is included here then we get a specific dtt.
-     * @return boolean         true = tickets remaining, false not.
-     * @throws \EE_Error
-     */
+	/**
+	 * The purpose of this method is to simply return a boolean for whether there are any tickets remaining for sale considering ALL the factors used for figuring that out.
+	 *
+	 * @access public
+	 * @param  int $DTT_ID if an int above 0 is included here then we get a specific dtt.
+	 * @return boolean         true = tickets remaining, false not.
+	 * @throws \EE_Error
+	 */
 	public function is_remaining( $DTT_ID = 0 ) {
 		$num_remaining = $this->remaining( $DTT_ID );
 		if ( $num_remaining === 0 ) {
@@ -174,76 +174,76 @@ 
 
 
 
-    /**
-     * return the total number of tickets available for purchase
-     *
-     * @param  int $DTT_ID the primary key for a particular datetime.
-     *                     set to 0 for all related datetimes
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * return the total number of tickets available for purchase
+	 *
+	 * @param  int $DTT_ID the primary key for a particular datetime.
+	 *                     set to 0 for all related datetimes
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function remaining( $DTT_ID = 0 ) {
 		return $this->real_quantity_on_ticket('saleable', $DTT_ID );
 	}
 
 
 
-    /**
-     * Gets min
-     *
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets min
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function min() {
 		return $this->get( 'TKT_min' );
 	}
 
 
 
-    /**
-     * return if a ticket is no longer available cause its available dates have expired.
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
+	/**
+	 * return if a ticket is no longer available cause its available dates have expired.
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
 	public function is_expired() {
 		return ( $this->get_raw( 'TKT_end_date' ) < time() );
 	}
 
 
 
-    /**
-     * Return if a ticket is yet to go on sale or not
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
+	/**
+	 * Return if a ticket is yet to go on sale or not
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
 	public function is_pending() {
 		return ( $this->get_raw( 'TKT_start_date' ) > time() );
 	}
 
 
 
-    /**
-     * Return if a ticket is on sale or not
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
+	/**
+	 * Return if a ticket is on sale or not
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
 	public function is_on_sale() {
 		return ( $this->get_raw( 'TKT_start_date' ) < time() && $this->get_raw( 'TKT_end_date' ) > time() );
 	}
 
 
 
-    /**
-     * This returns the chronologically last datetime that this ticket is associated with
-     *
-     * @param string $dt_frmt
-     * @param string $conjunction - conjunction junction what's your function ? this string joins the start date with the end date ie: Jan 01 "to" Dec 31
-     * @return string
-     * @throws \EE_Error
-     */
+	/**
+	 * This returns the chronologically last datetime that this ticket is associated with
+	 *
+	 * @param string $dt_frmt
+	 * @param string $conjunction - conjunction junction what's your function ? this string joins the start date with the end date ie: Jan 01 "to" Dec 31
+	 * @return string
+	 * @throws \EE_Error
+	 */
 	public function date_range( $dt_frmt = '', $conjunction = ' - ' ) {
 		$first_date = $this->first_datetime() instanceof EE_Datetime ? $this->first_datetime()->start_date( $dt_frmt ) : '';
 		$last_date = $this->last_datetime() instanceof EE_Datetime ? $this->last_datetime()->end_date( $dt_frmt ) : '';
@@ -253,12 +253,12 @@ 
 
 
 
-    /**
-     * This returns the chronologically first datetime that this ticket is associated with
-     *
-     * @return EE_Datetime
-     * @throws \EE_Error
-     */
+	/**
+	 * This returns the chronologically first datetime that this ticket is associated with
+	 *
+	 * @return EE_Datetime
+	 * @throws \EE_Error
+	 */
 	public function first_datetime() {
 		$datetimes = $this->datetimes( array( 'limit' => 1 ) );
 		return reset( $datetimes );
@@ -266,14 +266,14 @@ 
 
 
 
-    /**
-     * Gets all the datetimes this ticket can be used for attending.
-     * Unless otherwise specified, orders datetimes by start date.
-     *
-     * @param array $query_params see EEM_Base::get_all()
-     * @return EE_Datetime[]|EE_Base_Class[]
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets all the datetimes this ticket can be used for attending.
+	 * Unless otherwise specified, orders datetimes by start date.
+	 *
+	 * @param array $query_params see EEM_Base::get_all()
+	 * @return EE_Datetime[]|EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
 	public function datetimes( $query_params = array() ) {
 		if ( ! isset( $query_params[ 'order_by' ] ) ) {
 			$query_params[ 'order_by' ][ 'DTT_order' ] = 'ASC';
@@ -283,12 +283,12 @@ 
 
 
 
-    /**
-     * This returns the chronologically last datetime that this ticket is associated with
-     *
-     * @return EE_Datetime
-     * @throws \EE_Error
-     */
+	/**
+	 * This returns the chronologically last datetime that this ticket is associated with
+	 *
+	 * @return EE_Datetime
+	 * @throws \EE_Error
+	 */
 	public function last_datetime() {
 		$datetimes = $this->datetimes( array( 'limit' => 1, 'order_by' => array( 'DTT_EVT_start' => 'DESC' ) ) );
 		return end( $datetimes );
@@ -296,19 +296,19 @@ 
 
 
 
-    /**
-     * This returns the total tickets sold depending on the given parameters.
-     *
-     * @param  string $what   Can be one of two options: 'ticket', 'datetime'.
-     *                        'ticket' = total ticket sales for all datetimes this ticket is related to
-     *                        'datetime' = total ticket sales for a specified datetime (required $dtt_id)
-     *                        'datetime' = total ticket sales in the datetime_ticket table.
-     *                        If $dtt_id is not given then we return an array of sales indexed by datetime.
-     *                        If $dtt_id IS given then we return the tickets sold for that given datetime.
-     * @param  int    $dtt_id [optional] include the dtt_id with $what = 'datetime'.
-     * @return mixed (array|int)          how many tickets have sold
-     * @throws \EE_Error
-     */
+	/**
+	 * This returns the total tickets sold depending on the given parameters.
+	 *
+	 * @param  string $what   Can be one of two options: 'ticket', 'datetime'.
+	 *                        'ticket' = total ticket sales for all datetimes this ticket is related to
+	 *                        'datetime' = total ticket sales for a specified datetime (required $dtt_id)
+	 *                        'datetime' = total ticket sales in the datetime_ticket table.
+	 *                        If $dtt_id is not given then we return an array of sales indexed by datetime.
+	 *                        If $dtt_id IS given then we return the tickets sold for that given datetime.
+	 * @param  int    $dtt_id [optional] include the dtt_id with $what = 'datetime'.
+	 * @return mixed (array|int)          how many tickets have sold
+	 * @throws \EE_Error
+	 */
 	public function tickets_sold( $what = 'ticket', $dtt_id = NULL ) {
 		$total = 0;
 		$tickets_sold = $this->_all_tickets_sold();
@@ -333,12 +333,12 @@ 
 
 
 
-    /**
-     * This returns an array indexed by datetime_id for tickets sold with this ticket.
-     *
-     * @return EE_Ticket[]
-     * @throws \EE_Error
-     */
+	/**
+	 * This returns an array indexed by datetime_id for tickets sold with this ticket.
+	 *
+	 * @return EE_Ticket[]
+	 * @throws \EE_Error
+	 */
 	protected function _all_tickets_sold() {
 		$datetimes = $this->get_many_related( 'Datetime' );
 		$tickets_sold = array();
@@ -354,29 +354,29 @@ 
 
 
 
-    /**
-     * This returns the base price object for the ticket.
-     *
-     * @param  bool $return_array whether to return as an array indexed by price id or just the object.
-     * @return EE_Price|EE_Base_Class|EE_Price[]|EE_Base_Class[]
-     * @throws \EE_Error
-     */
+	/**
+	 * This returns the base price object for the ticket.
+	 *
+	 * @param  bool $return_array whether to return as an array indexed by price id or just the object.
+	 * @return EE_Price|EE_Base_Class|EE_Price[]|EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
 	public function base_price( $return_array = FALSE ) {
 		$_where = array( 'Price_Type.PBT_ID' => EEM_Price_Type::base_type_base_price );
 		return $return_array
-            ? $this->get_many_related( 'Price', array( $_where ) )
-            : $this->get_first_related( 'Price', array( $_where ) );
+			? $this->get_many_related( 'Price', array( $_where ) )
+			: $this->get_first_related( 'Price', array( $_where ) );
 	}
 
 
 
-    /**
-     * This returns ONLY the price modifiers for the ticket (i.e. no taxes or base price)
-     *
-     * @access public
-     * @return EE_Price[]
-     * @throws \EE_Error
-     */
+	/**
+	 * This returns ONLY the price modifiers for the ticket (i.e. no taxes or base price)
+	 *
+	 * @access public
+	 * @return EE_Price[]
+	 * @throws \EE_Error
+	 */
 	public function price_modifiers() {
 		$query_params = array( 0 => array( 'Price_Type.PBT_ID' => array( 'NOT IN', array( EEM_Price_Type::base_type_base_price, EEM_Price_Type::base_type_tax ) ) ) );
 		return $this->prices( $query_params );
@@ -384,132 +384,132 @@ 
 
 
 
-    /**
-     * Gets all the prices that combine to form the final price of this ticket
-     *
-     * @param array $query_params like EEM_Base::get_all
-     * @return EE_Price[]|EE_Base_Class[]
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets all the prices that combine to form the final price of this ticket
+	 *
+	 * @param array $query_params like EEM_Base::get_all
+	 * @return EE_Price[]|EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
 	public function prices( $query_params = array() ) {
 		return $this->get_many_related( 'Price', $query_params );
 	}
 
 
 
-    /**
-     * Gets all the ticket applicabilities (ie, relations between datetimes and tickets)
-     *
-     * @param array $query_params see EEM_Base::get_all()
-     * @return EE_Datetime_Ticket|EE_Base_Class[]
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets all the ticket applicabilities (ie, relations between datetimes and tickets)
+	 *
+	 * @param array $query_params see EEM_Base::get_all()
+	 * @return EE_Datetime_Ticket|EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
 	public function datetime_tickets( $query_params = array() ) {
 		return $this->get_many_related( 'Datetime_Ticket', $query_params );
 	}
 
 
 
-    /**
-     * Gets all the datetimes from the db ordered by DTT_order
-     *
-     * @param boolean $show_expired
-     * @param boolean $show_deleted
-     * @return EE_Datetime[]
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets all the datetimes from the db ordered by DTT_order
+	 *
+	 * @param boolean $show_expired
+	 * @param boolean $show_deleted
+	 * @return EE_Datetime[]
+	 * @throws \EE_Error
+	 */
 	public function datetimes_ordered( $show_expired = TRUE, $show_deleted = FALSE ) {
 		return EEM_Datetime::instance( $this->_timezone )->get_datetimes_for_ticket_ordered_by_DTT_order( $this->ID(), $show_expired, $show_deleted );
 	}
 
 
 
-    /**
-     * Gets ID
-     *
-     * @return string
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets ID
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
 	public function ID() {
 		return $this->get( 'TKT_ID' );
 	}
 
 
 
-    /**
-     * get the author of the ticket.
-     *
-     * @since 4.5.0
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * get the author of the ticket.
+	 *
+	 * @since 4.5.0
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function wp_user() {
 		return $this->get('TKT_wp_user');
 	}
 
 
 
-    /**
-     * Gets the template for the ticket
-     *
-     * @return EE_Ticket_Template|EE_Base_Class
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets the template for the ticket
+	 *
+	 * @return EE_Ticket_Template|EE_Base_Class
+	 * @throws \EE_Error
+	 */
 	public function template() {
 		return $this->get_first_related( 'Ticket_Template' );
 	}
 
 
 
-    /**
-     * Simply returns an array of EE_Price objects that are taxes.
-     *
-     * @return EE_Price[]
-     * @throws \EE_Error
-     */
+	/**
+	 * Simply returns an array of EE_Price objects that are taxes.
+	 *
+	 * @return EE_Price[]
+	 * @throws \EE_Error
+	 */
 	public function get_ticket_taxes_for_admin() {
 		return EE_Taxes::get_taxes_for_admin();
 	}
 
 
 
-    /**
-     * @return float
-     * @throws \EE_Error
-     */
+	/**
+	 * @return float
+	 * @throws \EE_Error
+	 */
 	public function ticket_price() {
 		return $this->get( 'TKT_price' );
 	}
 
 
 
-    /**
-     * @return mixed
-     * @throws \EE_Error
-     */
+	/**
+	 * @return mixed
+	 * @throws \EE_Error
+	 */
 	public function pretty_price() {
 		return $this->get_pretty( 'TKT_price' );
 	}
 
 
 
-    /**
-     * @return bool
-     * @throws \EE_Error
-     */
+	/**
+	 * @return bool
+	 * @throws \EE_Error
+	 */
 	public function is_free() {
 		return $this->get_ticket_total_with_taxes() === (float) 0;
 	}
 
 
 
-    /**
-     * get_ticket_total_with_taxes
-     *
-     * @param bool $no_cache
-     * @return float
-     * @throws \EE_Error
-     */
+	/**
+	 * get_ticket_total_with_taxes
+	 *
+	 * @param bool $no_cache
+	 * @return float
+	 * @throws \EE_Error
+	 */
 	public function get_ticket_total_with_taxes( $no_cache = FALSE ) {
 		if ($this->_ticket_total_with_taxes === null || $no_cache ) {
 			$this->_ticket_total_with_taxes = $this->get_ticket_subtotal() + $this->get_ticket_taxes_total_for_admin();
@@ -526,201 +526,201 @@ 
 
 
 
-    /**
-     * @return float
-     * @throws \EE_Error
-     */
+	/**
+	 * @return float
+	 * @throws \EE_Error
+	 */
 	public function get_ticket_subtotal() {
 		return EE_Taxes::get_subtotal_for_admin( $this );
 	}
 
 
 
-    /**
-     * Returns the total taxes applied to this ticket
-     *
-     * @return float
-     * @throws \EE_Error
-     */
+	/**
+	 * Returns the total taxes applied to this ticket
+	 *
+	 * @return float
+	 * @throws \EE_Error
+	 */
 	public function get_ticket_taxes_total_for_admin() {
 		return EE_Taxes::get_total_taxes_for_admin( $this );
 	}
 
 
 
-    /**
-     * Sets name
-     *
-     * @param string $name
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets name
+	 *
+	 * @param string $name
+	 * @throws \EE_Error
+	 */
 	public function set_name( $name ) {
 		$this->set( 'TKT_name', $name );
 	}
 
 
 
-    /**
-     * Gets description
-     *
-     * @return string
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets description
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
 	public function description() {
 		return $this->get( 'TKT_description' );
 	}
 
 
 
-    /**
-     * Sets description
-     *
-     * @param string $description
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets description
+	 *
+	 * @param string $description
+	 * @throws \EE_Error
+	 */
 	public function set_description( $description ) {
 		$this->set( 'TKT_description', $description );
 	}
 
 
 
-    /**
-     * Gets start_date
-     *
-     * @param string $dt_frmt
-     * @param string $tm_frmt
-     * @return string
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets start_date
+	 *
+	 * @param string $dt_frmt
+	 * @param string $tm_frmt
+	 * @return string
+	 * @throws \EE_Error
+	 */
 	public function start_date( $dt_frmt = '', $tm_frmt = '' ) {
 		return $this->_get_datetime( 'TKT_start_date', $dt_frmt, $tm_frmt );
 	}
 
 
 
-    /**
-     * Sets start_date
-     *
-     * @param string $start_date
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets start_date
+	 *
+	 * @param string $start_date
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_start_date( $start_date ) {
 		$this->_set_date_time( 'B', $start_date, 'TKT_start_date' );
 	}
 
 
 
-    /**
-     * Gets end_date
-     *
-     * @param string $dt_frmt
-     * @param string $tm_frmt
-     * @return string
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets end_date
+	 *
+	 * @param string $dt_frmt
+	 * @param string $tm_frmt
+	 * @return string
+	 * @throws \EE_Error
+	 */
 	public function end_date( $dt_frmt = '', $tm_frmt = '' ) {
 		return $this->_get_datetime( 'TKT_end_date', $dt_frmt, $tm_frmt );
 	}
 
 
 
-    /**
-     * Sets end_date
-     *
-     * @param string $end_date
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets end_date
+	 *
+	 * @param string $end_date
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_end_date( $end_date ) {
 		$this->_set_date_time( 'B', $end_date, 'TKT_end_date' );
 	}
 
 
 
-    /**
-     * Sets sell until time
-     *
-     * @since 4.5.0
-     * @param string $time a string representation of the sell until time (ex 9am or 7:30pm)
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets sell until time
+	 *
+	 * @since 4.5.0
+	 * @param string $time a string representation of the sell until time (ex 9am or 7:30pm)
+	 * @throws \EE_Error
+	 */
 	public function set_end_time( $time ) {
 		$this->_set_time_for( $time, 'TKT_end_date' );
 	}
 
 
 
-    /**
-     * Sets min
-     *
-     * @param int $min
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets min
+	 *
+	 * @param int $min
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_min( $min ) {
 		$this->set( 'TKT_min', $min );
 	}
 
 
 
-    /**
-     * Gets max
-     *
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets max
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function max() {
 		return $this->get( 'TKT_max' );
 	}
 
 
 
-    /**
-     * Sets max
-     *
-     * @param int $max
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets max
+	 *
+	 * @param int $max
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_max( $max ) {
 		$this->set( 'TKT_max', $max );
 	}
 
 
 
-    /**
-     * Sets price
-     *
-     * @param float $price
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets price
+	 *
+	 * @param float $price
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_price( $price ) {
 		$this->set( 'TKT_price', $price );
 	}
 
 
 
-    /**
-     * Gets sold
-     *
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets sold
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function sold() {
 		return $this->get_raw( 'TKT_sold' );
 	}
 
 
 
-    /**
-     * Sets sold
-     *
-     * @param int $sold
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets sold
+	 *
+	 * @param int $sold
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_sold( $sold ) {
 		// sold can not go below zero
 		$sold = max( 0, $sold );
@@ -729,13 +729,13 @@ 
 
 
 
-    /**
-     * increments sold by amount passed by $qty
-     *
-     * @param int $qty
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * increments sold by amount passed by $qty
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function increase_sold( $qty = 1 ) {
 		$sold = $this->sold() + $qty;
 		// remove ticket reservation, but don't adjust datetime reservations,  because that will happen
@@ -744,22 +744,22 @@ 
 		$this->_increase_sold_for_datetimes( $qty );
 		$this->set_sold( $sold );
 		do_action(
-		    'AHEE__EE_Ticket__increase_sold',
-            $this,
-            $qty,
-            $sold
-        );
+			'AHEE__EE_Ticket__increase_sold',
+			$this,
+			$qty,
+			$sold
+		);
 	}
 
 
 
-    /**
-     * Increases sold on related datetimes
-     *
-     * @param int $qty
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Increases sold on related datetimes
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	protected function _increase_sold_for_datetimes( $qty = 1 ) {
 		$datetimes = $this->datetimes();
 		if ( is_array( $datetimes ) ) {
@@ -774,34 +774,34 @@ 
 
 
 
-    /**
-     * decrements (subtracts) sold by amount passed by $qty
-     *
-     * @param int $qty
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * decrements (subtracts) sold by amount passed by $qty
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function decrease_sold( $qty = 1 ) {
 		$sold = $this->sold() - $qty;
 		$this->_decrease_sold_for_datetimes( $qty );
 		$this->set_sold( $sold );
-        do_action(
-            'AHEE__EE_Ticket__decrease_sold',
-            $this,
-            $qty,
-            $sold
-        );
-    }
-
-
-
-    /**
-     * Decreases sold on related datetimes
-     *
-     * @param int $qty
-     * @return void
-     * @throws \EE_Error
-     */
+		do_action(
+			'AHEE__EE_Ticket__decrease_sold',
+			$this,
+			$qty,
+			$sold
+		);
+	}
+
+
+
+	/**
+	 * Decreases sold on related datetimes
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	protected function _decrease_sold_for_datetimes( $qty = 1 ) {
 		$datetimes = $this->datetimes();
 		if ( is_array( $datetimes ) ) {
@@ -816,25 +816,25 @@ 
 
 
 
-    /**
-     * Gets qty of reserved tickets
-     *
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets qty of reserved tickets
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function reserved() {
 		return $this->get_raw( 'TKT_reserved' );
 	}
 
 
 
-    /**
-     * Sets reserved
-     *
-     * @param int $reserved
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets reserved
+	 *
+	 * @param int $reserved
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_reserved( $reserved ) {
 		// reserved can not go below zero
 		$reserved = max( 0, (int) $reserved );
@@ -843,35 +843,35 @@ 
 
 
 
-    /**
-     * increments reserved by amount passed by $qty
-     *
-     * @param int $qty
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * increments reserved by amount passed by $qty
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function increase_reserved( $qty = 1 ) {
 		$qty = absint( $qty );
 		$reserved = $this->reserved() + $qty;
 		$this->_increase_reserved_for_datetimes( $qty );
 		$this->set_reserved( $reserved );
-        do_action(
-            'AHEE__EE_Ticket__increase_reserved',
-            $this,
-            $qty,
-            $reserved
-        );
-    }
-
-
-
-    /**
-     * Increases sold on related datetimes
-     *
-     * @param int $qty
-     * @return void
-     * @throws \EE_Error
-     */
+		do_action(
+			'AHEE__EE_Ticket__increase_reserved',
+			$this,
+			$qty,
+			$reserved
+		);
+	}
+
+
+
+	/**
+	 * Increases sold on related datetimes
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	protected function _increase_reserved_for_datetimes( $qty = 1 ) {
 		$datetimes = $this->datetimes();
 		if ( is_array( $datetimes ) ) {
@@ -886,37 +886,37 @@ 
 
 
 
-    /**
-     * decrements (subtracts) reserved by amount passed by $qty
-     *
-     * @param int  $qty
-     * @param bool $adjust_datetimes
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * decrements (subtracts) reserved by amount passed by $qty
+	 *
+	 * @param int  $qty
+	 * @param bool $adjust_datetimes
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function decrease_reserved( $qty = 1, $adjust_datetimes = true ) {
 		$reserved = $this->reserved() - absint( $qty );
 		if ( $adjust_datetimes ) {
 			$this->_decrease_reserved_for_datetimes( $qty );
 		}
 		$this->set_reserved( $reserved );
-        do_action(
-            'AHEE__EE_Ticket__decrease_reserved',
-            $this,
-            $qty,
-            $reserved
-        );
-    }
-
-
-
-    /**
-     * Increases sold on related datetimes
-     *
-     * @param int $qty
-     * @return void
-     * @throws \EE_Error
-     */
+		do_action(
+			'AHEE__EE_Ticket__decrease_reserved',
+			$this,
+			$qty,
+			$reserved
+		);
+	}
+
+
+
+	/**
+	 * Increases sold on related datetimes
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	protected function _decrease_reserved_for_datetimes( $qty = 1 ) {
 		$datetimes = $this->datetimes();
 		if ( is_array( $datetimes ) ) {
@@ -931,18 +931,18 @@ 
 
 
 
-    /**
-     * Gets ticket quantity
-     *
-     * @param string $context     ticket quantity is somewhat subjective depending on the exact information sought
-     *                            therefore $context can be one of three values: '', 'reg_limit', or 'saleable'
-     *                            '' (default) quantity is the actual db value for TKT_qty, unaffected by other objects
-     *                            REG LIMIT: caps qty based on DTT_reg_limit for ALL related datetimes
-     *                            SALEABLE: also considers datetime sold and returns zero if ANY DTT is sold out, and
-     *                            is therefore the truest measure of tickets that can be purchased at the moment
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets ticket quantity
+	 *
+	 * @param string $context     ticket quantity is somewhat subjective depending on the exact information sought
+	 *                            therefore $context can be one of three values: '', 'reg_limit', or 'saleable'
+	 *                            '' (default) quantity is the actual db value for TKT_qty, unaffected by other objects
+	 *                            REG LIMIT: caps qty based on DTT_reg_limit for ALL related datetimes
+	 *                            SALEABLE: also considers datetime sold and returns zero if ANY DTT is sold out, and
+	 *                            is therefore the truest measure of tickets that can be purchased at the moment
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function qty( $context = '' ) {
 		switch ( $context ) {
 			case 'reg_limit' :
@@ -956,19 +956,19 @@ 
 
 
 
-    /**
-     * Gets ticket quantity
-     *
-     * @param string $context     ticket quantity is somewhat subjective depending on the exact information sought
-     *                            therefore $context can be one of two values: 'reg_limit', or 'saleable'
-     *                            REG LIMIT: caps qty based on DTT_reg_limit for ALL related datetimes
-     *                            SALEABLE: also considers datetime sold and returns zero if ANY DTT is sold out, and
-     *                            is therefore the truest measure of tickets that can be purchased at the moment
-     * @param  int   $DTT_ID      the primary key for a particular datetime.
-     *                            set to 0 for all related datetimes
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets ticket quantity
+	 *
+	 * @param string $context     ticket quantity is somewhat subjective depending on the exact information sought
+	 *                            therefore $context can be one of two values: 'reg_limit', or 'saleable'
+	 *                            REG LIMIT: caps qty based on DTT_reg_limit for ALL related datetimes
+	 *                            SALEABLE: also considers datetime sold and returns zero if ANY DTT is sold out, and
+	 *                            is therefore the truest measure of tickets that can be purchased at the moment
+	 * @param  int   $DTT_ID      the primary key for a particular datetime.
+	 *                            set to 0 for all related datetimes
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function real_quantity_on_ticket( $context = 'reg_limit', $DTT_ID = 0 ) {
 		$raw = $this->get_raw( 'TKT_qty' );
 		// return immediately if it's zero
@@ -1051,212 +1051,212 @@ 
 
 
 
-    /**
-     * Gets uses
-     *
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets uses
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function uses() {
 		return $this->get( 'TKT_uses' );
 	}
 
 
 
-    /**
-     * Sets uses
-     *
-     * @param int $uses
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets uses
+	 *
+	 * @param int $uses
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_uses( $uses ) {
 		$this->set( 'TKT_uses', $uses );
 	}
 
 
 
-    /**
-     * returns whether ticket is required or not.
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
+	/**
+	 * returns whether ticket is required or not.
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
 	public function required() {
 		return $this->get( 'TKT_required' );
 	}
 
 
 
-    /**
-     * sets the TKT_required property
-     *
-     * @param boolean $required
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * sets the TKT_required property
+	 *
+	 * @param boolean $required
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_required( $required ) {
 		$this->set( 'TKT_required', $required );
 	}
 
 
 
-    /**
-     * Gets taxable
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets taxable
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
 	public function taxable() {
 		return $this->get( 'TKT_taxable' );
 	}
 
 
 
-    /**
-     * Sets taxable
-     *
-     * @param boolean $taxable
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets taxable
+	 *
+	 * @param boolean $taxable
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_taxable( $taxable ) {
 		$this->set( 'TKT_taxable', $taxable );
 	}
 
 
 
-    /**
-     * Gets is_default
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets is_default
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
 	public function is_default() {
 		return $this->get( 'TKT_is_default' );
 	}
 
 
 
-    /**
-     * Sets is_default
-     *
-     * @param boolean $is_default
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets is_default
+	 *
+	 * @param boolean $is_default
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_is_default( $is_default ) {
 		$this->set( 'TKT_is_default', $is_default );
 	}
 
 
 
-    /**
-     * Gets order
-     *
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets order
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function order() {
 		return $this->get( 'TKT_order' );
 	}
 
 
 
-    /**
-     * Sets order
-     *
-     * @param int $order
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets order
+	 *
+	 * @param int $order
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_order( $order ) {
 		$this->set( 'TKT_order', $order );
 	}
 
 
 
-    /**
-     * Gets row
-     *
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets row
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function row() {
 		return $this->get( 'TKT_row' );
 	}
 
 
 
-    /**
-     * Sets row
-     *
-     * @param int $row
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets row
+	 *
+	 * @param int $row
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_row( $row ) {
 		$this->set( 'TKT_row', $row );
 	}
 
 
 
-    /**
-     * Gets deleted
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets deleted
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
 	public function deleted() {
 		return $this->get( 'TKT_deleted' );
 	}
 
 
 
-    /**
-     * Sets deleted
-     *
-     * @param boolean $deleted
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets deleted
+	 *
+	 * @param boolean $deleted
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_deleted( $deleted ) {
 		$this->set( 'TKT_deleted', $deleted );
 	}
 
 
 
-    /**
-     * Gets parent
-     *
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets parent
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function parent_ID() {
 		return $this->get( 'TKT_parent' );
 	}
 
 
 
-    /**
-     * Sets parent
-     *
-     * @param int $parent
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets parent
+	 *
+	 * @param int $parent
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_parent_ID( $parent ) {
 		$this->set( 'TKT_parent', $parent );
 	}
 
 
 
-    /**
-     * Gets a string which is handy for showing in gateways etc that describes the ticket.
-     *
-     * @return string
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets a string which is handy for showing in gateways etc that describes the ticket.
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
 	public function name_and_info() {
 		$times = array();
 		foreach ( $this->datetimes() as $datetime ) {
@@ -1267,67 +1267,67 @@ 
 
 
 
-    /**
-     * Gets name
-     *
-     * @return string
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets name
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
 	public function name() {
 		return $this->get( 'TKT_name' );
 	}
 
 
 
-    /**
-     * Gets price
-     *
-     * @return float
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets price
+	 *
+	 * @return float
+	 * @throws \EE_Error
+	 */
 	public function price() {
 		return $this->get( 'TKT_price' );
 	}
 
 
 
-    /**
-     * Gets all the registrations for this ticket
-     *
-     * @param array $query_params like EEM_Base::get_all's
-     * @return EE_Registration[]|EE_Base_Class[]
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets all the registrations for this ticket
+	 *
+	 * @param array $query_params like EEM_Base::get_all's
+	 * @return EE_Registration[]|EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
 	public function registrations( $query_params = array() ) {
 		return $this->get_many_related( 'Registration', $query_params );
 	}
 
 
 
-    /**
-     * Updates the TKT_sold attribute (and saves) based on the number of APPROVED registrations for this ticket.
-     * into account
-     *
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Updates the TKT_sold attribute (and saves) based on the number of APPROVED registrations for this ticket.
+	 * into account
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function update_tickets_sold() {
-        $count_regs_for_this_ticket = $this->count_registrations(
-            array(
-                array(
-                    'STS_ID'      => EEM_Registration::status_id_approved,
-                    'REG_deleted' => 0,
-                ),
-            )
-        );
-        $sold = $this->sold();
-        if ($count_regs_for_this_ticket > $sold) {
-            $this->increase_sold($count_regs_for_this_ticket - $sold);
-            $this->save();
-        } else if ($count_regs_for_this_ticket < $sold) {
-            $this->decrease_sold($count_regs_for_this_ticket - $sold);
-            $this->save();
-        }
+		$count_regs_for_this_ticket = $this->count_registrations(
+			array(
+				array(
+					'STS_ID'      => EEM_Registration::status_id_approved,
+					'REG_deleted' => 0,
+				),
+			)
+		);
+		$sold = $this->sold();
+		if ($count_regs_for_this_ticket > $sold) {
+			$this->increase_sold($count_regs_for_this_ticket - $sold);
+			$this->save();
+		} else if ($count_regs_for_this_ticket < $sold) {
+			$this->decrease_sold($count_regs_for_this_ticket - $sold);
+			$this->save();
+		}
 		return $count_regs_for_this_ticket;
 	}
 
@@ -1355,21 +1355,21 @@ 
 
 
 
-    /**
-     * Implementation of the EEI_Event_Relation interface method
-     *
-     * @see EEI_Event_Relation for comments
-     * @return EE_Event
-     * @throws \EE_Error
-     * @throws UnexpectedEntityException
-     */
+	/**
+	 * Implementation of the EEI_Event_Relation interface method
+	 *
+	 * @see EEI_Event_Relation for comments
+	 * @return EE_Event
+	 * @throws \EE_Error
+	 * @throws UnexpectedEntityException
+	 */
 	public function get_related_event() {
 		//get one datetime to use for getting the event
 		$datetime = $this->first_datetime();
 		if ( ! $datetime instanceof \EE_Datetime ) {
 			throw new UnexpectedEntityException(
 				$datetime,
-                'EE_Datetime',
+				'EE_Datetime',
 				sprintf(
 					__( 'The ticket (%s) is not associated with any valid datetimes.', 'event_espresso'),
 					$this->name()
@@ -1380,7 +1380,7 @@ 
 		if ( ! $event instanceof \EE_Event ) {
 			throw new UnexpectedEntityException(
 				$event,
-                'EE_Event',
+				'EE_Event',
 				sprintf(
 					__( 'The ticket (%s) is not associated with a valid event.', 'event_espresso'),
 					$this->name()
@@ -1392,14 +1392,14 @@ 
 
 
 
-    /**
-     * Implementation of the EEI_Event_Relation interface method
-     *
-     * @see EEI_Event_Relation for comments
-     * @return string
-     * @throws UnexpectedEntityException
-     * @throws \EE_Error
-     */
+	/**
+	 * Implementation of the EEI_Event_Relation interface method
+	 *
+	 * @see EEI_Event_Relation for comments
+	 * @return string
+	 * @throws UnexpectedEntityException
+	 * @throws \EE_Error
+	 */
 	public function get_event_name() {
 		$event = $this->get_related_event();
 		return $event instanceof EE_Event ? $event->name() : '';
@@ -1407,28 +1407,28 @@ 
 
 
 
-    /**
-     * Implementation of the EEI_Event_Relation interface method
-     *
-     * @see EEI_Event_Relation for comments
-     * @return int
-     * @throws UnexpectedEntityException
-     * @throws \EE_Error
-     */
+	/**
+	 * Implementation of the EEI_Event_Relation interface method
+	 *
+	 * @see EEI_Event_Relation for comments
+	 * @return int
+	 * @throws UnexpectedEntityException
+	 * @throws \EE_Error
+	 */
 	public function get_event_ID() {
 		$event = $this->get_related_event();
 		return $event instanceof EE_Event ? $event->ID() : 0;
 	}
 
 
-    /**
-     * This simply returns whether a ticket can be permanently deleted or not.
-     * The criteria for determining this is whether the ticket has any related registrations.
-     * If there are none then it can be permanently deleted.
-     *
-     * @return bool
-     */
+	/**
+	 * This simply returns whether a ticket can be permanently deleted or not.
+	 * The criteria for determining this is whether the ticket has any related registrations.
+	 * If there are none then it can be permanently deleted.
+	 *
+	 * @return bool
+	 */
 	public function is_permanently_deleteable() {
-	    return $this->count_registrations() === 0;
-    }
+		return $this->count_registrations() === 0;
+	}
 } //end EE_Ticket class

Spacing +203 added lines, -203 removed lines

@@ -1,7 +1,7 @@ 
 <?php use EventEspresso\core\exceptions\UnexpectedEntityException;
 
-if ( !defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 /**
  * Event Espresso
@@ -70,9 +70,9 @@ 
      * @return EE_Ticket
      * @throws \EE_Error
      */
-	public static function new_instance( $props_n_values = array(), $timezone = null, $date_formats = array() ) {
-		$has_object = parent::_check_for_object( $props_n_values, __CLASS__, $timezone, $date_formats );
-		return $has_object ? $has_object : new self( $props_n_values, false, $timezone, $date_formats );
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) {
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
 	}
 
 
@@ -84,8 +84,8 @@ 
      * @return EE_Ticket
      * @throws \EE_Error
      */
-	public static function new_instance_from_db( $props_n_values = array(), $timezone = null ) {
-		return new self( $props_n_values, TRUE, $timezone );
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null) {
+		return new self($props_n_values, TRUE, $timezone);
 	}
 
 
@@ -95,7 +95,7 @@ 
      * @throws \EE_Error
      */
 	public function parent() {
-		return $this->get( 'TKT_parent' );
+		return $this->get('TKT_parent');
 	}
 
 
@@ -107,13 +107,13 @@ 
      * @return boolean
      * @throws \EE_Error
      */
-	public function available( $DTT_ID = 0 ) {
+	public function available($DTT_ID = 0) {
 		// are we checking availability for a particular datetime ?
-		if ( $DTT_ID ) {
+		if ($DTT_ID) {
 			// get that datetime object
-			$datetime = $this->get_first_related( 'Datetime', array( array( 'DTT_ID' => $DTT_ID ) ) );
+			$datetime = $this->get_first_related('Datetime', array(array('DTT_ID' => $DTT_ID)));
 			// if  ticket sales for this datetime have exceeded the reg limit...
-			if ( $datetime instanceof EE_Datetime && $datetime->sold_out() ) {
+			if ($datetime instanceof EE_Datetime && $datetime->sold_out()) {
 				return FALSE;
 			}
 		}
@@ -131,22 +131,22 @@ 
      * @return mixed status int if the display string isn't requested
      * @throws \EE_Error
      */
-	public function ticket_status( $display = FALSE, $remaining = null ) {
-		$remaining = is_bool( $remaining ) ? $remaining : $this->is_remaining();
-		if ( ! $remaining ) {
-			return $display ? EEH_Template::pretty_status( EE_Ticket::sold_out, FALSE, 'sentence' ) : EE_Ticket::sold_out;
+	public function ticket_status($display = FALSE, $remaining = null) {
+		$remaining = is_bool($remaining) ? $remaining : $this->is_remaining();
+		if ( ! $remaining) {
+			return $display ? EEH_Template::pretty_status(EE_Ticket::sold_out, FALSE, 'sentence') : EE_Ticket::sold_out;
 		}
-		if ( $this->get( 'TKT_deleted' ) ) {
-			return $display ? EEH_Template::pretty_status( EE_Ticket::archived, FALSE, 'sentence' ) : EE_Ticket::archived;
+		if ($this->get('TKT_deleted')) {
+			return $display ? EEH_Template::pretty_status(EE_Ticket::archived, FALSE, 'sentence') : EE_Ticket::archived;
 		}
-		if ( $this->is_expired() ) {
-			return $display ? EEH_Template::pretty_status( EE_Ticket::expired, FALSE, 'sentence' ) : EE_Ticket::expired;
+		if ($this->is_expired()) {
+			return $display ? EEH_Template::pretty_status(EE_Ticket::expired, FALSE, 'sentence') : EE_Ticket::expired;
 		}
-		if ( $this->is_pending() ) {
-			return $display ? EEH_Template::pretty_status( EE_Ticket::pending, FALSE, 'sentence' ) : EE_Ticket::pending;
+		if ($this->is_pending()) {
+			return $display ? EEH_Template::pretty_status(EE_Ticket::pending, FALSE, 'sentence') : EE_Ticket::pending;
 		}
-		if ( $this->is_on_sale() ) {
-			return $display ? EEH_Template::pretty_status( EE_Ticket::onsale, FALSE, 'sentence' ) : EE_Ticket::onsale;
+		if ($this->is_on_sale()) {
+			return $display ? EEH_Template::pretty_status(EE_Ticket::onsale, FALSE, 'sentence') : EE_Ticket::onsale;
 		}
 		return '';
 	}
@@ -161,12 +161,12 @@ 
      * @return boolean         true = tickets remaining, false not.
      * @throws \EE_Error
      */
-	public function is_remaining( $DTT_ID = 0 ) {
-		$num_remaining = $this->remaining( $DTT_ID );
-		if ( $num_remaining === 0 ) {
+	public function is_remaining($DTT_ID = 0) {
+		$num_remaining = $this->remaining($DTT_ID);
+		if ($num_remaining === 0) {
 			return FALSE;
 		}
-		if ( $num_remaining > 0 && $num_remaining < $this->min() ) {
+		if ($num_remaining > 0 && $num_remaining < $this->min()) {
 			return FALSE;
 		}
 		return TRUE;
@@ -182,8 +182,8 @@ 
      * @return int
      * @throws \EE_Error
      */
-	public function remaining( $DTT_ID = 0 ) {
-		return $this->real_quantity_on_ticket('saleable', $DTT_ID );
+	public function remaining($DTT_ID = 0) {
+		return $this->real_quantity_on_ticket('saleable', $DTT_ID);
 	}
 
 
@@ -195,7 +195,7 @@ 
      * @throws \EE_Error
      */
 	public function min() {
-		return $this->get( 'TKT_min' );
+		return $this->get('TKT_min');
 	}
 
 
@@ -207,7 +207,7 @@ 
      * @throws \EE_Error
      */
 	public function is_expired() {
-		return ( $this->get_raw( 'TKT_end_date' ) < time() );
+		return ($this->get_raw('TKT_end_date') < time());
 	}
 
 
@@ -219,7 +219,7 @@ 
      * @throws \EE_Error
      */
 	public function is_pending() {
-		return ( $this->get_raw( 'TKT_start_date' ) > time() );
+		return ($this->get_raw('TKT_start_date') > time());
 	}
 
 
@@ -231,7 +231,7 @@ 
      * @throws \EE_Error
      */
 	public function is_on_sale() {
-		return ( $this->get_raw( 'TKT_start_date' ) < time() && $this->get_raw( 'TKT_end_date' ) > time() );
+		return ($this->get_raw('TKT_start_date') < time() && $this->get_raw('TKT_end_date') > time());
 	}
 
 
@@ -244,11 +244,11 @@ 
      * @return string
      * @throws \EE_Error
      */
-	public function date_range( $dt_frmt = '', $conjunction = ' - ' ) {
-		$first_date = $this->first_datetime() instanceof EE_Datetime ? $this->first_datetime()->start_date( $dt_frmt ) : '';
-		$last_date = $this->last_datetime() instanceof EE_Datetime ? $this->last_datetime()->end_date( $dt_frmt ) : '';
+	public function date_range($dt_frmt = '', $conjunction = ' - ') {
+		$first_date = $this->first_datetime() instanceof EE_Datetime ? $this->first_datetime()->start_date($dt_frmt) : '';
+		$last_date = $this->last_datetime() instanceof EE_Datetime ? $this->last_datetime()->end_date($dt_frmt) : '';
 
-		return $first_date && $last_date ? $first_date . $conjunction  . $last_date : '';
+		return $first_date && $last_date ? $first_date.$conjunction.$last_date : '';
 	}
 
 
@@ -260,8 +260,8 @@ 
      * @throws \EE_Error
      */
 	public function first_datetime() {
-		$datetimes = $this->datetimes( array( 'limit' => 1 ) );
-		return reset( $datetimes );
+		$datetimes = $this->datetimes(array('limit' => 1));
+		return reset($datetimes);
 	}
 
 
@@ -274,11 +274,11 @@ 
      * @return EE_Datetime[]|EE_Base_Class[]
      * @throws \EE_Error
      */
-	public function datetimes( $query_params = array() ) {
-		if ( ! isset( $query_params[ 'order_by' ] ) ) {
-			$query_params[ 'order_by' ][ 'DTT_order' ] = 'ASC';
+	public function datetimes($query_params = array()) {
+		if ( ! isset($query_params['order_by'])) {
+			$query_params['order_by']['DTT_order'] = 'ASC';
 		}
-		return $this->get_many_related( 'Datetime', $query_params );
+		return $this->get_many_related('Datetime', $query_params);
 	}
 
 
@@ -290,8 +290,8 @@ 
      * @throws \EE_Error
      */
 	public function last_datetime() {
-		$datetimes = $this->datetimes( array( 'limit' => 1, 'order_by' => array( 'DTT_EVT_start' => 'DESC' ) ) );
-		return end( $datetimes );
+		$datetimes = $this->datetimes(array('limit' => 1, 'order_by' => array('DTT_EVT_start' => 'DESC')));
+		return end($datetimes);
 	}
 
 
@@ -309,22 +309,22 @@ 
      * @return mixed (array|int)          how many tickets have sold
      * @throws \EE_Error
      */
-	public function tickets_sold( $what = 'ticket', $dtt_id = NULL ) {
+	public function tickets_sold($what = 'ticket', $dtt_id = NULL) {
 		$total = 0;
 		$tickets_sold = $this->_all_tickets_sold();
-		switch ( $what ) {
+		switch ($what) {
 			case 'ticket' :
-				return $tickets_sold[ 'ticket' ];
+				return $tickets_sold['ticket'];
 				break;
 			case 'datetime' :
-				if ( empty( $tickets_sold[ 'datetime' ] ) ) {
+				if (empty($tickets_sold['datetime'])) {
 					return $total;
 				}
-				if ( ! empty( $dtt_id ) && ! isset( $tickets_sold[ 'datetime' ][ $dtt_id ] ) ) {
-					EE_Error::add_error( __( 'You\'ve requested the amount of tickets sold for a given ticket and datetime, however there are no records for the datetime id you included.  Are you SURE that is a datetime related to this ticket?', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
+				if ( ! empty($dtt_id) && ! isset($tickets_sold['datetime'][$dtt_id])) {
+					EE_Error::add_error(__('You\'ve requested the amount of tickets sold for a given ticket and datetime, however there are no records for the datetime id you included.  Are you SURE that is a datetime related to this ticket?', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 					return $total;
 				}
-				return empty( $dtt_id ) ? $tickets_sold[ 'datetime' ] : $tickets_sold[ 'datetime' ][ $dtt_id ];
+				return empty($dtt_id) ? $tickets_sold['datetime'] : $tickets_sold['datetime'][$dtt_id];
 				break;
 			default:
 				return $total;
@@ -340,15 +340,15 @@ 
      * @throws \EE_Error
      */
 	protected function _all_tickets_sold() {
-		$datetimes = $this->get_many_related( 'Datetime' );
+		$datetimes = $this->get_many_related('Datetime');
 		$tickets_sold = array();
-		if ( ! empty( $datetimes ) ) {
-			foreach ( $datetimes as $datetime ) {
-				$tickets_sold[ 'datetime' ][ $datetime->ID() ] = $datetime->get( 'DTT_sold' );
+		if ( ! empty($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				$tickets_sold['datetime'][$datetime->ID()] = $datetime->get('DTT_sold');
 			}
 		}
 		//Tickets sold
-		$tickets_sold[ 'ticket' ] = $this->sold();
+		$tickets_sold['ticket'] = $this->sold();
 		return $tickets_sold;
 	}
 
@@ -361,11 +361,11 @@ 
      * @return EE_Price|EE_Base_Class|EE_Price[]|EE_Base_Class[]
      * @throws \EE_Error
      */
-	public function base_price( $return_array = FALSE ) {
-		$_where = array( 'Price_Type.PBT_ID' => EEM_Price_Type::base_type_base_price );
+	public function base_price($return_array = FALSE) {
+		$_where = array('Price_Type.PBT_ID' => EEM_Price_Type::base_type_base_price);
 		return $return_array
-            ? $this->get_many_related( 'Price', array( $_where ) )
-            : $this->get_first_related( 'Price', array( $_where ) );
+            ? $this->get_many_related('Price', array($_where))
+            : $this->get_first_related('Price', array($_where));
 	}
 
 
@@ -378,8 +378,8 @@ 
      * @throws \EE_Error
      */
 	public function price_modifiers() {
-		$query_params = array( 0 => array( 'Price_Type.PBT_ID' => array( 'NOT IN', array( EEM_Price_Type::base_type_base_price, EEM_Price_Type::base_type_tax ) ) ) );
-		return $this->prices( $query_params );
+		$query_params = array(0 => array('Price_Type.PBT_ID' => array('NOT IN', array(EEM_Price_Type::base_type_base_price, EEM_Price_Type::base_type_tax))));
+		return $this->prices($query_params);
 	}
 
 
@@ -391,8 +391,8 @@ 
      * @return EE_Price[]|EE_Base_Class[]
      * @throws \EE_Error
      */
-	public function prices( $query_params = array() ) {
-		return $this->get_many_related( 'Price', $query_params );
+	public function prices($query_params = array()) {
+		return $this->get_many_related('Price', $query_params);
 	}
 
 
@@ -404,8 +404,8 @@ 
      * @return EE_Datetime_Ticket|EE_Base_Class[]
      * @throws \EE_Error
      */
-	public function datetime_tickets( $query_params = array() ) {
-		return $this->get_many_related( 'Datetime_Ticket', $query_params );
+	public function datetime_tickets($query_params = array()) {
+		return $this->get_many_related('Datetime_Ticket', $query_params);
 	}
 
 
@@ -418,8 +418,8 @@ 
      * @return EE_Datetime[]
      * @throws \EE_Error
      */
-	public function datetimes_ordered( $show_expired = TRUE, $show_deleted = FALSE ) {
-		return EEM_Datetime::instance( $this->_timezone )->get_datetimes_for_ticket_ordered_by_DTT_order( $this->ID(), $show_expired, $show_deleted );
+	public function datetimes_ordered($show_expired = TRUE, $show_deleted = FALSE) {
+		return EEM_Datetime::instance($this->_timezone)->get_datetimes_for_ticket_ordered_by_DTT_order($this->ID(), $show_expired, $show_deleted);
 	}
 
 
@@ -431,7 +431,7 @@ 
      * @throws \EE_Error
      */
 	public function ID() {
-		return $this->get( 'TKT_ID' );
+		return $this->get('TKT_ID');
 	}
 
 
@@ -456,7 +456,7 @@ 
      * @throws \EE_Error
      */
 	public function template() {
-		return $this->get_first_related( 'Ticket_Template' );
+		return $this->get_first_related('Ticket_Template');
 	}
 
 
@@ -478,7 +478,7 @@ 
      * @throws \EE_Error
      */
 	public function ticket_price() {
-		return $this->get( 'TKT_price' );
+		return $this->get('TKT_price');
 	}
 
 
@@ -488,7 +488,7 @@ 
      * @throws \EE_Error
      */
 	public function pretty_price() {
-		return $this->get_pretty( 'TKT_price' );
+		return $this->get_pretty('TKT_price');
 	}
 
 
@@ -510,8 +510,8 @@ 
      * @return float
      * @throws \EE_Error
      */
-	public function get_ticket_total_with_taxes( $no_cache = FALSE ) {
-		if ($this->_ticket_total_with_taxes === null || $no_cache ) {
+	public function get_ticket_total_with_taxes($no_cache = FALSE) {
+		if ($this->_ticket_total_with_taxes === null || $no_cache) {
 			$this->_ticket_total_with_taxes = $this->get_ticket_subtotal() + $this->get_ticket_taxes_total_for_admin();
 		}
 		return (float) $this->_ticket_total_with_taxes;
@@ -520,7 +520,7 @@ 
 
 
 	public function ensure_TKT_Price_correct() {
-		$this->set( 'TKT_price', EE_Taxes::get_subtotal_for_admin( $this ) );
+		$this->set('TKT_price', EE_Taxes::get_subtotal_for_admin($this));
 		$this->save();
 	}
 
@@ -531,7 +531,7 @@ 
      * @throws \EE_Error
      */
 	public function get_ticket_subtotal() {
-		return EE_Taxes::get_subtotal_for_admin( $this );
+		return EE_Taxes::get_subtotal_for_admin($this);
 	}
 
 
@@ -543,7 +543,7 @@ 
      * @throws \EE_Error
      */
 	public function get_ticket_taxes_total_for_admin() {
-		return EE_Taxes::get_total_taxes_for_admin( $this );
+		return EE_Taxes::get_total_taxes_for_admin($this);
 	}
 
 
@@ -554,8 +554,8 @@ 
      * @param string $name
      * @throws \EE_Error
      */
-	public function set_name( $name ) {
-		$this->set( 'TKT_name', $name );
+	public function set_name($name) {
+		$this->set('TKT_name', $name);
 	}
 
 
@@ -567,7 +567,7 @@ 
      * @throws \EE_Error
      */
 	public function description() {
-		return $this->get( 'TKT_description' );
+		return $this->get('TKT_description');
 	}
 
 
@@ -578,8 +578,8 @@ 
      * @param string $description
      * @throws \EE_Error
      */
-	public function set_description( $description ) {
-		$this->set( 'TKT_description', $description );
+	public function set_description($description) {
+		$this->set('TKT_description', $description);
 	}
 
 
@@ -592,8 +592,8 @@ 
      * @return string
      * @throws \EE_Error
      */
-	public function start_date( $dt_frmt = '', $tm_frmt = '' ) {
-		return $this->_get_datetime( 'TKT_start_date', $dt_frmt, $tm_frmt );
+	public function start_date($dt_frmt = '', $tm_frmt = '') {
+		return $this->_get_datetime('TKT_start_date', $dt_frmt, $tm_frmt);
 	}
 
 
@@ -605,8 +605,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_start_date( $start_date ) {
-		$this->_set_date_time( 'B', $start_date, 'TKT_start_date' );
+	public function set_start_date($start_date) {
+		$this->_set_date_time('B', $start_date, 'TKT_start_date');
 	}
 
 
@@ -619,8 +619,8 @@ 
      * @return string
      * @throws \EE_Error
      */
-	public function end_date( $dt_frmt = '', $tm_frmt = '' ) {
-		return $this->_get_datetime( 'TKT_end_date', $dt_frmt, $tm_frmt );
+	public function end_date($dt_frmt = '', $tm_frmt = '') {
+		return $this->_get_datetime('TKT_end_date', $dt_frmt, $tm_frmt);
 	}
 
 
@@ -632,8 +632,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_end_date( $end_date ) {
-		$this->_set_date_time( 'B', $end_date, 'TKT_end_date' );
+	public function set_end_date($end_date) {
+		$this->_set_date_time('B', $end_date, 'TKT_end_date');
 	}
 
 
@@ -645,8 +645,8 @@ 
      * @param string $time a string representation of the sell until time (ex 9am or 7:30pm)
      * @throws \EE_Error
      */
-	public function set_end_time( $time ) {
-		$this->_set_time_for( $time, 'TKT_end_date' );
+	public function set_end_time($time) {
+		$this->_set_time_for($time, 'TKT_end_date');
 	}
 
 
@@ -658,8 +658,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_min( $min ) {
-		$this->set( 'TKT_min', $min );
+	public function set_min($min) {
+		$this->set('TKT_min', $min);
 	}
 
 
@@ -671,7 +671,7 @@ 
      * @throws \EE_Error
      */
 	public function max() {
-		return $this->get( 'TKT_max' );
+		return $this->get('TKT_max');
 	}
 
 
@@ -683,8 +683,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_max( $max ) {
-		$this->set( 'TKT_max', $max );
+	public function set_max($max) {
+		$this->set('TKT_max', $max);
 	}
 
 
@@ -696,8 +696,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_price( $price ) {
-		$this->set( 'TKT_price', $price );
+	public function set_price($price) {
+		$this->set('TKT_price', $price);
 	}
 
 
@@ -709,7 +709,7 @@ 
      * @throws \EE_Error
      */
 	public function sold() {
-		return $this->get_raw( 'TKT_sold' );
+		return $this->get_raw('TKT_sold');
 	}
 
 
@@ -721,10 +721,10 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_sold( $sold ) {
+	public function set_sold($sold) {
 		// sold can not go below zero
-		$sold = max( 0, $sold );
-		$this->set( 'TKT_sold', $sold );
+		$sold = max(0, $sold);
+		$this->set('TKT_sold', $sold);
 	}
 
 
@@ -736,13 +736,13 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function increase_sold( $qty = 1 ) {
+	public function increase_sold($qty = 1) {
 		$sold = $this->sold() + $qty;
 		// remove ticket reservation, but don't adjust datetime reservations,  because that will happen
 		// via \EE_Datetime::increase_sold() when \EE_Ticket::_increase_sold_for_datetimes() is called
-		$this->decrease_reserved( $qty, false );
-		$this->_increase_sold_for_datetimes( $qty );
-		$this->set_sold( $sold );
+		$this->decrease_reserved($qty, false);
+		$this->_increase_sold_for_datetimes($qty);
+		$this->set_sold($sold);
 		do_action(
 		    'AHEE__EE_Ticket__increase_sold',
             $this,
@@ -760,12 +760,12 @@ 
      * @return void
      * @throws \EE_Error
      */
-	protected function _increase_sold_for_datetimes( $qty = 1 ) {
+	protected function _increase_sold_for_datetimes($qty = 1) {
 		$datetimes = $this->datetimes();
-		if ( is_array( $datetimes ) ) {
-			foreach ( $datetimes as $datetime ) {
-				if ( $datetime instanceof EE_Datetime ) {
-					$datetime->increase_sold( $qty );
+		if (is_array($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					$datetime->increase_sold($qty);
 					$datetime->save();
 				}
 			}
@@ -781,10 +781,10 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function decrease_sold( $qty = 1 ) {
+	public function decrease_sold($qty = 1) {
 		$sold = $this->sold() - $qty;
-		$this->_decrease_sold_for_datetimes( $qty );
-		$this->set_sold( $sold );
+		$this->_decrease_sold_for_datetimes($qty);
+		$this->set_sold($sold);
         do_action(
             'AHEE__EE_Ticket__decrease_sold',
             $this,
@@ -802,12 +802,12 @@ 
      * @return void
      * @throws \EE_Error
      */
-	protected function _decrease_sold_for_datetimes( $qty = 1 ) {
+	protected function _decrease_sold_for_datetimes($qty = 1) {
 		$datetimes = $this->datetimes();
-		if ( is_array( $datetimes ) ) {
-			foreach ( $datetimes as $datetime ) {
-				if ( $datetime instanceof EE_Datetime ) {
-					$datetime->decrease_sold( $qty );
+		if (is_array($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					$datetime->decrease_sold($qty);
 					$datetime->save();
 				}
 			}
@@ -823,7 +823,7 @@ 
      * @throws \EE_Error
      */
 	public function reserved() {
-		return $this->get_raw( 'TKT_reserved' );
+		return $this->get_raw('TKT_reserved');
 	}
 
 
@@ -835,10 +835,10 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_reserved( $reserved ) {
+	public function set_reserved($reserved) {
 		// reserved can not go below zero
-		$reserved = max( 0, (int) $reserved );
-		$this->set( 'TKT_reserved', $reserved );
+		$reserved = max(0, (int) $reserved);
+		$this->set('TKT_reserved', $reserved);
 	}
 
 
@@ -850,11 +850,11 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function increase_reserved( $qty = 1 ) {
-		$qty = absint( $qty );
+	public function increase_reserved($qty = 1) {
+		$qty = absint($qty);
 		$reserved = $this->reserved() + $qty;
-		$this->_increase_reserved_for_datetimes( $qty );
-		$this->set_reserved( $reserved );
+		$this->_increase_reserved_for_datetimes($qty);
+		$this->set_reserved($reserved);
         do_action(
             'AHEE__EE_Ticket__increase_reserved',
             $this,
@@ -872,12 +872,12 @@ 
      * @return void
      * @throws \EE_Error
      */
-	protected function _increase_reserved_for_datetimes( $qty = 1 ) {
+	protected function _increase_reserved_for_datetimes($qty = 1) {
 		$datetimes = $this->datetimes();
-		if ( is_array( $datetimes ) ) {
-			foreach ( $datetimes as $datetime ) {
-				if ( $datetime instanceof EE_Datetime ) {
-					$datetime->increase_reserved( $qty );
+		if (is_array($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					$datetime->increase_reserved($qty);
 					$datetime->save();
 				}
 			}
@@ -894,12 +894,12 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function decrease_reserved( $qty = 1, $adjust_datetimes = true ) {
-		$reserved = $this->reserved() - absint( $qty );
-		if ( $adjust_datetimes ) {
-			$this->_decrease_reserved_for_datetimes( $qty );
+	public function decrease_reserved($qty = 1, $adjust_datetimes = true) {
+		$reserved = $this->reserved() - absint($qty);
+		if ($adjust_datetimes) {
+			$this->_decrease_reserved_for_datetimes($qty);
 		}
-		$this->set_reserved( $reserved );
+		$this->set_reserved($reserved);
         do_action(
             'AHEE__EE_Ticket__decrease_reserved',
             $this,
@@ -917,12 +917,12 @@ 
      * @return void
      * @throws \EE_Error
      */
-	protected function _decrease_reserved_for_datetimes( $qty = 1 ) {
+	protected function _decrease_reserved_for_datetimes($qty = 1) {
 		$datetimes = $this->datetimes();
-		if ( is_array( $datetimes ) ) {
-			foreach ( $datetimes as $datetime ) {
-				if ( $datetime instanceof EE_Datetime ) {
-					$datetime->decrease_reserved( $qty );
+		if (is_array($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					$datetime->decrease_reserved($qty);
 					$datetime->save();
 				}
 			}
@@ -943,14 +943,14 @@ 
      * @return int
      * @throws \EE_Error
      */
-	public function qty( $context = '' ) {
-		switch ( $context ) {
+	public function qty($context = '') {
+		switch ($context) {
 			case 'reg_limit' :
 				return $this->real_quantity_on_ticket();
 			case 'saleable' :
-				return $this->real_quantity_on_ticket( 'saleable' );
+				return $this->real_quantity_on_ticket('saleable');
 			default:
-				return $this->get_raw( 'TKT_qty' );
+				return $this->get_raw('TKT_qty');
 		}
 	}
 
@@ -969,15 +969,15 @@ 
      * @return int
      * @throws \EE_Error
      */
-	public function real_quantity_on_ticket( $context = 'reg_limit', $DTT_ID = 0 ) {
-		$raw = $this->get_raw( 'TKT_qty' );
+	public function real_quantity_on_ticket($context = 'reg_limit', $DTT_ID = 0) {
+		$raw = $this->get_raw('TKT_qty');
 		// return immediately if it's zero
-		if ( $raw === 0 ) {
+		if ($raw === 0) {
 			return $raw;
 		}
 		//echo "\n\n<br />Ticket: " . $this->name() . '<br />';
 		// ensure qty doesn't exceed raw value for THIS ticket
-		$qty = min( EE_INF, $raw );
+		$qty = min(EE_INF, $raw);
 		//echo "\n . qty: " . $qty . '<br />';
 		// calculate this ticket's total sales and reservations
 		$sold_and_reserved_for_this_ticket = $this->sold() + $this->reserved();
@@ -986,23 +986,23 @@ 
 		//echo "\n . sold_and_reserved_for_this_ticket: " . $sold_and_reserved_for_this_ticket . '<br />';
 		// first we need to calculate the maximum number of tickets available for the datetime
 		// do we want data for one datetime or all of them ?
-		$query_params = $DTT_ID ? array( array( 'DTT_ID' => $DTT_ID ) ) : array();
-		$datetimes = $this->datetimes( $query_params );
-		if ( is_array( $datetimes ) && ! empty( $datetimes ) ) {
-			foreach ( $datetimes as $datetime ) {
-				if ( $datetime instanceof EE_Datetime ) {
+		$query_params = $DTT_ID ? array(array('DTT_ID' => $DTT_ID)) : array();
+		$datetimes = $this->datetimes($query_params);
+		if (is_array($datetimes) && ! empty($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
 					$datetime->refresh_from_db();
 					//echo "\n . . datetime name: " . $datetime->name() . '<br />';
 					//echo "\n . . datetime ID: " . $datetime->ID() . '<br />';
 					// initialize with no restrictions for each datetime
 					// but adjust datetime qty based on datetime reg limit
-					$datetime_qty = min( EE_INF, $datetime->reg_limit() );
+					$datetime_qty = min(EE_INF, $datetime->reg_limit());
 					//echo "\n . . . datetime reg_limit: " . $datetime->reg_limit() . '<br />';
 					//echo "\n . . . datetime_qty: " . $datetime_qty . '<br />';
 					// if we want the actual saleable amount, then we need to consider OTHER ticket sales
 					// and reservations for this datetime, that do NOT include sales and reservations
 					// for this ticket (so we add $this->sold() and $this->reserved() back in)
-					if ( $context === 'saleable' ) {
+					if ($context === 'saleable') {
 						$datetime_qty = max(
 							$datetime_qty - $datetime->sold_and_reserved() + $sold_and_reserved_for_this_ticket,
 							0
@@ -1014,16 +1014,16 @@ 
 						$datetime_qty = ! $datetime->sold_out() ? $datetime_qty : 0;
 						//echo "\n . . . datetime_qty: " . $datetime_qty . '<br />';
 					}
-					$qty = min( $datetime_qty, $qty );
+					$qty = min($datetime_qty, $qty);
 					//echo "\n . . qty: " . $qty . '<br />';
 				}
 			}
 		}
 		// NOW that we know the  maximum number of tickets available for the datetime
 		// we can finally factor in the details for this specific ticket
-		if ( $qty > 0 && $context === 'saleable' ) {
+		if ($qty > 0 && $context === 'saleable') {
 			// and subtract the sales for THIS ticket
-			$qty = max( $qty - $sold_and_reserved_for_this_ticket, 0 );
+			$qty = max($qty - $sold_and_reserved_for_this_ticket, 0);
 			//echo "\n . qty: " . $qty . '<br />';
 		}
 		//echo "\nFINAL QTY: " . $qty . "<br /><br />";
@@ -1039,14 +1039,14 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	public function set_qty( $qty ) {
+	public function set_qty($qty) {
 		$datetimes = $this->datetimes();
-		foreach ( $datetimes as $datetime ) {
-			if ( $datetime instanceof EE_Datetime ) {
-				$qty = min( $qty, $datetime->reg_limit() );
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				$qty = min($qty, $datetime->reg_limit());
 			}
 		}
-		$this->set( 'TKT_qty', $qty );
+		$this->set('TKT_qty', $qty);
 	}
 
 
@@ -1058,7 +1058,7 @@ 
      * @throws \EE_Error
      */
 	public function uses() {
-		return $this->get( 'TKT_uses' );
+		return $this->get('TKT_uses');
 	}
 
 
@@ -1070,8 +1070,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_uses( $uses ) {
-		$this->set( 'TKT_uses', $uses );
+	public function set_uses($uses) {
+		$this->set('TKT_uses', $uses);
 	}
 
 
@@ -1083,7 +1083,7 @@ 
      * @throws \EE_Error
      */
 	public function required() {
-		return $this->get( 'TKT_required' );
+		return $this->get('TKT_required');
 	}
 
 
@@ -1095,8 +1095,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_required( $required ) {
-		$this->set( 'TKT_required', $required );
+	public function set_required($required) {
+		$this->set('TKT_required', $required);
 	}
 
 
@@ -1108,7 +1108,7 @@ 
      * @throws \EE_Error
      */
 	public function taxable() {
-		return $this->get( 'TKT_taxable' );
+		return $this->get('TKT_taxable');
 	}
 
 
@@ -1120,8 +1120,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_taxable( $taxable ) {
-		$this->set( 'TKT_taxable', $taxable );
+	public function set_taxable($taxable) {
+		$this->set('TKT_taxable', $taxable);
 	}
 
 
@@ -1133,7 +1133,7 @@ 
      * @throws \EE_Error
      */
 	public function is_default() {
-		return $this->get( 'TKT_is_default' );
+		return $this->get('TKT_is_default');
 	}
 
 
@@ -1145,8 +1145,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_is_default( $is_default ) {
-		$this->set( 'TKT_is_default', $is_default );
+	public function set_is_default($is_default) {
+		$this->set('TKT_is_default', $is_default);
 	}
 
 
@@ -1158,7 +1158,7 @@ 
      * @throws \EE_Error
      */
 	public function order() {
-		return $this->get( 'TKT_order' );
+		return $this->get('TKT_order');
 	}
 
 
@@ -1170,8 +1170,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_order( $order ) {
-		$this->set( 'TKT_order', $order );
+	public function set_order($order) {
+		$this->set('TKT_order', $order);
 	}
 
 
@@ -1183,7 +1183,7 @@ 
      * @throws \EE_Error
      */
 	public function row() {
-		return $this->get( 'TKT_row' );
+		return $this->get('TKT_row');
 	}
 
 
@@ -1195,8 +1195,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_row( $row ) {
-		$this->set( 'TKT_row', $row );
+	public function set_row($row) {
+		$this->set('TKT_row', $row);
 	}
 
 
@@ -1208,7 +1208,7 @@ 
      * @throws \EE_Error
      */
 	public function deleted() {
-		return $this->get( 'TKT_deleted' );
+		return $this->get('TKT_deleted');
 	}
 
 
@@ -1220,8 +1220,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_deleted( $deleted ) {
-		$this->set( 'TKT_deleted', $deleted );
+	public function set_deleted($deleted) {
+		$this->set('TKT_deleted', $deleted);
 	}
 
 
@@ -1233,7 +1233,7 @@ 
      * @throws \EE_Error
      */
 	public function parent_ID() {
-		return $this->get( 'TKT_parent' );
+		return $this->get('TKT_parent');
 	}
 
 
@@ -1245,8 +1245,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_parent_ID( $parent ) {
-		$this->set( 'TKT_parent', $parent );
+	public function set_parent_ID($parent) {
+		$this->set('TKT_parent', $parent);
 	}
 
 
@@ -1259,10 +1259,10 @@ 
      */
 	public function name_and_info() {
 		$times = array();
-		foreach ( $this->datetimes() as $datetime ) {
+		foreach ($this->datetimes() as $datetime) {
 			$times[] = $datetime->start_date_and_time();
 		}
-		return $this->name() . ' @ ' . implode( ', ', $times ) . ' for ' . $this->pretty_price();
+		return $this->name().' @ '.implode(', ', $times).' for '.$this->pretty_price();
 	}
 
 
@@ -1274,7 +1274,7 @@ 
      * @throws \EE_Error
      */
 	public function name() {
-		return $this->get( 'TKT_name' );
+		return $this->get('TKT_name');
 	}
 
 
@@ -1286,7 +1286,7 @@ 
      * @throws \EE_Error
      */
 	public function price() {
-		return $this->get( 'TKT_price' );
+		return $this->get('TKT_price');
 	}
 
 
@@ -1298,8 +1298,8 @@ 
      * @return EE_Registration[]|EE_Base_Class[]
      * @throws \EE_Error
      */
-	public function registrations( $query_params = array() ) {
-		return $this->get_many_related( 'Registration', $query_params );
+	public function registrations($query_params = array()) {
+		return $this->get_many_related('Registration', $query_params);
 	}
 
 
@@ -1338,7 +1338,7 @@ 
 	 * @param array $query_params like EEM_Base::get_all's
 	 * @return int
 	 */
-	public function count_registrations( $query_params = array() ) {
+	public function count_registrations($query_params = array()) {
 		return $this->count_related('Registration', $query_params);
 	}
 
@@ -1366,23 +1366,23 @@ 
 	public function get_related_event() {
 		//get one datetime to use for getting the event
 		$datetime = $this->first_datetime();
-		if ( ! $datetime instanceof \EE_Datetime ) {
+		if ( ! $datetime instanceof \EE_Datetime) {
 			throw new UnexpectedEntityException(
 				$datetime,
                 'EE_Datetime',
 				sprintf(
-					__( 'The ticket (%s) is not associated with any valid datetimes.', 'event_espresso'),
+					__('The ticket (%s) is not associated with any valid datetimes.', 'event_espresso'),
 					$this->name()
 				)
 			);
 		}
 		$event = $datetime->event();
-		if ( ! $event instanceof \EE_Event ) {
+		if ( ! $event instanceof \EE_Event) {
 			throw new UnexpectedEntityException(
 				$event,
                 'EE_Event',
 				sprintf(
-					__( 'The ticket (%s) is not associated with a valid event.', 'event_espresso'),
+					__('The ticket (%s) is not associated with a valid event.', 'event_espresso'),
 					$this->name()
 				)
 			);

core/EE_System.core.php

Spacing +26 added lines, -26 removed lines

@@ -132,7 +132,7 @@ 
         EE_Maintenance_Mode $maintenance_mode = null
     ) {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_System) {
+        if ( ! self::$_instance instanceof EE_System) {
             self::$_instance = new self($registry, $loader, $capabilities, $request, $maintenance_mode);
         }
         return self::$_instance;
@@ -298,7 +298,7 @@ 
     {
         // set autoloaders for all of the classes implementing EEI_Plugin_API
         // which provide helpers for EE plugin authors to more easily register certain components with EE.
-        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
+        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES.'plugin_api');
     }
 
 
@@ -317,14 +317,14 @@ 
         $load_callback,
         $plugin_file_constant
     ) {
-        if (! defined($version_constant)) {
+        if ( ! defined($version_constant)) {
             return;
         }
         $addon_version = constant($version_constant);
         if ($addon_version && version_compare($addon_version, $min_version_required, '<')) {
             remove_action('AHEE__EE_System__load_espresso_addons', $load_callback);
-            if (! function_exists('deactivate_plugins')) {
-                require_once ABSPATH . 'wp-admin/includes/plugin.php';
+            if ( ! function_exists('deactivate_plugins')) {
+                require_once ABSPATH.'wp-admin/includes/plugin.php';
             }
             deactivate_plugins(plugin_basename(constant($plugin_file_constant)));
             unset($_GET['activate'], $_REQUEST['activate'], $_GET['activate-multi'], $_REQUEST['activate-multi']);
@@ -337,7 +337,7 @@ 
                     $addon_name,
                     $min_version_required
                 ),
-                __FILE__, __FUNCTION__ . "({$addon_name})", __LINE__
+                __FILE__, __FUNCTION__."({$addon_name})", __LINE__
             );
             EE_Error::get_notices(false, true);
         }
@@ -389,7 +389,7 @@ 
                 && in_array($_GET['action'], array('activate', 'activate-selected'), true)
             )
         ) {
-            include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php';
+            include_once EE_THIRD_PARTY.'wp-api-basic-auth'.DS.'basic-auth.php';
         }
         do_action('AHEE__EE_System__load_espresso_addons__complete');
     }
@@ -497,11 +497,11 @@ 
     private function fix_espresso_db_upgrade_option($espresso_db_update = null)
     {
         do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
-        if (! $espresso_db_update) {
+        if ( ! $espresso_db_update) {
             $espresso_db_update = get_option('espresso_db_update');
         }
         // check that option is an array
-        if (! is_array($espresso_db_update)) {
+        if ( ! is_array($espresso_db_update)) {
             // if option is FALSE, then it never existed
             if ($espresso_db_update === false) {
                 // make $espresso_db_update an array and save option with autoload OFF
@@ -606,7 +606,7 @@ 
      */
     public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
     {
-        if (! $version_history) {
+        if ( ! $version_history) {
             $version_history = $this->fix_espresso_db_upgrade_option($version_history);
         }
         if ($current_version_to_add === null) {
@@ -704,7 +704,7 @@ 
         if ($activation_history_for_addon) {
             //it exists, so this isn't a completely new install
             //check if this version already in that list of previously installed versions
-            if (! isset($activation_history_for_addon[$version_to_upgrade_to])) {
+            if ( ! isset($activation_history_for_addon[$version_to_upgrade_to])) {
                 //it a version we haven't seen before
                 if ($version_is_higher === 1) {
                     $req_type = EE_System::req_type_upgrade;
@@ -784,7 +784,7 @@ 
             foreach ($activation_history as $version => $times_activated) {
                 //check there is a record of when this version was activated. Otherwise,
                 //mark it as unknown
-                if (! $times_activated) {
+                if ( ! $times_activated) {
                     $times_activated = array('unknown-date');
                 }
                 if (is_string($times_activated)) {
@@ -884,7 +884,7 @@ 
     private function _parse_model_names()
     {
         //get all the files in the EE_MODELS folder that end in .model.php
-        $models = glob(EE_MODELS . '*.model.php');
+        $models = glob(EE_MODELS.'*.model.php');
         $model_names = array();
         $non_abstract_db_models = array();
         foreach ($models as $model) {
@@ -914,8 +914,8 @@ 
      */
     private function _maybe_brew_regular()
     {
-        if ((! defined('EE_DECAF') || EE_DECAF !== true) && is_readable(EE_CAFF_PATH . 'brewing_regular.php')) {
-            require_once EE_CAFF_PATH . 'brewing_regular.php';
+        if (( ! defined('EE_DECAF') || EE_DECAF !== true) && is_readable(EE_CAFF_PATH.'brewing_regular.php')) {
+            require_once EE_CAFF_PATH.'brewing_regular.php';
         }
     }
 
@@ -966,17 +966,17 @@ 
         $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook(
             'AHEE__EE_System__register_shortcodes_modules_and_addons'
         );
-        if (! empty($class_names)) {
+        if ( ! empty($class_names)) {
             $msg = __(
                 'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
                 'event_espresso'
             );
             $msg .= '<ul>';
             foreach ($class_names as $class_name) {
-                $msg .= '<li><b>Event Espresso - ' . str_replace(
+                $msg .= '<li><b>Event Espresso - '.str_replace(
                         array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '',
                         $class_name
-                    ) . '</b></li>';
+                    ).'</b></li>';
             }
             $msg .= '</ul>';
             $msg .= __(
@@ -1047,7 +1047,7 @@ 
     private function _deactivate_incompatible_addons()
     {
         $incompatible_addons = get_option('ee_incompatible_addons', array());
-        if (! empty($incompatible_addons)) {
+        if ( ! empty($incompatible_addons)) {
             $active_plugins = get_option('active_plugins', array());
             foreach ($active_plugins as $active_plugin) {
                 foreach ($incompatible_addons as $incompatible_addon) {
@@ -1108,10 +1108,10 @@ 
     {
         do_action('AHEE__EE_System__load_controllers__start');
         // let's get it started
-        if (! is_admin() && ! $this->maintenance_mode->level()) {
+        if ( ! is_admin() && ! $this->maintenance_mode->level()) {
             do_action('AHEE__EE_System__load_controllers__load_front_controllers');
             $this->loader->getShared('EE_Front_Controller');
-        } else if (! EE_FRONT_AJAX) {
+        } else if ( ! EE_FRONT_AJAX) {
             do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
             $this->loader->getShared('EE_Admin');
         }
@@ -1132,8 +1132,8 @@ 
         $this->loader->getShared('EE_Session');
         do_action('AHEE__EE_System__core_loaded_and_ready');
         // load_espresso_template_tags
-        if (is_readable(EE_PUBLIC . 'template_tags.php')) {
-            require_once(EE_PUBLIC . 'template_tags.php');
+        if (is_readable(EE_PUBLIC.'template_tags.php')) {
+            require_once(EE_PUBLIC.'template_tags.php');
         }
         do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
         $this->loader->getShared('EventEspresso\core\services\assets\Registry');
@@ -1195,13 +1195,13 @@ 
     public static function do_not_cache()
     {
         // set no cache constants
-        if (! defined('DONOTCACHEPAGE')) {
+        if ( ! defined('DONOTCACHEPAGE')) {
             define('DONOTCACHEPAGE', true);
         }
-        if (! defined('DONOTCACHCEOBJECT')) {
+        if ( ! defined('DONOTCACHCEOBJECT')) {
             define('DONOTCACHCEOBJECT', true);
         }
-        if (! defined('DONOTCACHEDB')) {
+        if ( ! defined('DONOTCACHEDB')) {
             define('DONOTCACHEDB', true);
         }
         // add no cache headers

Indentation +1236 added lines, -1236 removed lines

@@ -21,1242 +21,1242 @@
 {
 
 
-    /**
-     * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation.
-     * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc
-     */
-    const req_type_normal = 0;
-
-    /**
-     * Indicates this is a brand new installation of EE so we should install
-     * tables and default data etc
-     */
-    const req_type_new_activation = 1;
-
-    /**
-     * we've detected that EE has been reactivated (or EE was activated during maintenance mode,
-     * and we just exited maintenance mode). We MUST check the database is setup properly
-     * and that default data is setup too
-     */
-    const req_type_reactivation = 2;
-
-    /**
-     * indicates that EE has been upgraded since its previous request.
-     * We may have data migration scripts to call and will want to trigger maintenance mode
-     */
-    const req_type_upgrade = 3;
-
-    /**
-     * TODO  will detect that EE has been DOWNGRADED. We probably don't want to run in this case...
-     */
-    const req_type_downgrade = 4;
-
-    /**
-     * @deprecated since version 4.6.0.dev.006
-     * Now whenever a new_activation is detected the request type is still just
-     * new_activation (same for reactivation, upgrade, downgrade etc), but if we'r ein maintenance mode
-     * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required
-     * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode.
-     * (Specifically, when the migration manager indicates migrations are finished
-     * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called)
-     */
-    const req_type_activation_but_not_installed = 5;
-
-    /**
-     * option prefix for recording the activation history (like core's "espresso_db_update") of addons
-     */
-    const addon_activation_history_option_prefix = 'ee_addon_activation_history_';
-
-
-    /**
-     * @var EE_System $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var EE_Registry $registry
-     */
-    private $registry;
-
-    /**
-     * @var LoaderInterface $loader
-     */
-    private $loader;
-
-    /**
-     * @var EE_Capabilities $capabilities
-     */
-    private $capabilities;
-
-    /**
-     * @var EE_Request $request
-     */
-    private $request;
-
-    /**
-     * @var EE_Maintenance_Mode $maintenance_mode
-     */
-    private $maintenance_mode;
-
-    /**
-     * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*.
-     * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request.
-     *
-     * @var int $_req_type
-     */
-    private $_req_type;
-
-    /**
-     * Whether or not there was a non-micro version change in EE core version during this request
-     *
-     * @var boolean $_major_version_change
-     */
-    private $_major_version_change = false;
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param EE_Registry|null         $registry
-     * @param LoaderInterface|null     $loader
-     * @param EE_Capabilities|null     $capabilities
-     * @param EE_Request|null          $request
-     * @param EE_Maintenance_Mode|null $maintenance_mode
-     * @return EE_System
-     */
-    public static function instance(
-        EE_Registry $registry = null,
-        LoaderInterface $loader = null,
-        EE_Capabilities $capabilities = null,
-        EE_Request $request = null,
-        EE_Maintenance_Mode $maintenance_mode = null
-    ) {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_System) {
-            self::$_instance = new self($registry, $loader, $capabilities, $request, $maintenance_mode);
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     * resets the instance and returns it
-     *
-     * @return EE_System
-     */
-    public static function reset()
-    {
-        self::$_instance->_req_type = null;
-        //make sure none of the old hooks are left hanging around
-        remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
-        //we need to reset the migration manager in order for it to detect DMSs properly
-        EE_Data_Migration_Manager::reset();
-        self::instance()->detect_activations_or_upgrades();
-        self::instance()->perform_activations_upgrades_and_migrations();
-        return self::instance();
-    }
-
-
-
-    /**
-     * sets hooks for running rest of system
-     * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
-     * starting EE Addons from any other point may lead to problems
-     *
-     * @param EE_Registry         $registry
-     * @param LoaderInterface     $loader
-     * @param EE_Capabilities     $capabilities
-     * @param EE_Request          $request
-     * @param EE_Maintenance_Mode $maintenance_mode
-     */
-    private function __construct(
-        EE_Registry $registry,
-        LoaderInterface $loader,
-        EE_Capabilities $capabilities,
-        EE_Request $request,
-        EE_Maintenance_Mode $maintenance_mode
-    ) {
-        $this->registry = $registry;
-        $this->loader = $loader;
-        $this->capabilities = $capabilities;
-        $this->request = $request;
-        $this->maintenance_mode = $maintenance_mode;
-        do_action('AHEE__EE_System__construct__begin', $this);
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'loadCapabilities'),
-            5
-        );
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'loadCommandBus'),
-            7
-        );
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'loadPluginApi'),
-            9
-        );
-        // allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'load_espresso_addons')
-        );
-        // when an ee addon is activated, we want to call the core hook(s) again
-        // because the newly-activated addon didn't get a chance to run at all
-        add_action('activate_plugin', array($this, 'load_espresso_addons'), 1);
-        // detect whether install or upgrade
-        add_action(
-            'AHEE__EE_Bootstrap__detect_activations_or_upgrades',
-            array($this, 'detect_activations_or_upgrades'),
-            3
-        );
-        // load EE_Config, EE_Textdomain, etc
-        add_action(
-            'AHEE__EE_Bootstrap__load_core_configuration',
-            array($this, 'load_core_configuration'),
-            5
-        );
-        // load EE_Config, EE_Textdomain, etc
-        add_action(
-            'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
-            array($this, 'register_shortcodes_modules_and_widgets'),
-            7
-        );
-        // you wanna get going? I wanna get going... let's get going!
-        add_action(
-            'AHEE__EE_Bootstrap__brew_espresso',
-            array($this, 'brew_espresso'),
-            9
-        );
-        //other housekeeping
-        //exclude EE critical pages from wp_list_pages
-        add_filter(
-            'wp_list_pages_excludes',
-            array($this, 'remove_pages_from_wp_list_pages'),
-            10
-        );
-        // ALL EE Addons should use the following hook point to attach their initial setup too
-        // it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
-        do_action('AHEE__EE_System__construct__complete', $this);
-    }
-
-
-
-    /**
-     * load and setup EE_Capabilities
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function loadCapabilities()
-    {
-        $this->loader->getShared('EE_Capabilities');
-        add_action(
-            'AHEE__EE_Capabilities__init_caps__before_initialization',
-            function() {
-                LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
-            }
-        );
-    }
-
-
-
-    /**
-     * create and cache the CommandBus, and also add middleware
-     * The CapChecker middleware requires the use of EE_Capabilities
-     * which is why we need to load the CommandBus after Caps are set up
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function loadCommandBus()
-    {
-        $this->loader->getShared(
-            'CommandBusInterface',
-            array(
-                null,
-                apply_filters(
-                    'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware',
-                    array(
-                        $this->loader->getShared('EventEspresso\core\services\commands\middleware\CapChecker'),
-                        $this->loader->getShared('EventEspresso\core\services\commands\middleware\AddActionHook'),
-                    )
-                ),
-            )
-        );
-    }
-
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    public function loadPluginApi()
-    {
-        // set autoloaders for all of the classes implementing EEI_Plugin_API
-        // which provide helpers for EE plugin authors to more easily register certain components with EE.
-        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @param string $version_constant
-     * @param string $min_version_required
-     * @param string $load_callback
-     * @param string $plugin_file_constant
-     * @return void
-     */
-    private function deactivateIncompatibleAddon(
-        $addon_name,
-        $version_constant,
-        $min_version_required,
-        $load_callback,
-        $plugin_file_constant
-    ) {
-        if (! defined($version_constant)) {
-            return;
-        }
-        $addon_version = constant($version_constant);
-        if ($addon_version && version_compare($addon_version, $min_version_required, '<')) {
-            remove_action('AHEE__EE_System__load_espresso_addons', $load_callback);
-            if (! function_exists('deactivate_plugins')) {
-                require_once ABSPATH . 'wp-admin/includes/plugin.php';
-            }
-            deactivate_plugins(plugin_basename(constant($plugin_file_constant)));
-            unset($_GET['activate'], $_REQUEST['activate'], $_GET['activate-multi'], $_REQUEST['activate-multi']);
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'We\'re sorry, but the Event Espresso %1$s addon was deactivated because version %2$s or higher is required with this version of Event Espresso core.',
-                        'event_espresso'
-                    ),
-                    $addon_name,
-                    $min_version_required
-                ),
-                __FILE__, __FUNCTION__ . "({$addon_name})", __LINE__
-            );
-            EE_Error::get_notices(false, true);
-        }
-    }
-
-
-    /**
-     * load_espresso_addons
-     * allow addons to load first so that they can set hooks for running DMS's, etc
-     * this is hooked into both:
-     *    'AHEE__EE_Bootstrap__load_core_configuration'
-     *        which runs during the WP 'plugins_loaded' action at priority 5
-     *    and the WP 'activate_plugin' hook point
-     *
-     * @access public
-     * @return void
-     */
-    public function load_espresso_addons()
-    {
-        $this->deactivateIncompatibleAddon(
-            'Wait Lists',
-            'EE_WAIT_LISTS_VERSION',
-            '1.0.0.beta.074',
-            'load_espresso_wait_lists',
-            'EE_WAIT_LISTS_PLUGIN_FILE'
-        );
-        $this->deactivateIncompatibleAddon(
-            'Automated Upcoming Event Notifications',
-            'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_VERSION',
-            '1.0.0.beta.091',
-            'load_espresso_automated_upcoming_event_notification',
-            'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_PLUGIN_FILE'
-        );
-        do_action('AHEE__EE_System__load_espresso_addons');
-        //if the WP API basic auth plugin isn't already loaded, load it now.
-        //We want it for mobile apps. Just include the entire plugin
-        //also, don't load the basic auth when a plugin is getting activated, because
-        //it could be the basic auth plugin, and it doesn't check if its methods are already defined
-        //and causes a fatal error
-        if (
-            ! (
-                isset($_GET['activate'])
-                && $_GET['activate'] === 'true'
-            )
-            && ! function_exists('json_basic_auth_handler')
-            && ! function_exists('json_basic_auth_error')
-            && ! (
-                isset($_GET['action'])
-                && in_array($_GET['action'], array('activate', 'activate-selected'), true)
-            )
-        ) {
-            include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php';
-        }
-        do_action('AHEE__EE_System__load_espresso_addons__complete');
-    }
-
-
-
-    /**
-     * detect_activations_or_upgrades
-     * Checks for activation or upgrade of core first;
-     * then also checks if any registered addons have been activated or upgraded
-     * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
-     * which runs during the WP 'plugins_loaded' action at priority 3
-     *
-     * @access public
-     * @return void
-     */
-    public function detect_activations_or_upgrades()
-    {
-        //first off: let's make sure to handle core
-        $this->detect_if_activation_or_upgrade();
-        foreach ($this->registry->addons as $addon) {
-            if ($addon instanceof EE_Addon) {
-                //detect teh request type for that addon
-                $addon->detect_activation_or_upgrade();
-            }
-        }
-    }
-
-
-
-    /**
-     * detect_if_activation_or_upgrade
-     * Takes care of detecting whether this is a brand new install or code upgrade,
-     * and either setting up the DB or setting up maintenance mode etc.
-     *
-     * @access public
-     * @return void
-     */
-    public function detect_if_activation_or_upgrade()
-    {
-        do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
-        // check if db has been updated, or if its a brand-new installation
-        $espresso_db_update = $this->fix_espresso_db_upgrade_option();
-        $request_type = $this->detect_req_type($espresso_db_update);
-        //EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ );
-        switch ($request_type) {
-            case EE_System::req_type_new_activation:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_reactivation:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_upgrade:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
-                //migrations may be required now that we've upgraded
-                $this->maintenance_mode->set_maintenance_mode_if_db_old();
-                $this->_handle_core_version_change($espresso_db_update);
-                //				echo "done upgrade";die;
-                break;
-            case EE_System::req_type_downgrade:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
-                //its possible migrations are no longer required
-                $this->maintenance_mode->set_maintenance_mode_if_db_old();
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_normal:
-            default:
-                //				$this->_maybe_redirect_to_ee_about();
-                break;
-        }
-        do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
-    }
-
-
-
-    /**
-     * Updates the list of installed versions and sets hooks for
-     * initializing the database later during the request
-     *
-     * @param array $espresso_db_update
-     */
-    private function _handle_core_version_change($espresso_db_update)
-    {
-        $this->update_list_of_installed_versions($espresso_db_update);
-        //get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
-        add_action(
-            'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-            array($this, 'initialize_db_if_no_migrations_required')
-        );
-    }
-
-
-
-    /**
-     * standardizes the wp option 'espresso_db_upgrade' which actually stores
-     * information about what versions of EE have been installed and activated,
-     * NOT necessarily the state of the database
-     *
-     * @param mixed $espresso_db_update the value of the WordPress option.
-     *                                            If not supplied, fetches it from the options table
-     * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
-     */
-    private function fix_espresso_db_upgrade_option($espresso_db_update = null)
-    {
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
-        if (! $espresso_db_update) {
-            $espresso_db_update = get_option('espresso_db_update');
-        }
-        // check that option is an array
-        if (! is_array($espresso_db_update)) {
-            // if option is FALSE, then it never existed
-            if ($espresso_db_update === false) {
-                // make $espresso_db_update an array and save option with autoload OFF
-                $espresso_db_update = array();
-                add_option('espresso_db_update', $espresso_db_update, '', 'no');
-            } else {
-                // option is NOT FALSE but also is NOT an array, so make it an array and save it
-                $espresso_db_update = array($espresso_db_update => array());
-                update_option('espresso_db_update', $espresso_db_update);
-            }
-        } else {
-            $corrected_db_update = array();
-            //if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
-            foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
-                if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
-                    //the key is an int, and the value IS NOT an array
-                    //so it must be numerically-indexed, where values are versions installed...
-                    //fix it!
-                    $version_string = $should_be_array;
-                    $corrected_db_update[$version_string] = array('unknown-date');
-                } else {
-                    //ok it checks out
-                    $corrected_db_update[$should_be_version_string] = $should_be_array;
-                }
-            }
-            $espresso_db_update = $corrected_db_update;
-            update_option('espresso_db_update', $espresso_db_update);
-        }
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
-        return $espresso_db_update;
-    }
-
-
-
-    /**
-     * Does the traditional work of setting up the plugin's database and adding default data.
-     * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
-     * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
-     * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
-     * so that it will be done when migrations are finished
-     *
-     * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
-     * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
-     *                                       This is a resource-intensive job
-     *                                       so we prefer to only do it when necessary
-     * @return void
-     * @throws EE_Error
-     */
-    public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
-    {
-        $request_type = $this->detect_req_type();
-        //only initialize system if we're not in maintenance mode.
-        if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
-            update_option('ee_flush_rewrite_rules', true);
-            if ($verify_schema) {
-                EEH_Activation::initialize_db_and_folders();
-            }
-            EEH_Activation::initialize_db_content();
-            EEH_Activation::system_initialization();
-            if ($initialize_addons_too) {
-                $this->initialize_addons();
-            }
-        } else {
-            EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
-        }
-        if ($request_type === EE_System::req_type_new_activation
-            || $request_type === EE_System::req_type_reactivation
-            || (
-                $request_type === EE_System::req_type_upgrade
-                && $this->is_major_version_change()
-            )
-        ) {
-            add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9);
-        }
-    }
-
-
-
-    /**
-     * Initializes the db for all registered addons
-     *
-     * @throws EE_Error
-     */
-    public function initialize_addons()
-    {
-        //foreach registered addon, make sure its db is up-to-date too
-        foreach ($this->registry->addons as $addon) {
-            if ($addon instanceof EE_Addon) {
-                $addon->initialize_db_if_no_migrations_required();
-            }
-        }
-    }
-
-
-
-    /**
-     * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
-     *
-     * @param    array  $version_history
-     * @param    string $current_version_to_add version to be added to the version history
-     * @return    boolean success as to whether or not this option was changed
-     */
-    public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
-    {
-        if (! $version_history) {
-            $version_history = $this->fix_espresso_db_upgrade_option($version_history);
-        }
-        if ($current_version_to_add === null) {
-            $current_version_to_add = espresso_version();
-        }
-        $version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time());
-        // re-save
-        return update_option('espresso_db_update', $version_history);
-    }
-
-
-
-    /**
-     * Detects if the current version indicated in the has existed in the list of
-     * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
-     *
-     * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
-     *                                  If not supplied, fetches it from the options table.
-     *                                  Also, caches its result so later parts of the code can also know whether
-     *                                  there's been an update or not. This way we can add the current version to
-     *                                  espresso_db_update, but still know if this is a new install or not
-     * @return int one of the constants on EE_System::req_type_
-     */
-    public function detect_req_type($espresso_db_update = null)
-    {
-        if ($this->_req_type === null) {
-            $espresso_db_update = ! empty($espresso_db_update)
-                ? $espresso_db_update
-                : $this->fix_espresso_db_upgrade_option();
-            $this->_req_type = EE_System::detect_req_type_given_activation_history(
-                $espresso_db_update,
-                'ee_espresso_activation', espresso_version()
-            );
-            $this->_major_version_change = $this->_detect_major_version_change($espresso_db_update);
-        }
-        return $this->_req_type;
-    }
-
-
-
-    /**
-     * Returns whether or not there was a non-micro version change (ie, change in either
-     * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000,
-     * but not 4.9.0.rc.0001 to 4.9.1.rc.0001
-     *
-     * @param $activation_history
-     * @return bool
-     */
-    private function _detect_major_version_change($activation_history)
-    {
-        $previous_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history);
-        $previous_version_parts = explode('.', $previous_version);
-        $current_version_parts = explode('.', espresso_version());
-        return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1])
-               && ($previous_version_parts[0] !== $current_version_parts[0]
-                   || $previous_version_parts[1] !== $current_version_parts[1]
-               );
-    }
-
-
-
-    /**
-     * Returns true if either the major or minor version of EE changed during this request.
-     * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001
-     *
-     * @return bool
-     */
-    public function is_major_version_change()
-    {
-        return $this->_major_version_change;
-    }
-
-
-
-    /**
-     * Determines the request type for any ee addon, given three piece of info: the current array of activation
-     * histories (for core that' 'espresso_db_update' wp option); the name of the WordPress option which is temporarily
-     * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
-     * just activated to (for core that will always be espresso_version())
-     *
-     * @param array  $activation_history_for_addon     the option's value which stores the activation history for this
-     *                                                 ee plugin. for core that's 'espresso_db_update'
-     * @param string $activation_indicator_option_name the name of the WordPress option that is temporarily set to
-     *                                                 indicate that this plugin was just activated
-     * @param string $version_to_upgrade_to            the version that was just upgraded to (for core that will be
-     *                                                 espresso_version())
-     * @return int one of the constants on EE_System::req_type_*
-     */
-    public static function detect_req_type_given_activation_history(
-        $activation_history_for_addon,
-        $activation_indicator_option_name,
-        $version_to_upgrade_to
-    ) {
-        $version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to);
-        if ($activation_history_for_addon) {
-            //it exists, so this isn't a completely new install
-            //check if this version already in that list of previously installed versions
-            if (! isset($activation_history_for_addon[$version_to_upgrade_to])) {
-                //it a version we haven't seen before
-                if ($version_is_higher === 1) {
-                    $req_type = EE_System::req_type_upgrade;
-                } else {
-                    $req_type = EE_System::req_type_downgrade;
-                }
-                delete_option($activation_indicator_option_name);
-            } else {
-                // its not an update. maybe a reactivation?
-                if (get_option($activation_indicator_option_name, false)) {
-                    if ($version_is_higher === -1) {
-                        $req_type = EE_System::req_type_downgrade;
-                    } else if ($version_is_higher === 0) {
-                        //we've seen this version before, but it's an activation. must be a reactivation
-                        $req_type = EE_System::req_type_reactivation;
-                    } else {//$version_is_higher === 1
-                        $req_type = EE_System::req_type_upgrade;
-                    }
-                    delete_option($activation_indicator_option_name);
-                } else {
-                    //we've seen this version before and the activation indicate doesn't show it was just activated
-                    if ($version_is_higher === -1) {
-                        $req_type = EE_System::req_type_downgrade;
-                    } else if ($version_is_higher === 0) {
-                        //we've seen this version before and it's not an activation. its normal request
-                        $req_type = EE_System::req_type_normal;
-                    } else {//$version_is_higher === 1
-                        $req_type = EE_System::req_type_upgrade;
-                    }
-                }
-            }
-        } else {
-            //brand new install
-            $req_type = EE_System::req_type_new_activation;
-            delete_option($activation_indicator_option_name);
-        }
-        return $req_type;
-    }
-
-
-
-    /**
-     * Detects if the $version_to_upgrade_to is higher than the most recent version in
-     * the $activation_history_for_addon
-     *
-     * @param array  $activation_history_for_addon (keys are versions, values are arrays of times activated,
-     *                                             sometimes containing 'unknown-date'
-     * @param string $version_to_upgrade_to        (current version)
-     * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
-     *                                             ie, -1 if $version_to_upgrade_to is LOWER (downgrade);
-     *                                             0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
-     *                                             1 if $version_to_upgrade_to is HIGHER (upgrade) ;
-     */
-    private static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to)
-    {
-        //find the most recently-activated version
-        $most_recently_active_version =
-            EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon);
-        return version_compare($version_to_upgrade_to, $most_recently_active_version);
-    }
-
-
-
-    /**
-     * Gets the most recently active version listed in the activation history,
-     * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
-     *
-     * @param array $activation_history  (keys are versions, values are arrays of times activated,
-     *                                   sometimes containing 'unknown-date'
-     * @return string
-     */
-    private static function _get_most_recently_active_version_from_activation_history($activation_history)
-    {
-        $most_recently_active_version_activation = '1970-01-01 00:00:00';
-        $most_recently_active_version = '0.0.0.dev.000';
-        if (is_array($activation_history)) {
-            foreach ($activation_history as $version => $times_activated) {
-                //check there is a record of when this version was activated. Otherwise,
-                //mark it as unknown
-                if (! $times_activated) {
-                    $times_activated = array('unknown-date');
-                }
-                if (is_string($times_activated)) {
-                    $times_activated = array($times_activated);
-                }
-                foreach ($times_activated as $an_activation) {
-                    if ($an_activation !== 'unknown-date' && $an_activation > $most_recently_active_version_activation) {
-                        $most_recently_active_version = $version;
-                        $most_recently_active_version_activation = $an_activation === 'unknown-date'
-                            ? '1970-01-01 00:00:00'
-                            : $an_activation;
-                    }
-                }
-            }
-        }
-        return $most_recently_active_version;
-    }
-
-
-
-    /**
-     * This redirects to the about EE page after activation
-     *
-     * @return void
-     */
-    public function redirect_to_about_ee()
-    {
-        $notices = EE_Error::get_notices(false);
-        //if current user is an admin and it's not an ajax or rest request
-        if (
-            ! (defined('DOING_AJAX') && DOING_AJAX)
-            && ! (defined('REST_REQUEST') && REST_REQUEST)
-            && ! isset($notices['errors'])
-            && apply_filters(
-                'FHEE__EE_System__redirect_to_about_ee__do_redirect',
-                $this->capabilities->current_user_can('manage_options', 'espresso_about_default')
-            )
-        ) {
-            $query_params = array('page' => 'espresso_about');
-            if (EE_System::instance()->detect_req_type() === EE_System::req_type_new_activation) {
-                $query_params['new_activation'] = true;
-            }
-            if (EE_System::instance()->detect_req_type() === EE_System::req_type_reactivation) {
-                $query_params['reactivation'] = true;
-            }
-            $url = add_query_arg($query_params, admin_url('admin.php'));
-            wp_safe_redirect($url);
-            exit();
-        }
-    }
-
-
-
-    /**
-     * load_core_configuration
-     * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
-     * which runs during the WP 'plugins_loaded' action at priority 5
-     *
-     * @return void
-     * @throws ReflectionException
-     */
-    public function load_core_configuration()
-    {
-        do_action('AHEE__EE_System__load_core_configuration__begin', $this);
-        $this->loader->getShared('EE_Load_Textdomain');
-        //load textdomain
-        EE_Load_Textdomain::load_textdomain();
-        // load and setup EE_Config and EE_Network_Config
-        $config = $this->loader->getShared('EE_Config');
-        $this->loader->getShared('EE_Network_Config');
-        // setup autoloaders
-        // enable logging?
-        if ($config->admin->use_full_logging) {
-            $this->loader->getShared('EE_Log');
-        }
-        // check for activation errors
-        $activation_errors = get_option('ee_plugin_activation_errors', false);
-        if ($activation_errors) {
-            EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
-            update_option('ee_plugin_activation_errors', false);
-        }
-        // get model names
-        $this->_parse_model_names();
-        //load caf stuff a chance to play during the activation process too.
-        $this->_maybe_brew_regular();
-        do_action('AHEE__EE_System__load_core_configuration__complete', $this);
-    }
-
-
-
-    /**
-     * cycles through all of the models/*.model.php files, and assembles an array of model names
-     *
-     * @return void
-     * @throws ReflectionException
-     */
-    private function _parse_model_names()
-    {
-        //get all the files in the EE_MODELS folder that end in .model.php
-        $models = glob(EE_MODELS . '*.model.php');
-        $model_names = array();
-        $non_abstract_db_models = array();
-        foreach ($models as $model) {
-            // get model classname
-            $classname = EEH_File::get_classname_from_filepath_with_standard_filename($model);
-            $short_name = str_replace('EEM_', '', $classname);
-            $reflectionClass = new ReflectionClass($classname);
-            if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
-                $non_abstract_db_models[$short_name] = $classname;
-            }
-            $model_names[$short_name] = $classname;
-        }
-        $this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
-        $this->registry->non_abstract_db_models = apply_filters(
-            'FHEE__EE_System__parse_implemented_model_names',
-            $non_abstract_db_models
-        );
-    }
-
-
-
-    /**
-     * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
-     * that need to be setup before our EE_System launches.
-     *
-     * @return void
-     */
-    private function _maybe_brew_regular()
-    {
-        if ((! defined('EE_DECAF') || EE_DECAF !== true) && is_readable(EE_CAFF_PATH . 'brewing_regular.php')) {
-            require_once EE_CAFF_PATH . 'brewing_regular.php';
-        }
-    }
-
-
-
-    /**
-     * register_shortcodes_modules_and_widgets
-     * generate lists of shortcodes and modules, then verify paths and classes
-     * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
-     * which runs during the WP 'plugins_loaded' action at priority 7
-     *
-     * @access public
-     * @return void
-     * @throws Exception
-     */
-    public function register_shortcodes_modules_and_widgets()
-    {
-        try {
-            // load, register, and add shortcodes the new way
-            $this->loader->getShared(
-                'EventEspresso\core\services\shortcodes\ShortcodesManager',
-                array(
-                    // and the old way, but we'll put it under control of the new system
-                    EE_Config::getLegacyShortcodesManager()
-                )
-            );
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-        do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
-        // check for addons using old hook point
-        if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
-            $this->_incompatible_addon_error();
-        }
-    }
-
-
-
-    /**
-     * _incompatible_addon_error
-     *
-     * @access public
-     * @return void
-     */
-    private function _incompatible_addon_error()
-    {
-        // get array of classes hooking into here
-        $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook(
-            'AHEE__EE_System__register_shortcodes_modules_and_addons'
-        );
-        if (! empty($class_names)) {
-            $msg = __(
-                'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
-                'event_espresso'
-            );
-            $msg .= '<ul>';
-            foreach ($class_names as $class_name) {
-                $msg .= '<li><b>Event Espresso - ' . str_replace(
-                        array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '',
-                        $class_name
-                    ) . '</b></li>';
-            }
-            $msg .= '</ul>';
-            $msg .= __(
-                'Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
-                'event_espresso'
-            );
-            // save list of incompatible addons to wp-options for later use
-            add_option('ee_incompatible_addons', $class_names, '', 'no');
-            if (is_admin()) {
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        }
-    }
-
-
-
-    /**
-     * brew_espresso
-     * begins the process of setting hooks for initializing EE in the correct order
-     * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hook point
-     * which runs during the WP 'plugins_loaded' action at priority 9
-     *
-     * @return void
-     */
-    public function brew_espresso()
-    {
-        do_action('AHEE__EE_System__brew_espresso__begin', $this);
-        // load some final core systems
-        add_action('init', array($this, 'set_hooks_for_core'), 1);
-        add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3);
-        add_action('init', array($this, 'load_CPTs_and_session'), 5);
-        add_action('init', array($this, 'load_controllers'), 7);
-        add_action('init', array($this, 'core_loaded_and_ready'), 9);
-        add_action('init', array($this, 'initialize'), 10);
-        add_action('init', array($this, 'initialize_last'), 100);
-        if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) {
-            // pew pew pew
-            $this->loader->getShared('EE_PUE');
-            do_action('AHEE__EE_System__brew_espresso__after_pue_init');
-        }
-        do_action('AHEE__EE_System__brew_espresso__complete', $this);
-    }
-
-
-
-    /**
-     *    set_hooks_for_core
-     *
-     * @access public
-     * @return    void
-     * @throws EE_Error
-     */
-    public function set_hooks_for_core()
-    {
-        $this->_deactivate_incompatible_addons();
-        do_action('AHEE__EE_System__set_hooks_for_core');
-        //caps need to be initialized on every request so that capability maps are set.
-        //@see https://events.codebasehq.com/projects/event-espresso/tickets/8674
-        $this->registry->CAP->init_caps();
-    }
-
-
-
-    /**
-     * Using the information gathered in EE_System::_incompatible_addon_error,
-     * deactivates any addons considered incompatible with the current version of EE
-     */
-    private function _deactivate_incompatible_addons()
-    {
-        $incompatible_addons = get_option('ee_incompatible_addons', array());
-        if (! empty($incompatible_addons)) {
-            $active_plugins = get_option('active_plugins', array());
-            foreach ($active_plugins as $active_plugin) {
-                foreach ($incompatible_addons as $incompatible_addon) {
-                    if (strpos($active_plugin, $incompatible_addon) !== false) {
-                        unset($_GET['activate']);
-                        espresso_deactivate_plugin($active_plugin);
-                    }
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     *    perform_activations_upgrades_and_migrations
-     *
-     * @access public
-     * @return    void
-     */
-    public function perform_activations_upgrades_and_migrations()
-    {
-        //first check if we had previously attempted to setup EE's directories but failed
-        if (EEH_Activation::upload_directories_incomplete()) {
-            EEH_Activation::create_upload_directories();
-        }
-        do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
-    }
-
-
-
-    /**
-     *    load_CPTs_and_session
-     *
-     * @access public
-     * @return    void
-     */
-    public function load_CPTs_and_session()
-    {
-        do_action('AHEE__EE_System__load_CPTs_and_session__start');
-        // register Custom Post Types
-        $this->loader->getShared('EE_Register_CPTs');
-        do_action('AHEE__EE_System__load_CPTs_and_session__complete');
-    }
-
-
-
-    /**
-     * load_controllers
-     * this is the best place to load any additional controllers that needs access to EE core.
-     * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
-     * time
-     *
-     * @access public
-     * @return void
-     */
-    public function load_controllers()
-    {
-        do_action('AHEE__EE_System__load_controllers__start');
-        // let's get it started
-        if (! is_admin() && ! $this->maintenance_mode->level()) {
-            do_action('AHEE__EE_System__load_controllers__load_front_controllers');
-            $this->loader->getShared('EE_Front_Controller');
-        } else if (! EE_FRONT_AJAX) {
-            do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
-            $this->loader->getShared('EE_Admin');
-        }
-        do_action('AHEE__EE_System__load_controllers__complete');
-    }
-
-
-
-    /**
-     * core_loaded_and_ready
-     * all of the basic EE core should be loaded at this point and available regardless of M-Mode
-     *
-     * @access public
-     * @return void
-     */
-    public function core_loaded_and_ready()
-    {
-        $this->loader->getShared('EE_Session');
-        do_action('AHEE__EE_System__core_loaded_and_ready');
-        // load_espresso_template_tags
-        if (is_readable(EE_PUBLIC . 'template_tags.php')) {
-            require_once(EE_PUBLIC . 'template_tags.php');
-        }
-        do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
-        $this->loader->getShared('EventEspresso\core\services\assets\Registry');
-    }
-
-
-
-    /**
-     * initialize
-     * this is the best place to begin initializing client code
-     *
-     * @access public
-     * @return void
-     */
-    public function initialize()
-    {
-        do_action('AHEE__EE_System__initialize');
-    }
-
-
-
-    /**
-     * initialize_last
-     * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to
-     * initialize has done so
-     *
-     * @access public
-     * @return void
-     */
-    public function initialize_last()
-    {
-        do_action('AHEE__EE_System__initialize_last');
-        add_action('admin_bar_init', array($this, 'addEspressoToolbar'));
-    }
-
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    public function addEspressoToolbar()
-    {
-        $this->loader->getShared(
-            'EventEspresso\core\domain\services\admin\AdminToolBar',
-            array($this->registry->CAP)
-        );
-    }
-
-
-
-    /**
-     * do_not_cache
-     * sets no cache headers and defines no cache constants for WP plugins
-     *
-     * @access public
-     * @return void
-     */
-    public static function do_not_cache()
-    {
-        // set no cache constants
-        if (! defined('DONOTCACHEPAGE')) {
-            define('DONOTCACHEPAGE', true);
-        }
-        if (! defined('DONOTCACHCEOBJECT')) {
-            define('DONOTCACHCEOBJECT', true);
-        }
-        if (! defined('DONOTCACHEDB')) {
-            define('DONOTCACHEDB', true);
-        }
-        // add no cache headers
-        add_action('send_headers', array('EE_System', 'nocache_headers'), 10);
-        // plus a little extra for nginx and Google Chrome
-        add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1);
-        // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
-        remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
-    }
-
-
-
-    /**
-     *    extra_nocache_headers
-     *
-     * @access    public
-     * @param $headers
-     * @return    array
-     */
-    public static function extra_nocache_headers($headers)
-    {
-        // for NGINX
-        $headers['X-Accel-Expires'] = 0;
-        // plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
-        $headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
-        return $headers;
-    }
-
-
-
-    /**
-     *    nocache_headers
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function nocache_headers()
-    {
-        nocache_headers();
-    }
-
-
-
-
-    /**
-     * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
-     * never returned with the function.
-     *
-     * @param  array $exclude_array any existing pages being excluded are in this array.
-     * @return array
-     */
-    public function remove_pages_from_wp_list_pages($exclude_array)
-    {
-        return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
-    }
+	/**
+	 * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation.
+	 * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc
+	 */
+	const req_type_normal = 0;
+
+	/**
+	 * Indicates this is a brand new installation of EE so we should install
+	 * tables and default data etc
+	 */
+	const req_type_new_activation = 1;
+
+	/**
+	 * we've detected that EE has been reactivated (or EE was activated during maintenance mode,
+	 * and we just exited maintenance mode). We MUST check the database is setup properly
+	 * and that default data is setup too
+	 */
+	const req_type_reactivation = 2;
+
+	/**
+	 * indicates that EE has been upgraded since its previous request.
+	 * We may have data migration scripts to call and will want to trigger maintenance mode
+	 */
+	const req_type_upgrade = 3;
+
+	/**
+	 * TODO  will detect that EE has been DOWNGRADED. We probably don't want to run in this case...
+	 */
+	const req_type_downgrade = 4;
+
+	/**
+	 * @deprecated since version 4.6.0.dev.006
+	 * Now whenever a new_activation is detected the request type is still just
+	 * new_activation (same for reactivation, upgrade, downgrade etc), but if we'r ein maintenance mode
+	 * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required
+	 * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode.
+	 * (Specifically, when the migration manager indicates migrations are finished
+	 * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called)
+	 */
+	const req_type_activation_but_not_installed = 5;
+
+	/**
+	 * option prefix for recording the activation history (like core's "espresso_db_update") of addons
+	 */
+	const addon_activation_history_option_prefix = 'ee_addon_activation_history_';
+
+
+	/**
+	 * @var EE_System $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var EE_Registry $registry
+	 */
+	private $registry;
+
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	private $loader;
+
+	/**
+	 * @var EE_Capabilities $capabilities
+	 */
+	private $capabilities;
+
+	/**
+	 * @var EE_Request $request
+	 */
+	private $request;
+
+	/**
+	 * @var EE_Maintenance_Mode $maintenance_mode
+	 */
+	private $maintenance_mode;
+
+	/**
+	 * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*.
+	 * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request.
+	 *
+	 * @var int $_req_type
+	 */
+	private $_req_type;
+
+	/**
+	 * Whether or not there was a non-micro version change in EE core version during this request
+	 *
+	 * @var boolean $_major_version_change
+	 */
+	private $_major_version_change = false;
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param EE_Registry|null         $registry
+	 * @param LoaderInterface|null     $loader
+	 * @param EE_Capabilities|null     $capabilities
+	 * @param EE_Request|null          $request
+	 * @param EE_Maintenance_Mode|null $maintenance_mode
+	 * @return EE_System
+	 */
+	public static function instance(
+		EE_Registry $registry = null,
+		LoaderInterface $loader = null,
+		EE_Capabilities $capabilities = null,
+		EE_Request $request = null,
+		EE_Maintenance_Mode $maintenance_mode = null
+	) {
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_System) {
+			self::$_instance = new self($registry, $loader, $capabilities, $request, $maintenance_mode);
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 * resets the instance and returns it
+	 *
+	 * @return EE_System
+	 */
+	public static function reset()
+	{
+		self::$_instance->_req_type = null;
+		//make sure none of the old hooks are left hanging around
+		remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
+		//we need to reset the migration manager in order for it to detect DMSs properly
+		EE_Data_Migration_Manager::reset();
+		self::instance()->detect_activations_or_upgrades();
+		self::instance()->perform_activations_upgrades_and_migrations();
+		return self::instance();
+	}
+
+
+
+	/**
+	 * sets hooks for running rest of system
+	 * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
+	 * starting EE Addons from any other point may lead to problems
+	 *
+	 * @param EE_Registry         $registry
+	 * @param LoaderInterface     $loader
+	 * @param EE_Capabilities     $capabilities
+	 * @param EE_Request          $request
+	 * @param EE_Maintenance_Mode $maintenance_mode
+	 */
+	private function __construct(
+		EE_Registry $registry,
+		LoaderInterface $loader,
+		EE_Capabilities $capabilities,
+		EE_Request $request,
+		EE_Maintenance_Mode $maintenance_mode
+	) {
+		$this->registry = $registry;
+		$this->loader = $loader;
+		$this->capabilities = $capabilities;
+		$this->request = $request;
+		$this->maintenance_mode = $maintenance_mode;
+		do_action('AHEE__EE_System__construct__begin', $this);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'loadCapabilities'),
+			5
+		);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'loadCommandBus'),
+			7
+		);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'loadPluginApi'),
+			9
+		);
+		// allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'load_espresso_addons')
+		);
+		// when an ee addon is activated, we want to call the core hook(s) again
+		// because the newly-activated addon didn't get a chance to run at all
+		add_action('activate_plugin', array($this, 'load_espresso_addons'), 1);
+		// detect whether install or upgrade
+		add_action(
+			'AHEE__EE_Bootstrap__detect_activations_or_upgrades',
+			array($this, 'detect_activations_or_upgrades'),
+			3
+		);
+		// load EE_Config, EE_Textdomain, etc
+		add_action(
+			'AHEE__EE_Bootstrap__load_core_configuration',
+			array($this, 'load_core_configuration'),
+			5
+		);
+		// load EE_Config, EE_Textdomain, etc
+		add_action(
+			'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
+			array($this, 'register_shortcodes_modules_and_widgets'),
+			7
+		);
+		// you wanna get going? I wanna get going... let's get going!
+		add_action(
+			'AHEE__EE_Bootstrap__brew_espresso',
+			array($this, 'brew_espresso'),
+			9
+		);
+		//other housekeeping
+		//exclude EE critical pages from wp_list_pages
+		add_filter(
+			'wp_list_pages_excludes',
+			array($this, 'remove_pages_from_wp_list_pages'),
+			10
+		);
+		// ALL EE Addons should use the following hook point to attach their initial setup too
+		// it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
+		do_action('AHEE__EE_System__construct__complete', $this);
+	}
+
+
+
+	/**
+	 * load and setup EE_Capabilities
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function loadCapabilities()
+	{
+		$this->loader->getShared('EE_Capabilities');
+		add_action(
+			'AHEE__EE_Capabilities__init_caps__before_initialization',
+			function() {
+				LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
+			}
+		);
+	}
+
+
+
+	/**
+	 * create and cache the CommandBus, and also add middleware
+	 * The CapChecker middleware requires the use of EE_Capabilities
+	 * which is why we need to load the CommandBus after Caps are set up
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function loadCommandBus()
+	{
+		$this->loader->getShared(
+			'CommandBusInterface',
+			array(
+				null,
+				apply_filters(
+					'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware',
+					array(
+						$this->loader->getShared('EventEspresso\core\services\commands\middleware\CapChecker'),
+						$this->loader->getShared('EventEspresso\core\services\commands\middleware\AddActionHook'),
+					)
+				),
+			)
+		);
+	}
+
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function loadPluginApi()
+	{
+		// set autoloaders for all of the classes implementing EEI_Plugin_API
+		// which provide helpers for EE plugin authors to more easily register certain components with EE.
+		EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @param string $version_constant
+	 * @param string $min_version_required
+	 * @param string $load_callback
+	 * @param string $plugin_file_constant
+	 * @return void
+	 */
+	private function deactivateIncompatibleAddon(
+		$addon_name,
+		$version_constant,
+		$min_version_required,
+		$load_callback,
+		$plugin_file_constant
+	) {
+		if (! defined($version_constant)) {
+			return;
+		}
+		$addon_version = constant($version_constant);
+		if ($addon_version && version_compare($addon_version, $min_version_required, '<')) {
+			remove_action('AHEE__EE_System__load_espresso_addons', $load_callback);
+			if (! function_exists('deactivate_plugins')) {
+				require_once ABSPATH . 'wp-admin/includes/plugin.php';
+			}
+			deactivate_plugins(plugin_basename(constant($plugin_file_constant)));
+			unset($_GET['activate'], $_REQUEST['activate'], $_GET['activate-multi'], $_REQUEST['activate-multi']);
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'We\'re sorry, but the Event Espresso %1$s addon was deactivated because version %2$s or higher is required with this version of Event Espresso core.',
+						'event_espresso'
+					),
+					$addon_name,
+					$min_version_required
+				),
+				__FILE__, __FUNCTION__ . "({$addon_name})", __LINE__
+			);
+			EE_Error::get_notices(false, true);
+		}
+	}
+
+
+	/**
+	 * load_espresso_addons
+	 * allow addons to load first so that they can set hooks for running DMS's, etc
+	 * this is hooked into both:
+	 *    'AHEE__EE_Bootstrap__load_core_configuration'
+	 *        which runs during the WP 'plugins_loaded' action at priority 5
+	 *    and the WP 'activate_plugin' hook point
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_espresso_addons()
+	{
+		$this->deactivateIncompatibleAddon(
+			'Wait Lists',
+			'EE_WAIT_LISTS_VERSION',
+			'1.0.0.beta.074',
+			'load_espresso_wait_lists',
+			'EE_WAIT_LISTS_PLUGIN_FILE'
+		);
+		$this->deactivateIncompatibleAddon(
+			'Automated Upcoming Event Notifications',
+			'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_VERSION',
+			'1.0.0.beta.091',
+			'load_espresso_automated_upcoming_event_notification',
+			'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_PLUGIN_FILE'
+		);
+		do_action('AHEE__EE_System__load_espresso_addons');
+		//if the WP API basic auth plugin isn't already loaded, load it now.
+		//We want it for mobile apps. Just include the entire plugin
+		//also, don't load the basic auth when a plugin is getting activated, because
+		//it could be the basic auth plugin, and it doesn't check if its methods are already defined
+		//and causes a fatal error
+		if (
+			! (
+				isset($_GET['activate'])
+				&& $_GET['activate'] === 'true'
+			)
+			&& ! function_exists('json_basic_auth_handler')
+			&& ! function_exists('json_basic_auth_error')
+			&& ! (
+				isset($_GET['action'])
+				&& in_array($_GET['action'], array('activate', 'activate-selected'), true)
+			)
+		) {
+			include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php';
+		}
+		do_action('AHEE__EE_System__load_espresso_addons__complete');
+	}
+
+
+
+	/**
+	 * detect_activations_or_upgrades
+	 * Checks for activation or upgrade of core first;
+	 * then also checks if any registered addons have been activated or upgraded
+	 * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
+	 * which runs during the WP 'plugins_loaded' action at priority 3
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function detect_activations_or_upgrades()
+	{
+		//first off: let's make sure to handle core
+		$this->detect_if_activation_or_upgrade();
+		foreach ($this->registry->addons as $addon) {
+			if ($addon instanceof EE_Addon) {
+				//detect teh request type for that addon
+				$addon->detect_activation_or_upgrade();
+			}
+		}
+	}
+
+
+
+	/**
+	 * detect_if_activation_or_upgrade
+	 * Takes care of detecting whether this is a brand new install or code upgrade,
+	 * and either setting up the DB or setting up maintenance mode etc.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function detect_if_activation_or_upgrade()
+	{
+		do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
+		// check if db has been updated, or if its a brand-new installation
+		$espresso_db_update = $this->fix_espresso_db_upgrade_option();
+		$request_type = $this->detect_req_type($espresso_db_update);
+		//EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ );
+		switch ($request_type) {
+			case EE_System::req_type_new_activation:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_reactivation:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_upgrade:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
+				//migrations may be required now that we've upgraded
+				$this->maintenance_mode->set_maintenance_mode_if_db_old();
+				$this->_handle_core_version_change($espresso_db_update);
+				//				echo "done upgrade";die;
+				break;
+			case EE_System::req_type_downgrade:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
+				//its possible migrations are no longer required
+				$this->maintenance_mode->set_maintenance_mode_if_db_old();
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_normal:
+			default:
+				//				$this->_maybe_redirect_to_ee_about();
+				break;
+		}
+		do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
+	}
+
+
+
+	/**
+	 * Updates the list of installed versions and sets hooks for
+	 * initializing the database later during the request
+	 *
+	 * @param array $espresso_db_update
+	 */
+	private function _handle_core_version_change($espresso_db_update)
+	{
+		$this->update_list_of_installed_versions($espresso_db_update);
+		//get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
+		add_action(
+			'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+			array($this, 'initialize_db_if_no_migrations_required')
+		);
+	}
+
+
+
+	/**
+	 * standardizes the wp option 'espresso_db_upgrade' which actually stores
+	 * information about what versions of EE have been installed and activated,
+	 * NOT necessarily the state of the database
+	 *
+	 * @param mixed $espresso_db_update the value of the WordPress option.
+	 *                                            If not supplied, fetches it from the options table
+	 * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
+	 */
+	private function fix_espresso_db_upgrade_option($espresso_db_update = null)
+	{
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
+		if (! $espresso_db_update) {
+			$espresso_db_update = get_option('espresso_db_update');
+		}
+		// check that option is an array
+		if (! is_array($espresso_db_update)) {
+			// if option is FALSE, then it never existed
+			if ($espresso_db_update === false) {
+				// make $espresso_db_update an array and save option with autoload OFF
+				$espresso_db_update = array();
+				add_option('espresso_db_update', $espresso_db_update, '', 'no');
+			} else {
+				// option is NOT FALSE but also is NOT an array, so make it an array and save it
+				$espresso_db_update = array($espresso_db_update => array());
+				update_option('espresso_db_update', $espresso_db_update);
+			}
+		} else {
+			$corrected_db_update = array();
+			//if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
+			foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
+				if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
+					//the key is an int, and the value IS NOT an array
+					//so it must be numerically-indexed, where values are versions installed...
+					//fix it!
+					$version_string = $should_be_array;
+					$corrected_db_update[$version_string] = array('unknown-date');
+				} else {
+					//ok it checks out
+					$corrected_db_update[$should_be_version_string] = $should_be_array;
+				}
+			}
+			$espresso_db_update = $corrected_db_update;
+			update_option('espresso_db_update', $espresso_db_update);
+		}
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
+		return $espresso_db_update;
+	}
+
+
+
+	/**
+	 * Does the traditional work of setting up the plugin's database and adding default data.
+	 * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
+	 * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
+	 * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
+	 * so that it will be done when migrations are finished
+	 *
+	 * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
+	 * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
+	 *                                       This is a resource-intensive job
+	 *                                       so we prefer to only do it when necessary
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
+	{
+		$request_type = $this->detect_req_type();
+		//only initialize system if we're not in maintenance mode.
+		if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
+			update_option('ee_flush_rewrite_rules', true);
+			if ($verify_schema) {
+				EEH_Activation::initialize_db_and_folders();
+			}
+			EEH_Activation::initialize_db_content();
+			EEH_Activation::system_initialization();
+			if ($initialize_addons_too) {
+				$this->initialize_addons();
+			}
+		} else {
+			EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
+		}
+		if ($request_type === EE_System::req_type_new_activation
+			|| $request_type === EE_System::req_type_reactivation
+			|| (
+				$request_type === EE_System::req_type_upgrade
+				&& $this->is_major_version_change()
+			)
+		) {
+			add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9);
+		}
+	}
+
+
+
+	/**
+	 * Initializes the db for all registered addons
+	 *
+	 * @throws EE_Error
+	 */
+	public function initialize_addons()
+	{
+		//foreach registered addon, make sure its db is up-to-date too
+		foreach ($this->registry->addons as $addon) {
+			if ($addon instanceof EE_Addon) {
+				$addon->initialize_db_if_no_migrations_required();
+			}
+		}
+	}
+
+
+
+	/**
+	 * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
+	 *
+	 * @param    array  $version_history
+	 * @param    string $current_version_to_add version to be added to the version history
+	 * @return    boolean success as to whether or not this option was changed
+	 */
+	public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
+	{
+		if (! $version_history) {
+			$version_history = $this->fix_espresso_db_upgrade_option($version_history);
+		}
+		if ($current_version_to_add === null) {
+			$current_version_to_add = espresso_version();
+		}
+		$version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time());
+		// re-save
+		return update_option('espresso_db_update', $version_history);
+	}
+
+
+
+	/**
+	 * Detects if the current version indicated in the has existed in the list of
+	 * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
+	 *
+	 * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
+	 *                                  If not supplied, fetches it from the options table.
+	 *                                  Also, caches its result so later parts of the code can also know whether
+	 *                                  there's been an update or not. This way we can add the current version to
+	 *                                  espresso_db_update, but still know if this is a new install or not
+	 * @return int one of the constants on EE_System::req_type_
+	 */
+	public function detect_req_type($espresso_db_update = null)
+	{
+		if ($this->_req_type === null) {
+			$espresso_db_update = ! empty($espresso_db_update)
+				? $espresso_db_update
+				: $this->fix_espresso_db_upgrade_option();
+			$this->_req_type = EE_System::detect_req_type_given_activation_history(
+				$espresso_db_update,
+				'ee_espresso_activation', espresso_version()
+			);
+			$this->_major_version_change = $this->_detect_major_version_change($espresso_db_update);
+		}
+		return $this->_req_type;
+	}
+
+
+
+	/**
+	 * Returns whether or not there was a non-micro version change (ie, change in either
+	 * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000,
+	 * but not 4.9.0.rc.0001 to 4.9.1.rc.0001
+	 *
+	 * @param $activation_history
+	 * @return bool
+	 */
+	private function _detect_major_version_change($activation_history)
+	{
+		$previous_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history);
+		$previous_version_parts = explode('.', $previous_version);
+		$current_version_parts = explode('.', espresso_version());
+		return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1])
+			   && ($previous_version_parts[0] !== $current_version_parts[0]
+				   || $previous_version_parts[1] !== $current_version_parts[1]
+			   );
+	}
+
+
+
+	/**
+	 * Returns true if either the major or minor version of EE changed during this request.
+	 * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001
+	 *
+	 * @return bool
+	 */
+	public function is_major_version_change()
+	{
+		return $this->_major_version_change;
+	}
+
+
+
+	/**
+	 * Determines the request type for any ee addon, given three piece of info: the current array of activation
+	 * histories (for core that' 'espresso_db_update' wp option); the name of the WordPress option which is temporarily
+	 * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
+	 * just activated to (for core that will always be espresso_version())
+	 *
+	 * @param array  $activation_history_for_addon     the option's value which stores the activation history for this
+	 *                                                 ee plugin. for core that's 'espresso_db_update'
+	 * @param string $activation_indicator_option_name the name of the WordPress option that is temporarily set to
+	 *                                                 indicate that this plugin was just activated
+	 * @param string $version_to_upgrade_to            the version that was just upgraded to (for core that will be
+	 *                                                 espresso_version())
+	 * @return int one of the constants on EE_System::req_type_*
+	 */
+	public static function detect_req_type_given_activation_history(
+		$activation_history_for_addon,
+		$activation_indicator_option_name,
+		$version_to_upgrade_to
+	) {
+		$version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to);
+		if ($activation_history_for_addon) {
+			//it exists, so this isn't a completely new install
+			//check if this version already in that list of previously installed versions
+			if (! isset($activation_history_for_addon[$version_to_upgrade_to])) {
+				//it a version we haven't seen before
+				if ($version_is_higher === 1) {
+					$req_type = EE_System::req_type_upgrade;
+				} else {
+					$req_type = EE_System::req_type_downgrade;
+				}
+				delete_option($activation_indicator_option_name);
+			} else {
+				// its not an update. maybe a reactivation?
+				if (get_option($activation_indicator_option_name, false)) {
+					if ($version_is_higher === -1) {
+						$req_type = EE_System::req_type_downgrade;
+					} else if ($version_is_higher === 0) {
+						//we've seen this version before, but it's an activation. must be a reactivation
+						$req_type = EE_System::req_type_reactivation;
+					} else {//$version_is_higher === 1
+						$req_type = EE_System::req_type_upgrade;
+					}
+					delete_option($activation_indicator_option_name);
+				} else {
+					//we've seen this version before and the activation indicate doesn't show it was just activated
+					if ($version_is_higher === -1) {
+						$req_type = EE_System::req_type_downgrade;
+					} else if ($version_is_higher === 0) {
+						//we've seen this version before and it's not an activation. its normal request
+						$req_type = EE_System::req_type_normal;
+					} else {//$version_is_higher === 1
+						$req_type = EE_System::req_type_upgrade;
+					}
+				}
+			}
+		} else {
+			//brand new install
+			$req_type = EE_System::req_type_new_activation;
+			delete_option($activation_indicator_option_name);
+		}
+		return $req_type;
+	}
+
+
+
+	/**
+	 * Detects if the $version_to_upgrade_to is higher than the most recent version in
+	 * the $activation_history_for_addon
+	 *
+	 * @param array  $activation_history_for_addon (keys are versions, values are arrays of times activated,
+	 *                                             sometimes containing 'unknown-date'
+	 * @param string $version_to_upgrade_to        (current version)
+	 * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
+	 *                                             ie, -1 if $version_to_upgrade_to is LOWER (downgrade);
+	 *                                             0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
+	 *                                             1 if $version_to_upgrade_to is HIGHER (upgrade) ;
+	 */
+	private static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to)
+	{
+		//find the most recently-activated version
+		$most_recently_active_version =
+			EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon);
+		return version_compare($version_to_upgrade_to, $most_recently_active_version);
+	}
+
+
+
+	/**
+	 * Gets the most recently active version listed in the activation history,
+	 * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
+	 *
+	 * @param array $activation_history  (keys are versions, values are arrays of times activated,
+	 *                                   sometimes containing 'unknown-date'
+	 * @return string
+	 */
+	private static function _get_most_recently_active_version_from_activation_history($activation_history)
+	{
+		$most_recently_active_version_activation = '1970-01-01 00:00:00';
+		$most_recently_active_version = '0.0.0.dev.000';
+		if (is_array($activation_history)) {
+			foreach ($activation_history as $version => $times_activated) {
+				//check there is a record of when this version was activated. Otherwise,
+				//mark it as unknown
+				if (! $times_activated) {
+					$times_activated = array('unknown-date');
+				}
+				if (is_string($times_activated)) {
+					$times_activated = array($times_activated);
+				}
+				foreach ($times_activated as $an_activation) {
+					if ($an_activation !== 'unknown-date' && $an_activation > $most_recently_active_version_activation) {
+						$most_recently_active_version = $version;
+						$most_recently_active_version_activation = $an_activation === 'unknown-date'
+							? '1970-01-01 00:00:00'
+							: $an_activation;
+					}
+				}
+			}
+		}
+		return $most_recently_active_version;
+	}
+
+
+
+	/**
+	 * This redirects to the about EE page after activation
+	 *
+	 * @return void
+	 */
+	public function redirect_to_about_ee()
+	{
+		$notices = EE_Error::get_notices(false);
+		//if current user is an admin and it's not an ajax or rest request
+		if (
+			! (defined('DOING_AJAX') && DOING_AJAX)
+			&& ! (defined('REST_REQUEST') && REST_REQUEST)
+			&& ! isset($notices['errors'])
+			&& apply_filters(
+				'FHEE__EE_System__redirect_to_about_ee__do_redirect',
+				$this->capabilities->current_user_can('manage_options', 'espresso_about_default')
+			)
+		) {
+			$query_params = array('page' => 'espresso_about');
+			if (EE_System::instance()->detect_req_type() === EE_System::req_type_new_activation) {
+				$query_params['new_activation'] = true;
+			}
+			if (EE_System::instance()->detect_req_type() === EE_System::req_type_reactivation) {
+				$query_params['reactivation'] = true;
+			}
+			$url = add_query_arg($query_params, admin_url('admin.php'));
+			wp_safe_redirect($url);
+			exit();
+		}
+	}
+
+
+
+	/**
+	 * load_core_configuration
+	 * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
+	 * which runs during the WP 'plugins_loaded' action at priority 5
+	 *
+	 * @return void
+	 * @throws ReflectionException
+	 */
+	public function load_core_configuration()
+	{
+		do_action('AHEE__EE_System__load_core_configuration__begin', $this);
+		$this->loader->getShared('EE_Load_Textdomain');
+		//load textdomain
+		EE_Load_Textdomain::load_textdomain();
+		// load and setup EE_Config and EE_Network_Config
+		$config = $this->loader->getShared('EE_Config');
+		$this->loader->getShared('EE_Network_Config');
+		// setup autoloaders
+		// enable logging?
+		if ($config->admin->use_full_logging) {
+			$this->loader->getShared('EE_Log');
+		}
+		// check for activation errors
+		$activation_errors = get_option('ee_plugin_activation_errors', false);
+		if ($activation_errors) {
+			EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
+			update_option('ee_plugin_activation_errors', false);
+		}
+		// get model names
+		$this->_parse_model_names();
+		//load caf stuff a chance to play during the activation process too.
+		$this->_maybe_brew_regular();
+		do_action('AHEE__EE_System__load_core_configuration__complete', $this);
+	}
+
+
+
+	/**
+	 * cycles through all of the models/*.model.php files, and assembles an array of model names
+	 *
+	 * @return void
+	 * @throws ReflectionException
+	 */
+	private function _parse_model_names()
+	{
+		//get all the files in the EE_MODELS folder that end in .model.php
+		$models = glob(EE_MODELS . '*.model.php');
+		$model_names = array();
+		$non_abstract_db_models = array();
+		foreach ($models as $model) {
+			// get model classname
+			$classname = EEH_File::get_classname_from_filepath_with_standard_filename($model);
+			$short_name = str_replace('EEM_', '', $classname);
+			$reflectionClass = new ReflectionClass($classname);
+			if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
+				$non_abstract_db_models[$short_name] = $classname;
+			}
+			$model_names[$short_name] = $classname;
+		}
+		$this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
+		$this->registry->non_abstract_db_models = apply_filters(
+			'FHEE__EE_System__parse_implemented_model_names',
+			$non_abstract_db_models
+		);
+	}
+
+
+
+	/**
+	 * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
+	 * that need to be setup before our EE_System launches.
+	 *
+	 * @return void
+	 */
+	private function _maybe_brew_regular()
+	{
+		if ((! defined('EE_DECAF') || EE_DECAF !== true) && is_readable(EE_CAFF_PATH . 'brewing_regular.php')) {
+			require_once EE_CAFF_PATH . 'brewing_regular.php';
+		}
+	}
+
+
+
+	/**
+	 * register_shortcodes_modules_and_widgets
+	 * generate lists of shortcodes and modules, then verify paths and classes
+	 * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
+	 * which runs during the WP 'plugins_loaded' action at priority 7
+	 *
+	 * @access public
+	 * @return void
+	 * @throws Exception
+	 */
+	public function register_shortcodes_modules_and_widgets()
+	{
+		try {
+			// load, register, and add shortcodes the new way
+			$this->loader->getShared(
+				'EventEspresso\core\services\shortcodes\ShortcodesManager',
+				array(
+					// and the old way, but we'll put it under control of the new system
+					EE_Config::getLegacyShortcodesManager()
+				)
+			);
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+		do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
+		// check for addons using old hook point
+		if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
+			$this->_incompatible_addon_error();
+		}
+	}
+
+
+
+	/**
+	 * _incompatible_addon_error
+	 *
+	 * @access public
+	 * @return void
+	 */
+	private function _incompatible_addon_error()
+	{
+		// get array of classes hooking into here
+		$class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook(
+			'AHEE__EE_System__register_shortcodes_modules_and_addons'
+		);
+		if (! empty($class_names)) {
+			$msg = __(
+				'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
+				'event_espresso'
+			);
+			$msg .= '<ul>';
+			foreach ($class_names as $class_name) {
+				$msg .= '<li><b>Event Espresso - ' . str_replace(
+						array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '',
+						$class_name
+					) . '</b></li>';
+			}
+			$msg .= '</ul>';
+			$msg .= __(
+				'Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
+				'event_espresso'
+			);
+			// save list of incompatible addons to wp-options for later use
+			add_option('ee_incompatible_addons', $class_names, '', 'no');
+			if (is_admin()) {
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		}
+	}
+
+
+
+	/**
+	 * brew_espresso
+	 * begins the process of setting hooks for initializing EE in the correct order
+	 * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hook point
+	 * which runs during the WP 'plugins_loaded' action at priority 9
+	 *
+	 * @return void
+	 */
+	public function brew_espresso()
+	{
+		do_action('AHEE__EE_System__brew_espresso__begin', $this);
+		// load some final core systems
+		add_action('init', array($this, 'set_hooks_for_core'), 1);
+		add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3);
+		add_action('init', array($this, 'load_CPTs_and_session'), 5);
+		add_action('init', array($this, 'load_controllers'), 7);
+		add_action('init', array($this, 'core_loaded_and_ready'), 9);
+		add_action('init', array($this, 'initialize'), 10);
+		add_action('init', array($this, 'initialize_last'), 100);
+		if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) {
+			// pew pew pew
+			$this->loader->getShared('EE_PUE');
+			do_action('AHEE__EE_System__brew_espresso__after_pue_init');
+		}
+		do_action('AHEE__EE_System__brew_espresso__complete', $this);
+	}
+
+
+
+	/**
+	 *    set_hooks_for_core
+	 *
+	 * @access public
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public function set_hooks_for_core()
+	{
+		$this->_deactivate_incompatible_addons();
+		do_action('AHEE__EE_System__set_hooks_for_core');
+		//caps need to be initialized on every request so that capability maps are set.
+		//@see https://events.codebasehq.com/projects/event-espresso/tickets/8674
+		$this->registry->CAP->init_caps();
+	}
+
+
+
+	/**
+	 * Using the information gathered in EE_System::_incompatible_addon_error,
+	 * deactivates any addons considered incompatible with the current version of EE
+	 */
+	private function _deactivate_incompatible_addons()
+	{
+		$incompatible_addons = get_option('ee_incompatible_addons', array());
+		if (! empty($incompatible_addons)) {
+			$active_plugins = get_option('active_plugins', array());
+			foreach ($active_plugins as $active_plugin) {
+				foreach ($incompatible_addons as $incompatible_addon) {
+					if (strpos($active_plugin, $incompatible_addon) !== false) {
+						unset($_GET['activate']);
+						espresso_deactivate_plugin($active_plugin);
+					}
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 *    perform_activations_upgrades_and_migrations
+	 *
+	 * @access public
+	 * @return    void
+	 */
+	public function perform_activations_upgrades_and_migrations()
+	{
+		//first check if we had previously attempted to setup EE's directories but failed
+		if (EEH_Activation::upload_directories_incomplete()) {
+			EEH_Activation::create_upload_directories();
+		}
+		do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
+	}
+
+
+
+	/**
+	 *    load_CPTs_and_session
+	 *
+	 * @access public
+	 * @return    void
+	 */
+	public function load_CPTs_and_session()
+	{
+		do_action('AHEE__EE_System__load_CPTs_and_session__start');
+		// register Custom Post Types
+		$this->loader->getShared('EE_Register_CPTs');
+		do_action('AHEE__EE_System__load_CPTs_and_session__complete');
+	}
+
+
+
+	/**
+	 * load_controllers
+	 * this is the best place to load any additional controllers that needs access to EE core.
+	 * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
+	 * time
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_controllers()
+	{
+		do_action('AHEE__EE_System__load_controllers__start');
+		// let's get it started
+		if (! is_admin() && ! $this->maintenance_mode->level()) {
+			do_action('AHEE__EE_System__load_controllers__load_front_controllers');
+			$this->loader->getShared('EE_Front_Controller');
+		} else if (! EE_FRONT_AJAX) {
+			do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
+			$this->loader->getShared('EE_Admin');
+		}
+		do_action('AHEE__EE_System__load_controllers__complete');
+	}
+
+
+
+	/**
+	 * core_loaded_and_ready
+	 * all of the basic EE core should be loaded at this point and available regardless of M-Mode
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function core_loaded_and_ready()
+	{
+		$this->loader->getShared('EE_Session');
+		do_action('AHEE__EE_System__core_loaded_and_ready');
+		// load_espresso_template_tags
+		if (is_readable(EE_PUBLIC . 'template_tags.php')) {
+			require_once(EE_PUBLIC . 'template_tags.php');
+		}
+		do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
+		$this->loader->getShared('EventEspresso\core\services\assets\Registry');
+	}
+
+
+
+	/**
+	 * initialize
+	 * this is the best place to begin initializing client code
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function initialize()
+	{
+		do_action('AHEE__EE_System__initialize');
+	}
+
+
+
+	/**
+	 * initialize_last
+	 * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to
+	 * initialize has done so
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function initialize_last()
+	{
+		do_action('AHEE__EE_System__initialize_last');
+		add_action('admin_bar_init', array($this, 'addEspressoToolbar'));
+	}
+
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function addEspressoToolbar()
+	{
+		$this->loader->getShared(
+			'EventEspresso\core\domain\services\admin\AdminToolBar',
+			array($this->registry->CAP)
+		);
+	}
+
+
+
+	/**
+	 * do_not_cache
+	 * sets no cache headers and defines no cache constants for WP plugins
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public static function do_not_cache()
+	{
+		// set no cache constants
+		if (! defined('DONOTCACHEPAGE')) {
+			define('DONOTCACHEPAGE', true);
+		}
+		if (! defined('DONOTCACHCEOBJECT')) {
+			define('DONOTCACHCEOBJECT', true);
+		}
+		if (! defined('DONOTCACHEDB')) {
+			define('DONOTCACHEDB', true);
+		}
+		// add no cache headers
+		add_action('send_headers', array('EE_System', 'nocache_headers'), 10);
+		// plus a little extra for nginx and Google Chrome
+		add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1);
+		// prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
+		remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
+	}
+
+
+
+	/**
+	 *    extra_nocache_headers
+	 *
+	 * @access    public
+	 * @param $headers
+	 * @return    array
+	 */
+	public static function extra_nocache_headers($headers)
+	{
+		// for NGINX
+		$headers['X-Accel-Expires'] = 0;
+		// plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
+		$headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
+		return $headers;
+	}
+
+
+
+	/**
+	 *    nocache_headers
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function nocache_headers()
+	{
+		nocache_headers();
+	}
+
+
+
+
+	/**
+	 * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
+	 * never returned with the function.
+	 *
+	 * @param  array $exclude_array any existing pages being excluded are in this array.
+	 * @return array
+	 */
+	public function remove_pages_from_wp_list_pages($exclude_array)
+	{
+		return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
+	}
 
 
 

core/helpers/EEH_Template.helper.php

Indentation +930 added lines, -930 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 /**
  * Event Espresso
@@ -16,35 +16,35 @@ 
 
 
 if ( ! function_exists('espresso_get_template_part')) {
-    /**
-     * espresso_get_template_part
-     * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead, and doesn't add base versions of files
-     * so not a very useful function at all except that it adds familiarity PLUS filtering based off of the entire template part name
-     *
-     * @param string $slug The slug name for the generic template.
-     * @param string $name The name of the specialised template.
-     * @return string        the html output for the formatted money value
-     */
-    function espresso_get_template_part($slug = null, $name = null)
-    {
-        EEH_Template::get_template_part($slug, $name);
-    }
+	/**
+	 * espresso_get_template_part
+	 * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead, and doesn't add base versions of files
+	 * so not a very useful function at all except that it adds familiarity PLUS filtering based off of the entire template part name
+	 *
+	 * @param string $slug The slug name for the generic template.
+	 * @param string $name The name of the specialised template.
+	 * @return string        the html output for the formatted money value
+	 */
+	function espresso_get_template_part($slug = null, $name = null)
+	{
+		EEH_Template::get_template_part($slug, $name);
+	}
 }
 
 
 if ( ! function_exists('espresso_get_object_css_class')) {
-    /**
-     * espresso_get_object_css_class - attempts to generate a css class based on the type of EE object passed
-     *
-     * @param EE_Base_Class $object the EE object the css class is being generated for
-     * @param  string       $prefix added to the beginning of the generated class
-     * @param  string       $suffix added to the end of the generated class
-     * @return string
-     */
-    function espresso_get_object_css_class($object = null, $prefix = '', $suffix = '')
-    {
-        return EEH_Template::get_object_css_class($object, $prefix, $suffix);
-    }
+	/**
+	 * espresso_get_object_css_class - attempts to generate a css class based on the type of EE object passed
+	 *
+	 * @param EE_Base_Class $object the EE object the css class is being generated for
+	 * @param  string       $prefix added to the beginning of the generated class
+	 * @param  string       $suffix added to the end of the generated class
+	 * @return string
+	 */
+	function espresso_get_object_css_class($object = null, $prefix = '', $suffix = '')
+	{
+		return EEH_Template::get_object_css_class($object, $prefix, $suffix);
+	}
 }
 
 
@@ -59,650 +59,650 @@ 
 class EEH_Template
 {
 
-    private static $_espresso_themes = array();
-
-
-    /**
-     *    is_espresso_theme - returns TRUE or FALSE on whether the currently active WP theme is an espresso theme
-     *
-     * @return boolean
-     */
-    public static function is_espresso_theme()
-    {
-        return wp_get_theme()->get('TextDomain') == 'event_espresso' ? true : false;
-    }
-
-    /**
-     *    load_espresso_theme_functions - if current theme is an espresso theme, or uses ee theme template parts, then
-     *    load it's functions.php file ( if not already loaded )
-     *
-     * @return void
-     */
-    public static function load_espresso_theme_functions()
-    {
-        if ( ! defined('EE_THEME_FUNCTIONS_LOADED')) {
-            if (is_readable(EE_PUBLIC . EE_Config::get_current_theme() . DS . 'functions.php')) {
-                require_once(EE_PUBLIC . EE_Config::get_current_theme() . DS . 'functions.php');
-            }
-        }
-    }
-
-
-    /**
-     *    get_espresso_themes - returns an array of Espresso Child themes located in the /templates/ directory
-     *
-     * @return array
-     */
-    public static function get_espresso_themes()
-    {
-        if (empty(EEH_Template::$_espresso_themes)) {
-            $espresso_themes = glob(EE_PUBLIC . '*', GLOB_ONLYDIR);
-            if (empty($espresso_themes)) {
-                return array();
-            }
-            if (($key = array_search('global_assets', $espresso_themes)) !== false) {
-                unset($espresso_themes[$key]);
-            }
-            EEH_Template::$_espresso_themes = array();
-            foreach ($espresso_themes as $espresso_theme) {
-                EEH_Template::$_espresso_themes[basename($espresso_theme)] = $espresso_theme;
-            }
-        }
-        return EEH_Template::$_espresso_themes;
-    }
-
-
-    /**
-     * EEH_Template::get_template_part
-     * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead,
-     * and doesn't add base versions of files so not a very useful function at all except that it adds familiarity PLUS
-     * filtering based off of the entire template part name
-     *
-     * @param string $slug The slug name for the generic template.
-     * @param string $name The name of the specialised template.
-     * @param array  $template_args
-     * @param bool   $return_string
-     * @return string        the html output for the formatted money value
-     */
-    public static function get_template_part(
-        $slug = null,
-        $name = null,
-        $template_args = array(),
-        $return_string = false
-    ) {
-        do_action("get_template_part_{$slug}-{$name}", $slug, $name);
-        $templates = array();
-        $name      = (string)$name;
-        if ($name != '') {
-            $templates[] = "{$slug}-{$name}.php";
-        }
-        // allow template parts to be turned off via something like: add_filter( 'FHEE__content_espresso_events_tickets_template__display_datetimes', '__return_false' );
-        if (apply_filters("FHEE__EEH_Template__get_template_part__display__{$slug}_{$name}", true)) {
-            EEH_Template::locate_template($templates, $template_args, true, $return_string);
-        }
-    }
-
-
-    /**
-     *    locate_template
-     *    locate a template file by looking in the following places, in the following order:
-     *        <server path up to>/wp-content/themes/<current active WordPress theme>/
-     *        <assumed full absolute server path>
-     *        <server path up to>/wp-content/uploads/espresso/templates/<current EE theme>/
-     *        <server path up to>/wp-content/uploads/espresso/templates/
-     *        <server path up to>/wp-content/plugins/<EE4 folder>/public/<current EE theme>/
-     *        <server path up to>/wp-content/plugins/<EE4 folder>/core/templates/<current EE theme>/
-     *        <server path up to>/wp-content/plugins/<EE4 folder>/
-     *    as soon as the template is found in one of these locations, it will be returned or loaded
-     *        Example:
-     *          You are using the WordPress Twenty Sixteen theme,
-     *        and you want to customize the "some-event.template.php" template,
-     *          which is located in the "/relative/path/to/" folder relative to the main EE plugin folder.
-     *          Assuming WP is installed on your server in the "/home/public_html/" folder,
-     *        EEH_Template::locate_template() will look at the following paths in order until the template is found:
-     *        /home/public_html/wp-content/themes/twentysixteen/some-event.template.php
-     *        /relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/uploads/espresso/templates/Espresso_Arabica_2014/relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/uploads/espresso/templates/relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/plugins/event-espresso-core-reg/public/Espresso_Arabica_2014/relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/plugins/event-espresso-core-reg/core/templates/Espresso_Arabica_2014/relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/plugins/event-espresso-core-reg/relative/path/to/some-event.template.php
-     *          Had you passed an absolute path to your template that was in some other location,
-     *        ie: "/absolute/path/to/some-event.template.php"
-     *          then the search would have been :
-     *        /home/public_html/wp-content/themes/twentysixteen/some-event.template.php
-     *        /absolute/path/to/some-event.template.php
-     *          and stopped there upon finding it in the second location
-     *
-     * @param array|string $templates       array of template file names including extension (or just a single string)
-     * @param  array       $template_args   an array of arguments to be extracted for use in the template
-     * @param  boolean     $load            whether to pass the located template path on to the
-     *                                      EEH_Template::display_template() method or simply return it
-     * @param  boolean     $return_string   whether to send output immediately to screen, or capture and return as a
-     *                                      string
-     * @param boolean      $check_if_custom If TRUE, this flags this method to return boolean for whether this will
-     *                                      generate a custom template or not. Used in places where you don't actually
-     *                                      load the template, you just want to know if there's a custom version of it.
-     * @return mixed
-     */
-    public static function locate_template(
-        $templates = array(),
-        $template_args = array(),
-        $load = true,
-        $return_string = true,
-        $check_if_custom = false
-    ) {
-        // first use WP locate_template to check for template in the current theme folder
-        $template_path = locate_template($templates);
-
-        if ($check_if_custom && ! empty($template_path)) {
-            return true;
-        }
-
-        // not in the theme
-        if (empty($template_path)) {
-            // not even a template to look for ?
-            if (empty($templates)) {
-                // get post_type
-                $post_type = EE_Registry::instance()->REQ->get('post_type');
-                // get array of EE Custom Post Types
-                $EE_CPTs = EE_Register_CPTs::get_CPTs();
-                // build template name based on request
-                if (isset($EE_CPTs[$post_type])) {
-                    $archive_or_single = is_archive() ? 'archive' : '';
-                    $archive_or_single = is_single() ? 'single' : $archive_or_single;
-                    $templates         = $archive_or_single . '-' . $post_type . '.php';
-                }
-            }
-            // currently active EE template theme
-            $current_theme = EE_Config::get_current_theme();
-
-            // array of paths to folders that may contain templates
-            $template_folder_paths = array(
-                // first check the /wp-content/uploads/espresso/templates/(current EE theme)/  folder for an EE theme template file
-                EVENT_ESPRESSO_TEMPLATE_DIR . $current_theme,
-                // then in the root of the /wp-content/uploads/espresso/templates/ folder
-                EVENT_ESPRESSO_TEMPLATE_DIR,
-            );
-
-            //add core plugin folders for checking only if we're not $check_if_custom
-            if ( ! $check_if_custom) {
-                $core_paths            = array(
-                    // in the  /wp-content/plugins/(EE4 folder)/public/(current EE theme)/ folder within the plugin
-                    EE_PUBLIC . $current_theme,
-                    // in the  /wp-content/plugins/(EE4 folder)/core/templates/(current EE theme)/ folder within the plugin
-                    EE_TEMPLATES . $current_theme,
-                    // or maybe relative from the plugin root: /wp-content/plugins/(EE4 folder)/
-                    EE_PLUGIN_DIR_PATH,
-                );
-                $template_folder_paths = array_merge($template_folder_paths, $core_paths);
-            }
-
-            // now filter that array
-            $template_folder_paths = apply_filters('FHEE__EEH_Template__locate_template__template_folder_paths',
-                $template_folder_paths);
-            $templates             = is_array($templates) ? $templates : array($templates);
-            $template_folder_paths = is_array($template_folder_paths) ? $template_folder_paths : array($template_folder_paths);
-            // array to hold all possible template paths
-            $full_template_paths = array();
-
-            // loop through $templates
-            foreach ($templates as $template) {
-                // normalize directory separators
-                $template                      = EEH_File::standardise_directory_separators($template);
-                $file_name                     = basename($template);
-                $template_path_minus_file_name = substr($template, 0, (strlen($file_name) * -1));
-                // while looping through all template folder paths
-                foreach ($template_folder_paths as $template_folder_path) {
-                    // normalize directory separators
-                    $template_folder_path = EEH_File::standardise_directory_separators($template_folder_path);
-                    // determine if any common base path exists between the two paths
-                    $common_base_path = EEH_Template::_find_common_base_path(
-                        array($template_folder_path, $template_path_minus_file_name)
-                    );
-                    if ($common_base_path !== '') {
-                        // both paths have a common base, so just tack the filename onto our search path
-                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $file_name;
-                    } else {
-                        // no common base path, so let's just concatenate
-                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $template;
-                    }
-                    // build up our template locations array by adding our resolved paths
-                    $full_template_paths[] = $resolved_path;
-                }
-                // if $template is an absolute path, then we'll tack it onto the start of our array so that it gets searched first
-                array_unshift($full_template_paths, $template);
-                // path to the directory of the current theme: /wp-content/themes/(current WP theme)/
-                array_unshift($full_template_paths, get_stylesheet_directory() . DS . $file_name);
-            }
-            // filter final array of full template paths
-            $full_template_paths = apply_filters('FHEE__EEH_Template__locate_template__full_template_paths',
-                $full_template_paths, $file_name);
-            // now loop through our final array of template location paths and check each location
-            foreach ((array)$full_template_paths as $full_template_path) {
-                if (is_readable($full_template_path)) {
-                    $template_path = str_replace(array('\\', '/'), DIRECTORY_SEPARATOR, $full_template_path);
-                    break;
-                }
-            }
-        }
-
-        // hook that can be used to display the full template path that will be used
-        do_action('AHEE__EEH_Template__locate_template__full_template_path', $template_path);
-
-        // if we got it and you want to see it...
-        if ($template_path && $load && ! $check_if_custom) {
-            if ($return_string) {
-                return EEH_Template::display_template($template_path, $template_args, true);
-            } else {
-                EEH_Template::display_template($template_path, $template_args, false);
-            }
-        }
-        return $check_if_custom && ! empty($template_path) ? true : $template_path;
-    }
-
-
-    /**
-     * _find_common_base_path
-     * given two paths, this determines if there is a common base path between the two
-     *
-     * @param array $paths
-     * @return string
-     */
-    protected static function _find_common_base_path($paths)
-    {
-        $last_offset      = 0;
-        $common_base_path = '';
-        while (($index = strpos($paths[0], DS, $last_offset)) !== false) {
-            $dir_length = $index - $last_offset + 1;
-            $directory  = substr($paths[0], $last_offset, $dir_length);
-            foreach ($paths as $path) {
-                if (substr($path, $last_offset, $dir_length) != $directory) {
-                    return $common_base_path;
-                }
-            }
-            $common_base_path .= $directory;
-            $last_offset = $index + 1;
-        }
-        return substr($common_base_path, 0, -1);
-    }
-
-
-    /**
-     * load and display a template
-     *
-     * @param bool|string $template_path server path to the file to be loaded, including file name and extension
-     * @param  array      $template_args an array of arguments to be extracted for use in the template
-     * @param  boolean    $return_string whether to send output immediately to screen, or capture and return as a string
-     * @param bool        $throw_exceptions if set to true, will throw an exception if the template is either
-     *                                      not found or is not readable
-     * @return mixed string
-     * @throws \DomainException
-     */
+	private static $_espresso_themes = array();
+
+
+	/**
+	 *    is_espresso_theme - returns TRUE or FALSE on whether the currently active WP theme is an espresso theme
+	 *
+	 * @return boolean
+	 */
+	public static function is_espresso_theme()
+	{
+		return wp_get_theme()->get('TextDomain') == 'event_espresso' ? true : false;
+	}
+
+	/**
+	 *    load_espresso_theme_functions - if current theme is an espresso theme, or uses ee theme template parts, then
+	 *    load it's functions.php file ( if not already loaded )
+	 *
+	 * @return void
+	 */
+	public static function load_espresso_theme_functions()
+	{
+		if ( ! defined('EE_THEME_FUNCTIONS_LOADED')) {
+			if (is_readable(EE_PUBLIC . EE_Config::get_current_theme() . DS . 'functions.php')) {
+				require_once(EE_PUBLIC . EE_Config::get_current_theme() . DS . 'functions.php');
+			}
+		}
+	}
+
+
+	/**
+	 *    get_espresso_themes - returns an array of Espresso Child themes located in the /templates/ directory
+	 *
+	 * @return array
+	 */
+	public static function get_espresso_themes()
+	{
+		if (empty(EEH_Template::$_espresso_themes)) {
+			$espresso_themes = glob(EE_PUBLIC . '*', GLOB_ONLYDIR);
+			if (empty($espresso_themes)) {
+				return array();
+			}
+			if (($key = array_search('global_assets', $espresso_themes)) !== false) {
+				unset($espresso_themes[$key]);
+			}
+			EEH_Template::$_espresso_themes = array();
+			foreach ($espresso_themes as $espresso_theme) {
+				EEH_Template::$_espresso_themes[basename($espresso_theme)] = $espresso_theme;
+			}
+		}
+		return EEH_Template::$_espresso_themes;
+	}
+
+
+	/**
+	 * EEH_Template::get_template_part
+	 * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead,
+	 * and doesn't add base versions of files so not a very useful function at all except that it adds familiarity PLUS
+	 * filtering based off of the entire template part name
+	 *
+	 * @param string $slug The slug name for the generic template.
+	 * @param string $name The name of the specialised template.
+	 * @param array  $template_args
+	 * @param bool   $return_string
+	 * @return string        the html output for the formatted money value
+	 */
+	public static function get_template_part(
+		$slug = null,
+		$name = null,
+		$template_args = array(),
+		$return_string = false
+	) {
+		do_action("get_template_part_{$slug}-{$name}", $slug, $name);
+		$templates = array();
+		$name      = (string)$name;
+		if ($name != '') {
+			$templates[] = "{$slug}-{$name}.php";
+		}
+		// allow template parts to be turned off via something like: add_filter( 'FHEE__content_espresso_events_tickets_template__display_datetimes', '__return_false' );
+		if (apply_filters("FHEE__EEH_Template__get_template_part__display__{$slug}_{$name}", true)) {
+			EEH_Template::locate_template($templates, $template_args, true, $return_string);
+		}
+	}
+
+
+	/**
+	 *    locate_template
+	 *    locate a template file by looking in the following places, in the following order:
+	 *        <server path up to>/wp-content/themes/<current active WordPress theme>/
+	 *        <assumed full absolute server path>
+	 *        <server path up to>/wp-content/uploads/espresso/templates/<current EE theme>/
+	 *        <server path up to>/wp-content/uploads/espresso/templates/
+	 *        <server path up to>/wp-content/plugins/<EE4 folder>/public/<current EE theme>/
+	 *        <server path up to>/wp-content/plugins/<EE4 folder>/core/templates/<current EE theme>/
+	 *        <server path up to>/wp-content/plugins/<EE4 folder>/
+	 *    as soon as the template is found in one of these locations, it will be returned or loaded
+	 *        Example:
+	 *          You are using the WordPress Twenty Sixteen theme,
+	 *        and you want to customize the "some-event.template.php" template,
+	 *          which is located in the "/relative/path/to/" folder relative to the main EE plugin folder.
+	 *          Assuming WP is installed on your server in the "/home/public_html/" folder,
+	 *        EEH_Template::locate_template() will look at the following paths in order until the template is found:
+	 *        /home/public_html/wp-content/themes/twentysixteen/some-event.template.php
+	 *        /relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/uploads/espresso/templates/Espresso_Arabica_2014/relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/uploads/espresso/templates/relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/plugins/event-espresso-core-reg/public/Espresso_Arabica_2014/relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/plugins/event-espresso-core-reg/core/templates/Espresso_Arabica_2014/relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/plugins/event-espresso-core-reg/relative/path/to/some-event.template.php
+	 *          Had you passed an absolute path to your template that was in some other location,
+	 *        ie: "/absolute/path/to/some-event.template.php"
+	 *          then the search would have been :
+	 *        /home/public_html/wp-content/themes/twentysixteen/some-event.template.php
+	 *        /absolute/path/to/some-event.template.php
+	 *          and stopped there upon finding it in the second location
+	 *
+	 * @param array|string $templates       array of template file names including extension (or just a single string)
+	 * @param  array       $template_args   an array of arguments to be extracted for use in the template
+	 * @param  boolean     $load            whether to pass the located template path on to the
+	 *                                      EEH_Template::display_template() method or simply return it
+	 * @param  boolean     $return_string   whether to send output immediately to screen, or capture and return as a
+	 *                                      string
+	 * @param boolean      $check_if_custom If TRUE, this flags this method to return boolean for whether this will
+	 *                                      generate a custom template or not. Used in places where you don't actually
+	 *                                      load the template, you just want to know if there's a custom version of it.
+	 * @return mixed
+	 */
+	public static function locate_template(
+		$templates = array(),
+		$template_args = array(),
+		$load = true,
+		$return_string = true,
+		$check_if_custom = false
+	) {
+		// first use WP locate_template to check for template in the current theme folder
+		$template_path = locate_template($templates);
+
+		if ($check_if_custom && ! empty($template_path)) {
+			return true;
+		}
+
+		// not in the theme
+		if (empty($template_path)) {
+			// not even a template to look for ?
+			if (empty($templates)) {
+				// get post_type
+				$post_type = EE_Registry::instance()->REQ->get('post_type');
+				// get array of EE Custom Post Types
+				$EE_CPTs = EE_Register_CPTs::get_CPTs();
+				// build template name based on request
+				if (isset($EE_CPTs[$post_type])) {
+					$archive_or_single = is_archive() ? 'archive' : '';
+					$archive_or_single = is_single() ? 'single' : $archive_or_single;
+					$templates         = $archive_or_single . '-' . $post_type . '.php';
+				}
+			}
+			// currently active EE template theme
+			$current_theme = EE_Config::get_current_theme();
+
+			// array of paths to folders that may contain templates
+			$template_folder_paths = array(
+				// first check the /wp-content/uploads/espresso/templates/(current EE theme)/  folder for an EE theme template file
+				EVENT_ESPRESSO_TEMPLATE_DIR . $current_theme,
+				// then in the root of the /wp-content/uploads/espresso/templates/ folder
+				EVENT_ESPRESSO_TEMPLATE_DIR,
+			);
+
+			//add core plugin folders for checking only if we're not $check_if_custom
+			if ( ! $check_if_custom) {
+				$core_paths            = array(
+					// in the  /wp-content/plugins/(EE4 folder)/public/(current EE theme)/ folder within the plugin
+					EE_PUBLIC . $current_theme,
+					// in the  /wp-content/plugins/(EE4 folder)/core/templates/(current EE theme)/ folder within the plugin
+					EE_TEMPLATES . $current_theme,
+					// or maybe relative from the plugin root: /wp-content/plugins/(EE4 folder)/
+					EE_PLUGIN_DIR_PATH,
+				);
+				$template_folder_paths = array_merge($template_folder_paths, $core_paths);
+			}
+
+			// now filter that array
+			$template_folder_paths = apply_filters('FHEE__EEH_Template__locate_template__template_folder_paths',
+				$template_folder_paths);
+			$templates             = is_array($templates) ? $templates : array($templates);
+			$template_folder_paths = is_array($template_folder_paths) ? $template_folder_paths : array($template_folder_paths);
+			// array to hold all possible template paths
+			$full_template_paths = array();
+
+			// loop through $templates
+			foreach ($templates as $template) {
+				// normalize directory separators
+				$template                      = EEH_File::standardise_directory_separators($template);
+				$file_name                     = basename($template);
+				$template_path_minus_file_name = substr($template, 0, (strlen($file_name) * -1));
+				// while looping through all template folder paths
+				foreach ($template_folder_paths as $template_folder_path) {
+					// normalize directory separators
+					$template_folder_path = EEH_File::standardise_directory_separators($template_folder_path);
+					// determine if any common base path exists between the two paths
+					$common_base_path = EEH_Template::_find_common_base_path(
+						array($template_folder_path, $template_path_minus_file_name)
+					);
+					if ($common_base_path !== '') {
+						// both paths have a common base, so just tack the filename onto our search path
+						$resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $file_name;
+					} else {
+						// no common base path, so let's just concatenate
+						$resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $template;
+					}
+					// build up our template locations array by adding our resolved paths
+					$full_template_paths[] = $resolved_path;
+				}
+				// if $template is an absolute path, then we'll tack it onto the start of our array so that it gets searched first
+				array_unshift($full_template_paths, $template);
+				// path to the directory of the current theme: /wp-content/themes/(current WP theme)/
+				array_unshift($full_template_paths, get_stylesheet_directory() . DS . $file_name);
+			}
+			// filter final array of full template paths
+			$full_template_paths = apply_filters('FHEE__EEH_Template__locate_template__full_template_paths',
+				$full_template_paths, $file_name);
+			// now loop through our final array of template location paths and check each location
+			foreach ((array)$full_template_paths as $full_template_path) {
+				if (is_readable($full_template_path)) {
+					$template_path = str_replace(array('\\', '/'), DIRECTORY_SEPARATOR, $full_template_path);
+					break;
+				}
+			}
+		}
+
+		// hook that can be used to display the full template path that will be used
+		do_action('AHEE__EEH_Template__locate_template__full_template_path', $template_path);
+
+		// if we got it and you want to see it...
+		if ($template_path && $load && ! $check_if_custom) {
+			if ($return_string) {
+				return EEH_Template::display_template($template_path, $template_args, true);
+			} else {
+				EEH_Template::display_template($template_path, $template_args, false);
+			}
+		}
+		return $check_if_custom && ! empty($template_path) ? true : $template_path;
+	}
+
+
+	/**
+	 * _find_common_base_path
+	 * given two paths, this determines if there is a common base path between the two
+	 *
+	 * @param array $paths
+	 * @return string
+	 */
+	protected static function _find_common_base_path($paths)
+	{
+		$last_offset      = 0;
+		$common_base_path = '';
+		while (($index = strpos($paths[0], DS, $last_offset)) !== false) {
+			$dir_length = $index - $last_offset + 1;
+			$directory  = substr($paths[0], $last_offset, $dir_length);
+			foreach ($paths as $path) {
+				if (substr($path, $last_offset, $dir_length) != $directory) {
+					return $common_base_path;
+				}
+			}
+			$common_base_path .= $directory;
+			$last_offset = $index + 1;
+		}
+		return substr($common_base_path, 0, -1);
+	}
+
+
+	/**
+	 * load and display a template
+	 *
+	 * @param bool|string $template_path server path to the file to be loaded, including file name and extension
+	 * @param  array      $template_args an array of arguments to be extracted for use in the template
+	 * @param  boolean    $return_string whether to send output immediately to screen, or capture and return as a string
+	 * @param bool        $throw_exceptions if set to true, will throw an exception if the template is either
+	 *                                      not found or is not readable
+	 * @return mixed string
+	 * @throws \DomainException
+	 */
 	public static function display_template(
-        $template_path    = false,
-        $template_args    = array(),
-        $return_string    = false,
-        $throw_exceptions = false
-    ) {
-
-        /**
-         * These two filters are intended for last minute changes to templates being loaded and/or template arg
-         * modifications.  NOTE... modifying these things can cause breakage as most templates running through
-         * the display_template method are templates we DON'T want modified (usually because of js
-         * dependencies etc).  So unless you know what you are doing, do NOT filter templates or template args
-         * using this.
-         *
-         * @since 4.6.0
-         */
-        $template_path = (string) apply_filters('FHEE__EEH_Template__display_template__template_path', $template_path);
-        $template_args = (array) apply_filters('FHEE__EEH_Template__display_template__template_args', $template_args);
-
-        // you gimme nuttin - YOU GET NUTTIN !!
-        if ( ! $template_path || ! is_readable($template_path)) {
-            return '';
-        }
-        // if $template_args are not in an array, then make it so
-        if ( ! is_array($template_args) && ! is_object($template_args)) {
-            $template_args = array($template_args);
-        }
-        extract( $template_args, EXTR_SKIP );
-        // ignore whether template is accessible ?
-        if ( $throw_exceptions && ! is_readable( $template_path ) ) {
-            throw new \DomainException(
-                    esc_html__(
-                            'Invalid, unreadable, or missing file.',
-                            'event_espresso'
-                    )
-            );
-        }
-
-
-        if ($return_string) {
-            // because we want to return a string, we are going to capture the output
-            ob_start();
-            include($template_path);
-            return ob_get_clean();
-        } else {
-            include($template_path);
-        }
-        return '';
-    }
-
-
-    /**
-     * get_object_css_class - attempts to generate a css class based on the type of EE object passed
-     *
-     * @param EE_Base_Class $object the EE object the css class is being generated for
-     * @param  string       $prefix added to the beginning of the generated class
-     * @param  string       $suffix added to the end of the generated class
-     * @return string
-     */
-    public static function get_object_css_class($object = null, $prefix = '', $suffix = '')
-    {
-        // in the beginning...
-        $prefix = ! empty($prefix) ? rtrim($prefix, '-') . '-' : '';
-        // da muddle
-        $class = '';
-        // the end
-        $suffix = ! empty($suffix) ? '-' . ltrim($suffix, '-') : '';
-        // is the passed object an EE object ?
-        if ($object instanceof EE_Base_Class) {
-            // grab the exact type of object
-            $obj_class = get_class($object);
-            // depending on the type of object...
-            switch ($obj_class) {
-                // no specifics just yet...
-                default :
-                    $class = strtolower(str_replace('_', '-', $obj_class));
-                    $class .= method_exists($obj_class, 'name') ? '-' . sanitize_title($object->name()) : '';
-
-            }
-        }
-        return $prefix . $class . $suffix;
-    }
-
-
-
-    /**
-     * EEH_Template::format_currency
-     * This helper takes a raw float value and formats it according to the default config country currency settings, or
-     * the country currency settings from the supplied country ISO code
-     *
-     * @param  float   $amount       raw money value
-     * @param  boolean $return_raw   whether to return the formatted float value only with no currency sign or code
-     * @param  boolean $display_code whether to display the country code (USD). Default = TRUE
-     * @param string   $CNT_ISO      2 letter ISO code for a country
-     * @param string   $cur_code_span_class
-     * @return string        the html output for the formatted money value
-     * @throws \EE_Error
-     */
-    public static function format_currency(
-        $amount = null,
-        $return_raw = false,
-        $display_code = true,
-        $CNT_ISO = '',
-        $cur_code_span_class = 'currency-code'
-    ) {
-        // ensure amount was received
-        if ($amount === null) {
-            $msg = __('In order to format currency, an amount needs to be passed.', 'event_espresso');
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return '';
-        }
-        //ensure amount is float
-        $amount  = apply_filters('FHEE__EEH_Template__format_currency__raw_amount', (float)$amount);
-        $CNT_ISO = apply_filters('FHEE__EEH_Template__format_currency__CNT_ISO', $CNT_ISO, $amount);
-        // filter raw amount (allows 0.00 to be changed to "free" for example)
-        $amount_formatted = apply_filters('FHEE__EEH_Template__format_currency__amount', $amount, $return_raw);
-        // still a number or was amount converted to a string like "free" ?
-        if (is_float($amount_formatted)) {
-            // was a country ISO code passed ? if so generate currency config object for that country
-            $mny = $CNT_ISO !== '' ? new EE_Currency_Config($CNT_ISO) : null;
-            // verify results
-            if ( ! $mny instanceof EE_Currency_Config) {
-                // set default config country currency settings
-                $mny = EE_Registry::instance()->CFG->currency instanceof EE_Currency_Config
-                    ? EE_Registry::instance()->CFG->currency
-                    : new EE_Currency_Config();
-            }
-            // format float
-            $amount_formatted = number_format($amount, $mny->dec_plc, $mny->dec_mrk, $mny->thsnds);
-            // add formatting ?
-            if ( ! $return_raw) {
-                // add currency sign
-                if ($mny->sign_b4) {
-                    if ($amount >= 0) {
-                        $amount_formatted = $mny->sign . $amount_formatted;
-                    } else {
-                        $amount_formatted = '-' . $mny->sign . str_replace('-', '', $amount_formatted);
-                    }
-
-                } else {
-                    $amount_formatted = $amount_formatted . $mny->sign;
-                }
-
-                // filter to allow global setting of display_code
-                $display_code = apply_filters('FHEE__EEH_Template__format_currency__display_code', $display_code);
-
-                // add currency code ?
-                $amount_formatted = $display_code ? $amount_formatted . ' <span class="' . $cur_code_span_class . '">(' . $mny->code . ')</span>' : $amount_formatted;
-            }
-            // filter results
-            $amount_formatted = apply_filters('FHEE__EEH_Template__format_currency__amount_formatted',
-                $amount_formatted, $mny, $return_raw);
-        }
-        // clean up vars
-        unset($mny);
-        // return formatted currency amount
-        return $amount_formatted;
-    }
-
-
-    /**
-     * This function is used for outputting the localized label for a given status id in the schema requested (and
-     * possibly plural).  The intended use of this function is only for cases where wanting a label outside of a
-     * related status model or model object (i.e. in documentation etc.)
-     *
-     * @param  string  $status_id Status ID matching a registered status in the esp_status table.  If there is no
-     *                            match, then 'Unknown' will be returned.
-     * @param  boolean $plural    Whether to return plural or not
-     * @param  string  $schema    'UPPER', 'lower', or 'Sentence'
-     * @return string             The localized label for the status id.
-     */
-    public static function pretty_status($status_id, $plural = false, $schema = 'upper')
-    {
-        /** @type EEM_Status $EEM_Status */
-        $EEM_Status = EE_Registry::instance()->load_model('Status');
-        $status     = $EEM_Status->localized_status(array($status_id => __('unknown', 'event_espresso')), $plural,
-            $schema);
-        return $status[$status_id];
-    }
-
-
-    /**
-     * This helper just returns a button or link for the given parameters
-     *
-     * @param  string $url   the url for the link, note that `esc_url` will be called on it
-     * @param  string $label What is the label you want displayed for the button
-     * @param  string $class what class is used for the button (defaults to 'button-primary')
-     * @param string  $icon
-     * @param string  $title
-     * @return string the html output for the button
-     */
-    public static function get_button_or_link($url, $label, $class = 'button-primary', $icon = '', $title = '')
-    {
-        $icon_html = '';
-        if ( ! empty($icon)) {
-            $dashicons = preg_split("(ee-icon |dashicons )", $icon);
-            $dashicons = array_filter($dashicons);
-            $count     = count($dashicons);
-            $icon_html .= $count > 1 ? '<span class="ee-composite-dashicon">' : '';
-            foreach ($dashicons as $dashicon) {
-                $type = strpos($dashicon, 'ee-icon') !== false ? 'ee-icon ' : 'dashicons ';
-                $icon_html .= '<span class="' . $type . $dashicon . '"></span>';
-            }
-            $icon_html .= $count > 1 ? '</span>' : '';
-        }
-        $label  = ! empty($icon) ? $icon_html . $label : $label;
-        $button = '<a id="' . sanitize_title_with_dashes($label) . '" href="' . esc_url($url) . '" class="' . $class . '" title="' . $title . '">' . $label . '</a>';
-        return $button;
-    }
-
-
-    /**
-     * This returns a generated link that will load the related help tab on admin pages.
-     *
-     * @param  string     $help_tab_id the id for the connected help tab
-     * @param bool|string $page        The page identifier for the page the help tab is on
-     * @param bool|string $action      The action (route) for the admin page the help tab is on.
-     * @param bool|string $icon_style  (optional) include css class for the style you want to use for the help icon.
-     * @param bool|string $help_text   (optional) send help text you want to use for the link if default not to be used
-     * @return string              generated link
-     */
-    public static function get_help_tab_link(
-        $help_tab_id,
-        $page = false,
-        $action = false,
-        $icon_style = false,
-        $help_text = false
-    ) {
-
-        if ( ! $page) {
-            $page = isset($_REQUEST['page']) && ! empty($_REQUEST['page']) ? sanitize_key($_REQUEST['page']) : $page;
-        }
-
-        if ( ! $action) {
-            $action = isset($_REQUEST['action']) && ! empty($_REQUEST['action']) ? sanitize_key($_REQUEST['action']) : $action;
-        }
-
-        $action = empty($action) ? 'default' : $action;
-
-
-        $help_tab_lnk = $page . '-' . $action . '-' . $help_tab_id;
-        $icon         = ! $icon_style ? ' dashicons-editor-help' : $icon_style;
-        $help_text    = ! $help_text ? '' : $help_text;
-        return '<a id="' . $help_tab_lnk . '" class="ee-clickable dashicons espresso-help-tab-lnk ee-icon-size-22' . $icon . '" title="' . esc_attr__('Click to open the \'Help\' tab for more information about this feature.',
-                'event_espresso') . '" > ' . $help_text . ' </a>';
-    }
-
-
-    /**
-     * This helper generates the html structure for the jquery joyride plugin with the given params.
-     *
-     * @link http://zurb.com/playground/jquery-joyride-feature-tour-plugin
-     * @see  EE_Admin_Page->_stop_callback() for the construct expected for the $stops param.
-     * @param EE_Help_Tour
-     * @return string         html
-     */
-    public static function help_tour_stops_generator(EE_Help_Tour $tour)
-    {
-        $id    = $tour->get_slug();
-        $stops = $tour->get_stops();
-
-        $content = '<ol style="display:none" id="' . $id . '">';
-
-        foreach ($stops as $stop) {
-            $data_id    = ! empty($stop['id']) ? ' data-id="' . $stop['id'] . '"' : '';
-            $data_class = empty($data_id) && ! empty($stop['class']) ? ' data-class="' . $stop['class'] . '"' : '';
-
-            //if container is set to modal then let's make sure we set the options accordingly
-            if (empty($data_id) && empty($data_class)) {
-                $stop['options']['modal']  = true;
-                $stop['options']['expose'] = true;
-            }
-
-            $custom_class  = ! empty($stop['custom_class']) ? ' class="' . $stop['custom_class'] . '"' : '';
-            $button_text   = ! empty($stop['button_text']) ? ' data-button="' . $stop['button_text'] . '"' : '';
-            $inner_content = isset($stop['content']) ? $stop['content'] : '';
-
-            //options
-            if (isset($stop['options']) && is_array($stop['options'])) {
-                $options = ' data-options="';
-                foreach ($stop['options'] as $option => $value) {
-                    $options .= $option . ':' . $value . ';';
-                }
-                $options .= '"';
-            } else {
-                $options = '';
-            }
-
-            //let's put all together
-            $content .= '<li' . $data_id . $data_class . $custom_class . $button_text . $options . '>' . $inner_content . '</li>';
-        }
-
-        $content .= '</ol>';
-        return $content;
-    }
-
-
-    /**
-     * This is a helper method to generate a status legend for a given status array.
-     * Note this will only work if the incoming statuses have a key in the EEM_Status->localized_status() methods
-     * status_array.
-     *
-     * @param  array  $status_array  array of statuses that will make up the legend. In format:
-     *                               array(
-     *                               'status_item' => 'status_name'
-     *                               )
-     * @param  string $active_status This is used to indicate what the active status is IF that is to be highlighted in
-     *                               the legend.
-     * @throws EE_Error
-     * @return string               html structure for status.
-     */
-    public static function status_legend($status_array, $active_status = '')
-    {
-        if ( ! is_array($status_array)) {
-            throw new EE_Error(esc_html__('The EEH_Template::status_legend helper required the incoming status_array argument to be an array!',
-                'event_espresso'));
-        }
-
-        $setup_array = array();
-        foreach ($status_array as $item => $status) {
-            $setup_array[$item] = array(
-                'class'  => 'ee-status-legend ee-status-legend-' . $status,
-                'desc'   => EEH_Template::pretty_status($status, false, 'sentence'),
-                'status' => $status,
-            );
-        }
-
-        $content = '<div class="ee-list-table-legend-container">' . "\n";
-        $content .= '<h4 class="status-legend-title">' . esc_html__('Status Legend', 'event_espresso') . '</h4>' . "\n";
-        $content .= '<dl class="ee-list-table-legend">' . "\n\t";
-        foreach ($setup_array as $item => $details) {
-            $active_class = $active_status == $details['status'] ? ' class="ee-is-active-status"' : '';
-            $content .= '<dt id="ee-legend-item-tooltip-' . $item . '"' . $active_class . '>' . "\n\t\t";
-            $content .= '<span class="' . $details['class'] . '"></span>' . "\n\t\t";
-            $content .= '<span class="ee-legend-description">' . $details['desc'] . '</span>' . "\n\t";
-            $content .= '</dt>' . "\n";
-        }
-        $content .= '</dl>' . "\n";
-        $content .= '</div>' . "\n";
-        return $content;
-    }
-
-
-    /**
-     * Gets HTML for laying out a deeply-nested array (and objects) in a format
-     * that's nice for presenting in the wp admin
-     *
-     * @param mixed $data
-     * @return string
-     */
-    public static function layout_array_as_table($data)
-    {
-        if (is_object($data) || $data instanceof __PHP_Incomplete_Class) {
-            $data = (array)$data;
-        }
-        ob_start();
-        if (is_array($data)) {
-            if (EEH_Array::is_associative_array($data)) {
-                ?>
+		$template_path    = false,
+		$template_args    = array(),
+		$return_string    = false,
+		$throw_exceptions = false
+	) {
+
+		/**
+		 * These two filters are intended for last minute changes to templates being loaded and/or template arg
+		 * modifications.  NOTE... modifying these things can cause breakage as most templates running through
+		 * the display_template method are templates we DON'T want modified (usually because of js
+		 * dependencies etc).  So unless you know what you are doing, do NOT filter templates or template args
+		 * using this.
+		 *
+		 * @since 4.6.0
+		 */
+		$template_path = (string) apply_filters('FHEE__EEH_Template__display_template__template_path', $template_path);
+		$template_args = (array) apply_filters('FHEE__EEH_Template__display_template__template_args', $template_args);
+
+		// you gimme nuttin - YOU GET NUTTIN !!
+		if ( ! $template_path || ! is_readable($template_path)) {
+			return '';
+		}
+		// if $template_args are not in an array, then make it so
+		if ( ! is_array($template_args) && ! is_object($template_args)) {
+			$template_args = array($template_args);
+		}
+		extract( $template_args, EXTR_SKIP );
+		// ignore whether template is accessible ?
+		if ( $throw_exceptions && ! is_readable( $template_path ) ) {
+			throw new \DomainException(
+					esc_html__(
+							'Invalid, unreadable, or missing file.',
+							'event_espresso'
+					)
+			);
+		}
+
+
+		if ($return_string) {
+			// because we want to return a string, we are going to capture the output
+			ob_start();
+			include($template_path);
+			return ob_get_clean();
+		} else {
+			include($template_path);
+		}
+		return '';
+	}
+
+
+	/**
+	 * get_object_css_class - attempts to generate a css class based on the type of EE object passed
+	 *
+	 * @param EE_Base_Class $object the EE object the css class is being generated for
+	 * @param  string       $prefix added to the beginning of the generated class
+	 * @param  string       $suffix added to the end of the generated class
+	 * @return string
+	 */
+	public static function get_object_css_class($object = null, $prefix = '', $suffix = '')
+	{
+		// in the beginning...
+		$prefix = ! empty($prefix) ? rtrim($prefix, '-') . '-' : '';
+		// da muddle
+		$class = '';
+		// the end
+		$suffix = ! empty($suffix) ? '-' . ltrim($suffix, '-') : '';
+		// is the passed object an EE object ?
+		if ($object instanceof EE_Base_Class) {
+			// grab the exact type of object
+			$obj_class = get_class($object);
+			// depending on the type of object...
+			switch ($obj_class) {
+				// no specifics just yet...
+				default :
+					$class = strtolower(str_replace('_', '-', $obj_class));
+					$class .= method_exists($obj_class, 'name') ? '-' . sanitize_title($object->name()) : '';
+
+			}
+		}
+		return $prefix . $class . $suffix;
+	}
+
+
+
+	/**
+	 * EEH_Template::format_currency
+	 * This helper takes a raw float value and formats it according to the default config country currency settings, or
+	 * the country currency settings from the supplied country ISO code
+	 *
+	 * @param  float   $amount       raw money value
+	 * @param  boolean $return_raw   whether to return the formatted float value only with no currency sign or code
+	 * @param  boolean $display_code whether to display the country code (USD). Default = TRUE
+	 * @param string   $CNT_ISO      2 letter ISO code for a country
+	 * @param string   $cur_code_span_class
+	 * @return string        the html output for the formatted money value
+	 * @throws \EE_Error
+	 */
+	public static function format_currency(
+		$amount = null,
+		$return_raw = false,
+		$display_code = true,
+		$CNT_ISO = '',
+		$cur_code_span_class = 'currency-code'
+	) {
+		// ensure amount was received
+		if ($amount === null) {
+			$msg = __('In order to format currency, an amount needs to be passed.', 'event_espresso');
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return '';
+		}
+		//ensure amount is float
+		$amount  = apply_filters('FHEE__EEH_Template__format_currency__raw_amount', (float)$amount);
+		$CNT_ISO = apply_filters('FHEE__EEH_Template__format_currency__CNT_ISO', $CNT_ISO, $amount);
+		// filter raw amount (allows 0.00 to be changed to "free" for example)
+		$amount_formatted = apply_filters('FHEE__EEH_Template__format_currency__amount', $amount, $return_raw);
+		// still a number or was amount converted to a string like "free" ?
+		if (is_float($amount_formatted)) {
+			// was a country ISO code passed ? if so generate currency config object for that country
+			$mny = $CNT_ISO !== '' ? new EE_Currency_Config($CNT_ISO) : null;
+			// verify results
+			if ( ! $mny instanceof EE_Currency_Config) {
+				// set default config country currency settings
+				$mny = EE_Registry::instance()->CFG->currency instanceof EE_Currency_Config
+					? EE_Registry::instance()->CFG->currency
+					: new EE_Currency_Config();
+			}
+			// format float
+			$amount_formatted = number_format($amount, $mny->dec_plc, $mny->dec_mrk, $mny->thsnds);
+			// add formatting ?
+			if ( ! $return_raw) {
+				// add currency sign
+				if ($mny->sign_b4) {
+					if ($amount >= 0) {
+						$amount_formatted = $mny->sign . $amount_formatted;
+					} else {
+						$amount_formatted = '-' . $mny->sign . str_replace('-', '', $amount_formatted);
+					}
+
+				} else {
+					$amount_formatted = $amount_formatted . $mny->sign;
+				}
+
+				// filter to allow global setting of display_code
+				$display_code = apply_filters('FHEE__EEH_Template__format_currency__display_code', $display_code);
+
+				// add currency code ?
+				$amount_formatted = $display_code ? $amount_formatted . ' <span class="' . $cur_code_span_class . '">(' . $mny->code . ')</span>' : $amount_formatted;
+			}
+			// filter results
+			$amount_formatted = apply_filters('FHEE__EEH_Template__format_currency__amount_formatted',
+				$amount_formatted, $mny, $return_raw);
+		}
+		// clean up vars
+		unset($mny);
+		// return formatted currency amount
+		return $amount_formatted;
+	}
+
+
+	/**
+	 * This function is used for outputting the localized label for a given status id in the schema requested (and
+	 * possibly plural).  The intended use of this function is only for cases where wanting a label outside of a
+	 * related status model or model object (i.e. in documentation etc.)
+	 *
+	 * @param  string  $status_id Status ID matching a registered status in the esp_status table.  If there is no
+	 *                            match, then 'Unknown' will be returned.
+	 * @param  boolean $plural    Whether to return plural or not
+	 * @param  string  $schema    'UPPER', 'lower', or 'Sentence'
+	 * @return string             The localized label for the status id.
+	 */
+	public static function pretty_status($status_id, $plural = false, $schema = 'upper')
+	{
+		/** @type EEM_Status $EEM_Status */
+		$EEM_Status = EE_Registry::instance()->load_model('Status');
+		$status     = $EEM_Status->localized_status(array($status_id => __('unknown', 'event_espresso')), $plural,
+			$schema);
+		return $status[$status_id];
+	}
+
+
+	/**
+	 * This helper just returns a button or link for the given parameters
+	 *
+	 * @param  string $url   the url for the link, note that `esc_url` will be called on it
+	 * @param  string $label What is the label you want displayed for the button
+	 * @param  string $class what class is used for the button (defaults to 'button-primary')
+	 * @param string  $icon
+	 * @param string  $title
+	 * @return string the html output for the button
+	 */
+	public static function get_button_or_link($url, $label, $class = 'button-primary', $icon = '', $title = '')
+	{
+		$icon_html = '';
+		if ( ! empty($icon)) {
+			$dashicons = preg_split("(ee-icon |dashicons )", $icon);
+			$dashicons = array_filter($dashicons);
+			$count     = count($dashicons);
+			$icon_html .= $count > 1 ? '<span class="ee-composite-dashicon">' : '';
+			foreach ($dashicons as $dashicon) {
+				$type = strpos($dashicon, 'ee-icon') !== false ? 'ee-icon ' : 'dashicons ';
+				$icon_html .= '<span class="' . $type . $dashicon . '"></span>';
+			}
+			$icon_html .= $count > 1 ? '</span>' : '';
+		}
+		$label  = ! empty($icon) ? $icon_html . $label : $label;
+		$button = '<a id="' . sanitize_title_with_dashes($label) . '" href="' . esc_url($url) . '" class="' . $class . '" title="' . $title . '">' . $label . '</a>';
+		return $button;
+	}
+
+
+	/**
+	 * This returns a generated link that will load the related help tab on admin pages.
+	 *
+	 * @param  string     $help_tab_id the id for the connected help tab
+	 * @param bool|string $page        The page identifier for the page the help tab is on
+	 * @param bool|string $action      The action (route) for the admin page the help tab is on.
+	 * @param bool|string $icon_style  (optional) include css class for the style you want to use for the help icon.
+	 * @param bool|string $help_text   (optional) send help text you want to use for the link if default not to be used
+	 * @return string              generated link
+	 */
+	public static function get_help_tab_link(
+		$help_tab_id,
+		$page = false,
+		$action = false,
+		$icon_style = false,
+		$help_text = false
+	) {
+
+		if ( ! $page) {
+			$page = isset($_REQUEST['page']) && ! empty($_REQUEST['page']) ? sanitize_key($_REQUEST['page']) : $page;
+		}
+
+		if ( ! $action) {
+			$action = isset($_REQUEST['action']) && ! empty($_REQUEST['action']) ? sanitize_key($_REQUEST['action']) : $action;
+		}
+
+		$action = empty($action) ? 'default' : $action;
+
+
+		$help_tab_lnk = $page . '-' . $action . '-' . $help_tab_id;
+		$icon         = ! $icon_style ? ' dashicons-editor-help' : $icon_style;
+		$help_text    = ! $help_text ? '' : $help_text;
+		return '<a id="' . $help_tab_lnk . '" class="ee-clickable dashicons espresso-help-tab-lnk ee-icon-size-22' . $icon . '" title="' . esc_attr__('Click to open the \'Help\' tab for more information about this feature.',
+				'event_espresso') . '" > ' . $help_text . ' </a>';
+	}
+
+
+	/**
+	 * This helper generates the html structure for the jquery joyride plugin with the given params.
+	 *
+	 * @link http://zurb.com/playground/jquery-joyride-feature-tour-plugin
+	 * @see  EE_Admin_Page->_stop_callback() for the construct expected for the $stops param.
+	 * @param EE_Help_Tour
+	 * @return string         html
+	 */
+	public static function help_tour_stops_generator(EE_Help_Tour $tour)
+	{
+		$id    = $tour->get_slug();
+		$stops = $tour->get_stops();
+
+		$content = '<ol style="display:none" id="' . $id . '">';
+
+		foreach ($stops as $stop) {
+			$data_id    = ! empty($stop['id']) ? ' data-id="' . $stop['id'] . '"' : '';
+			$data_class = empty($data_id) && ! empty($stop['class']) ? ' data-class="' . $stop['class'] . '"' : '';
+
+			//if container is set to modal then let's make sure we set the options accordingly
+			if (empty($data_id) && empty($data_class)) {
+				$stop['options']['modal']  = true;
+				$stop['options']['expose'] = true;
+			}
+
+			$custom_class  = ! empty($stop['custom_class']) ? ' class="' . $stop['custom_class'] . '"' : '';
+			$button_text   = ! empty($stop['button_text']) ? ' data-button="' . $stop['button_text'] . '"' : '';
+			$inner_content = isset($stop['content']) ? $stop['content'] : '';
+
+			//options
+			if (isset($stop['options']) && is_array($stop['options'])) {
+				$options = ' data-options="';
+				foreach ($stop['options'] as $option => $value) {
+					$options .= $option . ':' . $value . ';';
+				}
+				$options .= '"';
+			} else {
+				$options = '';
+			}
+
+			//let's put all together
+			$content .= '<li' . $data_id . $data_class . $custom_class . $button_text . $options . '>' . $inner_content . '</li>';
+		}
+
+		$content .= '</ol>';
+		return $content;
+	}
+
+
+	/**
+	 * This is a helper method to generate a status legend for a given status array.
+	 * Note this will only work if the incoming statuses have a key in the EEM_Status->localized_status() methods
+	 * status_array.
+	 *
+	 * @param  array  $status_array  array of statuses that will make up the legend. In format:
+	 *                               array(
+	 *                               'status_item' => 'status_name'
+	 *                               )
+	 * @param  string $active_status This is used to indicate what the active status is IF that is to be highlighted in
+	 *                               the legend.
+	 * @throws EE_Error
+	 * @return string               html structure for status.
+	 */
+	public static function status_legend($status_array, $active_status = '')
+	{
+		if ( ! is_array($status_array)) {
+			throw new EE_Error(esc_html__('The EEH_Template::status_legend helper required the incoming status_array argument to be an array!',
+				'event_espresso'));
+		}
+
+		$setup_array = array();
+		foreach ($status_array as $item => $status) {
+			$setup_array[$item] = array(
+				'class'  => 'ee-status-legend ee-status-legend-' . $status,
+				'desc'   => EEH_Template::pretty_status($status, false, 'sentence'),
+				'status' => $status,
+			);
+		}
+
+		$content = '<div class="ee-list-table-legend-container">' . "\n";
+		$content .= '<h4 class="status-legend-title">' . esc_html__('Status Legend', 'event_espresso') . '</h4>' . "\n";
+		$content .= '<dl class="ee-list-table-legend">' . "\n\t";
+		foreach ($setup_array as $item => $details) {
+			$active_class = $active_status == $details['status'] ? ' class="ee-is-active-status"' : '';
+			$content .= '<dt id="ee-legend-item-tooltip-' . $item . '"' . $active_class . '>' . "\n\t\t";
+			$content .= '<span class="' . $details['class'] . '"></span>' . "\n\t\t";
+			$content .= '<span class="ee-legend-description">' . $details['desc'] . '</span>' . "\n\t";
+			$content .= '</dt>' . "\n";
+		}
+		$content .= '</dl>' . "\n";
+		$content .= '</div>' . "\n";
+		return $content;
+	}
+
+
+	/**
+	 * Gets HTML for laying out a deeply-nested array (and objects) in a format
+	 * that's nice for presenting in the wp admin
+	 *
+	 * @param mixed $data
+	 * @return string
+	 */
+	public static function layout_array_as_table($data)
+	{
+		if (is_object($data) || $data instanceof __PHP_Incomplete_Class) {
+			$data = (array)$data;
+		}
+		ob_start();
+		if (is_array($data)) {
+			if (EEH_Array::is_associative_array($data)) {
+				?>
                 <table class="widefat">
                     <tbody>
                     <?php
-                    foreach ($data as $data_key => $data_values) {
-                        ?>
+					foreach ($data as $data_key => $data_values) {
+						?>
                         <tr>
                             <td>
                                 <?php echo $data_key; ?>
@@ -712,248 +712,248 @@ 
                             </td>
                         </tr>
                         <?php
-                    } ?>
+					} ?>
                     </tbody>
                 </table>
                 <?php
-            } else {
-                ?>
+			} else {
+				?>
                 <ul>
                     <?php
-                    foreach ($data as $datum) {
-                        echo "<li>";
-                        echo self::layout_array_as_table($datum);
-                        echo "</li>";
-                    } ?>
+					foreach ($data as $datum) {
+						echo "<li>";
+						echo self::layout_array_as_table($datum);
+						echo "</li>";
+					} ?>
                 </ul>
                 <?php
-            }
-        } else {
-            //simple value
-            echo esc_html($data);
-        }
-        return ob_get_clean();
-    }
-
-
-    /**
-     * wrapper for self::get_paging_html() that simply echos the generated paging html
-     *
-     * @since 4.4.0
-     * @see   self:get_paging_html() for argument docs.
-     * @param        $total_items
-     * @param        $current
-     * @param        $per_page
-     * @param        $url
-     * @param bool   $show_num_field
-     * @param string $paged_arg_name
-     * @param array  $items_label
-     * @return string
-     */
-    public static function paging_html(
-        $total_items,
-        $current,
-        $per_page,
-        $url,
-        $show_num_field = true,
-        $paged_arg_name = 'paged',
-        $items_label = array()
-    ) {
-        echo self::get_paging_html($total_items, $current, $per_page, $url, $show_num_field, $paged_arg_name,
-            $items_label);
-    }
-
-
-    /**
-     * A method for generating paging similar to WP_List_Table
-     *
-     * @since    4.4.0
-     * @see      wp-admin/includes/class-wp-list-table.php WP_List_Table::pagination()
-     * @param  integer $total_items     How many total items there are to page.
-     * @param  integer $current         What the current page is.
-     * @param  integer $per_page        How many items per page.
-     * @param  string  $url             What the base url for page links is.
-     * @param  boolean $show_num_field  Whether to show the input for changing page number.
-     * @param  string  $paged_arg_name  The name of the key for the paged query argument.
-     * @param  array   $items_label     An array of singular/plural values for the items label:
-     *                                  array(
-     *                                  'single' => 'item',
-     *                                  'plural' => 'items'
-     *                                  )
-     * @return  string
-     */
-    public static function get_paging_html(
-        $total_items,
-        $current,
-        $per_page,
-        $url,
-        $show_num_field = true,
-        $paged_arg_name = 'paged',
-        $items_label = array()
-    ) {
-        $page_links     = array();
-        $disable_first  = $disable_last = '';
-        $total_items    = (int)$total_items;
-        $per_page       = (int)$per_page;
-        $current        = (int)$current;
-        $paged_arg_name = empty($paged_arg_name) ? 'paged' : sanitize_key($paged_arg_name);
-
-        //filter items_label
-        $items_label = apply_filters(
-            'FHEE__EEH_Template__get_paging_html__items_label',
-            $items_label
-        );
-
-        if (empty($items_label)
-            || ! is_array($items_label)
-            || ! isset($items_label['single'])
-            || ! isset($items_label['plural'])
-        ) {
-            $items_label = array(
-                'single' => __('1 item', 'event_espresso'),
-                'plural' => __('%s items', 'event_espresso'),
-            );
-        } else {
-            $items_label = array(
-                'single' => '1 ' . esc_html($items_label['single']),
-                'plural' => '%s ' . esc_html($items_label['plural']),
-            );
-        }
-
-        $total_pages = ceil($total_items / $per_page);
-
-        if ($total_pages <= 1) {
-            return '';
-        }
-
-        $item_label = $total_items > 1 ? sprintf($items_label['plural'], $total_items) : $items_label['single'];
-
-        $output = '<span class="displaying-num">' . $item_label . '</span>';
-
-        if ($current === 1) {
-            $disable_first = ' disabled';
-        }
-        if ($current == $total_pages) {
-            $disable_last = ' disabled';
-        }
-
-        $page_links[] = sprintf("<a class='%s' title='%s' href='%s'>%s</a>",
-            'first-page' . $disable_first,
-            esc_attr__('Go to the first page'),
-            esc_url(remove_query_arg($paged_arg_name, $url)),
-            '&laquo;'
-        );
-
-        $page_links[] = sprintf(
-            '<a class="%s" title="%s" href="%s">%s</a>',
-            'prev-page' . $disable_first,
-            esc_attr__('Go to the previous page'),
-            esc_url(add_query_arg($paged_arg_name, max(1, $current - 1), $url)),
-            '&lsaquo;'
-        );
-
-        if ( ! $show_num_field) {
-            $html_current_page = $current;
-        } else {
-            $html_current_page = sprintf("<input class='current-page' title='%s' type='text' name=$paged_arg_name value='%s' size='%d' />",
-                esc_attr__('Current page'),
-                $current,
-                strlen($total_pages)
-            );
-        }
-
-        $html_total_pages = sprintf(
-            '<span class="total-pages">%s</span>',
-            number_format_i18n($total_pages)
-        );
-        $page_links[]     = sprintf(
-            _x('%3$s%1$s of %2$s%4$s', 'paging'),
-            $html_current_page,
-            $html_total_pages,
-            '<span class="paging-input">',
-            '</span>'
-        );
-
-        $page_links[] = sprintf(
-            '<a class="%s" title="%s" href="%s">%s</a>',
-            'next-page' . $disable_last,
-            esc_attr__('Go to the next page'),
-            esc_url(add_query_arg($paged_arg_name, min($total_pages, $current + 1), $url)),
-            '&rsaquo;'
-        );
-
-        $page_links[] = sprintf(
-            '<a class="%s" title="%s" href="%s">%s</a>',
-            'last-page' . $disable_last,
-            esc_attr__('Go to the last page'),
-            esc_url(add_query_arg($paged_arg_name, $total_pages, $url)),
-            '&raquo;'
-        );
-
-        $output .= "\n" . '<span class="pagination-links">' . join("\n", $page_links) . '</span>';
-        // set page class
-        if ($total_pages) {
-            $page_class = $total_pages < 2 ? ' one-page' : '';
-        } else {
-            $page_class = ' no-pages';
-        }
-
-        return '<div class="tablenav"><div class="tablenav-pages' . $page_class . '">' . $output . '</div></div>';
-    }
-
-
-    /**
-     * @param string $wrap_class
-     * @param string $wrap_id
-     * @return string
-     */
-    public static function powered_by_event_espresso($wrap_class = '', $wrap_id = '', array $query_args = array())
-    {
-        $admin = is_admin() && ! (defined('DOING_AJAX') && DOING_AJAX);
-        if (
-            ! $admin &&
-            ! apply_filters(
-                'FHEE__EEH_Template__powered_by_event_espresso__show_reg_footer',
-                EE_Registry::instance()->CFG->admin->show_reg_footer
-            )
-        ) {
-            return '';
-        }
-        $tag        = $admin ? 'span' : 'div';
-        $attributes = ! empty($wrap_id) ? " id=\"{$wrap_id}\"" : '';
-        $wrap_class = $admin ? "{$wrap_class} float-left" : $wrap_class;
-        $attributes .= ! empty($wrap_class)
-            ? " class=\"{$wrap_class} powered-by-event-espresso-credit\""
-            : ' class="powered-by-event-espresso-credit"';
-        $query_args = array_merge(
-            array(
-                'ap_id'        => EE_Registry::instance()->CFG->admin->affiliate_id(),
-                'utm_source'   => 'powered_by_event_espresso',
-                'utm_medium'   => 'link',
-                'utm_campaign' => 'powered_by',
-            ),
-            $query_args
-        );
-        $powered_by = apply_filters('FHEE__EEH_Template__powered_by_event_espresso_text',
-            $admin ? 'Event Espresso - ' . EVENT_ESPRESSO_VERSION : 'Event Espresso');
-        $url        = add_query_arg($query_args, 'https://eventespresso.com/');
-        $url        = apply_filters('FHEE__EEH_Template__powered_by_event_espresso__url', $url);
-        return (string)apply_filters(
-            'FHEE__EEH_Template__powered_by_event_espresso__html',
-            sprintf(
-                esc_html_x(
-                    '%3$s%1$sOnline event registration and ticketing powered by %2$s%3$s',
-                    'Online event registration and ticketing powered by [link to eventespresso.com]',
-                    'event_espresso'
-                ),
-                "<{$tag}{$attributes}>",
-                "<a href=\"{$url}\" target=\"_blank\" rel=\"nofollow\">{$powered_by}</a></{$tag}>",
-                $admin ? '' : '<br />'
-            ),
-            $wrap_class,
-            $wrap_id
-        );
-    }
+			}
+		} else {
+			//simple value
+			echo esc_html($data);
+		}
+		return ob_get_clean();
+	}
+
+
+	/**
+	 * wrapper for self::get_paging_html() that simply echos the generated paging html
+	 *
+	 * @since 4.4.0
+	 * @see   self:get_paging_html() for argument docs.
+	 * @param        $total_items
+	 * @param        $current
+	 * @param        $per_page
+	 * @param        $url
+	 * @param bool   $show_num_field
+	 * @param string $paged_arg_name
+	 * @param array  $items_label
+	 * @return string
+	 */
+	public static function paging_html(
+		$total_items,
+		$current,
+		$per_page,
+		$url,
+		$show_num_field = true,
+		$paged_arg_name = 'paged',
+		$items_label = array()
+	) {
+		echo self::get_paging_html($total_items, $current, $per_page, $url, $show_num_field, $paged_arg_name,
+			$items_label);
+	}
+
+
+	/**
+	 * A method for generating paging similar to WP_List_Table
+	 *
+	 * @since    4.4.0
+	 * @see      wp-admin/includes/class-wp-list-table.php WP_List_Table::pagination()
+	 * @param  integer $total_items     How many total items there are to page.
+	 * @param  integer $current         What the current page is.
+	 * @param  integer $per_page        How many items per page.
+	 * @param  string  $url             What the base url for page links is.
+	 * @param  boolean $show_num_field  Whether to show the input for changing page number.
+	 * @param  string  $paged_arg_name  The name of the key for the paged query argument.
+	 * @param  array   $items_label     An array of singular/plural values for the items label:
+	 *                                  array(
+	 *                                  'single' => 'item',
+	 *                                  'plural' => 'items'
+	 *                                  )
+	 * @return  string
+	 */
+	public static function get_paging_html(
+		$total_items,
+		$current,
+		$per_page,
+		$url,
+		$show_num_field = true,
+		$paged_arg_name = 'paged',
+		$items_label = array()
+	) {
+		$page_links     = array();
+		$disable_first  = $disable_last = '';
+		$total_items    = (int)$total_items;
+		$per_page       = (int)$per_page;
+		$current        = (int)$current;
+		$paged_arg_name = empty($paged_arg_name) ? 'paged' : sanitize_key($paged_arg_name);
+
+		//filter items_label
+		$items_label = apply_filters(
+			'FHEE__EEH_Template__get_paging_html__items_label',
+			$items_label
+		);
+
+		if (empty($items_label)
+			|| ! is_array($items_label)
+			|| ! isset($items_label['single'])
+			|| ! isset($items_label['plural'])
+		) {
+			$items_label = array(
+				'single' => __('1 item', 'event_espresso'),
+				'plural' => __('%s items', 'event_espresso'),
+			);
+		} else {
+			$items_label = array(
+				'single' => '1 ' . esc_html($items_label['single']),
+				'plural' => '%s ' . esc_html($items_label['plural']),
+			);
+		}
+
+		$total_pages = ceil($total_items / $per_page);
+
+		if ($total_pages <= 1) {
+			return '';
+		}
+
+		$item_label = $total_items > 1 ? sprintf($items_label['plural'], $total_items) : $items_label['single'];
+
+		$output = '<span class="displaying-num">' . $item_label . '</span>';
+
+		if ($current === 1) {
+			$disable_first = ' disabled';
+		}
+		if ($current == $total_pages) {
+			$disable_last = ' disabled';
+		}
+
+		$page_links[] = sprintf("<a class='%s' title='%s' href='%s'>%s</a>",
+			'first-page' . $disable_first,
+			esc_attr__('Go to the first page'),
+			esc_url(remove_query_arg($paged_arg_name, $url)),
+			'&laquo;'
+		);
+
+		$page_links[] = sprintf(
+			'<a class="%s" title="%s" href="%s">%s</a>',
+			'prev-page' . $disable_first,
+			esc_attr__('Go to the previous page'),
+			esc_url(add_query_arg($paged_arg_name, max(1, $current - 1), $url)),
+			'&lsaquo;'
+		);
+
+		if ( ! $show_num_field) {
+			$html_current_page = $current;
+		} else {
+			$html_current_page = sprintf("<input class='current-page' title='%s' type='text' name=$paged_arg_name value='%s' size='%d' />",
+				esc_attr__('Current page'),
+				$current,
+				strlen($total_pages)
+			);
+		}
+
+		$html_total_pages = sprintf(
+			'<span class="total-pages">%s</span>',
+			number_format_i18n($total_pages)
+		);
+		$page_links[]     = sprintf(
+			_x('%3$s%1$s of %2$s%4$s', 'paging'),
+			$html_current_page,
+			$html_total_pages,
+			'<span class="paging-input">',
+			'</span>'
+		);
+
+		$page_links[] = sprintf(
+			'<a class="%s" title="%s" href="%s">%s</a>',
+			'next-page' . $disable_last,
+			esc_attr__('Go to the next page'),
+			esc_url(add_query_arg($paged_arg_name, min($total_pages, $current + 1), $url)),
+			'&rsaquo;'
+		);
+
+		$page_links[] = sprintf(
+			'<a class="%s" title="%s" href="%s">%s</a>',
+			'last-page' . $disable_last,
+			esc_attr__('Go to the last page'),
+			esc_url(add_query_arg($paged_arg_name, $total_pages, $url)),
+			'&raquo;'
+		);
+
+		$output .= "\n" . '<span class="pagination-links">' . join("\n", $page_links) . '</span>';
+		// set page class
+		if ($total_pages) {
+			$page_class = $total_pages < 2 ? ' one-page' : '';
+		} else {
+			$page_class = ' no-pages';
+		}
+
+		return '<div class="tablenav"><div class="tablenav-pages' . $page_class . '">' . $output . '</div></div>';
+	}
+
+
+	/**
+	 * @param string $wrap_class
+	 * @param string $wrap_id
+	 * @return string
+	 */
+	public static function powered_by_event_espresso($wrap_class = '', $wrap_id = '', array $query_args = array())
+	{
+		$admin = is_admin() && ! (defined('DOING_AJAX') && DOING_AJAX);
+		if (
+			! $admin &&
+			! apply_filters(
+				'FHEE__EEH_Template__powered_by_event_espresso__show_reg_footer',
+				EE_Registry::instance()->CFG->admin->show_reg_footer
+			)
+		) {
+			return '';
+		}
+		$tag        = $admin ? 'span' : 'div';
+		$attributes = ! empty($wrap_id) ? " id=\"{$wrap_id}\"" : '';
+		$wrap_class = $admin ? "{$wrap_class} float-left" : $wrap_class;
+		$attributes .= ! empty($wrap_class)
+			? " class=\"{$wrap_class} powered-by-event-espresso-credit\""
+			: ' class="powered-by-event-espresso-credit"';
+		$query_args = array_merge(
+			array(
+				'ap_id'        => EE_Registry::instance()->CFG->admin->affiliate_id(),
+				'utm_source'   => 'powered_by_event_espresso',
+				'utm_medium'   => 'link',
+				'utm_campaign' => 'powered_by',
+			),
+			$query_args
+		);
+		$powered_by = apply_filters('FHEE__EEH_Template__powered_by_event_espresso_text',
+			$admin ? 'Event Espresso - ' . EVENT_ESPRESSO_VERSION : 'Event Espresso');
+		$url        = add_query_arg($query_args, 'https://eventespresso.com/');
+		$url        = apply_filters('FHEE__EEH_Template__powered_by_event_espresso__url', $url);
+		return (string)apply_filters(
+			'FHEE__EEH_Template__powered_by_event_espresso__html',
+			sprintf(
+				esc_html_x(
+					'%3$s%1$sOnline event registration and ticketing powered by %2$s%3$s',
+					'Online event registration and ticketing powered by [link to eventespresso.com]',
+					'event_espresso'
+				),
+				"<{$tag}{$attributes}>",
+				"<a href=\"{$url}\" target=\"_blank\" rel=\"nofollow\">{$powered_by}</a></{$tag}>",
+				$admin ? '' : '<br />'
+			),
+			$wrap_class,
+			$wrap_id
+		);
+	}
 
 
 } //end EEH_Template class
@@ -962,33 +962,33 @@ 
 
 
 if ( ! function_exists('espresso_pagination')) {
-    /**
-     *    espresso_pagination
-     *
-     * @access    public
-     * @return    void
-     */
-    function espresso_pagination()
-    {
-        global $wp_query;
-        $big        = 999999999; // need an unlikely integer
-        $pagination = paginate_links(
-            array(
-                'base'         => str_replace($big, '%#%', esc_url(get_pagenum_link($big))),
-                'format'       => '?paged=%#%',
-                'current'      => max(1, get_query_var('paged')),
-                'total'        => $wp_query->max_num_pages,
-                'show_all'     => true,
-                'end_size'     => 10,
-                'mid_size'     => 6,
-                'prev_next'    => true,
-                'prev_text'    => __('&lsaquo; PREV', 'event_espresso'),
-                'next_text'    => __('NEXT &rsaquo;', 'event_espresso'),
-                'type'         => 'plain',
-                'add_args'     => false,
-                'add_fragment' => '',
-            )
-        );
-        echo ! empty($pagination) ? '<div class="ee-pagination-dv ee-clear-float">' . $pagination . '</div>' : '';
-    }
+	/**
+	 *    espresso_pagination
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	function espresso_pagination()
+	{
+		global $wp_query;
+		$big        = 999999999; // need an unlikely integer
+		$pagination = paginate_links(
+			array(
+				'base'         => str_replace($big, '%#%', esc_url(get_pagenum_link($big))),
+				'format'       => '?paged=%#%',
+				'current'      => max(1, get_query_var('paged')),
+				'total'        => $wp_query->max_num_pages,
+				'show_all'     => true,
+				'end_size'     => 10,
+				'mid_size'     => 6,
+				'prev_next'    => true,
+				'prev_text'    => __('&lsaquo; PREV', 'event_espresso'),
+				'next_text'    => __('NEXT &rsaquo;', 'event_espresso'),
+				'type'         => 'plain',
+				'add_args'     => false,
+				'add_fragment' => '',
+			)
+		);
+		echo ! empty($pagination) ? '<div class="ee-pagination-dv ee-clear-float">' . $pagination . '</div>' : '';
+	}
 }
\ No newline at end of file

Spacing +65 added lines, -65 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('NO direct script access allowed');
 }
 /**
@@ -81,8 +81,8 @@ 
     public static function load_espresso_theme_functions()
     {
         if ( ! defined('EE_THEME_FUNCTIONS_LOADED')) {
-            if (is_readable(EE_PUBLIC . EE_Config::get_current_theme() . DS . 'functions.php')) {
-                require_once(EE_PUBLIC . EE_Config::get_current_theme() . DS . 'functions.php');
+            if (is_readable(EE_PUBLIC.EE_Config::get_current_theme().DS.'functions.php')) {
+                require_once(EE_PUBLIC.EE_Config::get_current_theme().DS.'functions.php');
             }
         }
     }
@@ -96,7 +96,7 @@ 
     public static function get_espresso_themes()
     {
         if (empty(EEH_Template::$_espresso_themes)) {
-            $espresso_themes = glob(EE_PUBLIC . '*', GLOB_ONLYDIR);
+            $espresso_themes = glob(EE_PUBLIC.'*', GLOB_ONLYDIR);
             if (empty($espresso_themes)) {
                 return array();
             }
@@ -132,7 +132,7 @@ 
     ) {
         do_action("get_template_part_{$slug}-{$name}", $slug, $name);
         $templates = array();
-        $name      = (string)$name;
+        $name      = (string) $name;
         if ($name != '') {
             $templates[] = "{$slug}-{$name}.php";
         }
@@ -211,7 +211,7 @@ 
                 if (isset($EE_CPTs[$post_type])) {
                     $archive_or_single = is_archive() ? 'archive' : '';
                     $archive_or_single = is_single() ? 'single' : $archive_or_single;
-                    $templates         = $archive_or_single . '-' . $post_type . '.php';
+                    $templates         = $archive_or_single.'-'.$post_type.'.php';
                 }
             }
             // currently active EE template theme
@@ -220,18 +220,18 @@ 
             // array of paths to folders that may contain templates
             $template_folder_paths = array(
                 // first check the /wp-content/uploads/espresso/templates/(current EE theme)/  folder for an EE theme template file
-                EVENT_ESPRESSO_TEMPLATE_DIR . $current_theme,
+                EVENT_ESPRESSO_TEMPLATE_DIR.$current_theme,
                 // then in the root of the /wp-content/uploads/espresso/templates/ folder
                 EVENT_ESPRESSO_TEMPLATE_DIR,
             );
 
             //add core plugin folders for checking only if we're not $check_if_custom
             if ( ! $check_if_custom) {
-                $core_paths            = array(
+                $core_paths = array(
                     // in the  /wp-content/plugins/(EE4 folder)/public/(current EE theme)/ folder within the plugin
-                    EE_PUBLIC . $current_theme,
+                    EE_PUBLIC.$current_theme,
                     // in the  /wp-content/plugins/(EE4 folder)/core/templates/(current EE theme)/ folder within the plugin
-                    EE_TEMPLATES . $current_theme,
+                    EE_TEMPLATES.$current_theme,
                     // or maybe relative from the plugin root: /wp-content/plugins/(EE4 folder)/
                     EE_PLUGIN_DIR_PATH,
                 );
@@ -262,10 +262,10 @@ 
                     );
                     if ($common_base_path !== '') {
                         // both paths have a common base, so just tack the filename onto our search path
-                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $file_name;
+                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path).$file_name;
                     } else {
                         // no common base path, so let's just concatenate
-                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $template;
+                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path).$template;
                     }
                     // build up our template locations array by adding our resolved paths
                     $full_template_paths[] = $resolved_path;
@@ -273,13 +273,13 @@ 
                 // if $template is an absolute path, then we'll tack it onto the start of our array so that it gets searched first
                 array_unshift($full_template_paths, $template);
                 // path to the directory of the current theme: /wp-content/themes/(current WP theme)/
-                array_unshift($full_template_paths, get_stylesheet_directory() . DS . $file_name);
+                array_unshift($full_template_paths, get_stylesheet_directory().DS.$file_name);
             }
             // filter final array of full template paths
             $full_template_paths = apply_filters('FHEE__EEH_Template__locate_template__full_template_paths',
                 $full_template_paths, $file_name);
             // now loop through our final array of template location paths and check each location
-            foreach ((array)$full_template_paths as $full_template_path) {
+            foreach ((array) $full_template_paths as $full_template_path) {
                 if (is_readable($full_template_path)) {
                     $template_path = str_replace(array('\\', '/'), DIRECTORY_SEPARATOR, $full_template_path);
                     break;
@@ -366,9 +366,9 @@ 
         if ( ! is_array($template_args) && ! is_object($template_args)) {
             $template_args = array($template_args);
         }
-        extract( $template_args, EXTR_SKIP );
+        extract($template_args, EXTR_SKIP);
         // ignore whether template is accessible ?
-        if ( $throw_exceptions && ! is_readable( $template_path ) ) {
+        if ($throw_exceptions && ! is_readable($template_path)) {
             throw new \DomainException(
                     esc_html__(
                             'Invalid, unreadable, or missing file.',
@@ -401,11 +401,11 @@ 
     public static function get_object_css_class($object = null, $prefix = '', $suffix = '')
     {
         // in the beginning...
-        $prefix = ! empty($prefix) ? rtrim($prefix, '-') . '-' : '';
+        $prefix = ! empty($prefix) ? rtrim($prefix, '-').'-' : '';
         // da muddle
         $class = '';
         // the end
-        $suffix = ! empty($suffix) ? '-' . ltrim($suffix, '-') : '';
+        $suffix = ! empty($suffix) ? '-'.ltrim($suffix, '-') : '';
         // is the passed object an EE object ?
         if ($object instanceof EE_Base_Class) {
             // grab the exact type of object
@@ -415,11 +415,11 @@ 
                 // no specifics just yet...
                 default :
                     $class = strtolower(str_replace('_', '-', $obj_class));
-                    $class .= method_exists($obj_class, 'name') ? '-' . sanitize_title($object->name()) : '';
+                    $class .= method_exists($obj_class, 'name') ? '-'.sanitize_title($object->name()) : '';
 
             }
         }
-        return $prefix . $class . $suffix;
+        return $prefix.$class.$suffix;
     }
 
 
@@ -451,7 +451,7 @@ 
             return '';
         }
         //ensure amount is float
-        $amount  = apply_filters('FHEE__EEH_Template__format_currency__raw_amount', (float)$amount);
+        $amount  = apply_filters('FHEE__EEH_Template__format_currency__raw_amount', (float) $amount);
         $CNT_ISO = apply_filters('FHEE__EEH_Template__format_currency__CNT_ISO', $CNT_ISO, $amount);
         // filter raw amount (allows 0.00 to be changed to "free" for example)
         $amount_formatted = apply_filters('FHEE__EEH_Template__format_currency__amount', $amount, $return_raw);
@@ -473,20 +473,20 @@ 
                 // add currency sign
                 if ($mny->sign_b4) {
                     if ($amount >= 0) {
-                        $amount_formatted = $mny->sign . $amount_formatted;
+                        $amount_formatted = $mny->sign.$amount_formatted;
                     } else {
-                        $amount_formatted = '-' . $mny->sign . str_replace('-', '', $amount_formatted);
+                        $amount_formatted = '-'.$mny->sign.str_replace('-', '', $amount_formatted);
                     }
 
                 } else {
-                    $amount_formatted = $amount_formatted . $mny->sign;
+                    $amount_formatted = $amount_formatted.$mny->sign;
                 }
 
                 // filter to allow global setting of display_code
                 $display_code = apply_filters('FHEE__EEH_Template__format_currency__display_code', $display_code);
 
                 // add currency code ?
-                $amount_formatted = $display_code ? $amount_formatted . ' <span class="' . $cur_code_span_class . '">(' . $mny->code . ')</span>' : $amount_formatted;
+                $amount_formatted = $display_code ? $amount_formatted.' <span class="'.$cur_code_span_class.'">('.$mny->code.')</span>' : $amount_formatted;
             }
             // filter results
             $amount_formatted = apply_filters('FHEE__EEH_Template__format_currency__amount_formatted',
@@ -540,12 +540,12 @@ 
             $icon_html .= $count > 1 ? '<span class="ee-composite-dashicon">' : '';
             foreach ($dashicons as $dashicon) {
                 $type = strpos($dashicon, 'ee-icon') !== false ? 'ee-icon ' : 'dashicons ';
-                $icon_html .= '<span class="' . $type . $dashicon . '"></span>';
+                $icon_html .= '<span class="'.$type.$dashicon.'"></span>';
             }
             $icon_html .= $count > 1 ? '</span>' : '';
         }
-        $label  = ! empty($icon) ? $icon_html . $label : $label;
-        $button = '<a id="' . sanitize_title_with_dashes($label) . '" href="' . esc_url($url) . '" class="' . $class . '" title="' . $title . '">' . $label . '</a>';
+        $label  = ! empty($icon) ? $icon_html.$label : $label;
+        $button = '<a id="'.sanitize_title_with_dashes($label).'" href="'.esc_url($url).'" class="'.$class.'" title="'.$title.'">'.$label.'</a>';
         return $button;
     }
 
@@ -579,11 +579,11 @@ 
         $action = empty($action) ? 'default' : $action;
 
 
-        $help_tab_lnk = $page . '-' . $action . '-' . $help_tab_id;
+        $help_tab_lnk = $page.'-'.$action.'-'.$help_tab_id;
         $icon         = ! $icon_style ? ' dashicons-editor-help' : $icon_style;
         $help_text    = ! $help_text ? '' : $help_text;
-        return '<a id="' . $help_tab_lnk . '" class="ee-clickable dashicons espresso-help-tab-lnk ee-icon-size-22' . $icon . '" title="' . esc_attr__('Click to open the \'Help\' tab for more information about this feature.',
-                'event_espresso') . '" > ' . $help_text . ' </a>';
+        return '<a id="'.$help_tab_lnk.'" class="ee-clickable dashicons espresso-help-tab-lnk ee-icon-size-22'.$icon.'" title="'.esc_attr__('Click to open the \'Help\' tab for more information about this feature.',
+                'event_espresso').'" > '.$help_text.' </a>';
     }
 
 
@@ -600,11 +600,11 @@ 
         $id    = $tour->get_slug();
         $stops = $tour->get_stops();
 
-        $content = '<ol style="display:none" id="' . $id . '">';
+        $content = '<ol style="display:none" id="'.$id.'">';
 
         foreach ($stops as $stop) {
-            $data_id    = ! empty($stop['id']) ? ' data-id="' . $stop['id'] . '"' : '';
-            $data_class = empty($data_id) && ! empty($stop['class']) ? ' data-class="' . $stop['class'] . '"' : '';
+            $data_id    = ! empty($stop['id']) ? ' data-id="'.$stop['id'].'"' : '';
+            $data_class = empty($data_id) && ! empty($stop['class']) ? ' data-class="'.$stop['class'].'"' : '';
 
             //if container is set to modal then let's make sure we set the options accordingly
             if (empty($data_id) && empty($data_class)) {
@@ -612,15 +612,15 @@ 
                 $stop['options']['expose'] = true;
             }
 
-            $custom_class  = ! empty($stop['custom_class']) ? ' class="' . $stop['custom_class'] . '"' : '';
-            $button_text   = ! empty($stop['button_text']) ? ' data-button="' . $stop['button_text'] . '"' : '';
+            $custom_class  = ! empty($stop['custom_class']) ? ' class="'.$stop['custom_class'].'"' : '';
+            $button_text   = ! empty($stop['button_text']) ? ' data-button="'.$stop['button_text'].'"' : '';
             $inner_content = isset($stop['content']) ? $stop['content'] : '';
 
             //options
             if (isset($stop['options']) && is_array($stop['options'])) {
                 $options = ' data-options="';
                 foreach ($stop['options'] as $option => $value) {
-                    $options .= $option . ':' . $value . ';';
+                    $options .= $option.':'.$value.';';
                 }
                 $options .= '"';
             } else {
@@ -628,7 +628,7 @@ 
             }
 
             //let's put all together
-            $content .= '<li' . $data_id . $data_class . $custom_class . $button_text . $options . '>' . $inner_content . '</li>';
+            $content .= '<li'.$data_id.$data_class.$custom_class.$button_text.$options.'>'.$inner_content.'</li>';
         }
 
         $content .= '</ol>';
@@ -660,24 +660,24 @@ 
         $setup_array = array();
         foreach ($status_array as $item => $status) {
             $setup_array[$item] = array(
-                'class'  => 'ee-status-legend ee-status-legend-' . $status,
+                'class'  => 'ee-status-legend ee-status-legend-'.$status,
                 'desc'   => EEH_Template::pretty_status($status, false, 'sentence'),
                 'status' => $status,
             );
         }
 
-        $content = '<div class="ee-list-table-legend-container">' . "\n";
-        $content .= '<h4 class="status-legend-title">' . esc_html__('Status Legend', 'event_espresso') . '</h4>' . "\n";
-        $content .= '<dl class="ee-list-table-legend">' . "\n\t";
+        $content = '<div class="ee-list-table-legend-container">'."\n";
+        $content .= '<h4 class="status-legend-title">'.esc_html__('Status Legend', 'event_espresso').'</h4>'."\n";
+        $content .= '<dl class="ee-list-table-legend">'."\n\t";
         foreach ($setup_array as $item => $details) {
             $active_class = $active_status == $details['status'] ? ' class="ee-is-active-status"' : '';
-            $content .= '<dt id="ee-legend-item-tooltip-' . $item . '"' . $active_class . '>' . "\n\t\t";
-            $content .= '<span class="' . $details['class'] . '"></span>' . "\n\t\t";
-            $content .= '<span class="ee-legend-description">' . $details['desc'] . '</span>' . "\n\t";
-            $content .= '</dt>' . "\n";
+            $content .= '<dt id="ee-legend-item-tooltip-'.$item.'"'.$active_class.'>'."\n\t\t";
+            $content .= '<span class="'.$details['class'].'"></span>'."\n\t\t";
+            $content .= '<span class="ee-legend-description">'.$details['desc'].'</span>'."\n\t";
+            $content .= '</dt>'."\n";
         }
-        $content .= '</dl>' . "\n";
-        $content .= '</div>' . "\n";
+        $content .= '</dl>'."\n";
+        $content .= '</div>'."\n";
         return $content;
     }
 
@@ -692,7 +692,7 @@ 
     public static function layout_array_as_table($data)
     {
         if (is_object($data) || $data instanceof __PHP_Incomplete_Class) {
-            $data = (array)$data;
+            $data = (array) $data;
         }
         ob_start();
         if (is_array($data)) {
@@ -793,9 +793,9 @@ 
     ) {
         $page_links     = array();
         $disable_first  = $disable_last = '';
-        $total_items    = (int)$total_items;
-        $per_page       = (int)$per_page;
-        $current        = (int)$current;
+        $total_items    = (int) $total_items;
+        $per_page       = (int) $per_page;
+        $current        = (int) $current;
         $paged_arg_name = empty($paged_arg_name) ? 'paged' : sanitize_key($paged_arg_name);
 
         //filter items_label
@@ -815,8 +815,8 @@ 
             );
         } else {
             $items_label = array(
-                'single' => '1 ' . esc_html($items_label['single']),
-                'plural' => '%s ' . esc_html($items_label['plural']),
+                'single' => '1 '.esc_html($items_label['single']),
+                'plural' => '%s '.esc_html($items_label['plural']),
             );
         }
 
@@ -828,7 +828,7 @@ 
 
         $item_label = $total_items > 1 ? sprintf($items_label['plural'], $total_items) : $items_label['single'];
 
-        $output = '<span class="displaying-num">' . $item_label . '</span>';
+        $output = '<span class="displaying-num">'.$item_label.'</span>';
 
         if ($current === 1) {
             $disable_first = ' disabled';
@@ -838,7 +838,7 @@ 
         }
 
         $page_links[] = sprintf("<a class='%s' title='%s' href='%s'>%s</a>",
-            'first-page' . $disable_first,
+            'first-page'.$disable_first,
             esc_attr__('Go to the first page'),
             esc_url(remove_query_arg($paged_arg_name, $url)),
             '&laquo;'
@@ -846,7 +846,7 @@ 
 
         $page_links[] = sprintf(
             '<a class="%s" title="%s" href="%s">%s</a>',
-            'prev-page' . $disable_first,
+            'prev-page'.$disable_first,
             esc_attr__('Go to the previous page'),
             esc_url(add_query_arg($paged_arg_name, max(1, $current - 1), $url)),
             '&lsaquo;'
@@ -866,7 +866,7 @@ 
             '<span class="total-pages">%s</span>',
             number_format_i18n($total_pages)
         );
-        $page_links[]     = sprintf(
+        $page_links[] = sprintf(
             _x('%3$s%1$s of %2$s%4$s', 'paging'),
             $html_current_page,
             $html_total_pages,
@@ -876,7 +876,7 @@ 
 
         $page_links[] = sprintf(
             '<a class="%s" title="%s" href="%s">%s</a>',
-            'next-page' . $disable_last,
+            'next-page'.$disable_last,
             esc_attr__('Go to the next page'),
             esc_url(add_query_arg($paged_arg_name, min($total_pages, $current + 1), $url)),
             '&rsaquo;'
@@ -884,13 +884,13 @@ 
 
         $page_links[] = sprintf(
             '<a class="%s" title="%s" href="%s">%s</a>',
-            'last-page' . $disable_last,
+            'last-page'.$disable_last,
             esc_attr__('Go to the last page'),
             esc_url(add_query_arg($paged_arg_name, $total_pages, $url)),
             '&raquo;'
         );
 
-        $output .= "\n" . '<span class="pagination-links">' . join("\n", $page_links) . '</span>';
+        $output .= "\n".'<span class="pagination-links">'.join("\n", $page_links).'</span>';
         // set page class
         if ($total_pages) {
             $page_class = $total_pages < 2 ? ' one-page' : '';
@@ -898,7 +898,7 @@ 
             $page_class = ' no-pages';
         }
 
-        return '<div class="tablenav"><div class="tablenav-pages' . $page_class . '">' . $output . '</div></div>';
+        return '<div class="tablenav"><div class="tablenav-pages'.$page_class.'">'.$output.'</div></div>';
     }
 
 
@@ -935,10 +935,10 @@ 
             $query_args
         );
         $powered_by = apply_filters('FHEE__EEH_Template__powered_by_event_espresso_text',
-            $admin ? 'Event Espresso - ' . EVENT_ESPRESSO_VERSION : 'Event Espresso');
+            $admin ? 'Event Espresso - '.EVENT_ESPRESSO_VERSION : 'Event Espresso');
         $url        = add_query_arg($query_args, 'https://eventespresso.com/');
         $url        = apply_filters('FHEE__EEH_Template__powered_by_event_espresso__url', $url);
-        return (string)apply_filters(
+        return (string) apply_filters(
             'FHEE__EEH_Template__powered_by_event_espresso__html',
             sprintf(
                 esc_html_x(
@@ -989,6 +989,6 @@ 
                 'add_fragment' => '',
             )
         );
-        echo ! empty($pagination) ? '<div class="ee-pagination-dv ee-clear-float">' . $pagination . '</div>' : '';
+        echo ! empty($pagination) ? '<div class="ee-pagination-dv ee-clear-float">'.$pagination.'</div>' : '';
     }
 }
\ No newline at end of file

caffeinated/brewing_regular.php

Indentation +260 added lines, -260 removed lines

@@ -4,7 +4,7 @@ 
 use EventEspresso\core\services\database\TableAnalysis;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 /**
  * the purpose of this file is to simply contain any action/filter hook callbacks etc for specific aspects of EE
@@ -29,268 +29,268 @@ 
 class EE_Brewing_Regular extends EE_BASE implements InterminableInterface
 {
 
-    /**
-     * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis
-     */
-    protected $_table_analysis;
-
-
-    /**
-     * EE_Brewing_Regular constructor.
-     * @throws \DomainException
-     * @throws \EE_Error
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \InvalidArgumentException
-     */
-    public function __construct(TableAnalysis $table_analysis)
-    {
-        $this->_table_analysis = $table_analysis;
-        if (defined('EE_CAFF_PATH')) {
-            // activation
-            add_action('AHEE__EEH_Activation__initialize_db_content', array($this, 'initialize_caf_db_content'));
-            // load caff init
-            add_action('AHEE__EE_System__set_hooks_for_core', array($this, 'caffeinated_init'));
-            // remove the "powered by" credit link from receipts and invoices
-            add_filter('FHEE_EE_Html_messenger__add_powered_by_credit_link_to_receipt_and_invoice', '__return_false');
-            // add caffeinated modules
-            add_filter(
-                'FHEE__EE_Config__register_modules__modules_to_register',
-                array($this, 'caffeinated_modules_to_register')
-            );
-            // load caff scripts
-            add_action('wp_enqueue_scripts', array($this, 'enqueue_caffeinated_scripts'), 10);
-            add_filter('FHEE__EE_Registry__load_helper__helper_paths', array($this, 'caf_helper_paths'), 10);
-            //add_filter('FHEE__EE_Registry__load_helper__helper_paths', array($this, 'caf_helper_paths'), 10);
-            EE_Register_Payment_Method::register(
-                'caffeinated_payment_methods',
-                array(
-                    'payment_method_paths' => glob(EE_CAF_PAYMENT_METHODS . '*', GLOB_ONLYDIR)
-                )
-            );
-            // caffeinated constructed
-            do_action('AHEE__EE_Brewing_Regular__construct__complete');
-            //seeing how this is caf, which isn't put on WordPress.org, we can have affiliate links without a disclaimer
-            add_filter('FHEE__ee_show_affiliate_links', '__return_false');
-        }
-    }
-
-
-
-    /**
-     * callback for the FHEE__EE_Registry__load_helper__helper_paths filter to add the caffeinated paths
-     *
-     * @param array $paths original helper paths array
-     * @return array             new array of paths
-     */
-    public function caf_helper_paths($paths)
-    {
-        $paths[] = EE_CAF_CORE . 'helpers' . DS;
-        return $paths;
-    }
-
-
-
-    /**
-     * Upon brand-new activation, if this is a new activation of CAF, we want to add
-     * some global prices that will show off EE4's capabilities. However, if they're upgrading
-     * from 3.1, or simply EE4.x decaf, we assume they don't want us to suddenly introduce these extra prices.
-     * This action should only be called when EE 4.x.0.P is initially activated.
-     * Right now the only CAF content are these global prices. If there's more in the future, then
-     * we should probably create a caf file to contain it all instead just a function like this.
-     * Right now, we ASSUME the only price types in the system are default ones
-     *
-     * @global wpdb $wpdb
-     */
-    public function initialize_caf_db_content()
-    {
-        global $wpdb;
-        //use same method of getting creator id as the version introducing the change
-        $default_creator_id = apply_filters('FHEE__EE_DMS_Core_4_5_0__get_default_creator_id', get_current_user_id());
-        $price_type_table = $wpdb->prefix . "esp_price_type";
-        $price_table = $wpdb->prefix . "esp_price";
-        if ($this->_get_table_analysis()->tableExists($price_type_table)) {
-            $SQL = 'SELECT COUNT(PRT_ID) FROM ' . $price_type_table . ' WHERE PBT_ID=4';//include trashed price types
-            $tax_price_type_count = $wpdb->get_var($SQL);
-            if ($tax_price_type_count <= 1) {
-                $wpdb->insert(
-                    $price_type_table,
-                    array(
-                        'PRT_name'       => __("Regional Tax", "event_espresso"),
-                        'PBT_ID'         => 4,
-                        'PRT_is_percent' => true,
-                        'PRT_order'      => 60,
-                        'PRT_deleted'    => false,
-                        'PRT_wp_user'    => $default_creator_id,
-                    ),
-                    array(
-                        '%s',//PRT_name
-                        '%d',//PBT_id
-                        '%d',//PRT_is_percent
-                        '%d',//PRT_order
-                        '%d',//PRT_deleted
-                        '%d', //PRT_wp_user
-                    )
-                );
-                //federal tax
-                $result = $wpdb->insert(
-                    $price_type_table,
-                    array(
-                        'PRT_name'       => __("Federal Tax", "event_espresso"),
-                        'PBT_ID'         => 4,
-                        'PRT_is_percent' => true,
-                        'PRT_order'      => 70,
-                        'PRT_deleted'    => false,
-                        'PRT_wp_user'    => $default_creator_id,
-                    ),
-                    array(
-                        '%s',//PRT_name
-                        '%d',//PBT_id
-                        '%d',//PRT_is_percent
-                        '%d',//PRT_order
-                        '%d',//PRT_deleted
-                        '%d' //PRT_wp_user
-                    )
-                );
-                if ($result) {
-                    $wpdb->insert(
-                        $price_table,
-                        array(
-                            'PRT_ID'         => $wpdb->insert_id,
-                            'PRC_amount'     => 15.00,
-                            'PRC_name'       => __("Sales Tax", "event_espresso"),
-                            'PRC_desc'       => '',
-                            'PRC_is_default' => true,
-                            'PRC_overrides'  => null,
-                            'PRC_deleted'    => false,
-                            'PRC_order'      => 50,
-                            'PRC_parent'     => null,
-                            'PRC_wp_user'    => $default_creator_id,
-                        ),
-                        array(
-                            '%d',//PRT_id
-                            '%f',//PRC_amount
-                            '%s',//PRC_name
-                            '%s',//PRC_desc
-                            '%d',//PRC_is_default
-                            '%d',//PRC_overrides
-                            '%d',//PRC_deleted
-                            '%d',//PRC_order
-                            '%d',//PRC_parent
-                            '%d' //PRC_wp_user
-                        )
-                    );
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     *    caffeinated_modules_to_register
-     *
-     * @access public
-     * @param array $modules_to_register
-     * @return array
-     */
-    public function caffeinated_modules_to_register($modules_to_register = array())
-    {
-        if (is_readable(EE_CAFF_PATH . 'modules')) {
-            $caffeinated_modules_to_register = glob(EE_CAFF_PATH . 'modules' . DS . '*', GLOB_ONLYDIR);
-            if (is_array($caffeinated_modules_to_register) && ! empty($caffeinated_modules_to_register)) {
-                $modules_to_register = array_merge($modules_to_register, $caffeinated_modules_to_register);
-            }
-        }
-        return $modules_to_register;
-    }
-
-
-
-    public function caffeinated_init()
-    {
-        // EE_Register_CPTs hooks
-        add_filter('FHEE__EE_Register_CPTs__get_taxonomies__taxonomies', array($this, 'filter_taxonomies'), 10);
-        add_filter('FHEE__EE_Register_CPTs__get_CPTs__cpts', array($this, 'filter_cpts'), 10);
-        add_filter('FHEE__EE_Admin__get_extra_nav_menu_pages_items', array($this, 'nav_metabox_items'), 10);
-        EE_Registry::instance()->load_file(EE_CAFF_PATH, 'EE_Caf_Messages', 'class', array(), false);
-        // caffeinated_init__complete hook
-        do_action('AHEE__EE_Brewing_Regular__caffeinated_init__complete');
-    }
-
-
-
-    public function enqueue_caffeinated_scripts()
-    {
-        // sound of crickets...
-    }
-
-
-
-    /**
-     * callbacks below here
-     *
-     * @param array $taxonomy_array
-     * @return array
-     */
-    public function filter_taxonomies(array $taxonomy_array)
-    {
-        $taxonomy_array['espresso_venue_categories']['args']['show_in_nav_menus'] = true;
-        return $taxonomy_array;
-    }
-
-
-
-    /**
-     * @param array $cpt_array
-     * @return mixed
-     */
-    public function filter_cpts(array $cpt_array)
-    {
-        $cpt_array['espresso_venues']['args']['show_in_nav_menus'] = true;
-        return $cpt_array;
-    }
-
-
-
-    /**
-     * @param array $menuitems
-     * @return array
-     */
-    public function nav_metabox_items(array $menuitems)
-    {
-        $menuitems[] = array(
-            'title'       => __('Venue List', 'event_espresso'),
-            'url'         => get_post_type_archive_link('espresso_venues'),
-            'description' => __('Archive page for all venues.', 'event_espresso'),
-        );
-        return $menuitems;
-    }
-
-
-    /**
-     * Gets the injected table analyzer, or throws an exception
-     *
-     * @return TableAnalysis
-     * @throws \EE_Error
-     */
-    protected function _get_table_analysis()
-    {
-        if ($this->_table_analysis instanceof TableAnalysis) {
-            return $this->_table_analysis;
-        } else {
-            throw new \EE_Error(
-                sprintf(
-                    __('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
+	/**
+	 * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis
+	 */
+	protected $_table_analysis;
+
+
+	/**
+	 * EE_Brewing_Regular constructor.
+	 * @throws \DomainException
+	 * @throws \EE_Error
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \InvalidArgumentException
+	 */
+	public function __construct(TableAnalysis $table_analysis)
+	{
+		$this->_table_analysis = $table_analysis;
+		if (defined('EE_CAFF_PATH')) {
+			// activation
+			add_action('AHEE__EEH_Activation__initialize_db_content', array($this, 'initialize_caf_db_content'));
+			// load caff init
+			add_action('AHEE__EE_System__set_hooks_for_core', array($this, 'caffeinated_init'));
+			// remove the "powered by" credit link from receipts and invoices
+			add_filter('FHEE_EE_Html_messenger__add_powered_by_credit_link_to_receipt_and_invoice', '__return_false');
+			// add caffeinated modules
+			add_filter(
+				'FHEE__EE_Config__register_modules__modules_to_register',
+				array($this, 'caffeinated_modules_to_register')
+			);
+			// load caff scripts
+			add_action('wp_enqueue_scripts', array($this, 'enqueue_caffeinated_scripts'), 10);
+			add_filter('FHEE__EE_Registry__load_helper__helper_paths', array($this, 'caf_helper_paths'), 10);
+			//add_filter('FHEE__EE_Registry__load_helper__helper_paths', array($this, 'caf_helper_paths'), 10);
+			EE_Register_Payment_Method::register(
+				'caffeinated_payment_methods',
+				array(
+					'payment_method_paths' => glob(EE_CAF_PAYMENT_METHODS . '*', GLOB_ONLYDIR)
+				)
+			);
+			// caffeinated constructed
+			do_action('AHEE__EE_Brewing_Regular__construct__complete');
+			//seeing how this is caf, which isn't put on WordPress.org, we can have affiliate links without a disclaimer
+			add_filter('FHEE__ee_show_affiliate_links', '__return_false');
+		}
+	}
+
+
+
+	/**
+	 * callback for the FHEE__EE_Registry__load_helper__helper_paths filter to add the caffeinated paths
+	 *
+	 * @param array $paths original helper paths array
+	 * @return array             new array of paths
+	 */
+	public function caf_helper_paths($paths)
+	{
+		$paths[] = EE_CAF_CORE . 'helpers' . DS;
+		return $paths;
+	}
+
+
+
+	/**
+	 * Upon brand-new activation, if this is a new activation of CAF, we want to add
+	 * some global prices that will show off EE4's capabilities. However, if they're upgrading
+	 * from 3.1, or simply EE4.x decaf, we assume they don't want us to suddenly introduce these extra prices.
+	 * This action should only be called when EE 4.x.0.P is initially activated.
+	 * Right now the only CAF content are these global prices. If there's more in the future, then
+	 * we should probably create a caf file to contain it all instead just a function like this.
+	 * Right now, we ASSUME the only price types in the system are default ones
+	 *
+	 * @global wpdb $wpdb
+	 */
+	public function initialize_caf_db_content()
+	{
+		global $wpdb;
+		//use same method of getting creator id as the version introducing the change
+		$default_creator_id = apply_filters('FHEE__EE_DMS_Core_4_5_0__get_default_creator_id', get_current_user_id());
+		$price_type_table = $wpdb->prefix . "esp_price_type";
+		$price_table = $wpdb->prefix . "esp_price";
+		if ($this->_get_table_analysis()->tableExists($price_type_table)) {
+			$SQL = 'SELECT COUNT(PRT_ID) FROM ' . $price_type_table . ' WHERE PBT_ID=4';//include trashed price types
+			$tax_price_type_count = $wpdb->get_var($SQL);
+			if ($tax_price_type_count <= 1) {
+				$wpdb->insert(
+					$price_type_table,
+					array(
+						'PRT_name'       => __("Regional Tax", "event_espresso"),
+						'PBT_ID'         => 4,
+						'PRT_is_percent' => true,
+						'PRT_order'      => 60,
+						'PRT_deleted'    => false,
+						'PRT_wp_user'    => $default_creator_id,
+					),
+					array(
+						'%s',//PRT_name
+						'%d',//PBT_id
+						'%d',//PRT_is_percent
+						'%d',//PRT_order
+						'%d',//PRT_deleted
+						'%d', //PRT_wp_user
+					)
+				);
+				//federal tax
+				$result = $wpdb->insert(
+					$price_type_table,
+					array(
+						'PRT_name'       => __("Federal Tax", "event_espresso"),
+						'PBT_ID'         => 4,
+						'PRT_is_percent' => true,
+						'PRT_order'      => 70,
+						'PRT_deleted'    => false,
+						'PRT_wp_user'    => $default_creator_id,
+					),
+					array(
+						'%s',//PRT_name
+						'%d',//PBT_id
+						'%d',//PRT_is_percent
+						'%d',//PRT_order
+						'%d',//PRT_deleted
+						'%d' //PRT_wp_user
+					)
+				);
+				if ($result) {
+					$wpdb->insert(
+						$price_table,
+						array(
+							'PRT_ID'         => $wpdb->insert_id,
+							'PRC_amount'     => 15.00,
+							'PRC_name'       => __("Sales Tax", "event_espresso"),
+							'PRC_desc'       => '',
+							'PRC_is_default' => true,
+							'PRC_overrides'  => null,
+							'PRC_deleted'    => false,
+							'PRC_order'      => 50,
+							'PRC_parent'     => null,
+							'PRC_wp_user'    => $default_creator_id,
+						),
+						array(
+							'%d',//PRT_id
+							'%f',//PRC_amount
+							'%s',//PRC_name
+							'%s',//PRC_desc
+							'%d',//PRC_is_default
+							'%d',//PRC_overrides
+							'%d',//PRC_deleted
+							'%d',//PRC_order
+							'%d',//PRC_parent
+							'%d' //PRC_wp_user
+						)
+					);
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 *    caffeinated_modules_to_register
+	 *
+	 * @access public
+	 * @param array $modules_to_register
+	 * @return array
+	 */
+	public function caffeinated_modules_to_register($modules_to_register = array())
+	{
+		if (is_readable(EE_CAFF_PATH . 'modules')) {
+			$caffeinated_modules_to_register = glob(EE_CAFF_PATH . 'modules' . DS . '*', GLOB_ONLYDIR);
+			if (is_array($caffeinated_modules_to_register) && ! empty($caffeinated_modules_to_register)) {
+				$modules_to_register = array_merge($modules_to_register, $caffeinated_modules_to_register);
+			}
+		}
+		return $modules_to_register;
+	}
+
+
+
+	public function caffeinated_init()
+	{
+		// EE_Register_CPTs hooks
+		add_filter('FHEE__EE_Register_CPTs__get_taxonomies__taxonomies', array($this, 'filter_taxonomies'), 10);
+		add_filter('FHEE__EE_Register_CPTs__get_CPTs__cpts', array($this, 'filter_cpts'), 10);
+		add_filter('FHEE__EE_Admin__get_extra_nav_menu_pages_items', array($this, 'nav_metabox_items'), 10);
+		EE_Registry::instance()->load_file(EE_CAFF_PATH, 'EE_Caf_Messages', 'class', array(), false);
+		// caffeinated_init__complete hook
+		do_action('AHEE__EE_Brewing_Regular__caffeinated_init__complete');
+	}
+
+
+
+	public function enqueue_caffeinated_scripts()
+	{
+		// sound of crickets...
+	}
+
+
+
+	/**
+	 * callbacks below here
+	 *
+	 * @param array $taxonomy_array
+	 * @return array
+	 */
+	public function filter_taxonomies(array $taxonomy_array)
+	{
+		$taxonomy_array['espresso_venue_categories']['args']['show_in_nav_menus'] = true;
+		return $taxonomy_array;
+	}
+
+
+
+	/**
+	 * @param array $cpt_array
+	 * @return mixed
+	 */
+	public function filter_cpts(array $cpt_array)
+	{
+		$cpt_array['espresso_venues']['args']['show_in_nav_menus'] = true;
+		return $cpt_array;
+	}
+
+
+
+	/**
+	 * @param array $menuitems
+	 * @return array
+	 */
+	public function nav_metabox_items(array $menuitems)
+	{
+		$menuitems[] = array(
+			'title'       => __('Venue List', 'event_espresso'),
+			'url'         => get_post_type_archive_link('espresso_venues'),
+			'description' => __('Archive page for all venues.', 'event_espresso'),
+		);
+		return $menuitems;
+	}
+
+
+	/**
+	 * Gets the injected table analyzer, or throws an exception
+	 *
+	 * @return TableAnalysis
+	 * @throws \EE_Error
+	 */
+	protected function _get_table_analysis()
+	{
+		if ($this->_table_analysis instanceof TableAnalysis) {
+			return $this->_table_analysis;
+		} else {
+			throw new \EE_Error(
+				sprintf(
+					__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
 }
 
 
 
 $brewing = new EE_Brewing_Regular(
-    EE_Registry::instance()->create('TableAnalysis', array(), true)
+	EE_Registry::instance()->create('TableAnalysis', array(), true)
 );
\ No newline at end of file

Spacing +30 added lines, -30 removed lines

@@ -12,10 +12,10 @@ 
  * define and use the hook in a specific caffeinated/whatever class or file.
  */
 // defined some new constants related to caffeinated folder
-define('EE_CAF_URL', EE_PLUGIN_DIR_URL . 'caffeinated/');
-define('EE_CAF_CORE', EE_CAFF_PATH . 'core' . DS);
-define('EE_CAF_LIBRARIES', EE_CAF_CORE . 'libraries' . DS);
-define('EE_CAF_PAYMENT_METHODS', EE_CAFF_PATH . 'payment_methods' . DS);
+define('EE_CAF_URL', EE_PLUGIN_DIR_URL.'caffeinated/');
+define('EE_CAF_CORE', EE_CAFF_PATH.'core'.DS);
+define('EE_CAF_LIBRARIES', EE_CAF_CORE.'libraries'.DS);
+define('EE_CAF_PAYMENT_METHODS', EE_CAFF_PATH.'payment_methods'.DS);
 
 
 
@@ -65,7 +65,7 @@ 
             EE_Register_Payment_Method::register(
                 'caffeinated_payment_methods',
                 array(
-                    'payment_method_paths' => glob(EE_CAF_PAYMENT_METHODS . '*', GLOB_ONLYDIR)
+                    'payment_method_paths' => glob(EE_CAF_PAYMENT_METHODS.'*', GLOB_ONLYDIR)
                 )
             );
             // caffeinated constructed
@@ -85,7 +85,7 @@ 
      */
     public function caf_helper_paths($paths)
     {
-        $paths[] = EE_CAF_CORE . 'helpers' . DS;
+        $paths[] = EE_CAF_CORE.'helpers'.DS;
         return $paths;
     }
 
@@ -107,10 +107,10 @@ 
         global $wpdb;
         //use same method of getting creator id as the version introducing the change
         $default_creator_id = apply_filters('FHEE__EE_DMS_Core_4_5_0__get_default_creator_id', get_current_user_id());
-        $price_type_table = $wpdb->prefix . "esp_price_type";
-        $price_table = $wpdb->prefix . "esp_price";
+        $price_type_table = $wpdb->prefix."esp_price_type";
+        $price_table = $wpdb->prefix."esp_price";
         if ($this->_get_table_analysis()->tableExists($price_type_table)) {
-            $SQL = 'SELECT COUNT(PRT_ID) FROM ' . $price_type_table . ' WHERE PBT_ID=4';//include trashed price types
+            $SQL = 'SELECT COUNT(PRT_ID) FROM '.$price_type_table.' WHERE PBT_ID=4'; //include trashed price types
             $tax_price_type_count = $wpdb->get_var($SQL);
             if ($tax_price_type_count <= 1) {
                 $wpdb->insert(
@@ -124,11 +124,11 @@ 
                         'PRT_wp_user'    => $default_creator_id,
                     ),
                     array(
-                        '%s',//PRT_name
-                        '%d',//PBT_id
-                        '%d',//PRT_is_percent
-                        '%d',//PRT_order
-                        '%d',//PRT_deleted
+                        '%s', //PRT_name
+                        '%d', //PBT_id
+                        '%d', //PRT_is_percent
+                        '%d', //PRT_order
+                        '%d', //PRT_deleted
                         '%d', //PRT_wp_user
                     )
                 );
@@ -144,11 +144,11 @@ 
                         'PRT_wp_user'    => $default_creator_id,
                     ),
                     array(
-                        '%s',//PRT_name
-                        '%d',//PBT_id
-                        '%d',//PRT_is_percent
-                        '%d',//PRT_order
-                        '%d',//PRT_deleted
+                        '%s', //PRT_name
+                        '%d', //PBT_id
+                        '%d', //PRT_is_percent
+                        '%d', //PRT_order
+                        '%d', //PRT_deleted
                         '%d' //PRT_wp_user
                     )
                 );
@@ -168,15 +168,15 @@ 
                             'PRC_wp_user'    => $default_creator_id,
                         ),
                         array(
-                            '%d',//PRT_id
-                            '%f',//PRC_amount
-                            '%s',//PRC_name
-                            '%s',//PRC_desc
-                            '%d',//PRC_is_default
-                            '%d',//PRC_overrides
-                            '%d',//PRC_deleted
-                            '%d',//PRC_order
-                            '%d',//PRC_parent
+                            '%d', //PRT_id
+                            '%f', //PRC_amount
+                            '%s', //PRC_name
+                            '%s', //PRC_desc
+                            '%d', //PRC_is_default
+                            '%d', //PRC_overrides
+                            '%d', //PRC_deleted
+                            '%d', //PRC_order
+                            '%d', //PRC_parent
                             '%d' //PRC_wp_user
                         )
                     );
@@ -196,8 +196,8 @@ 
      */
     public function caffeinated_modules_to_register($modules_to_register = array())
     {
-        if (is_readable(EE_CAFF_PATH . 'modules')) {
-            $caffeinated_modules_to_register = glob(EE_CAFF_PATH . 'modules' . DS . '*', GLOB_ONLYDIR);
+        if (is_readable(EE_CAFF_PATH.'modules')) {
+            $caffeinated_modules_to_register = glob(EE_CAFF_PATH.'modules'.DS.'*', GLOB_ONLYDIR);
             if (is_array($caffeinated_modules_to_register) && ! empty($caffeinated_modules_to_register)) {
                 $modules_to_register = array_merge($modules_to_register, $caffeinated_modules_to_register);
             }

core/libraries/plugin_api/EE_Register_Capabilities.lib.php

Indentation +175 added lines, -175 removed lines

@@ -10,7 +10,7 @@ 
 use EventEspresso\core\services\loaders\LoaderFactory;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -24,189 +24,189 @@ 
 class EE_Register_Capabilities implements EEI_Plugin_API
 {
 
-    /**
-     * Holds the settings for a specific registration.
-     *
-     * @var array
-     */
-    protected static $_registry = array();
+	/**
+	 * Holds the settings for a specific registration.
+	 *
+	 * @var array
+	 */
+	protected static $_registry = array();
 
 
-    /**
-     * Used to register capability items with EE core.
-     *
-     * @since 4.5.0
-     * @param string $cap_reference                                                       usually will be a class name
-     *                                                                                    that references capability
-     *                                                                                    related items setup for
-     *                                                                                    something.
-     * @param array  $setup_args                                                          {
-     *                                                                                    An array of items related to
-     *                                                                                    registering capabilities.
-     * @type array   $capabilities                                                        An array mapping capability
-     *       strings to core WP Role. Something like: array(
-     *                                                                                    'administrator'    => array(
-     *                                                                                    'read_cap', 'edit_cap',
-     *                                                                                    'delete_cap'),
-     *                                                                                    'author'                =>
-     *                                                                                    array( 'read_cap' )
-     *                                                                                    ).
-     * @type array   $capability_maps                                                     EE_Meta_Capability_Map[]
-     * @see   EE_Capabilities.php for php docs on these objects.
-     *                                                                                    Should be indexed by the
-     *                                                                                    classname for the capability
-     *                                                                                    map and values representing
-     *                                                                                    the arguments for the map.
-     *                                                                                    }
-     * @throws EE_Error
-     * @return void
-     */
-    public static function register($cap_reference = null, $setup_args = array())
-    {
-        //required fields MUST be present, so let's make sure they are.
-        if ($cap_reference === null || ! is_array($setup_args) || empty($setup_args['capabilities'])) {
-            throw new EE_Error(
-                __('In order to register capabilities with EE_Register_Capabilities::register, you must include a unique name to reference the capabilities being registered, plus an array containing the following keys: "capabilities".',
-                    'event_espresso')
-            );
-        }
-        //make sure we don't register twice
-        if (isset(self::$_registry[$cap_reference])) {
-            return;
-        }
-        //make sure this is not registered too late or too early.
-        if (! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')) {
-            EE_Error::doing_it_wrong(__METHOD__,
-                sprintf(__('%s has been registered too late.  Please ensure that EE_Register_Capabilities::register has been called at some point before the "AHEE__EE_System___detect_if_activation_or_upgrade__begin" action hook has been called.',
-                    'event_espresso'), $cap_reference), '4.5.0');
-        }
-        //some preliminary sanitization and setting to the $_registry property
-        self::$_registry[ $cap_reference ] = array(
-            'caps'               => isset($setup_args['capabilities']) && is_array($setup_args['capabilities'])
-                ? $setup_args['capabilities']
-                : array(),
-            'cap_maps'           => isset($setup_args['capability_maps'])
-                ? $setup_args['capability_maps']
-                : array(),
-        );
-        //set initial caps (note that EE_Capabilities takes care of making sure that the caps get added only once)
-        add_filter(
-            'FHEE__EE_Capabilities__addCaps__capabilities_to_add',
-            array('EE_Register_Capabilities', 'register_capabilities')
-        );
-        //add filter for cap maps
-        add_filter(
-            'FHEE__EE_Capabilities___set_meta_caps__meta_caps',
-            array('EE_Register_Capabilities', 'register_cap_maps')
-        );
-    }
+	/**
+	 * Used to register capability items with EE core.
+	 *
+	 * @since 4.5.0
+	 * @param string $cap_reference                                                       usually will be a class name
+	 *                                                                                    that references capability
+	 *                                                                                    related items setup for
+	 *                                                                                    something.
+	 * @param array  $setup_args                                                          {
+	 *                                                                                    An array of items related to
+	 *                                                                                    registering capabilities.
+	 * @type array   $capabilities                                                        An array mapping capability
+	 *       strings to core WP Role. Something like: array(
+	 *                                                                                    'administrator'    => array(
+	 *                                                                                    'read_cap', 'edit_cap',
+	 *                                                                                    'delete_cap'),
+	 *                                                                                    'author'                =>
+	 *                                                                                    array( 'read_cap' )
+	 *                                                                                    ).
+	 * @type array   $capability_maps                                                     EE_Meta_Capability_Map[]
+	 * @see   EE_Capabilities.php for php docs on these objects.
+	 *                                                                                    Should be indexed by the
+	 *                                                                                    classname for the capability
+	 *                                                                                    map and values representing
+	 *                                                                                    the arguments for the map.
+	 *                                                                                    }
+	 * @throws EE_Error
+	 * @return void
+	 */
+	public static function register($cap_reference = null, $setup_args = array())
+	{
+		//required fields MUST be present, so let's make sure they are.
+		if ($cap_reference === null || ! is_array($setup_args) || empty($setup_args['capabilities'])) {
+			throw new EE_Error(
+				__('In order to register capabilities with EE_Register_Capabilities::register, you must include a unique name to reference the capabilities being registered, plus an array containing the following keys: "capabilities".',
+					'event_espresso')
+			);
+		}
+		//make sure we don't register twice
+		if (isset(self::$_registry[$cap_reference])) {
+			return;
+		}
+		//make sure this is not registered too late or too early.
+		if (! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')) {
+			EE_Error::doing_it_wrong(__METHOD__,
+				sprintf(__('%s has been registered too late.  Please ensure that EE_Register_Capabilities::register has been called at some point before the "AHEE__EE_System___detect_if_activation_or_upgrade__begin" action hook has been called.',
+					'event_espresso'), $cap_reference), '4.5.0');
+		}
+		//some preliminary sanitization and setting to the $_registry property
+		self::$_registry[ $cap_reference ] = array(
+			'caps'               => isset($setup_args['capabilities']) && is_array($setup_args['capabilities'])
+				? $setup_args['capabilities']
+				: array(),
+			'cap_maps'           => isset($setup_args['capability_maps'])
+				? $setup_args['capability_maps']
+				: array(),
+		);
+		//set initial caps (note that EE_Capabilities takes care of making sure that the caps get added only once)
+		add_filter(
+			'FHEE__EE_Capabilities__addCaps__capabilities_to_add',
+			array('EE_Register_Capabilities', 'register_capabilities')
+		);
+		//add filter for cap maps
+		add_filter(
+			'FHEE__EE_Capabilities___set_meta_caps__meta_caps',
+			array('EE_Register_Capabilities', 'register_cap_maps')
+		);
+	}
 
 
-    /**
-     * callback for FHEE__EE_Capabilities__init_caps_map__caps filter.
-     * Takes care of registering additional capabilities to the caps map.   Note, that this also on the initial
-     * registration ensures that new capabilities are added to existing roles.
-     *
-     * @param array $incoming_caps The original caps map.
-     * @return array merged in new caps.
-     */
-    public static function register_capabilities($incoming_caps)
-    {
-        foreach (self::$_registry as $cap_reference => $caps_and_cap_map) {
-            $incoming_caps = array_merge_recursive($incoming_caps, $caps_and_cap_map['caps']);
-        }
-        return $incoming_caps;
-    }
+	/**
+	 * callback for FHEE__EE_Capabilities__init_caps_map__caps filter.
+	 * Takes care of registering additional capabilities to the caps map.   Note, that this also on the initial
+	 * registration ensures that new capabilities are added to existing roles.
+	 *
+	 * @param array $incoming_caps The original caps map.
+	 * @return array merged in new caps.
+	 */
+	public static function register_capabilities($incoming_caps)
+	{
+		foreach (self::$_registry as $cap_reference => $caps_and_cap_map) {
+			$incoming_caps = array_merge_recursive($incoming_caps, $caps_and_cap_map['caps']);
+		}
+		return $incoming_caps;
+	}
 
 
-    /**
-     * Callback for the 'FHEE__EE_Capabilities___set_meta_caps__meta_caps' filter which registers an array of
-     * capability maps for the WP meta_caps filter called in EE_Capabilities.
-     *
-     * @since 4.5.0
-     * @param EE_Meta_Capability_Map[] $cap_maps The existing cap maps array.
-     * @return EE_Meta_Capability_Map[]
-     * @throws EE_Error
-     */
-    public static function register_cap_maps($cap_maps)
-    {
-        //loop through and instantiate cap maps.
-        foreach (self::$_registry as $cap_reference => $setup) {
-            if (! isset($setup['cap_maps'])) {
-                continue;
-            }
-            foreach ($setup['cap_maps'] as $cap_class => $args) {
+	/**
+	 * Callback for the 'FHEE__EE_Capabilities___set_meta_caps__meta_caps' filter which registers an array of
+	 * capability maps for the WP meta_caps filter called in EE_Capabilities.
+	 *
+	 * @since 4.5.0
+	 * @param EE_Meta_Capability_Map[] $cap_maps The existing cap maps array.
+	 * @return EE_Meta_Capability_Map[]
+	 * @throws EE_Error
+	 */
+	public static function register_cap_maps($cap_maps)
+	{
+		//loop through and instantiate cap maps.
+		foreach (self::$_registry as $cap_reference => $setup) {
+			if (! isset($setup['cap_maps'])) {
+				continue;
+			}
+			foreach ($setup['cap_maps'] as $cap_class => $args) {
 
-                /**
-                 * account for cases where capability maps may be indexed
-                 * numerically to allow for the same map class to be utilized
-                 * In those cases, maps will be setup in an array like:
-                 * array(
-                 *    0 => array( 'EE_Meta_Capability' => array(
-                 *        'ee_edit_cap', array( 'Object_Name',
-                 *        'ee_edit_published_cap',
-                 *        'ee_edit_others_cap', 'ee_edit_private_cap' )
-                 *        ) )
-                 *    1 => ...
-                 * )
-                 * instead of:
-                 * array(
-                 *    'EE_Meta_Capability' => array(
-                 *        'ee_edit_cap', array( 'Object_Name',
-                 *        'ee_edit_published_cap',
-                 *        'ee_edit_others_cap', 'ee_edit_private_cap' )
-                 *        ),
-                 *    ...
-                 * )
-                 */
-                if (is_numeric($cap_class)) {
-                    $cap_class = key($args);
-                    $args      = $args[$cap_class];
-                }
+				/**
+				 * account for cases where capability maps may be indexed
+				 * numerically to allow for the same map class to be utilized
+				 * In those cases, maps will be setup in an array like:
+				 * array(
+				 *    0 => array( 'EE_Meta_Capability' => array(
+				 *        'ee_edit_cap', array( 'Object_Name',
+				 *        'ee_edit_published_cap',
+				 *        'ee_edit_others_cap', 'ee_edit_private_cap' )
+				 *        ) )
+				 *    1 => ...
+				 * )
+				 * instead of:
+				 * array(
+				 *    'EE_Meta_Capability' => array(
+				 *        'ee_edit_cap', array( 'Object_Name',
+				 *        'ee_edit_published_cap',
+				 *        'ee_edit_others_cap', 'ee_edit_private_cap' )
+				 *        ),
+				 *    ...
+				 * )
+				 */
+				if (is_numeric($cap_class)) {
+					$cap_class = key($args);
+					$args      = $args[$cap_class];
+				}
 
-                if (! class_exists($cap_class)) {
-                    throw new EE_Error(sprintf(__('An addon (%s) has tried to register a capability map improperly.  Capability map arrays must be indexed by capability map classname, and an array for the class arguments',
-                        'event_espresso'), $cap_reference));
-                }
+				if (! class_exists($cap_class)) {
+					throw new EE_Error(sprintf(__('An addon (%s) has tried to register a capability map improperly.  Capability map arrays must be indexed by capability map classname, and an array for the class arguments',
+						'event_espresso'), $cap_reference));
+				}
 
-                if (count($args) !== 2) {
-                    throw new EE_Error(sprintf(__('An addon (%s) has tried to register a capability map improperly.  Capability map arrays must be indexed by capability map classname, and an array for the class arguments.  The array should have two values the first being a string and the second an array.',
-                        'event_espresso'), $cap_reference));
-                }
-                $cap_maps[] = new $cap_class($args[0], $args[1]);
-            }
-        }
-        return $cap_maps;
-    }
+				if (count($args) !== 2) {
+					throw new EE_Error(sprintf(__('An addon (%s) has tried to register a capability map improperly.  Capability map arrays must be indexed by capability map classname, and an array for the class arguments.  The array should have two values the first being a string and the second an array.',
+						'event_espresso'), $cap_reference));
+				}
+				$cap_maps[] = new $cap_class($args[0], $args[1]);
+			}
+		}
+		return $cap_maps;
+	}
 
 
-    /**
-     * @param string $cap_reference
-     * @throws EE_Error
-     * @throws \InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public static function deregister($cap_reference = '')
-    {
-        if (! empty(self::$_registry[$cap_reference])) {
-            if (! empty(self::$_registry[ $cap_reference ]['caps'])) {
-                //if it's too early to remove capabilities, wait to do this until core is loaded and ready
-                $caps_to_remove = self::$_registry[ $cap_reference ]['caps'];
-                if (did_action('AHEE__EE_System__core_loaded_and_ready')) {
-                    $capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
-                    $capabilities->removeCaps($caps_to_remove);
-                } else {
-                    add_action(
-                        'AHEE__EE_System__core_loaded_and_ready',
-                        function () use ($caps_to_remove) {
-                            $capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
-                            $capabilities->removeCaps($caps_to_remove);
-                        }
-                    );
-                }
-            }
-            unset(self::$_registry[$cap_reference]);
-        }
-    }
+	/**
+	 * @param string $cap_reference
+	 * @throws EE_Error
+	 * @throws \InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public static function deregister($cap_reference = '')
+	{
+		if (! empty(self::$_registry[$cap_reference])) {
+			if (! empty(self::$_registry[ $cap_reference ]['caps'])) {
+				//if it's too early to remove capabilities, wait to do this until core is loaded and ready
+				$caps_to_remove = self::$_registry[ $cap_reference ]['caps'];
+				if (did_action('AHEE__EE_System__core_loaded_and_ready')) {
+					$capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
+					$capabilities->removeCaps($caps_to_remove);
+				} else {
+					add_action(
+						'AHEE__EE_System__core_loaded_and_ready',
+						function () use ($caps_to_remove) {
+							$capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
+							$capabilities->removeCaps($caps_to_remove);
+						}
+					);
+				}
+			}
+			unset(self::$_registry[$cap_reference]);
+		}
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -9,7 +9,7 @@ 
 
 use EventEspresso\core\services\loaders\LoaderFactory;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -75,13 +75,13 @@ 
             return;
         }
         //make sure this is not registered too late or too early.
-        if (! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')) {
+        if ( ! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')) {
             EE_Error::doing_it_wrong(__METHOD__,
                 sprintf(__('%s has been registered too late.  Please ensure that EE_Register_Capabilities::register has been called at some point before the "AHEE__EE_System___detect_if_activation_or_upgrade__begin" action hook has been called.',
                     'event_espresso'), $cap_reference), '4.5.0');
         }
         //some preliminary sanitization and setting to the $_registry property
-        self::$_registry[ $cap_reference ] = array(
+        self::$_registry[$cap_reference] = array(
             'caps'               => isset($setup_args['capabilities']) && is_array($setup_args['capabilities'])
                 ? $setup_args['capabilities']
                 : array(),
@@ -132,7 +132,7 @@ 
     {
         //loop through and instantiate cap maps.
         foreach (self::$_registry as $cap_reference => $setup) {
-            if (! isset($setup['cap_maps'])) {
+            if ( ! isset($setup['cap_maps'])) {
                 continue;
             }
             foreach ($setup['cap_maps'] as $cap_class => $args) {
@@ -164,7 +164,7 @@ 
                     $args      = $args[$cap_class];
                 }
 
-                if (! class_exists($cap_class)) {
+                if ( ! class_exists($cap_class)) {
                     throw new EE_Error(sprintf(__('An addon (%s) has tried to register a capability map improperly.  Capability map arrays must be indexed by capability map classname, and an array for the class arguments',
                         'event_espresso'), $cap_reference));
                 }
@@ -189,17 +189,17 @@ 
      */
     public static function deregister($cap_reference = '')
     {
-        if (! empty(self::$_registry[$cap_reference])) {
-            if (! empty(self::$_registry[ $cap_reference ]['caps'])) {
+        if ( ! empty(self::$_registry[$cap_reference])) {
+            if ( ! empty(self::$_registry[$cap_reference]['caps'])) {
                 //if it's too early to remove capabilities, wait to do this until core is loaded and ready
-                $caps_to_remove = self::$_registry[ $cap_reference ]['caps'];
+                $caps_to_remove = self::$_registry[$cap_reference]['caps'];
                 if (did_action('AHEE__EE_System__core_loaded_and_ready')) {
                     $capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
                     $capabilities->removeCaps($caps_to_remove);
                 } else {
                     add_action(
                         'AHEE__EE_System__core_loaded_and_ready',
-                        function () use ($caps_to_remove) {
+                        function() use ($caps_to_remove) {
                             $capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
                             $capabilities->removeCaps($caps_to_remove);
                         }

core/db_classes/EE_Question.class.php

Indentation +19 added lines, -19 removed lines

@@ -445,8 +445,8 @@ 
 		$new_question->set_admin_label( sprintf( __( '%s **Duplicate**', 'event_espresso' ), $this->admin_label() ) );
 		$new_question->set_system_ID( null );
 		$new_question->set_wp_user( get_current_user_id() );
-                //if we're duplicating a trashed question, assume we don't want the new one to be trashed
-                $new_question->set_deleted( false );
+				//if we're duplicating a trashed question, assume we don't want the new one to be trashed
+				$new_question->set_deleted( false );
 		$success = $new_question->save();
 		if( $success ) {
 			//we don't totally want to duplicate the question options, because we want them to be for the NEW question
@@ -501,8 +501,8 @@ 
 		}
 		// has this question been answered ?
 		if ( $answer instanceof EE_Answer
-             && $answer->value() !== ''
-        ) {
+			 && $answer->value() !== ''
+		) {
 			//answer gets htmlspecialchars called on it, undo that please
 			//because the form input's display strategy may call esc_attr too
 			//which also does html special characters
@@ -516,10 +516,10 @@ 
 		}
 		$max_max_for_question = EEM_Question::instance()->absolute_max_for_system_question( $this->system_ID() );
 		if( in_array(
-		    $this->type(),
-            EEM_Question::instance()->questionTypesWithMaxLength(),
-            true
-        ) ) {
+			$this->type(),
+			EEM_Question::instance()->questionTypesWithMaxLength(),
+			true
+		) ) {
 			$input_constructor_args[ 'validation_strategies' ][] = new EE_Max_Length_Validation_Strategy(
 				null,
 				min( $max_max_for_question, $this->max() )
@@ -632,17 +632,17 @@ 
 
 
 
-    /**
-     * Returns whether or not this question type should have question option entries
-     * @return bool
-     */
+	/**
+	 * Returns whether or not this question type should have question option entries
+	 * @return bool
+	 */
 	public function should_have_question_options()
-    {
-        return in_array(
-            $this->type(),
-            $this->_model->question_types_with_options(),
-            true
-        );
-    }
+	{
+		return in_array(
+			$this->type(),
+			$this->_model->question_types_with_options(),
+			true
+		);
+	}
 
 }

Spacing +111 added lines, -111 removed lines

@@ -1,5 +1,5 @@ 
-<?php if ( !defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 /**
  * Event Espresso
@@ -37,9 +37,9 @@ 
 	 *                             		    date_format and the second value is the time format
 	 * @return EE_Question
 	 */
-	public static function new_instance( $props_n_values = array(), $timezone = null, $date_formats = array() ) {
-		$has_object = parent::_check_for_object( $props_n_values, __CLASS__, $timezone, $date_formats );
-		return $has_object ? $has_object : new self( $props_n_values, false, $timezone, $date_formats );
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) {
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
 	}
 
 
@@ -50,8 +50,8 @@ 
 	 *                          		the website will be used.
 	 * @return EE_Question
 	 */
-	public static function new_instance_from_db( $props_n_values = array(), $timezone = null ) {
-		return new self( $props_n_values, TRUE, $timezone );
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null) {
+		return new self($props_n_values, TRUE, $timezone);
 	}
 
 
@@ -62,8 +62,8 @@ 
 	 * @access        public
 	 * @param string $QST_display_text
 	 */
-	public function set_display_text( $QST_display_text = '' ) {
-		$this->set( 'QST_display_text', $QST_display_text );
+	public function set_display_text($QST_display_text = '') {
+		$this->set('QST_display_text', $QST_display_text);
 	}
 
 
@@ -74,8 +74,8 @@ 
 	 * @access        public
 	 * @param        string $QST_admin_label
 	 */
-	public function set_admin_label( $QST_admin_label = '' ) {
-		$this->set( 'QST_admin_label', $QST_admin_label );
+	public function set_admin_label($QST_admin_label = '') {
+		$this->set('QST_admin_label', $QST_admin_label);
 	}
 
 
@@ -86,8 +86,8 @@ 
 	 * @access        public
 	 * @param        mixed $QST_system
 	 */
-	public function set_system_ID( $QST_system = '' ) {
-		$this->set( 'QST_system', $QST_system );
+	public function set_system_ID($QST_system = '') {
+		$this->set('QST_system', $QST_system);
 	}
 
 
@@ -98,8 +98,8 @@ 
 	 * @access        public
 	 * @param        string $QST_type
 	 */
-	public function set_question_type( $QST_type = '' ) {
-		$this->set( 'QST_type', $QST_type );
+	public function set_question_type($QST_type = '') {
+		$this->set('QST_type', $QST_type);
 	}
 
 
@@ -110,8 +110,8 @@ 
 	 * @access        public
 	 * @param        bool $QST_required
 	 */
-	public function set_required( $QST_required = FALSE ) {
-		$this->set( 'QST_required', $QST_required );
+	public function set_required($QST_required = FALSE) {
+		$this->set('QST_required', $QST_required);
 	}
 
 
@@ -122,8 +122,8 @@ 
 	 * @access        public
 	 * @param        string $QST_required_text
 	 */
-	public function set_required_text( $QST_required_text = '' ) {
-		$this->set( 'QST_required_text', $QST_required_text );
+	public function set_required_text($QST_required_text = '') {
+		$this->set('QST_required_text', $QST_required_text);
 	}
 
 
@@ -134,8 +134,8 @@ 
 	 * @access        public
 	 * @param        int $QST_order
 	 */
-	public function set_order( $QST_order = 0 ) {
-		$this->set( 'QST_order', $QST_order );
+	public function set_order($QST_order = 0) {
+		$this->set('QST_order', $QST_order);
 	}
 
 
@@ -146,8 +146,8 @@ 
 	 * @access        public
 	 * @param        bool $QST_admin_only
 	 */
-	public function set_admin_only( $QST_admin_only = FALSE ) {
-		$this->set( 'QST_admin_only', $QST_admin_only );
+	public function set_admin_only($QST_admin_only = FALSE) {
+		$this->set('QST_admin_only', $QST_admin_only);
 	}
 
 
@@ -158,8 +158,8 @@ 
 	 * @access        public
 	 * @param        int $QST_wp_user
 	 */
-	public function set_wp_user( $QST_wp_user = 1 ) {
-		$this->set( 'QST_wp_user', $QST_wp_user );
+	public function set_wp_user($QST_wp_user = 1) {
+		$this->set('QST_wp_user', $QST_wp_user);
 	}
 
 
@@ -175,8 +175,8 @@ 
 	 * @access        public
 	 * @param 	bool $QST_deleted
 	 */
-	public function set_deleted( $QST_deleted = FALSE ) {
-		$this->set( 'QST_deleted', $QST_deleted );
+	public function set_deleted($QST_deleted = FALSE) {
+		$this->set('QST_deleted', $QST_deleted);
 	}
 
 
@@ -187,7 +187,7 @@ 
 	 * @return string
 	 */
 	public function display_text() {
-		return $this->get( 'QST_display_text' );
+		return $this->get('QST_display_text');
 	}
 
 
@@ -198,7 +198,7 @@ 
 	 * @return string
 	 */
 	public function admin_label() {
-		return $this->get( 'QST_admin_label' );
+		return $this->get('QST_admin_label');
 	}
 
 
@@ -209,7 +209,7 @@ 
 	 * @return string
 	 */
 	public function system_ID() {
-		return $this->get( 'QST_system' );
+		return $this->get('QST_system');
 	}
 
 
@@ -220,7 +220,7 @@ 
 	 * @return boolean
 	 */
 	public function required() {
-		return $this->get( 'QST_required' );
+		return $this->get('QST_required');
 	}
 
 
@@ -232,7 +232,7 @@ 
 	 * @return string
 	 */
 	public function required_text() {
-		return $this->get( 'QST_required_text' );
+		return $this->get('QST_required_text');
 	}
 
 
@@ -243,7 +243,7 @@ 
 	 * @return string
 	 */
 	public function type() {
-		return $this->get( 'QST_type' );
+		return $this->get('QST_type');
 	}
 
 
@@ -255,7 +255,7 @@ 
 	 * @return int
 	 */
 	public function order() {
-		return $this->get( 'QST_order' );
+		return $this->get('QST_order');
 	}
 
 
@@ -267,7 +267,7 @@ 
 	 * @return boolean
 	 */
 	public function admin_only() {
-		return $this->get( 'QST_admin_only' );
+		return $this->get('QST_admin_only');
 	}
 
 
@@ -278,7 +278,7 @@ 
 	 * @return int
 	 */
 	public function wp_user() {
-		return $this->get( 'QST_wp_user' );
+		return $this->get('QST_wp_user');
 	}
 
 
@@ -289,7 +289,7 @@ 
 	 * @return boolean
 	 */
 	public function deleted() {
-		return $this->get( 'QST_deleted' );
+		return $this->get('QST_deleted');
 	}
 
 
@@ -299,7 +299,7 @@ 
 	 * @return EE_Answer[]
 	 */
 	public function answers() {
-		return $this->get_many_related( 'Answer' );
+		return $this->get_many_related('Answer');
 	}
 
 
@@ -309,7 +309,7 @@ 
 	 * @return boolean true = has answers, false = no answers.
 	 */
 	public function has_answers() {
-		return $this->count_related( 'Answer' ) > 0 ? TRUE : FALSE;
+		return $this->count_related('Answer') > 0 ? TRUE : FALSE;
 	}
 
 
@@ -319,7 +319,7 @@ 
 	 * @return EE_Question_Group[]
 	 */
 	public function question_groups() {
-		return $this->get_many_related( 'Question_Group' );
+		return $this->get_many_related('Question_Group');
 	}
 
 
@@ -333,24 +333,24 @@ 
 	 *                                                       whether it was trashed or not.
 	 * @return EE_Question_Option[]
 	 */
-	public function options( $notDeletedOptionsOnly = TRUE, $selected_value_to_always_include = NULL ) {
-		if ( ! $this->ID() ) {
+	public function options($notDeletedOptionsOnly = TRUE, $selected_value_to_always_include = NULL) {
+		if ( ! $this->ID()) {
 			return array();
 		}
 		$query_params = array();
-		if ( $selected_value_to_always_include ) {
-			if ( is_array( $selected_value_to_always_include ) ) {
-				$query_params[ 0 ][ 'OR*options-query' ][ 'QSO_value' ] = array( 'IN', $selected_value_to_always_include );
+		if ($selected_value_to_always_include) {
+			if (is_array($selected_value_to_always_include)) {
+				$query_params[0]['OR*options-query']['QSO_value'] = array('IN', $selected_value_to_always_include);
 			} else {
-				$query_params[ 0 ][ 'OR*options-query' ][ 'QSO_value' ] = $selected_value_to_always_include;
+				$query_params[0]['OR*options-query']['QSO_value'] = $selected_value_to_always_include;
 			}
 		}
-		if ( $notDeletedOptionsOnly ) {
-			$query_params[ 0 ][ 'OR*options-query' ][ 'QSO_deleted' ] = FALSE;
+		if ($notDeletedOptionsOnly) {
+			$query_params[0]['OR*options-query']['QSO_deleted'] = FALSE;
 		}
 		//order by QSO_order
-		$query_params[ 'order_by' ] = array( 'QSO_order' => 'ASC' );
-		return $this->get_many_related( 'Question_Option', $query_params );
+		$query_params['order_by'] = array('QSO_order' => 'ASC');
+		return $this->get_many_related('Question_Option', $query_params);
 	}
 
 
@@ -360,7 +360,7 @@ 
 	 * @return \EE_Question_Option[]
 	 */
 	public function temp_options() {
-		return $this->_model_relations[ 'Question_Option' ];
+		return $this->_model_relations['Question_Option'];
 	}
 
 
@@ -371,8 +371,8 @@ 
 	 * @param EE_Question_Option $option
 	 * @return boolean success
 	 */
-	public function add_option( EE_Question_Option $option ) {
-		return $this->_add_relation_to( $option, 'Question_Option' );
+	public function add_option(EE_Question_Option $option) {
+		return $this->_add_relation_to($option, 'Question_Option');
 	}
 
 
@@ -382,8 +382,8 @@ 
 	 * @param EE_Question_Option $option
 	 * @return boolean success
 	 */
-	public function add_temp_option( EE_Question_Option $option ) {
-		$this->_model_relations[ 'Question_Option' ][ ] = $option;
+	public function add_temp_option(EE_Question_Option $option) {
+		$this->_model_relations['Question_Option'][] = $option;
 		return TRUE;
 	}
 
@@ -394,8 +394,8 @@ 
 	 * @param EE_Question_Option $option
 	 * @return boolean success
 	 */
-	public function remove_option( EE_Question_Option $option ) {
-		return $this->_remove_relation_to( $option, 'Question_Option' );
+	public function remove_option(EE_Question_Option $option) {
+		return $this->_remove_relation_to($option, 'Question_Option');
 	}
 
 
@@ -404,8 +404,8 @@ 
 	 * @return bool
 	 */
 	public function is_system_question() {
-		$system_ID = $this->get( 'QST_system' );
-		return ! empty( $system_ID ) ? TRUE : FALSE;
+		$system_ID = $this->get('QST_system');
+		return ! empty($system_ID) ? TRUE : FALSE;
 	}
 
 
@@ -418,8 +418,8 @@ 
 	 */
 	public function set_order_to_latest() {
 		$latest_order = $this->get_model()->get_latest_question_order();
-		$latest_order ++;
-		$this->set( 'QST_order', $latest_order );
+		$latest_order++;
+		$this->set('QST_order', $latest_order);
 	}
 
 
@@ -438,20 +438,20 @@ 
 	 * Duplicates this question and its question options
 	 * @return \EE_Question
 	 */
-	public function duplicate( $options = array() ) {
+	public function duplicate($options = array()) {
 		$new_question = clone $this;
-		$new_question->set( 'QST_ID', null );
-		$new_question->set_display_text( sprintf( __( '%s **Duplicate**', 'event_espresso' ), $this->display_text() ) );
-		$new_question->set_admin_label( sprintf( __( '%s **Duplicate**', 'event_espresso' ), $this->admin_label() ) );
-		$new_question->set_system_ID( null );
-		$new_question->set_wp_user( get_current_user_id() );
+		$new_question->set('QST_ID', null);
+		$new_question->set_display_text(sprintf(__('%s **Duplicate**', 'event_espresso'), $this->display_text()));
+		$new_question->set_admin_label(sprintf(__('%s **Duplicate**', 'event_espresso'), $this->admin_label()));
+		$new_question->set_system_ID(null);
+		$new_question->set_wp_user(get_current_user_id());
                 //if we're duplicating a trashed question, assume we don't want the new one to be trashed
-                $new_question->set_deleted( false );
+                $new_question->set_deleted(false);
 		$success = $new_question->save();
-		if( $success ) {
+		if ($success) {
 			//we don't totally want to duplicate the question options, because we want them to be for the NEW question
-			foreach( $this->options() as $question_option ) {
-				$question_option->duplicate( array( 'QST_ID' => $new_question->ID() ) );
+			foreach ($this->options() as $question_option) {
+				$question_option->duplicate(array('QST_ID' => $new_question->ID()));
 			}
 			return $new_question;
 		} else {
@@ -464,7 +464,7 @@ 
 	 * @return int|float
 	 */
 	public function max() {
-		return $this->get( 'QST_max' );
+		return $this->get('QST_max');
 	}
 
 	/**
@@ -472,8 +472,8 @@ 
 	 * @param int|float $new_max
 	 * @return void
 	 */
-	public function set_max( $new_max ) {
-		$this->set( 'QST_max', $new_max );
+	public function set_max($new_max) {
+		$this->set('QST_max', $new_max);
 	}
 
 
@@ -485,7 +485,7 @@ 
 	 * @param array $input_constructor_args
 	 * @return EE_Form_Input_Base
 	 */
-	public function generate_form_input( $registration = null, $answer = null, $input_constructor_args = array() ) {
+	public function generate_form_input($registration = null, $answer = null, $input_constructor_args = array()) {
 		$identifier = $this->is_system_question() ? $this->system_ID() : $this->ID();
 
 		$input_constructor_args = array_merge(
@@ -496,33 +496,33 @@ 
 				),
 				$input_constructor_args
 			);
-		if( ! $answer instanceof EE_Answer && $registration instanceof EE_Registration ) {
-			$answer = EEM_Answer::instance()->get_registration_question_answer_object( $registration, $this->ID() );
+		if ( ! $answer instanceof EE_Answer && $registration instanceof EE_Registration) {
+			$answer = EEM_Answer::instance()->get_registration_question_answer_object($registration, $this->ID());
 		}
 		// has this question been answered ?
-		if ( $answer instanceof EE_Answer
+		if ($answer instanceof EE_Answer
              && $answer->value() !== ''
         ) {
 			//answer gets htmlspecialchars called on it, undo that please
 			//because the form input's display strategy may call esc_attr too
 			//which also does html special characters
 			$values_with_html_special_chars = $answer->value();
-			if( is_array( $values_with_html_special_chars ) ) {
-				$default_value = array_map( 'htmlspecialchars_decode', $values_with_html_special_chars );
+			if (is_array($values_with_html_special_chars)) {
+				$default_value = array_map('htmlspecialchars_decode', $values_with_html_special_chars);
 			} else {
-				$default_value = htmlspecialchars_decode( $values_with_html_special_chars );
+				$default_value = htmlspecialchars_decode($values_with_html_special_chars);
 			}
 			$input_constructor_args['default'] = $default_value;
 		}
-		$max_max_for_question = EEM_Question::instance()->absolute_max_for_system_question( $this->system_ID() );
-		if( in_array(
+		$max_max_for_question = EEM_Question::instance()->absolute_max_for_system_question($this->system_ID());
+		if (in_array(
 		    $this->type(),
             EEM_Question::instance()->questionTypesWithMaxLength(),
             true
-        ) ) {
-			$input_constructor_args[ 'validation_strategies' ][] = new EE_Max_Length_Validation_Strategy(
+        )) {
+			$input_constructor_args['validation_strategies'][] = new EE_Max_Length_Validation_Strategy(
 				null,
-				min( $max_max_for_question, $this->max() )
+				min($max_max_for_question, $this->max())
 			);
 		}
 		$input_constructor_args = apply_filters(
@@ -534,22 +534,22 @@ 
 		);
 
 		$result = null;
-		switch ( $this->type() ) {
+		switch ($this->type()) {
 			// Text
 			case EEM_Question::QST_type_text :
-				$result = new EE_Text_Input( $input_constructor_args );
+				$result = new EE_Text_Input($input_constructor_args);
 				break;
 			// Textarea
 			case EEM_Question::QST_type_textarea :
-				$result = new EE_Text_Area_Input( $input_constructor_args );
+				$result = new EE_Text_Area_Input($input_constructor_args);
 				break;
 			// Radio Buttons
 			case EEM_Question::QST_type_radio :
-				$result = new EE_Radio_Button_Input( $this->options(), $input_constructor_args );
+				$result = new EE_Radio_Button_Input($this->options(), $input_constructor_args);
 				break;
 			// Dropdown
 			case EEM_Question::QST_type_dropdown :
-				$result = new EE_Select_Input( $this->options(), $input_constructor_args );
+				$result = new EE_Select_Input($this->options(), $input_constructor_args);
 				break;
 			// State Dropdown
 			case EEM_Question::QST_type_state :
@@ -560,7 +560,7 @@ 
 					$registration,
 					$answer
 				);				
-				$result = new EE_State_Select_Input( $state_options, $input_constructor_args );
+				$result = new EE_State_Select_Input($state_options, $input_constructor_args);
 				break;
 			// Country Dropdown
 			case EEM_Question::QST_type_country :
@@ -571,47 +571,47 @@ 
 					$registration,
 					$answer
 				);
-				$result = new EE_Country_Select_Input( $country_options, $input_constructor_args );
+				$result = new EE_Country_Select_Input($country_options, $input_constructor_args);
 				break;
 			// Checkboxes
 			case EEM_Question::QST_type_checkbox :
-				$result = new EE_Checkbox_Multi_Input( $this->options(), $input_constructor_args );
+				$result = new EE_Checkbox_Multi_Input($this->options(), $input_constructor_args);
 				break;
 			// Date
 			case EEM_Question::QST_type_date :
-				$result = new EE_Datepicker_Input( $input_constructor_args );
+				$result = new EE_Datepicker_Input($input_constructor_args);
 				break;
 			case EEM_Question::QST_type_html_textarea :
-				$input_constructor_args[ 'validation_strategies' ][] = new EE_Simple_HTML_Validation_Strategy();
-				$result =  new EE_Text_Area_Input( $input_constructor_args );
-				$result->remove_validation_strategy( 'EE_Plaintext_Validation_Strategy' );
+				$input_constructor_args['validation_strategies'][] = new EE_Simple_HTML_Validation_Strategy();
+				$result = new EE_Text_Area_Input($input_constructor_args);
+				$result->remove_validation_strategy('EE_Plaintext_Validation_Strategy');
 				break;
 			case EEM_Question::QST_type_email :
-				$result = new EE_Email_Input( $input_constructor_args );
+				$result = new EE_Email_Input($input_constructor_args);
 				break;
 			case EEM_Question::QST_type_us_phone :
-				$result = new EE_Phone_Input( $input_constructor_args );
+				$result = new EE_Phone_Input($input_constructor_args);
 				break;
 			case EEM_Question::QST_type_int :
-				$result = new EE_Integer_Input( $input_constructor_args );
+				$result = new EE_Integer_Input($input_constructor_args);
 				break;
 			case EEM_Question::QST_type_decimal :
-				$result = new EE_Float_Input( $input_constructor_args );
+				$result = new EE_Float_Input($input_constructor_args);
 				break;
 			case EEM_Question::QST_type_url :
-				$input_constructor_args[ 'validation_strategies' ][] = new EE_URL_Validation_Strategy();
-				$result = new EE_Text_Input( $input_constructor_args );
+				$input_constructor_args['validation_strategies'][] = new EE_URL_Validation_Strategy();
+				$result = new EE_Text_Input($input_constructor_args);
 				break;
 			case EEM_Question::QST_type_year :
 				$result = new EE_Year_Input(
 						$input_constructor_args,
-						apply_filters( 'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__four_digit', true, $this ),
-						apply_filters( 'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__early_range', 100, $this ),
-						apply_filters( 'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__end_range', 100, $this )
+						apply_filters('FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__four_digit', true, $this),
+						apply_filters('FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__early_range', 100, $this),
+						apply_filters('FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__end_range', 100, $this)
 						);
 				break;
 			case EEM_Question::QST_type_multi_select :
-				$result = new EE_Select_Multiple_Input( $this->options(), $input_constructor_args );
+				$result = new EE_Select_Multiple_Input($this->options(), $input_constructor_args);
 				break;
 			// fallback
 			default :
@@ -622,12 +622,12 @@ 
 					$this,
 					$input_constructor_args
 				);
-				if( ! $default_input ){
-					$default_input = new EE_Text_Input( $input_constructor_args );
+				if ( ! $default_input) {
+					$default_input = new EE_Text_Input($input_constructor_args);
 				}
 				$result = $default_input;
 		}
-		return apply_filters( 'FHEE__EE_Question__generate_form_input__return', $result, $registration, $this, $answer );
+		return apply_filters('FHEE__EE_Question__generate_form_input__return', $result, $registration, $this, $answer);
 	}
 
 

core/db_models/EEM_Question.model.php

Indentation +426 added lines, -426 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (!defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 require_once(EE_MODELS . 'EEM_Soft_Delete_Base.model.php');
 require_once(EE_CLASSES . 'EE_Question.class.php');
@@ -16,431 +16,431 @@ 
 class EEM_Question extends EEM_Soft_Delete_Base
 {
 
-    // constant used to indicate that the question type is COUNTRY
-    const QST_type_country = 'COUNTRY';
-
-    // constant used to indicate that the question type is DATE
-    const QST_type_date = 'DATE';
-
-    // constant used to indicate that the question type is DROPDOWN
-    const QST_type_dropdown = 'DROPDOWN';
-
-    // constant used to indicate that the question type is CHECKBOX
-    const QST_type_checkbox = 'CHECKBOX';
-
-    // constant used to indicate that the question type is RADIO_BTN
-    const QST_type_radio = 'RADIO_BTN';
-
-    // constant used to indicate that the question type is STATE
-    const QST_type_state = 'STATE';
-
-    // constant used to indicate that the question type is TEXT
-    const QST_type_text = 'TEXT';
-
-    // constant used to indicate that the question type is TEXTAREA
-    const QST_type_textarea = 'TEXTAREA';
-
-    // constant used to indicate that the question type is a TEXTAREA that allows simple html
-    const QST_type_html_textarea = 'HTML_TEXTAREA';
-
-    // constant used to indicate that the question type is an email input
-    const QST_type_email = 'EMAIL';
-
-    // constant used to indicate that the question type is a US-formatted phone number
-    const QST_type_us_phone = 'US_PHONE';
-
-    // constant used to indicate that the question type is an integer (whole number)
-    const QST_type_int = 'INTEGER';
-
-    // constant used to indicate that the question type is a decimal (float)
-    const QST_type_decimal = 'DECIMAL';
-
-    // constant used to indicate that the question type is a valid URL
-    const QST_type_url = 'URL';
-
-    // constant used to indicate that the question type is a YEAR
-    const QST_type_year = 'YEAR';
-
-    // constant used to indicate that the question type is a multi-select
-    const QST_type_multi_select = 'MULTI_SELECT';
-
-    /**
-     * Question types that are interchangeable, even after answers have been provided for them.
-     * Top-level keys are category slugs, next level is an array of question types. If question types
-     * aren't in this array, it is assumed they AREN'T interchangeable with any other question types.
-     *
-     * @access protected
-     * @var array $_question_type_categories {
-     * @type string $text
-     * @type string $single -answer-enum
-     * @type string $multi -answer-enum
-     *                    }
-     */
-    protected $_question_type_categories = array();
-
-    /**
-     * lists all the question types which should be allowed. Ideally, this will be extensible.
-     *
-     * @access protected
-     * @var array $_allowed_question_types
-     */
-    protected $_allowed_question_types = array();
-
-    /**
-     * brief descriptions for all the question types
-     *
-     * @access protected
-     * @var EEM_Question $_instance
-     */
-    protected $_question_descriptions;
-
-
-    /**
-     * Question types that should have an admin-defined max input length
-     * @var array
-     */
-    protected $question_types_with_max_lengh;
-
-
-    // private instance of the Attendee object
-    protected static $_instance = NULL;
-
-
-    /**
-     * EEM_Question constructor.
-     *
-     * @param null $timezone
-     */
-    protected function __construct($timezone = NULL)
-    {
-        $this->singular_item = __('Question', 'event_espresso');
-        $this->plural_item = __('Questions', 'event_espresso');
-        $this->_allowed_question_types = apply_filters(
-            'FHEE__EEM_Question__construct__allowed_question_types',
-            array(
-                EEM_Question::QST_type_text => __('Text', 'event_espresso'),
-                EEM_Question::QST_type_textarea => __('Textarea', 'event_espresso'),
-                EEM_Question::QST_type_checkbox => __('Checkboxes', 'event_espresso'),
-                EEM_Question::QST_type_radio => __('Radio Buttons', 'event_espresso'),
-                EEM_Question::QST_type_dropdown => __('Dropdown', 'event_espresso'),
-                EEM_Question::QST_type_state => __('State/Province Dropdown', 'event_espresso'),
-                EEM_Question::QST_type_country => __('Country Dropdown', 'event_espresso'),
-                EEM_Question::QST_type_date => __('Date Picker', 'event_espresso'),
-                EEM_Question::QST_type_html_textarea => __('HTML Textarea', 'event_espresso'),
-                EEM_Question::QST_type_email => __('Email', 'event_espresso'),
-                EEM_Question::QST_type_us_phone => __('USA - Format Phone', 'event_espresso'),
-                EEM_Question::QST_type_decimal => __('Number', 'event_espresso'),
-                EEM_Question::QST_type_int => __('Whole Number', 'event_espresso'),
-                EEM_Question::QST_type_url => __('URL', 'event_espresso'),
-                EEM_Question::QST_type_year => __('Year', 'event_espresso'),
-                EEM_Question::QST_type_multi_select => __('Multi Select', 'event_espresso')
-            )
-        );
-        $this->_question_descriptions = apply_filters(
-            'FHEE__EEM_Question__construct__allowed_question_types',
-            array(
-                EEM_Question::QST_type_text => __('A single line text input field', 'event_espresso'),
-                EEM_Question::QST_type_textarea => __('A multi line text input field', 'event_espresso'),
-                EEM_Question::QST_type_checkbox => __('Allows multiple preset options to be selected', 'event_espresso'),
-                EEM_Question::QST_type_radio => __('Allows a single preset option to be selected', 'event_espresso'),
-                EEM_Question::QST_type_dropdown => __('A dropdown that allows a single selection', 'event_espresso'),
-                EEM_Question::QST_type_state => __('A dropdown that lists states/provinces', 'event_espresso'),
-                EEM_Question::QST_type_country => __('A dropdown that lists countries', 'event_espresso'),
-                EEM_Question::QST_type_date => __('A popup calendar that allows date selections', 'event_espresso'),
-                EEM_Question::QST_type_html_textarea => __('A multi line text input field that allows HTML', 'event_espresso'),
-                EEM_Question::QST_type_email => __('A text field that must contain a valid Email address', 'event_espresso'),
-                EEM_Question::QST_type_us_phone => __('A text field that must contain a valid US phone number', 'event_espresso'),
-                EEM_Question::QST_type_decimal => __('A text field that allows number values with decimals', 'event_espresso'),
-                EEM_Question::QST_type_int => __('A text field that only allows whole numbers (no decimals)', 'event_espresso'),
-                EEM_Question::QST_type_url => __('A text field that must contain a valid URL', 'event_espresso'),
-                EEM_Question::QST_type_year => __('A dropdown that lists the last 100 years', 'event_espresso'),
-                EEM_Question::QST_type_multi_select => __('A dropdown that allows multiple selections', 'event_espresso')
-            )
-        );
-        $this->_question_type_categories = (array)apply_filters(
-            'FHEE__EEM_Question__construct__question_type_categories',
-            array(
-                'text' => array(
-                    EEM_Question::QST_type_text,
-                    EEM_Question::QST_type_textarea,
-                    EEM_Question::QST_type_date,
-                    EEM_Question::QST_type_html_textarea,
-                    EEM_Question::QST_type_email,
-                    EEM_Question::QST_type_us_phone,
-                    EEM_Question::QST_type_decimal,
-                    EEM_Question::QST_type_int,
-                    EEM_Question::QST_type_url,
-                    EEM_Question::QST_type_year
-                ),
-                'single-answer-enum' => array(
-                    EEM_Question::QST_type_radio,
-                    EEM_Question::QST_type_dropdown
-                ),
-                'multi-answer-enum' => array(
-                    EEM_Question::QST_type_checkbox,
-                    EEM_Question::QST_type_multi_select
-                )
-            )
-        );
-        $this->question_types_with_max_lengh = apply_filters(
-            'FHEE__EEM_Question___construct__question_types_with_max_length',
-            array(
-                EEM_Question::QST_type_text,
-                EEM_Question::QST_type_textarea,
-                EEM_Question::QST_type_html_textarea
-            )
-        );
-
-        $this->_tables = array(
-            'Question' => new EE_Primary_Table('esp_question', 'QST_ID')
-        );
-        $this->_fields = array(
-            'Question' => array(
-                'QST_ID' => new EE_Primary_Key_Int_Field('QST_ID', __('Question ID', 'event_espresso')),
-                'QST_display_text' => new EE_Post_Content_Field('QST_display_text', __('Question Text', 'event_espresso'), true, ''),
-                'QST_admin_label' => new EE_Plain_Text_Field('QST_admin_label', __('Question Label (admin-only)', 'event_espresso'), true, ''),
-                'QST_system' => new EE_Plain_Text_Field('QST_system', __('Internal string ID for question', 'event_espresso'), false, ''),
-                'QST_type' => new EE_Enum_Text_Field('QST_type', __('Question Type', 'event_espresso'), false, 'TEXT', $this->_allowed_question_types),
-                'QST_required' => new EE_Boolean_Field('QST_required', __('Required Question?', 'event_espresso'), false, false),
-                'QST_required_text' => new EE_Simple_HTML_Field('QST_required_text', __('Text to Display if Not Provided', 'event_espresso'), true, ''),
-                'QST_order' => new EE_Integer_Field('QST_order', __('Question Order', 'event_espresso'), false, 0),
-                'QST_admin_only' => new EE_Boolean_Field('QST_admin_only', __('Admin-Only Question?', 'event_espresso'), false, false),
-                'QST_max' => new EE_Infinite_Integer_Field('QST_max', __('Max Size', 'event_espresso'), false, EE_INF),
-                'QST_wp_user' => new EE_WP_User_Field('QST_wp_user', __('Question Creator ID', 'event_espresso'), false),
-                'QST_deleted' => new EE_Trashed_Flag_Field('QST_deleted', __('Flag Indicating question was deleted', 'event_espresso'), false, false)
-            )
-        );
-        $this->_model_relations = array(
-            'Question_Group' => new EE_HABTM_Relation('Question_Group_Question'),
-            'Question_Option' => new EE_Has_Many_Relation(),
-            'Answer' => new EE_Has_Many_Relation(),
-            'WP_User' => new EE_Belongs_To_Relation(),
-            //for QST_order column
-            'Question_Group_Question' => new EE_Has_Many_Relation()
-        );
-        //this model is generally available for reading
-        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] = new EE_Restriction_Generator_Reg_Form('QST_system');
-        $this->_cap_restriction_generators[EEM_Base::caps_edit] = new EE_Restriction_Generator_Reg_Form('QST_system');
-        $this->_cap_restriction_generators[EEM_Base::caps_delete] = new EE_Restriction_Generator_Reg_Form('QST_system');
-        parent::__construct($timezone);
-    }
-
-    /**
-     * Returns the list of allowed question types, which are normally: 'TEXT','TEXTAREA','RADIO_BTN','DROPDOWN','CHECKBOX','DATE'
-     * but they can be extended
-     * @return string[]
-     */
-    public function allowed_question_types()
-    {
-        return $this->_allowed_question_types;
-    }
-
-    /**
-     * Gets all the question types in the same category
-     * @param string $question_type one of EEM_Question::allowed_question_types(
-     * @return string[] like EEM_Question::allowed_question_types()
-     */
-    public function question_types_in_same_category($question_type)
-    {
-        $question_types = array($question_type);
-        foreach ($this->_question_type_categories as $category => $question_types_in_category) {
-            if (in_array($question_type, $question_types_in_category)) {
-                $question_types = $question_types_in_category;
-                break;
-            }
-        }
-
-        return array_intersect_key($this->allowed_question_types(), array_flip($question_types));
-    }
-
-    /**
-     * Determines if the given question type is in the given question type category
-     * @param string $question_type one of EEM_Question::allowed_question_types()
-     * @param string $category one of the top-level keys of EEM_Question::question_type_categories()
-     * @return boolean
-     */
-    public function question_type_is_in_category($question_type, $category)
-    {
-        if (!isset($this->_question_type_categories[$category])) {
-            return false;
-        }
-        return in_array($question_type, $this->_question_type_categories[$category]);
-    }
-
-
-    /**
-     * Returns all the question types in the given category
-     * @param string $category
-     * @return array|mixed
-     */
-    public function question_types_in_category($category)
-    {
-        if (isset($this->_question_type_categories[$category])) {
-            return $this->_question_type_categories[$category];
-        }
-        return array();
-    }
-
-
-    /**
-     * Returns all the question types that should have question options
-     * @return array
-     */
-    public function question_types_with_options()
-    {
-        return array_merge(
-            $this->question_types_in_category('single-answer-enum'),
-            $this->question_types_in_category('multi-answer-enum')
-        );
-    }
-
-    /**
-     * Returns the question type categories 2d array
-     * @return array see EEM_Question::_question_type_categories
-     */
-    public function question_type_categories()
-    {
-        return $this->_question_type_categories;
-    }
-
-    /**
-     * Returns an array of all the QST_system values that can be allowed in the system question group
-     * identified by $system_question_group_id
-     * @param string $system_question_group_id QSG_system
-     * @return array of system question names (QST_system)
-     */
-    public function allowed_system_questions_in_system_question_group($system_question_group_id)
-    {
-        $question_system_ids = array();
-        switch ($system_question_group_id) {
-            case EEM_Question_Group::system_personal:
-                $question_system_ids = array(
-                    EEM_Attendee::system_question_fname,
-                    EEM_Attendee::system_question_lname,
-                    EEM_Attendee::system_question_email,
-                    EEM_Attendee::system_question_phone
-                );
-                break;
-            case EEM_Question_Group::system_address:
-                $question_system_ids = array(
-                    EEM_Attendee::system_question_address,
-                    EEM_Attendee::system_question_address2,
-                    EEM_Attendee::system_question_city,
-                    EEM_Attendee::system_question_state,
-                    EEM_Attendee::system_question_country,
-                    EEM_Attendee::system_question_zip,
-                    EEM_Attendee::system_question_phone
-                );
-                break;
-        }
-        return apply_filters('FHEE__EEM_Question__system_questions_allowed_in_system_question_group__return', $question_system_ids, $system_question_group_id);
-    }
-
-    /**
-     * Returns an array of all the QST_system values that are required in the system question group
-     * identified by $system_question_group_id
-     * @param string $system_question_group_id QSG_system
-     * @return array of system question names (QST_system)
-     */
-    public function required_system_questions_in_system_question_group($system_question_group_id)
-    {
-        $question_system_ids = null;
-        switch ($system_question_group_id) {
-            case EEM_Question_Group::system_personal:
-                $question_system_ids = array(
-                    EEM_Attendee::system_question_fname,
-                    EEM_Attendee::system_question_email,
-                );
-                break;
-            default:
-                $question_system_ids = array();
-        }
-        return apply_filters('FHEE__EEM_Question__system_questions_required_in_system_question_group', $question_system_ids, $system_question_group_id);
-    }
-
-
-    /**
-     * Gets an array for converting between QST_system and QST_IDs for system questions. Eg, if you want to know
-     * which system question QST_ID corresponds to the QST_system 'city', use EEM_Question::instance()->get_Question_ID_from_system_string('city');
-     * @param $QST_system
-     * @return int of QST_ID for the question that corresponds to that QST_system
-     */
-    public function get_Question_ID_from_system_string($QST_system)
-    {
-        return $this->get_var(array(array('QST_system' => $QST_system)));
-    }
-
-
-    /**
-     * searches the db for the question with the latest question order and returns that value.
-     * @access public
-     * @return int
-     */
-    public function get_latest_question_order()
-    {
-        $columns_to_select = array(
-            'max_order' => array("MAX(QST_order)", "%d")
-        );
-        $max = $this->_get_all_wpdb_results(array(), ARRAY_A, $columns_to_select);
-        return isset($max[0], $max[0]['max_order']) ? $max[0]['max_order'] : 0;
-    }
-
-    /**
-     * Returns an array where keys are system question QST_system values,
-     * and values are the highest question max the admin can set on the question
-     * (aka the "max max"; eg, a site admin can change the zip question to have a max
-     * of 5, but no larger than 12)
-     * @return array
-     */
-    public function system_question_maxes()
-    {
-        return array(
-            'fname' => 45,
-            'lname' => 45,
-            'address' => 255,
-            'address2' => 255,
-            'city' => 45,
-            'zip' => 12,
-            'email' => 255,
-            'phone' => 45,
-        );
-    }
-
-    /**
-     * Given a QST_system value, gets the question's largest allowable max input.
-     * @see Registration_Form_Admin_Page::system_question_maxes()
-     * @param string $system_question_value
-     * @return int|float
-     */
-    public function absolute_max_for_system_question($system_question_value)
-    {
-        $maxes = $this->system_question_maxes();
-        if (isset($maxes[$system_question_value])) {
-            return $maxes[$system_question_value];
-        } else {
-            return EE_INF;
-        }
-    }
-
-
-    /**
-     * @return array
-     */
-    public function question_descriptions()
-    {
-        return $this->_question_descriptions;
-    }
-
-
-    /**
-     * Returns all the question types that should have an admin-defined max input length
-     * @return array
-     */
-    public function questionTypesWithMaxLength()
-    {
-        return (array)$this->question_types_with_max_lengh;
-    }
+	// constant used to indicate that the question type is COUNTRY
+	const QST_type_country = 'COUNTRY';
+
+	// constant used to indicate that the question type is DATE
+	const QST_type_date = 'DATE';
+
+	// constant used to indicate that the question type is DROPDOWN
+	const QST_type_dropdown = 'DROPDOWN';
+
+	// constant used to indicate that the question type is CHECKBOX
+	const QST_type_checkbox = 'CHECKBOX';
+
+	// constant used to indicate that the question type is RADIO_BTN
+	const QST_type_radio = 'RADIO_BTN';
+
+	// constant used to indicate that the question type is STATE
+	const QST_type_state = 'STATE';
+
+	// constant used to indicate that the question type is TEXT
+	const QST_type_text = 'TEXT';
+
+	// constant used to indicate that the question type is TEXTAREA
+	const QST_type_textarea = 'TEXTAREA';
+
+	// constant used to indicate that the question type is a TEXTAREA that allows simple html
+	const QST_type_html_textarea = 'HTML_TEXTAREA';
+
+	// constant used to indicate that the question type is an email input
+	const QST_type_email = 'EMAIL';
+
+	// constant used to indicate that the question type is a US-formatted phone number
+	const QST_type_us_phone = 'US_PHONE';
+
+	// constant used to indicate that the question type is an integer (whole number)
+	const QST_type_int = 'INTEGER';
+
+	// constant used to indicate that the question type is a decimal (float)
+	const QST_type_decimal = 'DECIMAL';
+
+	// constant used to indicate that the question type is a valid URL
+	const QST_type_url = 'URL';
+
+	// constant used to indicate that the question type is a YEAR
+	const QST_type_year = 'YEAR';
+
+	// constant used to indicate that the question type is a multi-select
+	const QST_type_multi_select = 'MULTI_SELECT';
+
+	/**
+	 * Question types that are interchangeable, even after answers have been provided for them.
+	 * Top-level keys are category slugs, next level is an array of question types. If question types
+	 * aren't in this array, it is assumed they AREN'T interchangeable with any other question types.
+	 *
+	 * @access protected
+	 * @var array $_question_type_categories {
+	 * @type string $text
+	 * @type string $single -answer-enum
+	 * @type string $multi -answer-enum
+	 *                    }
+	 */
+	protected $_question_type_categories = array();
+
+	/**
+	 * lists all the question types which should be allowed. Ideally, this will be extensible.
+	 *
+	 * @access protected
+	 * @var array $_allowed_question_types
+	 */
+	protected $_allowed_question_types = array();
+
+	/**
+	 * brief descriptions for all the question types
+	 *
+	 * @access protected
+	 * @var EEM_Question $_instance
+	 */
+	protected $_question_descriptions;
+
+
+	/**
+	 * Question types that should have an admin-defined max input length
+	 * @var array
+	 */
+	protected $question_types_with_max_lengh;
+
+
+	// private instance of the Attendee object
+	protected static $_instance = NULL;
+
+
+	/**
+	 * EEM_Question constructor.
+	 *
+	 * @param null $timezone
+	 */
+	protected function __construct($timezone = NULL)
+	{
+		$this->singular_item = __('Question', 'event_espresso');
+		$this->plural_item = __('Questions', 'event_espresso');
+		$this->_allowed_question_types = apply_filters(
+			'FHEE__EEM_Question__construct__allowed_question_types',
+			array(
+				EEM_Question::QST_type_text => __('Text', 'event_espresso'),
+				EEM_Question::QST_type_textarea => __('Textarea', 'event_espresso'),
+				EEM_Question::QST_type_checkbox => __('Checkboxes', 'event_espresso'),
+				EEM_Question::QST_type_radio => __('Radio Buttons', 'event_espresso'),
+				EEM_Question::QST_type_dropdown => __('Dropdown', 'event_espresso'),
+				EEM_Question::QST_type_state => __('State/Province Dropdown', 'event_espresso'),
+				EEM_Question::QST_type_country => __('Country Dropdown', 'event_espresso'),
+				EEM_Question::QST_type_date => __('Date Picker', 'event_espresso'),
+				EEM_Question::QST_type_html_textarea => __('HTML Textarea', 'event_espresso'),
+				EEM_Question::QST_type_email => __('Email', 'event_espresso'),
+				EEM_Question::QST_type_us_phone => __('USA - Format Phone', 'event_espresso'),
+				EEM_Question::QST_type_decimal => __('Number', 'event_espresso'),
+				EEM_Question::QST_type_int => __('Whole Number', 'event_espresso'),
+				EEM_Question::QST_type_url => __('URL', 'event_espresso'),
+				EEM_Question::QST_type_year => __('Year', 'event_espresso'),
+				EEM_Question::QST_type_multi_select => __('Multi Select', 'event_espresso')
+			)
+		);
+		$this->_question_descriptions = apply_filters(
+			'FHEE__EEM_Question__construct__allowed_question_types',
+			array(
+				EEM_Question::QST_type_text => __('A single line text input field', 'event_espresso'),
+				EEM_Question::QST_type_textarea => __('A multi line text input field', 'event_espresso'),
+				EEM_Question::QST_type_checkbox => __('Allows multiple preset options to be selected', 'event_espresso'),
+				EEM_Question::QST_type_radio => __('Allows a single preset option to be selected', 'event_espresso'),
+				EEM_Question::QST_type_dropdown => __('A dropdown that allows a single selection', 'event_espresso'),
+				EEM_Question::QST_type_state => __('A dropdown that lists states/provinces', 'event_espresso'),
+				EEM_Question::QST_type_country => __('A dropdown that lists countries', 'event_espresso'),
+				EEM_Question::QST_type_date => __('A popup calendar that allows date selections', 'event_espresso'),
+				EEM_Question::QST_type_html_textarea => __('A multi line text input field that allows HTML', 'event_espresso'),
+				EEM_Question::QST_type_email => __('A text field that must contain a valid Email address', 'event_espresso'),
+				EEM_Question::QST_type_us_phone => __('A text field that must contain a valid US phone number', 'event_espresso'),
+				EEM_Question::QST_type_decimal => __('A text field that allows number values with decimals', 'event_espresso'),
+				EEM_Question::QST_type_int => __('A text field that only allows whole numbers (no decimals)', 'event_espresso'),
+				EEM_Question::QST_type_url => __('A text field that must contain a valid URL', 'event_espresso'),
+				EEM_Question::QST_type_year => __('A dropdown that lists the last 100 years', 'event_espresso'),
+				EEM_Question::QST_type_multi_select => __('A dropdown that allows multiple selections', 'event_espresso')
+			)
+		);
+		$this->_question_type_categories = (array)apply_filters(
+			'FHEE__EEM_Question__construct__question_type_categories',
+			array(
+				'text' => array(
+					EEM_Question::QST_type_text,
+					EEM_Question::QST_type_textarea,
+					EEM_Question::QST_type_date,
+					EEM_Question::QST_type_html_textarea,
+					EEM_Question::QST_type_email,
+					EEM_Question::QST_type_us_phone,
+					EEM_Question::QST_type_decimal,
+					EEM_Question::QST_type_int,
+					EEM_Question::QST_type_url,
+					EEM_Question::QST_type_year
+				),
+				'single-answer-enum' => array(
+					EEM_Question::QST_type_radio,
+					EEM_Question::QST_type_dropdown
+				),
+				'multi-answer-enum' => array(
+					EEM_Question::QST_type_checkbox,
+					EEM_Question::QST_type_multi_select
+				)
+			)
+		);
+		$this->question_types_with_max_lengh = apply_filters(
+			'FHEE__EEM_Question___construct__question_types_with_max_length',
+			array(
+				EEM_Question::QST_type_text,
+				EEM_Question::QST_type_textarea,
+				EEM_Question::QST_type_html_textarea
+			)
+		);
+
+		$this->_tables = array(
+			'Question' => new EE_Primary_Table('esp_question', 'QST_ID')
+		);
+		$this->_fields = array(
+			'Question' => array(
+				'QST_ID' => new EE_Primary_Key_Int_Field('QST_ID', __('Question ID', 'event_espresso')),
+				'QST_display_text' => new EE_Post_Content_Field('QST_display_text', __('Question Text', 'event_espresso'), true, ''),
+				'QST_admin_label' => new EE_Plain_Text_Field('QST_admin_label', __('Question Label (admin-only)', 'event_espresso'), true, ''),
+				'QST_system' => new EE_Plain_Text_Field('QST_system', __('Internal string ID for question', 'event_espresso'), false, ''),
+				'QST_type' => new EE_Enum_Text_Field('QST_type', __('Question Type', 'event_espresso'), false, 'TEXT', $this->_allowed_question_types),
+				'QST_required' => new EE_Boolean_Field('QST_required', __('Required Question?', 'event_espresso'), false, false),
+				'QST_required_text' => new EE_Simple_HTML_Field('QST_required_text', __('Text to Display if Not Provided', 'event_espresso'), true, ''),
+				'QST_order' => new EE_Integer_Field('QST_order', __('Question Order', 'event_espresso'), false, 0),
+				'QST_admin_only' => new EE_Boolean_Field('QST_admin_only', __('Admin-Only Question?', 'event_espresso'), false, false),
+				'QST_max' => new EE_Infinite_Integer_Field('QST_max', __('Max Size', 'event_espresso'), false, EE_INF),
+				'QST_wp_user' => new EE_WP_User_Field('QST_wp_user', __('Question Creator ID', 'event_espresso'), false),
+				'QST_deleted' => new EE_Trashed_Flag_Field('QST_deleted', __('Flag Indicating question was deleted', 'event_espresso'), false, false)
+			)
+		);
+		$this->_model_relations = array(
+			'Question_Group' => new EE_HABTM_Relation('Question_Group_Question'),
+			'Question_Option' => new EE_Has_Many_Relation(),
+			'Answer' => new EE_Has_Many_Relation(),
+			'WP_User' => new EE_Belongs_To_Relation(),
+			//for QST_order column
+			'Question_Group_Question' => new EE_Has_Many_Relation()
+		);
+		//this model is generally available for reading
+		$this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
+		$this->_cap_restriction_generators[EEM_Base::caps_read_admin] = new EE_Restriction_Generator_Reg_Form('QST_system');
+		$this->_cap_restriction_generators[EEM_Base::caps_edit] = new EE_Restriction_Generator_Reg_Form('QST_system');
+		$this->_cap_restriction_generators[EEM_Base::caps_delete] = new EE_Restriction_Generator_Reg_Form('QST_system');
+		parent::__construct($timezone);
+	}
+
+	/**
+	 * Returns the list of allowed question types, which are normally: 'TEXT','TEXTAREA','RADIO_BTN','DROPDOWN','CHECKBOX','DATE'
+	 * but they can be extended
+	 * @return string[]
+	 */
+	public function allowed_question_types()
+	{
+		return $this->_allowed_question_types;
+	}
+
+	/**
+	 * Gets all the question types in the same category
+	 * @param string $question_type one of EEM_Question::allowed_question_types(
+	 * @return string[] like EEM_Question::allowed_question_types()
+	 */
+	public function question_types_in_same_category($question_type)
+	{
+		$question_types = array($question_type);
+		foreach ($this->_question_type_categories as $category => $question_types_in_category) {
+			if (in_array($question_type, $question_types_in_category)) {
+				$question_types = $question_types_in_category;
+				break;
+			}
+		}
+
+		return array_intersect_key($this->allowed_question_types(), array_flip($question_types));
+	}
+
+	/**
+	 * Determines if the given question type is in the given question type category
+	 * @param string $question_type one of EEM_Question::allowed_question_types()
+	 * @param string $category one of the top-level keys of EEM_Question::question_type_categories()
+	 * @return boolean
+	 */
+	public function question_type_is_in_category($question_type, $category)
+	{
+		if (!isset($this->_question_type_categories[$category])) {
+			return false;
+		}
+		return in_array($question_type, $this->_question_type_categories[$category]);
+	}
+
+
+	/**
+	 * Returns all the question types in the given category
+	 * @param string $category
+	 * @return array|mixed
+	 */
+	public function question_types_in_category($category)
+	{
+		if (isset($this->_question_type_categories[$category])) {
+			return $this->_question_type_categories[$category];
+		}
+		return array();
+	}
+
+
+	/**
+	 * Returns all the question types that should have question options
+	 * @return array
+	 */
+	public function question_types_with_options()
+	{
+		return array_merge(
+			$this->question_types_in_category('single-answer-enum'),
+			$this->question_types_in_category('multi-answer-enum')
+		);
+	}
+
+	/**
+	 * Returns the question type categories 2d array
+	 * @return array see EEM_Question::_question_type_categories
+	 */
+	public function question_type_categories()
+	{
+		return $this->_question_type_categories;
+	}
+
+	/**
+	 * Returns an array of all the QST_system values that can be allowed in the system question group
+	 * identified by $system_question_group_id
+	 * @param string $system_question_group_id QSG_system
+	 * @return array of system question names (QST_system)
+	 */
+	public function allowed_system_questions_in_system_question_group($system_question_group_id)
+	{
+		$question_system_ids = array();
+		switch ($system_question_group_id) {
+			case EEM_Question_Group::system_personal:
+				$question_system_ids = array(
+					EEM_Attendee::system_question_fname,
+					EEM_Attendee::system_question_lname,
+					EEM_Attendee::system_question_email,
+					EEM_Attendee::system_question_phone
+				);
+				break;
+			case EEM_Question_Group::system_address:
+				$question_system_ids = array(
+					EEM_Attendee::system_question_address,
+					EEM_Attendee::system_question_address2,
+					EEM_Attendee::system_question_city,
+					EEM_Attendee::system_question_state,
+					EEM_Attendee::system_question_country,
+					EEM_Attendee::system_question_zip,
+					EEM_Attendee::system_question_phone
+				);
+				break;
+		}
+		return apply_filters('FHEE__EEM_Question__system_questions_allowed_in_system_question_group__return', $question_system_ids, $system_question_group_id);
+	}
+
+	/**
+	 * Returns an array of all the QST_system values that are required in the system question group
+	 * identified by $system_question_group_id
+	 * @param string $system_question_group_id QSG_system
+	 * @return array of system question names (QST_system)
+	 */
+	public function required_system_questions_in_system_question_group($system_question_group_id)
+	{
+		$question_system_ids = null;
+		switch ($system_question_group_id) {
+			case EEM_Question_Group::system_personal:
+				$question_system_ids = array(
+					EEM_Attendee::system_question_fname,
+					EEM_Attendee::system_question_email,
+				);
+				break;
+			default:
+				$question_system_ids = array();
+		}
+		return apply_filters('FHEE__EEM_Question__system_questions_required_in_system_question_group', $question_system_ids, $system_question_group_id);
+	}
+
+
+	/**
+	 * Gets an array for converting between QST_system and QST_IDs for system questions. Eg, if you want to know
+	 * which system question QST_ID corresponds to the QST_system 'city', use EEM_Question::instance()->get_Question_ID_from_system_string('city');
+	 * @param $QST_system
+	 * @return int of QST_ID for the question that corresponds to that QST_system
+	 */
+	public function get_Question_ID_from_system_string($QST_system)
+	{
+		return $this->get_var(array(array('QST_system' => $QST_system)));
+	}
+
+
+	/**
+	 * searches the db for the question with the latest question order and returns that value.
+	 * @access public
+	 * @return int
+	 */
+	public function get_latest_question_order()
+	{
+		$columns_to_select = array(
+			'max_order' => array("MAX(QST_order)", "%d")
+		);
+		$max = $this->_get_all_wpdb_results(array(), ARRAY_A, $columns_to_select);
+		return isset($max[0], $max[0]['max_order']) ? $max[0]['max_order'] : 0;
+	}
+
+	/**
+	 * Returns an array where keys are system question QST_system values,
+	 * and values are the highest question max the admin can set on the question
+	 * (aka the "max max"; eg, a site admin can change the zip question to have a max
+	 * of 5, but no larger than 12)
+	 * @return array
+	 */
+	public function system_question_maxes()
+	{
+		return array(
+			'fname' => 45,
+			'lname' => 45,
+			'address' => 255,
+			'address2' => 255,
+			'city' => 45,
+			'zip' => 12,
+			'email' => 255,
+			'phone' => 45,
+		);
+	}
+
+	/**
+	 * Given a QST_system value, gets the question's largest allowable max input.
+	 * @see Registration_Form_Admin_Page::system_question_maxes()
+	 * @param string $system_question_value
+	 * @return int|float
+	 */
+	public function absolute_max_for_system_question($system_question_value)
+	{
+		$maxes = $this->system_question_maxes();
+		if (isset($maxes[$system_question_value])) {
+			return $maxes[$system_question_value];
+		} else {
+			return EE_INF;
+		}
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function question_descriptions()
+	{
+		return $this->_question_descriptions;
+	}
+
+
+	/**
+	 * Returns all the question types that should have an admin-defined max input length
+	 * @return array
+	 */
+	public function questionTypesWithMaxLength()
+	{
+		return (array)$this->question_types_with_max_lengh;
+	}
 
 
 }

Spacing +6 added lines, -6 removed lines

@@ -1,8 +1,8 @@ 
-<?php if (!defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
-require_once(EE_MODELS . 'EEM_Soft_Delete_Base.model.php');
-require_once(EE_CLASSES . 'EE_Question.class.php');
+require_once(EE_MODELS.'EEM_Soft_Delete_Base.model.php');
+require_once(EE_CLASSES.'EE_Question.class.php');
 
 
 /**
@@ -157,7 +157,7 @@ 
                 EEM_Question::QST_type_multi_select => __('A dropdown that allows multiple selections', 'event_espresso')
             )
         );
-        $this->_question_type_categories = (array)apply_filters(
+        $this->_question_type_categories = (array) apply_filters(
             'FHEE__EEM_Question__construct__question_type_categories',
             array(
                 'text' => array(
@@ -262,7 +262,7 @@ 
      */
     public function question_type_is_in_category($question_type, $category)
     {
-        if (!isset($this->_question_type_categories[$category])) {
+        if ( ! isset($this->_question_type_categories[$category])) {
             return false;
         }
         return in_array($question_type, $this->_question_type_categories[$category]);
@@ -439,7 +439,7 @@ 
      */
     public function questionTypesWithMaxLength()
     {
-        return (array)$this->question_types_with_max_lengh;
+        return (array) $this->question_types_with_max_lengh;
     }
 
 

admin_pages/registration_form/Registration_Form_Admin_Page.core.php

Indentation +665 added lines, -665 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 /**
@@ -28,621 +28,621 @@ 
 class Registration_Form_Admin_Page extends EE_Admin_Page
 {
 
-    /**
-     * _question
-     * holds the specific question object for the question details screen
-     *
-     * @var EE_Question $_question
-     */
-    protected $_question;
-
-    /**
-     * _question_group
-     * holds the specific question group object for the question group details screen
-     *
-     * @var EE_Question_Group $_question_group
-     */
-    protected $_question_group;
-
-    /**
-     *_question_model EEM_Question model instance (for queries)
-     *
-     * @var EEM_Question $_question_model ;
-     */
-    protected $_question_model;
-
-    /**
-     * _question_group_model EEM_Question_group instance (for queries)
-     *
-     * @var EEM_Question_Group $_question_group_model
-     */
-    protected $_question_group_model;
-
-
-    /**
-     * @Constructor
-     * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
-     * @access public
-     */
-    public function __construct($routing = true)
-    {
-        require_once(EE_MODELS . 'EEM_Question.model.php');
-        require_once(EE_MODELS . 'EEM_Question_Group.model.php');
-        $this->_question_model       = EEM_Question::instance();
-        $this->_question_group_model = EEM_Question_Group::instance();
-        parent::__construct($routing);
-    }
-
-
-    protected function _init_page_props()
-    {
-        $this->page_slug        = REGISTRATION_FORM_PG_SLUG;
-        $this->page_label       = esc_html__('Registration Form', 'event_espresso');
-        $this->_admin_base_url  = REGISTRATION_FORM_ADMIN_URL;
-        $this->_admin_base_path = REGISTRATION_FORM_ADMIN;
-    }
-
-
-    protected function _ajax_hooks()
-    {
-    }
-
-
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = esc_html__('Registration Form', 'event_espresso');
-        $this->_labels           = array(
-            'buttons' => array(
-                'edit_question' => esc_html__('Edit Question', 'event_espresso'),
-            ),
-        );
-    }
-
-
-    /**
-     *_set_page_routes
-     */
-    protected function _set_page_routes()
-    {
-        $qst_id             = ! empty($this->_req_data['QST_ID']) ? $this->_req_data['QST_ID'] : 0;
-        $this->_page_routes = array(
-            'default' => array(
-                'func'       => '_questions_overview_list_table',
-                'capability' => 'ee_read_questions',
-            ),
-
-            'edit_question' => array(
-                'func'       => '_edit_question',
-                'capability' => 'ee_edit_question',
-                'obj_id'     => $qst_id,
-                'args'       => array('edit'),
-            ),
-
-            'question_groups' => array(
-                'func'       => '_questions_groups_preview',
-                'capability' => 'ee_read_question_groups',
-            ),
-
-            'update_question' => array(
-                'func'       => '_insert_or_update_question',
-                'args'       => array('new_question' => false),
-                'capability' => 'ee_edit_question',
-                'obj_id'     => $qst_id,
-                'noheader'   => true,
-            ),
-        );
-    }
-
-
-    protected function _set_page_config()
-    {
-        $this->_page_config = array(
-            'default' => array(
-                'nav'           => array(
-                    'label' => esc_html__('Questions', 'event_espresso'),
-                    'order' => 10,
-                ),
-                'list_table'    => 'Registration_Form_Questions_Admin_List_Table',
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'help_tabs'     => array(
-                    'registration_form_questions_overview_help_tab'                           => array(
-                        'title'    => esc_html__('Questions Overview', 'event_espresso'),
-                        'filename' => 'registration_form_questions_overview',
-                    ),
-                    'registration_form_questions_overview_table_column_headings_help_tab'     => array(
-                        'title'    => esc_html__('Questions Overview Table Column Headings', 'event_espresso'),
-                        'filename' => 'registration_form_questions_overview_table_column_headings',
-                    ),
-                    'registration_form_questions_overview_views_bulk_actions_search_help_tab' => array(
-                        'title'    => esc_html__('Question Overview Views & Bulk Actions & Search', 'event_espresso'),
-                        'filename' => 'registration_form_questions_overview_views_bulk_actions_search',
-                    ),
-                ),
-                'help_tour'     => array('Registration_Form_Questions_Overview_Help_Tour'),
-                'require_nonce' => false,
-                'qtips'         => array(
-                    'EE_Registration_Form_Tips',
-                )/**/
-            ),
-
-            'question_groups' => array(
-                'nav'           => array(
-                    'label' => esc_html__('Question Groups', 'event_espresso'),
-                    'order' => 20,
-                ),
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'help_tabs'     => array(
-                    'registration_form_question_groups_help_tab' => array(
-                        'title'    => esc_html__('Question Groups', 'event_espresso'),
-                        'filename' => 'registration_form_question_groups',
-                    ),
-                ),
-                'help_tour'     => array('Registration_Form_Question_Groups_Help_Tour'),
-                'require_nonce' => false,
-            ),
-
-            'edit_question' => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Edit Question', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                    'url'        => isset($this->_req_data['question_id']) ? add_query_arg(array('question_id' => $this->_req_data['question_id']),
-                        $this->_current_page_view_url) : $this->_admin_base_url,
-                ),
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
-                'help_tabs'     => array(
-                    'registration_form_edit_question_group_help_tab' => array(
-                        'title'    => esc_html__('Edit Question', 'event_espresso'),
-                        'filename' => 'registration_form_edit_question',
-                    ),
-                ),
-                'help_tour'     => array('Registration_Form_Edit_Question_Help_Tour'),
-                'require_nonce' => false,
-            ),
-        );
-    }
-
-
-    protected function _add_screen_options()
-    {
-        //todo
-    }
-
-    protected function _add_screen_options_default()
-    {
-        $page_title              = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__('Questions', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-    protected function _add_screen_options_question_groups()
-    {
-        $page_title              = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__('Question Groups', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-    //none of the below group are currently used for Event Categories
-    protected function _add_feature_pointers()
-    {
-    }
-
-    public function load_scripts_styles()
-    {
-        wp_register_style('espresso_registration',
-            REGISTRATION_FORM_ASSETS_URL . 'espresso_registration_form_admin.css', array(), EVENT_ESPRESSO_VERSION);
-        wp_enqueue_style('espresso_registration');
-    }
-
-    public function admin_init()
-    {
-    }
-
-    public function admin_notices()
-    {
-    }
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    public function load_scripts_styles_default()
-    {
-    }
-
-
-    public function load_scripts_styles_add_question()
-    {
-        $this->load_scripts_styles_question_details();
-    }
-
-    public function load_scripts_styles_edit_question()
-    {
-        $this->load_scripts_styles_question_details();
-    }
-
-    /**
-     * Loads the JS required for adding or editing a question
-     */
-    protected function load_scripts_styles_question_details()
-    {
-        $this->load_scripts_styles_forms();
-        wp_register_script('espresso_registration_form_single',
-            REGISTRATION_FORM_ASSETS_URL . 'espresso_registration_form_admin.js', array('jquery-ui-sortable'),
-            EVENT_ESPRESSO_VERSION, true);
-        wp_enqueue_script('espresso_registration_form_single');
-        wp_localize_script(
-            'espresso_registration_form_single',
-            'ee_question_data',
-            array(
-                'question_types_with_max' => EEM_Question::instance()->questionTypesWithMaxLength(),
-                'question_type_with_options' => EEM_Question::instance()->question_types_with_options()
-            )
-        );
-    }
-
-
-    public function recaptcha_info_help_tab()
-    {
-        $template = REGISTRATION_FORM_TEMPLATE_PATH . 'recaptcha_info_help_tab.template.php';
-        EEH_Template::display_template($template, array());
-    }
-
-
-    public function load_scripts_styles_forms()
-    {
-        //styles
-        wp_enqueue_style('espresso-ui-theme');
-        //scripts
-        wp_enqueue_script('ee_admin_js');
-    }
-
-
-    protected function _set_list_table_views_default()
-    {
-        $this->_views = array(
-            'all' => array(
-                'slug'  => 'all',
-                'label' => esc_html__('View All Questions', 'event_espresso'),
-                'count' => 0,
+	/**
+	 * _question
+	 * holds the specific question object for the question details screen
+	 *
+	 * @var EE_Question $_question
+	 */
+	protected $_question;
+
+	/**
+	 * _question_group
+	 * holds the specific question group object for the question group details screen
+	 *
+	 * @var EE_Question_Group $_question_group
+	 */
+	protected $_question_group;
+
+	/**
+	 *_question_model EEM_Question model instance (for queries)
+	 *
+	 * @var EEM_Question $_question_model ;
+	 */
+	protected $_question_model;
+
+	/**
+	 * _question_group_model EEM_Question_group instance (for queries)
+	 *
+	 * @var EEM_Question_Group $_question_group_model
+	 */
+	protected $_question_group_model;
+
+
+	/**
+	 * @Constructor
+	 * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
+	 * @access public
+	 */
+	public function __construct($routing = true)
+	{
+		require_once(EE_MODELS . 'EEM_Question.model.php');
+		require_once(EE_MODELS . 'EEM_Question_Group.model.php');
+		$this->_question_model       = EEM_Question::instance();
+		$this->_question_group_model = EEM_Question_Group::instance();
+		parent::__construct($routing);
+	}
+
+
+	protected function _init_page_props()
+	{
+		$this->page_slug        = REGISTRATION_FORM_PG_SLUG;
+		$this->page_label       = esc_html__('Registration Form', 'event_espresso');
+		$this->_admin_base_url  = REGISTRATION_FORM_ADMIN_URL;
+		$this->_admin_base_path = REGISTRATION_FORM_ADMIN;
+	}
+
+
+	protected function _ajax_hooks()
+	{
+	}
+
+
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = esc_html__('Registration Form', 'event_espresso');
+		$this->_labels           = array(
+			'buttons' => array(
+				'edit_question' => esc_html__('Edit Question', 'event_espresso'),
+			),
+		);
+	}
+
+
+	/**
+	 *_set_page_routes
+	 */
+	protected function _set_page_routes()
+	{
+		$qst_id             = ! empty($this->_req_data['QST_ID']) ? $this->_req_data['QST_ID'] : 0;
+		$this->_page_routes = array(
+			'default' => array(
+				'func'       => '_questions_overview_list_table',
+				'capability' => 'ee_read_questions',
+			),
+
+			'edit_question' => array(
+				'func'       => '_edit_question',
+				'capability' => 'ee_edit_question',
+				'obj_id'     => $qst_id,
+				'args'       => array('edit'),
+			),
+
+			'question_groups' => array(
+				'func'       => '_questions_groups_preview',
+				'capability' => 'ee_read_question_groups',
+			),
+
+			'update_question' => array(
+				'func'       => '_insert_or_update_question',
+				'args'       => array('new_question' => false),
+				'capability' => 'ee_edit_question',
+				'obj_id'     => $qst_id,
+				'noheader'   => true,
+			),
+		);
+	}
+
+
+	protected function _set_page_config()
+	{
+		$this->_page_config = array(
+			'default' => array(
+				'nav'           => array(
+					'label' => esc_html__('Questions', 'event_espresso'),
+					'order' => 10,
+				),
+				'list_table'    => 'Registration_Form_Questions_Admin_List_Table',
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'help_tabs'     => array(
+					'registration_form_questions_overview_help_tab'                           => array(
+						'title'    => esc_html__('Questions Overview', 'event_espresso'),
+						'filename' => 'registration_form_questions_overview',
+					),
+					'registration_form_questions_overview_table_column_headings_help_tab'     => array(
+						'title'    => esc_html__('Questions Overview Table Column Headings', 'event_espresso'),
+						'filename' => 'registration_form_questions_overview_table_column_headings',
+					),
+					'registration_form_questions_overview_views_bulk_actions_search_help_tab' => array(
+						'title'    => esc_html__('Question Overview Views & Bulk Actions & Search', 'event_espresso'),
+						'filename' => 'registration_form_questions_overview_views_bulk_actions_search',
+					),
+				),
+				'help_tour'     => array('Registration_Form_Questions_Overview_Help_Tour'),
+				'require_nonce' => false,
+				'qtips'         => array(
+					'EE_Registration_Form_Tips',
+				)/**/
+			),
+
+			'question_groups' => array(
+				'nav'           => array(
+					'label' => esc_html__('Question Groups', 'event_espresso'),
+					'order' => 20,
+				),
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'help_tabs'     => array(
+					'registration_form_question_groups_help_tab' => array(
+						'title'    => esc_html__('Question Groups', 'event_espresso'),
+						'filename' => 'registration_form_question_groups',
+					),
+				),
+				'help_tour'     => array('Registration_Form_Question_Groups_Help_Tour'),
+				'require_nonce' => false,
+			),
+
+			'edit_question' => array(
+				'nav'           => array(
+					'label'      => esc_html__('Edit Question', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+					'url'        => isset($this->_req_data['question_id']) ? add_query_arg(array('question_id' => $this->_req_data['question_id']),
+						$this->_current_page_view_url) : $this->_admin_base_url,
+				),
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
+				'help_tabs'     => array(
+					'registration_form_edit_question_group_help_tab' => array(
+						'title'    => esc_html__('Edit Question', 'event_espresso'),
+						'filename' => 'registration_form_edit_question',
+					),
+				),
+				'help_tour'     => array('Registration_Form_Edit_Question_Help_Tour'),
+				'require_nonce' => false,
+			),
+		);
+	}
+
+
+	protected function _add_screen_options()
+	{
+		//todo
+	}
+
+	protected function _add_screen_options_default()
+	{
+		$page_title              = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__('Questions', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+	protected function _add_screen_options_question_groups()
+	{
+		$page_title              = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__('Question Groups', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+	//none of the below group are currently used for Event Categories
+	protected function _add_feature_pointers()
+	{
+	}
+
+	public function load_scripts_styles()
+	{
+		wp_register_style('espresso_registration',
+			REGISTRATION_FORM_ASSETS_URL . 'espresso_registration_form_admin.css', array(), EVENT_ESPRESSO_VERSION);
+		wp_enqueue_style('espresso_registration');
+	}
+
+	public function admin_init()
+	{
+	}
+
+	public function admin_notices()
+	{
+	}
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	public function load_scripts_styles_default()
+	{
+	}
+
+
+	public function load_scripts_styles_add_question()
+	{
+		$this->load_scripts_styles_question_details();
+	}
+
+	public function load_scripts_styles_edit_question()
+	{
+		$this->load_scripts_styles_question_details();
+	}
+
+	/**
+	 * Loads the JS required for adding or editing a question
+	 */
+	protected function load_scripts_styles_question_details()
+	{
+		$this->load_scripts_styles_forms();
+		wp_register_script('espresso_registration_form_single',
+			REGISTRATION_FORM_ASSETS_URL . 'espresso_registration_form_admin.js', array('jquery-ui-sortable'),
+			EVENT_ESPRESSO_VERSION, true);
+		wp_enqueue_script('espresso_registration_form_single');
+		wp_localize_script(
+			'espresso_registration_form_single',
+			'ee_question_data',
+			array(
+				'question_types_with_max' => EEM_Question::instance()->questionTypesWithMaxLength(),
+				'question_type_with_options' => EEM_Question::instance()->question_types_with_options()
+			)
+		);
+	}
+
+
+	public function recaptcha_info_help_tab()
+	{
+		$template = REGISTRATION_FORM_TEMPLATE_PATH . 'recaptcha_info_help_tab.template.php';
+		EEH_Template::display_template($template, array());
+	}
+
+
+	public function load_scripts_styles_forms()
+	{
+		//styles
+		wp_enqueue_style('espresso-ui-theme');
+		//scripts
+		wp_enqueue_script('ee_admin_js');
+	}
+
+
+	protected function _set_list_table_views_default()
+	{
+		$this->_views = array(
+			'all' => array(
+				'slug'  => 'all',
+				'label' => esc_html__('View All Questions', 'event_espresso'),
+				'count' => 0,
 //				'bulk_action' => array(
 //					'trash_questions' => esc_html__('Trash', 'event_espresso'),
 //					)
-            ),
-        );
-
-        if (EE_Registry::instance()->CAP->current_user_can('ee_delete_questions',
-            'espresso_registration_form_trash_questions')
-        ) {
-            $this->_views['trash'] = array(
-                'slug'  => 'trash',
-                'label' => esc_html__('Trash', 'event_espresso'),
-                'count' => 0,
+			),
+		);
+
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_questions',
+			'espresso_registration_form_trash_questions')
+		) {
+			$this->_views['trash'] = array(
+				'slug'  => 'trash',
+				'label' => esc_html__('Trash', 'event_espresso'),
+				'count' => 0,
 //				'bulk_action' => array(
 //					'delete_questions' => esc_html__('Delete Permanently', 'event_espresso'),
 //					'restore_questions' => esc_html__('Restore', 'event_espresso'),
-            );
-        }
-    }
-
-    /**
-     * This just previews the question groups tab that comes in caffeinated.
-     *
-     * @return string html
-     */
-    protected function _questions_groups_preview()
-    {
-        $this->_admin_page_title              = esc_html__('Question Groups (Preview)', 'event_espresso');
-        $this->_template_args['preview_img']  = '<img src="' . REGISTRATION_FORM_ASSETS_URL . 'caf_reg_form_preview.jpg" alt="' . esc_attr__('Preview Question Groups Overview List Table screenshot',
-                'event_espresso') . '" />';
-        $this->_template_args['preview_text'] = '<strong>' . esc_html__('Question Groups is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Question Groups feature you are able to create new question groups, edit existing question groups, and create and edit new questions and add them to question groups.',
-                'event_espresso') . '</strong>';
-        $this->display_admin_caf_preview_page('question_groups_tab');
-    }
-
-
-    /**
-     * Extracts the question field's values from the POST request to update or insert them
-     *
-     * @param \EEM_Base $model
-     * @return array where each key is the name of a model's field/db column, and each value is its value.
-     */
-    protected function _set_column_values_for(EEM_Base $model)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $set_column_values = array();
-
-        //some initial checks for proper values.
-        //if QST_admin_only, then no matter what QST_required is we disable.
-        if (! empty($this->_req_data['QST_admin_only'])) {
-            $this->_req_data['QST_required'] = 0;
-        }
-        //if the question shouldn't have a max length, don't let them set one
-        if (! isset(
-            $this->_req_data['QST_type'],
-                $this->_req_data['QST_max']
-            )
-            || ! in_array(
-            $this->_req_data['QST_type'],
-            EEM_Question::instance()->questionTypesWithMaxLength(),
-            true)
-        ) {
-            //they're not allowed to set the max
-            $this->_req_data['QST_max'] = null;
-        }
-        foreach ($model->field_settings() as $fieldName => $settings) {
-            // basically if QSG_identifier is empty or not set
-            if ($fieldName === 'QSG_identifier' && (isset($this->_req_data['QSG_identifier']) && empty($this->_req_data['QSG_identifier']))) {
-                $QSG_name                      = isset($this->_req_data['QSG_name']) ? $this->_req_data['QSG_name'] : '';
-                $set_column_values[$fieldName] = sanitize_title($QSG_name) . '-' . uniqid('', true);
+			);
+		}
+	}
+
+	/**
+	 * This just previews the question groups tab that comes in caffeinated.
+	 *
+	 * @return string html
+	 */
+	protected function _questions_groups_preview()
+	{
+		$this->_admin_page_title              = esc_html__('Question Groups (Preview)', 'event_espresso');
+		$this->_template_args['preview_img']  = '<img src="' . REGISTRATION_FORM_ASSETS_URL . 'caf_reg_form_preview.jpg" alt="' . esc_attr__('Preview Question Groups Overview List Table screenshot',
+				'event_espresso') . '" />';
+		$this->_template_args['preview_text'] = '<strong>' . esc_html__('Question Groups is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Question Groups feature you are able to create new question groups, edit existing question groups, and create and edit new questions and add them to question groups.',
+				'event_espresso') . '</strong>';
+		$this->display_admin_caf_preview_page('question_groups_tab');
+	}
+
+
+	/**
+	 * Extracts the question field's values from the POST request to update or insert them
+	 *
+	 * @param \EEM_Base $model
+	 * @return array where each key is the name of a model's field/db column, and each value is its value.
+	 */
+	protected function _set_column_values_for(EEM_Base $model)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$set_column_values = array();
+
+		//some initial checks for proper values.
+		//if QST_admin_only, then no matter what QST_required is we disable.
+		if (! empty($this->_req_data['QST_admin_only'])) {
+			$this->_req_data['QST_required'] = 0;
+		}
+		//if the question shouldn't have a max length, don't let them set one
+		if (! isset(
+			$this->_req_data['QST_type'],
+				$this->_req_data['QST_max']
+			)
+			|| ! in_array(
+			$this->_req_data['QST_type'],
+			EEM_Question::instance()->questionTypesWithMaxLength(),
+			true)
+		) {
+			//they're not allowed to set the max
+			$this->_req_data['QST_max'] = null;
+		}
+		foreach ($model->field_settings() as $fieldName => $settings) {
+			// basically if QSG_identifier is empty or not set
+			if ($fieldName === 'QSG_identifier' && (isset($this->_req_data['QSG_identifier']) && empty($this->_req_data['QSG_identifier']))) {
+				$QSG_name                      = isset($this->_req_data['QSG_name']) ? $this->_req_data['QSG_name'] : '';
+				$set_column_values[$fieldName] = sanitize_title($QSG_name) . '-' . uniqid('', true);
 //				dd($set_column_values);
-            } //if the admin label is blank, use a slug version of the question text
-            else if ($fieldName === 'QST_admin_label' && (isset($this->_req_data['QST_admin_label']) && empty($this->_req_data['QST_admin_label']))) {
-                $QST_text                      = isset($this->_req_data['QST_display_text']) ? $this->_req_data['QST_display_text'] : '';
-                $set_column_values[$fieldName] = sanitize_title(wp_trim_words($QST_text, 10));
-            } else if ($fieldName === 'QST_admin_only' && (! isset($this->_req_data['QST_admin_only']))) {
-                $set_column_values[$fieldName] = 0;
-            } else if ($fieldName === 'QST_max') {
-                $qst_system = EEM_Question::instance()->get_var(
-                    array(
-                        array(
-                            'QST_ID' => isset($this->_req_data['QST_ID']) ? $this->_req_data['QST_ID'] : 0,
-                        ),
-                    ),
-                    'QST_system');
-                $max_max    = EEM_Question::instance()->absolute_max_for_system_question($qst_system);
-                if (empty($this->_req_data['QST_max']) ||
-                    $this->_req_data['QST_max'] > $max_max
-                ) {
-                    $set_column_values[$fieldName] = $max_max;
-                }
-            }
-
-
-            //only add a property to the array if it's not null (otherwise the model should just use the default value)
-            if (
-                ! isset($set_column_values[$fieldName]) &&
-                isset($this->_req_data[$fieldName])
-            ) {
-                $set_column_values[$fieldName] = $this->_req_data[$fieldName];
-            }
-
-        }
-        return $set_column_values;//validation fo this data to be performed by the model before insertion.
-    }
-
-
-    /**
-     *_questions_overview_list_table
-     */
-    protected function _questions_overview_list_table()
-    {
-        $this->_search_btn_label = esc_html__('Questions', 'event_espresso');
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-    /**
-     * _edit_question
-     */
-    protected function _edit_question()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $ID = isset($this->_req_data['QST_ID']) && ! empty($this->_req_data['QST_ID']) ? absint($this->_req_data['QST_ID']) : false;
-
-        switch ($this->_req_action) {
-            case 'add_question' :
-                $this->_admin_page_title = esc_html__('Add Question', 'event_espresso');
-                break;
-            case 'edit_question' :
-                $this->_admin_page_title = esc_html__('Edit Question', 'event_espresso');
-                break;
-            default :
-                $this->_admin_page_title = ucwords(str_replace('_', ' ', $this->_req_action));
-        }
-
-        // add PRC_ID to title if editing
-        $this->_admin_page_title = $ID ? $this->_admin_page_title . ' # ' . $ID : $this->_admin_page_title;
-        if ($ID) {
-            $question                 = $this->_question_model->get_one_by_ID($ID);
-            $additional_hidden_fields = array('QST_ID' => array('type' => 'hidden', 'value' => $ID));
-            $this->_set_add_edit_form_tags('update_question', $additional_hidden_fields);
-        } else {
-            $question = EE_Question::new_instance();
-            $question->set_order_to_latest();
-            $this->_set_add_edit_form_tags('insert_question');
-        }
-        if( $question->system_ID() === EEM_Attendee::system_question_phone ){
-            $question_types = array_intersect_key(
-                EEM_Question::instance()->allowed_question_types(),
-                array_flip(
-                    array(
-                        EEM_Question::QST_type_text,
-                        EEM_Question::QST_type_us_phone
-                    )
-                )
-            );
-        } else {
-            $question_types = $question->has_answers() ? $this->_question_model->question_types_in_same_category($question->type()) : $this->_question_model->allowed_question_types();
-        }
-        $this->_template_args['QST_ID']                     = $ID;
-        $this->_template_args['question']                   = $question;
-        $this->_template_args['question_types']             = $question_types;
-        $this->_template_args['max_max']                    = EEM_Question::instance()->absolute_max_for_system_question(
-            $question->system_ID()
-        );
-        $this->_template_args['question_type_descriptions'] = $this->_get_question_type_descriptions();
-        $this->_set_publish_post_box_vars('id', $ID);
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            REGISTRATION_FORM_TEMPLATE_PATH . 'questions_main_meta_box.template.php',
-            $this->_template_args, true
-        );
-
-        // the details template wrapper
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * @return string
-     */
-    protected function _get_question_type_descriptions()
-    {
-        EE_Registry::instance()->load_helper('HTML');
-        $descriptions               = '';
-        $question_type_descriptions = EEM_Question::instance()->question_descriptions();
-        foreach ($question_type_descriptions as $type => $question_type_description) {
-            if ($type == 'HTML_TEXTAREA') {
-                $html = new EE_Simple_HTML_Validation_Strategy();
-                $question_type_description .= sprintf(
-                    esc_html__('%1$s(allowed tags: %2$s)', 'event_espresso'),
-                    '<br/>',
-                    $html->get_list_of_allowed_tags()
-                );
-            }
-            $descriptions .= EEH_HTML::p(
-                $question_type_description,
-                'question_type_description-' . $type,
-                'question_type_description description',
-                'display:none;'
-            );
-        }
-        return $descriptions;
-    }
-
-
-    /**
-     * @param bool|true $new_question
-     * @throws \EE_Error
-     */
-    protected function _insert_or_update_question($new_question = true)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $set_column_values = $this->_set_column_values_for($this->_question_model);
-        if ($new_question) {
-            $question = EE_Question::new_instance($set_column_values);
-            $action_desc = 'added';
-        } else {
-            $question     = EEM_Question::instance()->get_one_by_ID(absint($this->_req_data['QST_ID']));
-            foreach($set_column_values as $field => $new_value) {
-                $question->set($field, $new_value);
-            }
-            $action_desc = 'updated';
-        }
-        $success = $question->save();
-        $ID = $question->ID();
-        if ($ID && $question->should_have_question_options()) {
-            //save the related options
-            //trash removed options, save old ones
-            //get list of all options
-            $options  = $question->options();
-            if (! empty($options)) {
-                foreach ($options as $option_ID => $option) {
-                    $option_req_index = $this->_get_option_req_data_index($option_ID);
-                    if ($option_req_index !== false) {
-                        $option->save($this->_req_data['question_options'][$option_req_index]);
-                    } else {
-                        //not found, remove it
-                        $option->delete();
-                    }
-                }
-            }
-            //save new related options
-            foreach ($this->_req_data['question_options'] as $index => $option_req_data) {
-                //skip $index that is from our sample
-                if ( $index === 'xxcountxx' ) {
-                    continue;
-                }
-                //note we allow saving blank options.
-                if (empty($option_req_data['QSO_ID'])
-                ) {//no ID! save it!
-                    $new_option = EE_Question_Option::new_instance(array(
-                        'QSO_value' => $option_req_data['QSO_value'],
-                        'QSO_desc'  => $option_req_data['QSO_desc'],
-                        'QSO_order' => $option_req_data['QSO_order'],
-                        'QST_ID'    => $question->ID(),
-                    ));
-                    $new_option->save();
-                }
-            }
-        }
-        $query_args = array('action' => 'edit_question', 'QST_ID' => $ID);
-        if ($success !== false) {
-            $msg = $new_question ? sprintf(esc_html__('The %s has been created', 'event_espresso'),
-                $this->_question_model->item_name()) : sprintf(esc_html__('The %s has been updated', 'event_espresso'),
-                $this->_question_model->item_name());
-            EE_Error::add_success($msg);
-        }
-
-        $this->_redirect_after_action(false, '', $action_desc, $query_args, true);
-    }
-
-
-    /**
-     * Upon saving a question, there should be an array of 'question_options'. This array is index numerically, but not
-     * by ID
-     * (this is done because new question options don't have an ID, but we may want to add multiple simultaneously).
-     * So, this function gets the index in that request data array called question_options. Returns FALSE if not found.
-     *
-     * @param int $ID of the question option to find
-     * @return int index in question_options array if successful, FALSE if unsuccessful
-     */
-    protected function _get_option_req_data_index($ID)
-    {
-        $req_data_for_question_options = $this->_req_data['question_options'];
-        foreach ($req_data_for_question_options as $num => $option_data) {
-            if (array_key_exists('QSO_ID', $option_data) && (int)$option_data['QSO_ID'] === $ID) {
-                return $num;
-            }
-        }
-        return false;
-    }
-
-
-
-
-    /***********/
-    /* QUERIES */
-    /**
-     * For internal use in getting all the query parameters
-     * (because it's pretty well the same between question, question groups,
-     * and for both when searching for trashed and untrashed ones)
-     *
-     * @param EEM_Base $model either EEM_Question or EEM_Question_Group
-     * @param int      $per_page
-     * @param int      $current_page
-     * @return array lik EEM_Base::get_all's $query_params parameter
-     */
-    protected function get_query_params($model, $per_page = 10, $current_page = 10)
-    {
-        $query_params             = array();
-        $offset                   = ($current_page - 1) * $per_page;
-        $query_params['limit']    = array($offset, $per_page);
-        $order                    = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order'] : 'ASC';
-        $orderby_field            = $model instanceof EEM_Question ? 'QST_ID' : 'QSG_order';
-        $field_to_order_by        = empty($this->_req_data['orderby']) ? $orderby_field : $this->_req_data['orderby'];
-        $query_params['order_by'] = array($field_to_order_by => $order);
-        $search_string            = array_key_exists('s', $this->_req_data) ? $this->_req_data['s'] : null;
-        if (! empty($search_string)) {
-            if ($model instanceof EEM_Question_Group) {
-                $query_params[0] = array(
-                    'OR' => array(
-                        'QSG_name' => array('LIKE', "%$search_string%"),
-                        'QSG_desc' => array('LIKE', "%$search_string%"),
-                    ),
-                );
-            } else {
-                $query_params[0] = array(
-                    'QST_display_text' => array('LIKE', "%$search_string%"),
-                );
-            }
-        }
-
-        //capability checks (just leaving this commented out for reference because it illustrates some complicated query params that could be useful when fully implemented)
-        /*if ( $model instanceof EEM_Question_Group ) {
+			} //if the admin label is blank, use a slug version of the question text
+			else if ($fieldName === 'QST_admin_label' && (isset($this->_req_data['QST_admin_label']) && empty($this->_req_data['QST_admin_label']))) {
+				$QST_text                      = isset($this->_req_data['QST_display_text']) ? $this->_req_data['QST_display_text'] : '';
+				$set_column_values[$fieldName] = sanitize_title(wp_trim_words($QST_text, 10));
+			} else if ($fieldName === 'QST_admin_only' && (! isset($this->_req_data['QST_admin_only']))) {
+				$set_column_values[$fieldName] = 0;
+			} else if ($fieldName === 'QST_max') {
+				$qst_system = EEM_Question::instance()->get_var(
+					array(
+						array(
+							'QST_ID' => isset($this->_req_data['QST_ID']) ? $this->_req_data['QST_ID'] : 0,
+						),
+					),
+					'QST_system');
+				$max_max    = EEM_Question::instance()->absolute_max_for_system_question($qst_system);
+				if (empty($this->_req_data['QST_max']) ||
+					$this->_req_data['QST_max'] > $max_max
+				) {
+					$set_column_values[$fieldName] = $max_max;
+				}
+			}
+
+
+			//only add a property to the array if it's not null (otherwise the model should just use the default value)
+			if (
+				! isset($set_column_values[$fieldName]) &&
+				isset($this->_req_data[$fieldName])
+			) {
+				$set_column_values[$fieldName] = $this->_req_data[$fieldName];
+			}
+
+		}
+		return $set_column_values;//validation fo this data to be performed by the model before insertion.
+	}
+
+
+	/**
+	 *_questions_overview_list_table
+	 */
+	protected function _questions_overview_list_table()
+	{
+		$this->_search_btn_label = esc_html__('Questions', 'event_espresso');
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+	/**
+	 * _edit_question
+	 */
+	protected function _edit_question()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$ID = isset($this->_req_data['QST_ID']) && ! empty($this->_req_data['QST_ID']) ? absint($this->_req_data['QST_ID']) : false;
+
+		switch ($this->_req_action) {
+			case 'add_question' :
+				$this->_admin_page_title = esc_html__('Add Question', 'event_espresso');
+				break;
+			case 'edit_question' :
+				$this->_admin_page_title = esc_html__('Edit Question', 'event_espresso');
+				break;
+			default :
+				$this->_admin_page_title = ucwords(str_replace('_', ' ', $this->_req_action));
+		}
+
+		// add PRC_ID to title if editing
+		$this->_admin_page_title = $ID ? $this->_admin_page_title . ' # ' . $ID : $this->_admin_page_title;
+		if ($ID) {
+			$question                 = $this->_question_model->get_one_by_ID($ID);
+			$additional_hidden_fields = array('QST_ID' => array('type' => 'hidden', 'value' => $ID));
+			$this->_set_add_edit_form_tags('update_question', $additional_hidden_fields);
+		} else {
+			$question = EE_Question::new_instance();
+			$question->set_order_to_latest();
+			$this->_set_add_edit_form_tags('insert_question');
+		}
+		if( $question->system_ID() === EEM_Attendee::system_question_phone ){
+			$question_types = array_intersect_key(
+				EEM_Question::instance()->allowed_question_types(),
+				array_flip(
+					array(
+						EEM_Question::QST_type_text,
+						EEM_Question::QST_type_us_phone
+					)
+				)
+			);
+		} else {
+			$question_types = $question->has_answers() ? $this->_question_model->question_types_in_same_category($question->type()) : $this->_question_model->allowed_question_types();
+		}
+		$this->_template_args['QST_ID']                     = $ID;
+		$this->_template_args['question']                   = $question;
+		$this->_template_args['question_types']             = $question_types;
+		$this->_template_args['max_max']                    = EEM_Question::instance()->absolute_max_for_system_question(
+			$question->system_ID()
+		);
+		$this->_template_args['question_type_descriptions'] = $this->_get_question_type_descriptions();
+		$this->_set_publish_post_box_vars('id', $ID);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			REGISTRATION_FORM_TEMPLATE_PATH . 'questions_main_meta_box.template.php',
+			$this->_template_args, true
+		);
+
+		// the details template wrapper
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	protected function _get_question_type_descriptions()
+	{
+		EE_Registry::instance()->load_helper('HTML');
+		$descriptions               = '';
+		$question_type_descriptions = EEM_Question::instance()->question_descriptions();
+		foreach ($question_type_descriptions as $type => $question_type_description) {
+			if ($type == 'HTML_TEXTAREA') {
+				$html = new EE_Simple_HTML_Validation_Strategy();
+				$question_type_description .= sprintf(
+					esc_html__('%1$s(allowed tags: %2$s)', 'event_espresso'),
+					'<br/>',
+					$html->get_list_of_allowed_tags()
+				);
+			}
+			$descriptions .= EEH_HTML::p(
+				$question_type_description,
+				'question_type_description-' . $type,
+				'question_type_description description',
+				'display:none;'
+			);
+		}
+		return $descriptions;
+	}
+
+
+	/**
+	 * @param bool|true $new_question
+	 * @throws \EE_Error
+	 */
+	protected function _insert_or_update_question($new_question = true)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$set_column_values = $this->_set_column_values_for($this->_question_model);
+		if ($new_question) {
+			$question = EE_Question::new_instance($set_column_values);
+			$action_desc = 'added';
+		} else {
+			$question     = EEM_Question::instance()->get_one_by_ID(absint($this->_req_data['QST_ID']));
+			foreach($set_column_values as $field => $new_value) {
+				$question->set($field, $new_value);
+			}
+			$action_desc = 'updated';
+		}
+		$success = $question->save();
+		$ID = $question->ID();
+		if ($ID && $question->should_have_question_options()) {
+			//save the related options
+			//trash removed options, save old ones
+			//get list of all options
+			$options  = $question->options();
+			if (! empty($options)) {
+				foreach ($options as $option_ID => $option) {
+					$option_req_index = $this->_get_option_req_data_index($option_ID);
+					if ($option_req_index !== false) {
+						$option->save($this->_req_data['question_options'][$option_req_index]);
+					} else {
+						//not found, remove it
+						$option->delete();
+					}
+				}
+			}
+			//save new related options
+			foreach ($this->_req_data['question_options'] as $index => $option_req_data) {
+				//skip $index that is from our sample
+				if ( $index === 'xxcountxx' ) {
+					continue;
+				}
+				//note we allow saving blank options.
+				if (empty($option_req_data['QSO_ID'])
+				) {//no ID! save it!
+					$new_option = EE_Question_Option::new_instance(array(
+						'QSO_value' => $option_req_data['QSO_value'],
+						'QSO_desc'  => $option_req_data['QSO_desc'],
+						'QSO_order' => $option_req_data['QSO_order'],
+						'QST_ID'    => $question->ID(),
+					));
+					$new_option->save();
+				}
+			}
+		}
+		$query_args = array('action' => 'edit_question', 'QST_ID' => $ID);
+		if ($success !== false) {
+			$msg = $new_question ? sprintf(esc_html__('The %s has been created', 'event_espresso'),
+				$this->_question_model->item_name()) : sprintf(esc_html__('The %s has been updated', 'event_espresso'),
+				$this->_question_model->item_name());
+			EE_Error::add_success($msg);
+		}
+
+		$this->_redirect_after_action(false, '', $action_desc, $query_args, true);
+	}
+
+
+	/**
+	 * Upon saving a question, there should be an array of 'question_options'. This array is index numerically, but not
+	 * by ID
+	 * (this is done because new question options don't have an ID, but we may want to add multiple simultaneously).
+	 * So, this function gets the index in that request data array called question_options. Returns FALSE if not found.
+	 *
+	 * @param int $ID of the question option to find
+	 * @return int index in question_options array if successful, FALSE if unsuccessful
+	 */
+	protected function _get_option_req_data_index($ID)
+	{
+		$req_data_for_question_options = $this->_req_data['question_options'];
+		foreach ($req_data_for_question_options as $num => $option_data) {
+			if (array_key_exists('QSO_ID', $option_data) && (int)$option_data['QSO_ID'] === $ID) {
+				return $num;
+			}
+		}
+		return false;
+	}
+
+
+
+
+	/***********/
+	/* QUERIES */
+	/**
+	 * For internal use in getting all the query parameters
+	 * (because it's pretty well the same between question, question groups,
+	 * and for both when searching for trashed and untrashed ones)
+	 *
+	 * @param EEM_Base $model either EEM_Question or EEM_Question_Group
+	 * @param int      $per_page
+	 * @param int      $current_page
+	 * @return array lik EEM_Base::get_all's $query_params parameter
+	 */
+	protected function get_query_params($model, $per_page = 10, $current_page = 10)
+	{
+		$query_params             = array();
+		$offset                   = ($current_page - 1) * $per_page;
+		$query_params['limit']    = array($offset, $per_page);
+		$order                    = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order'] : 'ASC';
+		$orderby_field            = $model instanceof EEM_Question ? 'QST_ID' : 'QSG_order';
+		$field_to_order_by        = empty($this->_req_data['orderby']) ? $orderby_field : $this->_req_data['orderby'];
+		$query_params['order_by'] = array($field_to_order_by => $order);
+		$search_string            = array_key_exists('s', $this->_req_data) ? $this->_req_data['s'] : null;
+		if (! empty($search_string)) {
+			if ($model instanceof EEM_Question_Group) {
+				$query_params[0] = array(
+					'OR' => array(
+						'QSG_name' => array('LIKE', "%$search_string%"),
+						'QSG_desc' => array('LIKE', "%$search_string%"),
+					),
+				);
+			} else {
+				$query_params[0] = array(
+					'QST_display_text' => array('LIKE', "%$search_string%"),
+				);
+			}
+		}
+
+		//capability checks (just leaving this commented out for reference because it illustrates some complicated query params that could be useful when fully implemented)
+		/*if ( $model instanceof EEM_Question_Group ) {
             if ( ! EE_Registry::instance()->CAP->current_user_can( 'edit_others_question_groups', 'espresso_registration_form_edit_question_group' ) ) {
                 $query_params[0] = array(
                     'AND' => array(
@@ -672,62 +672,62 @@ 
             }
         }/**/
 
-        return $query_params;
-
-    }
-
-
-    /**
-     * @param int        $per_page
-     * @param int        $current_page
-     * @param bool|false $count
-     * @return \EE_Soft_Delete_Base_Class[]|int
-     */
-    public function get_questions($per_page = 10, $current_page = 1, $count = false)
-    {
-        $QST          = EEM_Question::instance();
-        $query_params = $this->get_query_params($QST, $per_page, $current_page);
-        if ($count) {
-            $where   = isset($query_params[0]) ? array($query_params[0]) : array();
-            $results = $QST->count($where);
-        } else {
-            $results = $QST->get_all($query_params);
-        }
-        return $results;
-
-    }
-
-
-    /**
-     * @param            $per_page
-     * @param int        $current_page
-     * @param bool|false $count
-     * @return \EE_Soft_Delete_Base_Class[]|int
-     */
-    public function get_trashed_questions($per_page, $current_page = 1, $count = false)
-    {
-        $query_params = $this->get_query_params(EEM_Question::instance(), $per_page, $current_page);
-        $where        = isset($query_params[0]) ? array($query_params[0]) : array();
-        $questions    = $count ? EEM_Question::instance()->count_deleted($where) : EEM_Question::instance()->get_all_deleted($query_params);
-        return $questions;
-    }
-
-
-    /**
-     * @param            $per_page
-     * @param int        $current_page
-     * @param bool|false $count
-     * @return \EE_Soft_Delete_Base_Class[]
-     */
-    public function get_question_groups($per_page, $current_page = 1, $count = false)
-    {
-        /** @type EEM_Question_Group $questionGroupModel */
-        $questionGroupModel = EEM_Question_Group::instance();
-        //note: this a subclass of EEM_Soft_Delete_Base, so this is actually only getting non-trashed items
-        return $questionGroupModel->get_all(
-            $this->get_query_params($questionGroupModel, $per_page, $current_page)
-        );
-    }
+		return $query_params;
+
+	}
+
+
+	/**
+	 * @param int        $per_page
+	 * @param int        $current_page
+	 * @param bool|false $count
+	 * @return \EE_Soft_Delete_Base_Class[]|int
+	 */
+	public function get_questions($per_page = 10, $current_page = 1, $count = false)
+	{
+		$QST          = EEM_Question::instance();
+		$query_params = $this->get_query_params($QST, $per_page, $current_page);
+		if ($count) {
+			$where   = isset($query_params[0]) ? array($query_params[0]) : array();
+			$results = $QST->count($where);
+		} else {
+			$results = $QST->get_all($query_params);
+		}
+		return $results;
+
+	}
+
+
+	/**
+	 * @param            $per_page
+	 * @param int        $current_page
+	 * @param bool|false $count
+	 * @return \EE_Soft_Delete_Base_Class[]|int
+	 */
+	public function get_trashed_questions($per_page, $current_page = 1, $count = false)
+	{
+		$query_params = $this->get_query_params(EEM_Question::instance(), $per_page, $current_page);
+		$where        = isset($query_params[0]) ? array($query_params[0]) : array();
+		$questions    = $count ? EEM_Question::instance()->count_deleted($where) : EEM_Question::instance()->get_all_deleted($query_params);
+		return $questions;
+	}
+
+
+	/**
+	 * @param            $per_page
+	 * @param int        $current_page
+	 * @param bool|false $count
+	 * @return \EE_Soft_Delete_Base_Class[]
+	 */
+	public function get_question_groups($per_page, $current_page = 1, $count = false)
+	{
+		/** @type EEM_Question_Group $questionGroupModel */
+		$questionGroupModel = EEM_Question_Group::instance();
+		//note: this a subclass of EEM_Soft_Delete_Base, so this is actually only getting non-trashed items
+		return $questionGroupModel->get_all(
+			$this->get_query_params($questionGroupModel, $per_page, $current_page)
+		);
+	}
 
 
 } //ends Registration_Form_Admin_Page class

Spacing +27 added lines, -27 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('NO direct script access allowed');
 }
 
@@ -66,8 +66,8 @@ 
      */
     public function __construct($routing = true)
     {
-        require_once(EE_MODELS . 'EEM_Question.model.php');
-        require_once(EE_MODELS . 'EEM_Question_Group.model.php');
+        require_once(EE_MODELS.'EEM_Question.model.php');
+        require_once(EE_MODELS.'EEM_Question_Group.model.php');
         $this->_question_model       = EEM_Question::instance();
         $this->_question_group_model = EEM_Question_Group::instance();
         parent::__construct($routing);
@@ -232,7 +232,7 @@ 
     public function load_scripts_styles()
     {
         wp_register_style('espresso_registration',
-            REGISTRATION_FORM_ASSETS_URL . 'espresso_registration_form_admin.css', array(), EVENT_ESPRESSO_VERSION);
+            REGISTRATION_FORM_ASSETS_URL.'espresso_registration_form_admin.css', array(), EVENT_ESPRESSO_VERSION);
         wp_enqueue_style('espresso_registration');
     }
 
@@ -271,7 +271,7 @@ 
     {
         $this->load_scripts_styles_forms();
         wp_register_script('espresso_registration_form_single',
-            REGISTRATION_FORM_ASSETS_URL . 'espresso_registration_form_admin.js', array('jquery-ui-sortable'),
+            REGISTRATION_FORM_ASSETS_URL.'espresso_registration_form_admin.js', array('jquery-ui-sortable'),
             EVENT_ESPRESSO_VERSION, true);
         wp_enqueue_script('espresso_registration_form_single');
         wp_localize_script(
@@ -287,7 +287,7 @@ 
 
     public function recaptcha_info_help_tab()
     {
-        $template = REGISTRATION_FORM_TEMPLATE_PATH . 'recaptcha_info_help_tab.template.php';
+        $template = REGISTRATION_FORM_TEMPLATE_PATH.'recaptcha_info_help_tab.template.php';
         EEH_Template::display_template($template, array());
     }
 
@@ -336,10 +336,10 @@ 
     protected function _questions_groups_preview()
     {
         $this->_admin_page_title              = esc_html__('Question Groups (Preview)', 'event_espresso');
-        $this->_template_args['preview_img']  = '<img src="' . REGISTRATION_FORM_ASSETS_URL . 'caf_reg_form_preview.jpg" alt="' . esc_attr__('Preview Question Groups Overview List Table screenshot',
-                'event_espresso') . '" />';
-        $this->_template_args['preview_text'] = '<strong>' . esc_html__('Question Groups is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Question Groups feature you are able to create new question groups, edit existing question groups, and create and edit new questions and add them to question groups.',
-                'event_espresso') . '</strong>';
+        $this->_template_args['preview_img']  = '<img src="'.REGISTRATION_FORM_ASSETS_URL.'caf_reg_form_preview.jpg" alt="'.esc_attr__('Preview Question Groups Overview List Table screenshot',
+                'event_espresso').'" />';
+        $this->_template_args['preview_text'] = '<strong>'.esc_html__('Question Groups is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Question Groups feature you are able to create new question groups, edit existing question groups, and create and edit new questions and add them to question groups.',
+                'event_espresso').'</strong>';
         $this->display_admin_caf_preview_page('question_groups_tab');
     }
 
@@ -357,11 +357,11 @@ 
 
         //some initial checks for proper values.
         //if QST_admin_only, then no matter what QST_required is we disable.
-        if (! empty($this->_req_data['QST_admin_only'])) {
+        if ( ! empty($this->_req_data['QST_admin_only'])) {
             $this->_req_data['QST_required'] = 0;
         }
         //if the question shouldn't have a max length, don't let them set one
-        if (! isset(
+        if ( ! isset(
             $this->_req_data['QST_type'],
                 $this->_req_data['QST_max']
             )
@@ -377,13 +377,13 @@ 
             // basically if QSG_identifier is empty or not set
             if ($fieldName === 'QSG_identifier' && (isset($this->_req_data['QSG_identifier']) && empty($this->_req_data['QSG_identifier']))) {
                 $QSG_name                      = isset($this->_req_data['QSG_name']) ? $this->_req_data['QSG_name'] : '';
-                $set_column_values[$fieldName] = sanitize_title($QSG_name) . '-' . uniqid('', true);
+                $set_column_values[$fieldName] = sanitize_title($QSG_name).'-'.uniqid('', true);
 //				dd($set_column_values);
             } //if the admin label is blank, use a slug version of the question text
             else if ($fieldName === 'QST_admin_label' && (isset($this->_req_data['QST_admin_label']) && empty($this->_req_data['QST_admin_label']))) {
                 $QST_text                      = isset($this->_req_data['QST_display_text']) ? $this->_req_data['QST_display_text'] : '';
                 $set_column_values[$fieldName] = sanitize_title(wp_trim_words($QST_text, 10));
-            } else if ($fieldName === 'QST_admin_only' && (! isset($this->_req_data['QST_admin_only']))) {
+            } else if ($fieldName === 'QST_admin_only' && ( ! isset($this->_req_data['QST_admin_only']))) {
                 $set_column_values[$fieldName] = 0;
             } else if ($fieldName === 'QST_max') {
                 $qst_system = EEM_Question::instance()->get_var(
@@ -393,7 +393,7 @@ 
                         ),
                     ),
                     'QST_system');
-                $max_max    = EEM_Question::instance()->absolute_max_for_system_question($qst_system);
+                $max_max = EEM_Question::instance()->absolute_max_for_system_question($qst_system);
                 if (empty($this->_req_data['QST_max']) ||
                     $this->_req_data['QST_max'] > $max_max
                 ) {
@@ -411,7 +411,7 @@ 
             }
 
         }
-        return $set_column_values;//validation fo this data to be performed by the model before insertion.
+        return $set_column_values; //validation fo this data to be performed by the model before insertion.
     }
 
 
@@ -445,7 +445,7 @@ 
         }
 
         // add PRC_ID to title if editing
-        $this->_admin_page_title = $ID ? $this->_admin_page_title . ' # ' . $ID : $this->_admin_page_title;
+        $this->_admin_page_title = $ID ? $this->_admin_page_title.' # '.$ID : $this->_admin_page_title;
         if ($ID) {
             $question                 = $this->_question_model->get_one_by_ID($ID);
             $additional_hidden_fields = array('QST_ID' => array('type' => 'hidden', 'value' => $ID));
@@ -455,7 +455,7 @@ 
             $question->set_order_to_latest();
             $this->_set_add_edit_form_tags('insert_question');
         }
-        if( $question->system_ID() === EEM_Attendee::system_question_phone ){
+        if ($question->system_ID() === EEM_Attendee::system_question_phone) {
             $question_types = array_intersect_key(
                 EEM_Question::instance()->allowed_question_types(),
                 array_flip(
@@ -477,7 +477,7 @@ 
         $this->_template_args['question_type_descriptions'] = $this->_get_question_type_descriptions();
         $this->_set_publish_post_box_vars('id', $ID);
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            REGISTRATION_FORM_TEMPLATE_PATH . 'questions_main_meta_box.template.php',
+            REGISTRATION_FORM_TEMPLATE_PATH.'questions_main_meta_box.template.php',
             $this->_template_args, true
         );
 
@@ -505,7 +505,7 @@ 
             }
             $descriptions .= EEH_HTML::p(
                 $question_type_description,
-                'question_type_description-' . $type,
+                'question_type_description-'.$type,
                 'question_type_description description',
                 'display:none;'
             );
@@ -526,8 +526,8 @@ 
             $question = EE_Question::new_instance($set_column_values);
             $action_desc = 'added';
         } else {
-            $question     = EEM_Question::instance()->get_one_by_ID(absint($this->_req_data['QST_ID']));
-            foreach($set_column_values as $field => $new_value) {
+            $question = EEM_Question::instance()->get_one_by_ID(absint($this->_req_data['QST_ID']));
+            foreach ($set_column_values as $field => $new_value) {
                 $question->set($field, $new_value);
             }
             $action_desc = 'updated';
@@ -538,8 +538,8 @@ 
             //save the related options
             //trash removed options, save old ones
             //get list of all options
-            $options  = $question->options();
-            if (! empty($options)) {
+            $options = $question->options();
+            if ( ! empty($options)) {
                 foreach ($options as $option_ID => $option) {
                     $option_req_index = $this->_get_option_req_data_index($option_ID);
                     if ($option_req_index !== false) {
@@ -553,7 +553,7 @@ 
             //save new related options
             foreach ($this->_req_data['question_options'] as $index => $option_req_data) {
                 //skip $index that is from our sample
-                if ( $index === 'xxcountxx' ) {
+                if ($index === 'xxcountxx') {
                     continue;
                 }
                 //note we allow saving blank options.
@@ -594,7 +594,7 @@ 
     {
         $req_data_for_question_options = $this->_req_data['question_options'];
         foreach ($req_data_for_question_options as $num => $option_data) {
-            if (array_key_exists('QSO_ID', $option_data) && (int)$option_data['QSO_ID'] === $ID) {
+            if (array_key_exists('QSO_ID', $option_data) && (int) $option_data['QSO_ID'] === $ID) {
                 return $num;
             }
         }
@@ -626,7 +626,7 @@ 
         $field_to_order_by        = empty($this->_req_data['orderby']) ? $orderby_field : $this->_req_data['orderby'];
         $query_params['order_by'] = array($field_to_order_by => $order);
         $search_string            = array_key_exists('s', $this->_req_data) ? $this->_req_data['s'] : null;
-        if (! empty($search_string)) {
+        if ( ! empty($search_string)) {
             if ($model instanceof EEM_Question_Group) {
                 $query_params[0] = array(
                     'OR' => array(

core/libraries/payment_methods/EE_PMT_Base.lib.php

Indentation +718 added lines, -718 removed lines

@@ -21,724 +21,724 @@
 abstract class EE_PMT_Base
 {
 
-    const onsite = 'on-site';
-    const offsite = 'off-site';
-    const offline = 'off-line';
-
-    /**
-     * @var EE_Payment_Method
-     */
-    protected $_pm_instance = NULL;
-
-    /**
-     * @var boolean
-     */
-    protected $_requires_https = FALSE;
-
-    /**
-     * @var boolean
-     */
-    protected $_has_billing_form;
-
-    /**
-     * @var EE_Gateway
-     */
-    protected $_gateway = NULL;
-
-    /**
-     * @var EE_Payment_Method_Form
-     */
-    protected $_settings_form = NULL;
-
-    /**
-     * @var EE_Form_Section_Proper
-     */
-    protected $_billing_form = NULL;
-
-    /**
-     * @var boolean
-     */
-    protected $_cache_billing_form = TRUE;
-
-    /**
-     * String of the absolute path to the folder containing this file, with a trailing slash.
-     * eg '/public_html/wp-site/wp-content/plugins/event-espresso/payment_methods/Invoice/'
-     * @var string
-     */
-    protected $_file_folder = NULL;
-
-    /**
-     * String to the absolute URL to this file (useful for getting its web-accessible resources
-     * like images, js, or css)
-     * @var string
-     */
-    protected $_file_url = NULL;
-
-    /**
-     * Pretty name for the payment method
-     * @var string
-     */
-    protected $_pretty_name = NULL;
-
-    /**
-     *
-     * @var string
-     */
-    protected $_default_button_url = NULL;
-
-    /**
-     *
-     * @var string
-     */
-    protected $_default_description = NULL;
-
-
-    /**
-     *
-     * @param EE_Payment_Method $pm_instance
-     * @throws EE_Error
-     * @return EE_PMT_Base
-     */
-    function __construct($pm_instance = NULL)
-    {
-        if ($pm_instance instanceof EE_Payment_Method) {
-            $this->set_instance($pm_instance);
-        }
-        if ($this->_gateway) {
-            $this->_gateway->set_payment_model(EEM_Payment::instance());
-            $this->_gateway->set_payment_log(EEM_Change_Log::instance());
-            $this->_gateway->set_template_helper(new EEH_Template());
-            $this->_gateway->set_line_item_helper(new EEH_Line_Item());
-            $this->_gateway->set_money_helper(new EEH_Money());
-            $this->_gateway->set_gateway_data_formatter(new GatewayDataFormatter());
-            $this->_gateway->set_unsupported_character_remover(new AsciiOnly());
-            do_action('AHEE__EE_PMT_Base___construct__done_initializing_gateway_class', $this, $this->_gateway);
-        }
-        if (!isset($this->_has_billing_form)) {
-            // by default, On Site gateways have a billing form
-            if ($this->payment_occurs() == EE_PMT_Base::onsite) {
-                $this->set_has_billing_form(true);
-            } else {
-                $this->set_has_billing_form(false);
-            }
-        }
-
-        if (!$this->_pretty_name) {
-            throw new EE_Error(sprintf(__("You must set the pretty name for the Payment Method Type in the constructor (_pretty_name), and please make it internationalized", "event_espresso")));
-        }
-        //if the child didn't specify a default button, use the credit card one
-        if ($this->_default_button_url === NULL) {
-            $this->_default_button_url = EE_PLUGIN_DIR_URL . 'payment_methods' . DS . 'pay-by-credit-card.png';
-        }
-    }
-
-
-    /**
-     * @param boolean $has_billing_form
-     */
-    public function set_has_billing_form($has_billing_form)
-    {
-        $this->_has_billing_form = filter_var($has_billing_form, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * sets the file_folder property
-     */
-    protected function _set_file_folder()
-    {
-        $reflector = new ReflectionClass(get_class($this));
-        $fn = $reflector->getFileName();
-        $this->_file_folder = dirname($fn) . DS;
-    }
-
-
-    /**
-     * sets the file URL with a trailing slash for this PMT
-     */
-    protected function _set_file_url()
-    {
-        $plugins_dir_fixed = str_replace('\\', DS, WP_PLUGIN_DIR);
-        $file_folder_fixed = str_replace('\\', DS, $this->file_folder());
-        $file_path = str_replace($plugins_dir_fixed, WP_PLUGIN_URL, $file_folder_fixed);
-        $this->_file_url = $file_path;
-    }
-
-    /**
-     * Gets the default description on all payment methods of this type
-     * @return string
-     */
-    public function default_description()
-    {
-        return $this->_default_description;
-    }
-
-
-    /**
-     * Returns the folder containing the PMT child class, with a trailing slash
-     * @return string
-     */
-    public function file_folder()
-    {
-        if (!$this->_file_folder) {
-            $this->_set_file_folder();
-        }
-        return $this->_file_folder;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function file_url()
-    {
-        if (!$this->_file_url) {
-            $this->_set_file_url();
-        }
-        return $this->_file_url;
-    }
-
-
-    /**
-     * Sets the payment method instance this payment method type is for.
-     * Its important teh payment method instance is set before
-     * @param EE_Payment_Method $payment_method_instance
-     */
-    function set_instance($payment_method_instance)
-    {
-        $this->_pm_instance = $payment_method_instance;
-        //if they have already requested the settings form, make sure its
-        //data matches this model object
-        if ($this->_settings_form) {
-            $this->settings_form()->populate_model_obj($payment_method_instance);
-        }
-        if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
-            $this->_gateway->set_settings($payment_method_instance->settings_array());
-        }
-    }
-
-
-    /**
-     * Gets teh form for displaying to admins where they setup the payment method
-     * @return EE_Payment_Method_Form
-     */
-    function settings_form()
-    {
-        if (!$this->_settings_form) {
-            $this->_settings_form = $this->generate_new_settings_form();
-            $this->_settings_form->set_payment_method_type($this);
-            //if we have already assigned a model object to this pmt, make
-            //sure its reflected in teh form we just generated
-            if ($this->_pm_instance) {
-                $this->_settings_form->populate_model_obj($this->_pm_instance);
-            }
-        }
-        return $this->_settings_form;
-    }
-
-
-    /**
-     * Gets the form for all the settings related to this payment method type
-     * @return EE_Payment_Method_Form
-     */
-    abstract function generate_new_settings_form();
-
-
-    /**
-     * Sets the form for settings. This may be useful if we have already received
-     * a form submission and have form data it in, and want to use it anytime we're showing
-     * this payment method type's settings form later in the request
-     * @param EE_Payment_Method_Form $form
-     */
-    public function set_settings_form($form)
-    {
-        $this->_settings_form = $form;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function has_billing_form()
-    {
-        return $this->_has_billing_form;
-    }
-
-
-    /**
-     * Gets the form for displaying to attendees where they can enter their billing info
-     * which will be sent to teh gateway (can be null)
-     *
-     * @param \EE_Transaction $transaction
-     * @param array $extra_args
-     * @return \EE_Billing_Attendee_Info_Form|\EE_Billing_Info_Form|null
-     */
-    public function billing_form(EE_Transaction $transaction = NULL, $extra_args = array())
-    {
-        // has billing form already been regenerated ? or overwrite cache?
-        if (!$this->_billing_form instanceof EE_Billing_Info_Form || !$this->_cache_billing_form) {
-            $this->_billing_form = $this->generate_new_billing_form($transaction, $extra_args);
-        }
-        //if we know who the attendee is, and this is a billing form
-        //that uses attendee info, populate it
-        if (
-        apply_filters(
-            'FHEE__populate_billing_form_fields_from_attendee',
-            (
-                $this->_billing_form instanceof EE_Billing_Attendee_Info_Form
-                && $transaction instanceof EE_Transaction
-                && $transaction->primary_registration() instanceof EE_Registration
-                && $transaction->primary_registration()->attendee() instanceof EE_Attendee
-            ),
-            $this->_billing_form,
-            $transaction
-        )
-        ) {
-            $this->_billing_form->populate_from_attendee($transaction->primary_registration()->attendee());
-        }
-        return $this->_billing_form;
-    }
-
-
-    /**
-     * Creates the billing form for this payment method type
-     * @param \EE_Transaction $transaction
-     * @return \EE_Billing_Info_Form
-     */
-    abstract function generate_new_billing_form(EE_Transaction $transaction = NULL);
-
-
-    /**
-     * apply_billing_form_debug_settings
-     * applies debug data to the form
-     *
-     * @param \EE_Billing_Info_Form $billing_form
-     * @return \EE_Billing_Info_Form
-     */
-    public function apply_billing_form_debug_settings(EE_Billing_Info_Form $billing_form)
-    {
-        return $billing_form;
-    }
-
-
-    /**
-     * Sets the billing form for this payment method type. You may want to use this
-     * if you have form
-     * @param EE_Payment_Method $form
-     */
-    public function set_billing_form($form)
-    {
-        $this->_billing_form = $form;
-    }
-
-
-    /**
-     * Returns whether or not this payment method requires HTTPS to be used
-     * @return boolean
-     */
-    function requires_https()
-    {
-        return $this->_requires_https;
-    }
-
-
-    /**
-     *
-     * @param EE_Transaction $transaction
-     * @param float $amount
-     * @param EE_Billing_Info_Form $billing_info
-     * @param string $return_url
-     * @param string $fail_url
-     * @param string $method
-     * @param bool $by_admin
-     * @return EE_Payment
-     * @throws EE_Error
-     */
-    function process_payment(EE_Transaction $transaction, $amount = null, $billing_info = null, $return_url = null, $fail_url = '', $method = 'CART', $by_admin = false)
-    {
-        // @todo: add surcharge for the payment method, if any
-        if ($this->_gateway) {
-            //there is a gateway, so we're going to make a payment object
-            //but wait! do they already have a payment in progress that we thought was failed?
-            $duplicate_properties = array(
-                'STS_ID' => EEM_Payment::status_id_failed,
-                'TXN_ID' => $transaction->ID(),
-                'PMD_ID' => $this->_pm_instance->ID(),
-                'PAY_source' => $method,
-                'PAY_amount' => $amount !== null ? $amount : $transaction->remaining(),
-                'PAY_gateway_response' => null,
-            );
-            $payment = EEM_Payment::instance()->get_one(array($duplicate_properties));
-            //if we didn't already have a payment in progress for the same thing,
-            //then we actually want to make a new payment
-            if (!$payment instanceof EE_Payment) {
-                $payment = EE_Payment::new_instance(
-                    array_merge(
-                        $duplicate_properties,
-                        array(
-                            'PAY_timestamp' => time(),
-                            'PAY_txn_id_chq_nmbr' => null,
-                            'PAY_po_number' => null,
-                            'PAY_extra_accntng' => null,
-                            'PAY_details' => null,
-                        )
-                    )
-                );
-            }
-            //make sure the payment has been saved to show we started it, and so it has an ID should the gateway try to log it
-            $payment->save();
-            $billing_values = $this->_get_billing_values_from_form($billing_info);
-
-            //  Offsite Gateway
-            if ($this->_gateway instanceof EE_Offsite_Gateway) {
-
-                $payment = $this->_gateway->set_redirection_info(
-                    $payment,
-                    $billing_values,
-                    $return_url,
-                    EE_Config::instance()->core->txn_page_url(
-                        array(
-                            'e_reg_url_link' => $transaction->primary_registration()->reg_url_link(),
-                            'ee_payment_method' => $this->_pm_instance->slug()
-                        )
-                    ),
-                    $fail_url
-                );
-                $payment->save();
-                //  Onsite Gateway
-            } elseif ($this->_gateway instanceof EE_Onsite_Gateway) {
-
-                $payment = $this->_gateway->do_direct_payment($payment, $billing_values);
-                $payment->save();
-
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        __('Gateway for payment method type "%s" is "%s", not a subclass of either EE_Offsite_Gateway or EE_Onsite_Gateway, or null (to indicate NO gateway)', 'event_espresso'),
-                        get_class($this),
-                        gettype($this->_gateway)
-                    )
-                );
-            }
-
-        } else {
-            // no gateway provided
-            // there is no payment. Must be an offline gateway
-            // create a payment object anyways, but dont save it
-            $payment = EE_Payment::new_instance(
-                array(
-                    'STS_ID' => EEM_Payment::status_id_pending,
-                    'TXN_ID' => $transaction->ID(),
-                    'PMD_ID' => $transaction->payment_method_ID(),
-                    'PAY_amount' => 0.00,
-                    'PAY_timestamp' => time(),
-                )
-            );
-
-        }
-
-        // if there is billing info, clean it and save it now
-        if ($billing_info instanceof EE_Billing_Attendee_Info_Form) {
-            $this->_save_billing_info_to_attendee($billing_info, $transaction);
-        }
-
-        return $payment;
-    }
-
-    /**
-     * Gets the values we want to pass onto the gateway. Normally these
-     * are just the 'pretty' values, but there may be times the data may need
-     * a  little massaging. Proper subsections will become arrays of inputs
-     * @param EE_Billing_Info_Form $billing_form
-     * @return array
-     */
-    protected function _get_billing_values_from_form($billing_form)
-    {
-        if ($billing_form instanceof EE_Form_Section_Proper) {
-            return $billing_form->input_pretty_values(true);
-        } else {
-            return NULL;
-        }
-    }
-
-
-    /**
-     * Handles an instant payment notification when the transaction is known (by default).
-     * @param array $req_data
-     * @param EE_Transaction $transaction
-     * @return EE_Payment
-     * @throws EE_Error
-     */
-    public function handle_ipn($req_data, $transaction)
-    {
-        $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        if (!$this->_gateway instanceof EE_Offsite_Gateway) {
-            throw new EE_Error(sprintf(__("Could not handle IPN because '%s' is not an offsite gateway", "event_espresso"), print_r($this->_gateway, TRUE)));
-
-        }
-        $payment = $this->_gateway->handle_payment_update($req_data, $transaction);
-        return $payment;
-    }
-
-
-    /**
-     * Saves the billing info onto the attendee of the primary registrant on this transaction, and
-     * cleans it first.
-     * @param EE_Billing_Attendee_Info_Form $billing_form
-     * @param EE_Transaction $transaction
-     * @return boolean success
-     */
-    protected function _save_billing_info_to_attendee($billing_form, $transaction)
-    {
-        if (!$transaction || !$transaction instanceof EE_Transaction) {
-            EE_Error::add_error(__("Cannot save billing info because no transaction was specified", "event_espresso"), __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        $primary_reg = $transaction->primary_registration();
-        if (!$primary_reg) {
-            EE_Error::add_error(__("Cannot save billing info because the transaction has no primary registration", "event_espresso"), __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        $attendee = $primary_reg->attendee();
-        if (!$attendee) {
-            EE_Error::add_error(__("Cannot save billing info because the transaction's primary registration has no attendee!", "event_espresso"), __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        return $attendee->save_and_clean_billing_info_for_payment_method($billing_form, $transaction->payment_method());
-
-    }
-
-
-    /**
-     * Gets the payment this IPN is for. Children may often want to
-     * override this to inspect the request
-     * @param EE_Transaction $transaction
-     * @param array $req_data
-     * @return EE_Payment
-     */
-    protected function find_payment_for_ipn(EE_Transaction $transaction, $req_data = array())
-    {
-        return $transaction->last_payment();
-    }
-
-
-    /**
-     * In case generic code cannot provide the payment processor with a specific payment method
-     * and transaction, it will try calling this method on each activate payment method.
-     * If the payment method is able to identify the request as being for it, it should fetch
-     * the payment its for and return it. If not, it should throw an EE_Error to indicate it cannot
-     * handle the IPN
-     * @param array $req_data
-     * @return EE_Payment only if this payment method can find the info its needs from $req_data
-     * and identifies the IPN as being for this payment method (not just fo ra payment method of this type)
-     * @throws EE_Error
-     */
-    public function handle_unclaimed_ipn($req_data = array())
-    {
-        throw new EE_Error(sprintf(__("Payment Method '%s' cannot handle unclaimed IPNs", "event_espresso"), get_class($this)));
-    }
-
-
-    /**
-     * Logic to be accomplished when the payment attempt is complete.
-     * Most payment methods don't need to do anything at this point; but some, like Mijireh, do.
-     * (Mijireh is an offsite gateway which doesn't send an IPN. So when the user returns to EE from
-     * mijireh, this method needs to be called so the Mijireh PM can ping Mijireh to know the status
-     * of the payment). Fed a transaction because it's always assumed to be the last payment that
-     * we're dealing with. Returns that last payment (if there is one)
-     *
-     * @param EE_Transaction $transaction
-     * @return EE_Payment
-     */
-    public function finalize_payment_for($transaction)
-    {
-        return $transaction->last_payment();
-    }
-
-
-    /**
-     * Whether or not this payment method's gateway supports sending refund requests
-     * @return boolean
-     */
-    public function supports_sending_refunds()
-    {
-        if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
-            return $this->_gateway->supports_sending_refunds();
-        } else {
-            return false;
-        }
-    }
-
-
-    /**
-     *
-     * @param EE_Payment $payment
-     * @param array $refund_info
-     * @throws EE_Error
-     * @return EE_Payment
-     */
-    public function process_refund(EE_Payment $payment, $refund_info = array())
-    {
-        if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
-            return $this->_gateway->do_direct_refund($payment, $refund_info);
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    __('Payment Method Type "%s" does not support sending refund requests', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
-
-
-    /**
-     * Returns one the class's constants onsite,offsite, or offline, depending on this
-     * payment method's gateway.
-     * @return string
-     * @throws EE_Error
-     */
-    public function payment_occurs()
-    {
-        if (!$this->_gateway) {
-            return EE_PMT_Base::offline;
-        } elseif ($this->_gateway instanceof EE_Onsite_Gateway) {
-            return EE_PMT_Base::onsite;
-        } elseif ($this->_gateway instanceof EE_Offsite_Gateway) {
-            return EE_PMT_Base::offsite;
-        } else {
-            throw new EE_Error(sprintf(__("Payment method type '%s's gateway isn't an instance of EE_Onsite_Gateway, EE_Offsite_Gateway, or null. It must be one of those", "event_espresso"), get_class($this)));
-        }
-    }
-
-
-    /**
-     * For adding any html output ab ove the payment overview.
-     * Many gateways won't want ot display anything, so this function just returns an empty string.
-     * Other gateways may want to override this, such as offline gateways.
-     * @param EE_Payment $payment
-     * @return string
-     */
-    public function payment_overview_content(EE_Payment $payment)
-    {
-        return EEH_Template::display_template(EE_LIBRARIES . 'payment_methods' . DS . 'templates' . DS . 'payment_details_content.template.php', array('payment_method' => $this->_pm_instance, 'payment' => $payment), true);
-    }
-
-
-    /**
-     * @return array where keys are the help tab name,
-     * values are: array {
-     * @type string $title i18n name for the help tab
-     * @type string $filename name of the file located in ./help_tabs/ (ie, in a folder next to this file)
-     * @type array $template_args any arguments you want passed to the template file while rendering.
-     *                Keys will be variable names and values with be their values.
-     */
-    public function help_tabs_config()
-    {
-        return array();
-    }
-
-
-    /**
-     * The system name for this PMT (eg AIM, Paypal_Pro, Invoice... what gets put into
-     * the payment method's table's PMT_type column)
-     * @return string
-     */
-    public function system_name()
-    {
-        $classname = get_class($this);
-        return str_replace("EE_PMT_", '', $classname);
-    }
-
-
-    /**
-     * A pretty i18n version of the PMT name
-     * @return string
-     */
-    public function pretty_name()
-    {
-        return $this->_pretty_name;
-    }
-
-
-    /**
-     * Gets the default absolute URL to the payment method type's button
-     * @return string
-     */
-    public function default_button_url()
-    {
-        return $this->_default_button_url;
-    }
-
-
-    /**
-     * Gets the gateway used by this payment method (if any)
-     * @return EE_Gateway
-     */
-    public function get_gateway()
-    {
-        return $this->_gateway;
-    }
-
-
-    /**
-     * @return string html for the link to a help tab
-     */
-    public function get_help_tab_link()
-    {
-        return EEH_Template::get_help_tab_link($this->get_help_tab_name());
-    }
-
-
-    /**
-     * Returns the name of the help tab for this PMT
-     * @return string
-     */
-    public function get_help_tab_name()
-    {
-        return 'ee_' . strtolower($this->system_name()) . '_help_tab';
-    }
-
-    /**
-     * The name of the wp capability that should be associated with the usage of
-     * this PMT by an admin
-     * @return string
-     */
-    public function cap_name()
-    {
-        return 'ee_payment_method_' . strtolower($this->system_name());
-    }
-
-    /**
-     * Called by client code to tell the gateway that if it wants to change
-     * the transaction or line items or registrations related to teh payment it already
-     * processed (we think, but possibly not) that now's the time to do it.
-     * It is expected that gateways will store any info they need for this on the PAY_details,
-     * or maybe an extra meta value
-     * @param EE_Payment $payment
-     * @return void
-     */
-    public function update_txn_based_on_payment($payment)
-    {
-        if ($this->_gateway instanceof EE_Gateway) {
-            $this->_gateway->update_txn_based_on_payment($payment);
-        }
-    }
-
-    /**
-     * Returns a string of HTML describing this payment method type for an admin,
-     * primarily intended for them to read before activating it.
-     * The easiest way to set this is to create a folder 'templates' alongside
-     * your EE_PMT_{System_Name} file, and in it create a file named "{system_name}_intro.template.php".
-     * Eg, if your payment method file is named "EE_PMT_Foo_Bar.pm.php",
-     * then you'd create a file named "templates" in the same folder as it, and name the file
-     * "foo_bar_intro.template.php", and its content will be returned by this method
-     * @return string
-     */
-    public function introductory_html()
-    {
-        return EEH_Template::locate_template($this->file_folder() . 'templates' . DS . strtolower($this->system_name()) . '_intro.template.php', array('pmt_obj' => $this, 'pm_instance' => $this->_pm_instance));
-    }
+	const onsite = 'on-site';
+	const offsite = 'off-site';
+	const offline = 'off-line';
+
+	/**
+	 * @var EE_Payment_Method
+	 */
+	protected $_pm_instance = NULL;
+
+	/**
+	 * @var boolean
+	 */
+	protected $_requires_https = FALSE;
+
+	/**
+	 * @var boolean
+	 */
+	protected $_has_billing_form;
+
+	/**
+	 * @var EE_Gateway
+	 */
+	protected $_gateway = NULL;
+
+	/**
+	 * @var EE_Payment_Method_Form
+	 */
+	protected $_settings_form = NULL;
+
+	/**
+	 * @var EE_Form_Section_Proper
+	 */
+	protected $_billing_form = NULL;
+
+	/**
+	 * @var boolean
+	 */
+	protected $_cache_billing_form = TRUE;
+
+	/**
+	 * String of the absolute path to the folder containing this file, with a trailing slash.
+	 * eg '/public_html/wp-site/wp-content/plugins/event-espresso/payment_methods/Invoice/'
+	 * @var string
+	 */
+	protected $_file_folder = NULL;
+
+	/**
+	 * String to the absolute URL to this file (useful for getting its web-accessible resources
+	 * like images, js, or css)
+	 * @var string
+	 */
+	protected $_file_url = NULL;
+
+	/**
+	 * Pretty name for the payment method
+	 * @var string
+	 */
+	protected $_pretty_name = NULL;
+
+	/**
+	 *
+	 * @var string
+	 */
+	protected $_default_button_url = NULL;
+
+	/**
+	 *
+	 * @var string
+	 */
+	protected $_default_description = NULL;
+
+
+	/**
+	 *
+	 * @param EE_Payment_Method $pm_instance
+	 * @throws EE_Error
+	 * @return EE_PMT_Base
+	 */
+	function __construct($pm_instance = NULL)
+	{
+		if ($pm_instance instanceof EE_Payment_Method) {
+			$this->set_instance($pm_instance);
+		}
+		if ($this->_gateway) {
+			$this->_gateway->set_payment_model(EEM_Payment::instance());
+			$this->_gateway->set_payment_log(EEM_Change_Log::instance());
+			$this->_gateway->set_template_helper(new EEH_Template());
+			$this->_gateway->set_line_item_helper(new EEH_Line_Item());
+			$this->_gateway->set_money_helper(new EEH_Money());
+			$this->_gateway->set_gateway_data_formatter(new GatewayDataFormatter());
+			$this->_gateway->set_unsupported_character_remover(new AsciiOnly());
+			do_action('AHEE__EE_PMT_Base___construct__done_initializing_gateway_class', $this, $this->_gateway);
+		}
+		if (!isset($this->_has_billing_form)) {
+			// by default, On Site gateways have a billing form
+			if ($this->payment_occurs() == EE_PMT_Base::onsite) {
+				$this->set_has_billing_form(true);
+			} else {
+				$this->set_has_billing_form(false);
+			}
+		}
+
+		if (!$this->_pretty_name) {
+			throw new EE_Error(sprintf(__("You must set the pretty name for the Payment Method Type in the constructor (_pretty_name), and please make it internationalized", "event_espresso")));
+		}
+		//if the child didn't specify a default button, use the credit card one
+		if ($this->_default_button_url === NULL) {
+			$this->_default_button_url = EE_PLUGIN_DIR_URL . 'payment_methods' . DS . 'pay-by-credit-card.png';
+		}
+	}
+
+
+	/**
+	 * @param boolean $has_billing_form
+	 */
+	public function set_has_billing_form($has_billing_form)
+	{
+		$this->_has_billing_form = filter_var($has_billing_form, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * sets the file_folder property
+	 */
+	protected function _set_file_folder()
+	{
+		$reflector = new ReflectionClass(get_class($this));
+		$fn = $reflector->getFileName();
+		$this->_file_folder = dirname($fn) . DS;
+	}
+
+
+	/**
+	 * sets the file URL with a trailing slash for this PMT
+	 */
+	protected function _set_file_url()
+	{
+		$plugins_dir_fixed = str_replace('\\', DS, WP_PLUGIN_DIR);
+		$file_folder_fixed = str_replace('\\', DS, $this->file_folder());
+		$file_path = str_replace($plugins_dir_fixed, WP_PLUGIN_URL, $file_folder_fixed);
+		$this->_file_url = $file_path;
+	}
+
+	/**
+	 * Gets the default description on all payment methods of this type
+	 * @return string
+	 */
+	public function default_description()
+	{
+		return $this->_default_description;
+	}
+
+
+	/**
+	 * Returns the folder containing the PMT child class, with a trailing slash
+	 * @return string
+	 */
+	public function file_folder()
+	{
+		if (!$this->_file_folder) {
+			$this->_set_file_folder();
+		}
+		return $this->_file_folder;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function file_url()
+	{
+		if (!$this->_file_url) {
+			$this->_set_file_url();
+		}
+		return $this->_file_url;
+	}
+
+
+	/**
+	 * Sets the payment method instance this payment method type is for.
+	 * Its important teh payment method instance is set before
+	 * @param EE_Payment_Method $payment_method_instance
+	 */
+	function set_instance($payment_method_instance)
+	{
+		$this->_pm_instance = $payment_method_instance;
+		//if they have already requested the settings form, make sure its
+		//data matches this model object
+		if ($this->_settings_form) {
+			$this->settings_form()->populate_model_obj($payment_method_instance);
+		}
+		if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
+			$this->_gateway->set_settings($payment_method_instance->settings_array());
+		}
+	}
+
+
+	/**
+	 * Gets teh form for displaying to admins where they setup the payment method
+	 * @return EE_Payment_Method_Form
+	 */
+	function settings_form()
+	{
+		if (!$this->_settings_form) {
+			$this->_settings_form = $this->generate_new_settings_form();
+			$this->_settings_form->set_payment_method_type($this);
+			//if we have already assigned a model object to this pmt, make
+			//sure its reflected in teh form we just generated
+			if ($this->_pm_instance) {
+				$this->_settings_form->populate_model_obj($this->_pm_instance);
+			}
+		}
+		return $this->_settings_form;
+	}
+
+
+	/**
+	 * Gets the form for all the settings related to this payment method type
+	 * @return EE_Payment_Method_Form
+	 */
+	abstract function generate_new_settings_form();
+
+
+	/**
+	 * Sets the form for settings. This may be useful if we have already received
+	 * a form submission and have form data it in, and want to use it anytime we're showing
+	 * this payment method type's settings form later in the request
+	 * @param EE_Payment_Method_Form $form
+	 */
+	public function set_settings_form($form)
+	{
+		$this->_settings_form = $form;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function has_billing_form()
+	{
+		return $this->_has_billing_form;
+	}
+
+
+	/**
+	 * Gets the form for displaying to attendees where they can enter their billing info
+	 * which will be sent to teh gateway (can be null)
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @param array $extra_args
+	 * @return \EE_Billing_Attendee_Info_Form|\EE_Billing_Info_Form|null
+	 */
+	public function billing_form(EE_Transaction $transaction = NULL, $extra_args = array())
+	{
+		// has billing form already been regenerated ? or overwrite cache?
+		if (!$this->_billing_form instanceof EE_Billing_Info_Form || !$this->_cache_billing_form) {
+			$this->_billing_form = $this->generate_new_billing_form($transaction, $extra_args);
+		}
+		//if we know who the attendee is, and this is a billing form
+		//that uses attendee info, populate it
+		if (
+		apply_filters(
+			'FHEE__populate_billing_form_fields_from_attendee',
+			(
+				$this->_billing_form instanceof EE_Billing_Attendee_Info_Form
+				&& $transaction instanceof EE_Transaction
+				&& $transaction->primary_registration() instanceof EE_Registration
+				&& $transaction->primary_registration()->attendee() instanceof EE_Attendee
+			),
+			$this->_billing_form,
+			$transaction
+		)
+		) {
+			$this->_billing_form->populate_from_attendee($transaction->primary_registration()->attendee());
+		}
+		return $this->_billing_form;
+	}
+
+
+	/**
+	 * Creates the billing form for this payment method type
+	 * @param \EE_Transaction $transaction
+	 * @return \EE_Billing_Info_Form
+	 */
+	abstract function generate_new_billing_form(EE_Transaction $transaction = NULL);
+
+
+	/**
+	 * apply_billing_form_debug_settings
+	 * applies debug data to the form
+	 *
+	 * @param \EE_Billing_Info_Form $billing_form
+	 * @return \EE_Billing_Info_Form
+	 */
+	public function apply_billing_form_debug_settings(EE_Billing_Info_Form $billing_form)
+	{
+		return $billing_form;
+	}
+
+
+	/**
+	 * Sets the billing form for this payment method type. You may want to use this
+	 * if you have form
+	 * @param EE_Payment_Method $form
+	 */
+	public function set_billing_form($form)
+	{
+		$this->_billing_form = $form;
+	}
+
+
+	/**
+	 * Returns whether or not this payment method requires HTTPS to be used
+	 * @return boolean
+	 */
+	function requires_https()
+	{
+		return $this->_requires_https;
+	}
+
+
+	/**
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param float $amount
+	 * @param EE_Billing_Info_Form $billing_info
+	 * @param string $return_url
+	 * @param string $fail_url
+	 * @param string $method
+	 * @param bool $by_admin
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 */
+	function process_payment(EE_Transaction $transaction, $amount = null, $billing_info = null, $return_url = null, $fail_url = '', $method = 'CART', $by_admin = false)
+	{
+		// @todo: add surcharge for the payment method, if any
+		if ($this->_gateway) {
+			//there is a gateway, so we're going to make a payment object
+			//but wait! do they already have a payment in progress that we thought was failed?
+			$duplicate_properties = array(
+				'STS_ID' => EEM_Payment::status_id_failed,
+				'TXN_ID' => $transaction->ID(),
+				'PMD_ID' => $this->_pm_instance->ID(),
+				'PAY_source' => $method,
+				'PAY_amount' => $amount !== null ? $amount : $transaction->remaining(),
+				'PAY_gateway_response' => null,
+			);
+			$payment = EEM_Payment::instance()->get_one(array($duplicate_properties));
+			//if we didn't already have a payment in progress for the same thing,
+			//then we actually want to make a new payment
+			if (!$payment instanceof EE_Payment) {
+				$payment = EE_Payment::new_instance(
+					array_merge(
+						$duplicate_properties,
+						array(
+							'PAY_timestamp' => time(),
+							'PAY_txn_id_chq_nmbr' => null,
+							'PAY_po_number' => null,
+							'PAY_extra_accntng' => null,
+							'PAY_details' => null,
+						)
+					)
+				);
+			}
+			//make sure the payment has been saved to show we started it, and so it has an ID should the gateway try to log it
+			$payment->save();
+			$billing_values = $this->_get_billing_values_from_form($billing_info);
+
+			//  Offsite Gateway
+			if ($this->_gateway instanceof EE_Offsite_Gateway) {
+
+				$payment = $this->_gateway->set_redirection_info(
+					$payment,
+					$billing_values,
+					$return_url,
+					EE_Config::instance()->core->txn_page_url(
+						array(
+							'e_reg_url_link' => $transaction->primary_registration()->reg_url_link(),
+							'ee_payment_method' => $this->_pm_instance->slug()
+						)
+					),
+					$fail_url
+				);
+				$payment->save();
+				//  Onsite Gateway
+			} elseif ($this->_gateway instanceof EE_Onsite_Gateway) {
+
+				$payment = $this->_gateway->do_direct_payment($payment, $billing_values);
+				$payment->save();
+
+			} else {
+				throw new EE_Error(
+					sprintf(
+						__('Gateway for payment method type "%s" is "%s", not a subclass of either EE_Offsite_Gateway or EE_Onsite_Gateway, or null (to indicate NO gateway)', 'event_espresso'),
+						get_class($this),
+						gettype($this->_gateway)
+					)
+				);
+			}
+
+		} else {
+			// no gateway provided
+			// there is no payment. Must be an offline gateway
+			// create a payment object anyways, but dont save it
+			$payment = EE_Payment::new_instance(
+				array(
+					'STS_ID' => EEM_Payment::status_id_pending,
+					'TXN_ID' => $transaction->ID(),
+					'PMD_ID' => $transaction->payment_method_ID(),
+					'PAY_amount' => 0.00,
+					'PAY_timestamp' => time(),
+				)
+			);
+
+		}
+
+		// if there is billing info, clean it and save it now
+		if ($billing_info instanceof EE_Billing_Attendee_Info_Form) {
+			$this->_save_billing_info_to_attendee($billing_info, $transaction);
+		}
+
+		return $payment;
+	}
+
+	/**
+	 * Gets the values we want to pass onto the gateway. Normally these
+	 * are just the 'pretty' values, but there may be times the data may need
+	 * a  little massaging. Proper subsections will become arrays of inputs
+	 * @param EE_Billing_Info_Form $billing_form
+	 * @return array
+	 */
+	protected function _get_billing_values_from_form($billing_form)
+	{
+		if ($billing_form instanceof EE_Form_Section_Proper) {
+			return $billing_form->input_pretty_values(true);
+		} else {
+			return NULL;
+		}
+	}
+
+
+	/**
+	 * Handles an instant payment notification when the transaction is known (by default).
+	 * @param array $req_data
+	 * @param EE_Transaction $transaction
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 */
+	public function handle_ipn($req_data, $transaction)
+	{
+		$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+		if (!$this->_gateway instanceof EE_Offsite_Gateway) {
+			throw new EE_Error(sprintf(__("Could not handle IPN because '%s' is not an offsite gateway", "event_espresso"), print_r($this->_gateway, TRUE)));
+
+		}
+		$payment = $this->_gateway->handle_payment_update($req_data, $transaction);
+		return $payment;
+	}
+
+
+	/**
+	 * Saves the billing info onto the attendee of the primary registrant on this transaction, and
+	 * cleans it first.
+	 * @param EE_Billing_Attendee_Info_Form $billing_form
+	 * @param EE_Transaction $transaction
+	 * @return boolean success
+	 */
+	protected function _save_billing_info_to_attendee($billing_form, $transaction)
+	{
+		if (!$transaction || !$transaction instanceof EE_Transaction) {
+			EE_Error::add_error(__("Cannot save billing info because no transaction was specified", "event_espresso"), __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		$primary_reg = $transaction->primary_registration();
+		if (!$primary_reg) {
+			EE_Error::add_error(__("Cannot save billing info because the transaction has no primary registration", "event_espresso"), __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		$attendee = $primary_reg->attendee();
+		if (!$attendee) {
+			EE_Error::add_error(__("Cannot save billing info because the transaction's primary registration has no attendee!", "event_espresso"), __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		return $attendee->save_and_clean_billing_info_for_payment_method($billing_form, $transaction->payment_method());
+
+	}
+
+
+	/**
+	 * Gets the payment this IPN is for. Children may often want to
+	 * override this to inspect the request
+	 * @param EE_Transaction $transaction
+	 * @param array $req_data
+	 * @return EE_Payment
+	 */
+	protected function find_payment_for_ipn(EE_Transaction $transaction, $req_data = array())
+	{
+		return $transaction->last_payment();
+	}
+
+
+	/**
+	 * In case generic code cannot provide the payment processor with a specific payment method
+	 * and transaction, it will try calling this method on each activate payment method.
+	 * If the payment method is able to identify the request as being for it, it should fetch
+	 * the payment its for and return it. If not, it should throw an EE_Error to indicate it cannot
+	 * handle the IPN
+	 * @param array $req_data
+	 * @return EE_Payment only if this payment method can find the info its needs from $req_data
+	 * and identifies the IPN as being for this payment method (not just fo ra payment method of this type)
+	 * @throws EE_Error
+	 */
+	public function handle_unclaimed_ipn($req_data = array())
+	{
+		throw new EE_Error(sprintf(__("Payment Method '%s' cannot handle unclaimed IPNs", "event_espresso"), get_class($this)));
+	}
+
+
+	/**
+	 * Logic to be accomplished when the payment attempt is complete.
+	 * Most payment methods don't need to do anything at this point; but some, like Mijireh, do.
+	 * (Mijireh is an offsite gateway which doesn't send an IPN. So when the user returns to EE from
+	 * mijireh, this method needs to be called so the Mijireh PM can ping Mijireh to know the status
+	 * of the payment). Fed a transaction because it's always assumed to be the last payment that
+	 * we're dealing with. Returns that last payment (if there is one)
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return EE_Payment
+	 */
+	public function finalize_payment_for($transaction)
+	{
+		return $transaction->last_payment();
+	}
+
+
+	/**
+	 * Whether or not this payment method's gateway supports sending refund requests
+	 * @return boolean
+	 */
+	public function supports_sending_refunds()
+	{
+		if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
+			return $this->_gateway->supports_sending_refunds();
+		} else {
+			return false;
+		}
+	}
+
+
+	/**
+	 *
+	 * @param EE_Payment $payment
+	 * @param array $refund_info
+	 * @throws EE_Error
+	 * @return EE_Payment
+	 */
+	public function process_refund(EE_Payment $payment, $refund_info = array())
+	{
+		if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
+			return $this->_gateway->do_direct_refund($payment, $refund_info);
+		} else {
+			throw new EE_Error(
+				sprintf(
+					__('Payment Method Type "%s" does not support sending refund requests', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * Returns one the class's constants onsite,offsite, or offline, depending on this
+	 * payment method's gateway.
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function payment_occurs()
+	{
+		if (!$this->_gateway) {
+			return EE_PMT_Base::offline;
+		} elseif ($this->_gateway instanceof EE_Onsite_Gateway) {
+			return EE_PMT_Base::onsite;
+		} elseif ($this->_gateway instanceof EE_Offsite_Gateway) {
+			return EE_PMT_Base::offsite;
+		} else {
+			throw new EE_Error(sprintf(__("Payment method type '%s's gateway isn't an instance of EE_Onsite_Gateway, EE_Offsite_Gateway, or null. It must be one of those", "event_espresso"), get_class($this)));
+		}
+	}
+
+
+	/**
+	 * For adding any html output ab ove the payment overview.
+	 * Many gateways won't want ot display anything, so this function just returns an empty string.
+	 * Other gateways may want to override this, such as offline gateways.
+	 * @param EE_Payment $payment
+	 * @return string
+	 */
+	public function payment_overview_content(EE_Payment $payment)
+	{
+		return EEH_Template::display_template(EE_LIBRARIES . 'payment_methods' . DS . 'templates' . DS . 'payment_details_content.template.php', array('payment_method' => $this->_pm_instance, 'payment' => $payment), true);
+	}
+
+
+	/**
+	 * @return array where keys are the help tab name,
+	 * values are: array {
+	 * @type string $title i18n name for the help tab
+	 * @type string $filename name of the file located in ./help_tabs/ (ie, in a folder next to this file)
+	 * @type array $template_args any arguments you want passed to the template file while rendering.
+	 *                Keys will be variable names and values with be their values.
+	 */
+	public function help_tabs_config()
+	{
+		return array();
+	}
+
+
+	/**
+	 * The system name for this PMT (eg AIM, Paypal_Pro, Invoice... what gets put into
+	 * the payment method's table's PMT_type column)
+	 * @return string
+	 */
+	public function system_name()
+	{
+		$classname = get_class($this);
+		return str_replace("EE_PMT_", '', $classname);
+	}
+
+
+	/**
+	 * A pretty i18n version of the PMT name
+	 * @return string
+	 */
+	public function pretty_name()
+	{
+		return $this->_pretty_name;
+	}
+
+
+	/**
+	 * Gets the default absolute URL to the payment method type's button
+	 * @return string
+	 */
+	public function default_button_url()
+	{
+		return $this->_default_button_url;
+	}
+
+
+	/**
+	 * Gets the gateway used by this payment method (if any)
+	 * @return EE_Gateway
+	 */
+	public function get_gateway()
+	{
+		return $this->_gateway;
+	}
+
+
+	/**
+	 * @return string html for the link to a help tab
+	 */
+	public function get_help_tab_link()
+	{
+		return EEH_Template::get_help_tab_link($this->get_help_tab_name());
+	}
+
+
+	/**
+	 * Returns the name of the help tab for this PMT
+	 * @return string
+	 */
+	public function get_help_tab_name()
+	{
+		return 'ee_' . strtolower($this->system_name()) . '_help_tab';
+	}
+
+	/**
+	 * The name of the wp capability that should be associated with the usage of
+	 * this PMT by an admin
+	 * @return string
+	 */
+	public function cap_name()
+	{
+		return 'ee_payment_method_' . strtolower($this->system_name());
+	}
+
+	/**
+	 * Called by client code to tell the gateway that if it wants to change
+	 * the transaction or line items or registrations related to teh payment it already
+	 * processed (we think, but possibly not) that now's the time to do it.
+	 * It is expected that gateways will store any info they need for this on the PAY_details,
+	 * or maybe an extra meta value
+	 * @param EE_Payment $payment
+	 * @return void
+	 */
+	public function update_txn_based_on_payment($payment)
+	{
+		if ($this->_gateway instanceof EE_Gateway) {
+			$this->_gateway->update_txn_based_on_payment($payment);
+		}
+	}
+
+	/**
+	 * Returns a string of HTML describing this payment method type for an admin,
+	 * primarily intended for them to read before activating it.
+	 * The easiest way to set this is to create a folder 'templates' alongside
+	 * your EE_PMT_{System_Name} file, and in it create a file named "{system_name}_intro.template.php".
+	 * Eg, if your payment method file is named "EE_PMT_Foo_Bar.pm.php",
+	 * then you'd create a file named "templates" in the same folder as it, and name the file
+	 * "foo_bar_intro.template.php", and its content will be returned by this method
+	 * @return string
+	 */
+	public function introductory_html()
+	{
+		return EEH_Template::locate_template($this->file_folder() . 'templates' . DS . strtolower($this->system_name()) . '_intro.template.php', array('pmt_obj' => $this, 'pm_instance' => $this->_pm_instance));
+	}
 
 
 }

Spacing +18 added lines, -18 removed lines

@@ -114,7 +114,7 @@ 
             $this->_gateway->set_unsupported_character_remover(new AsciiOnly());
             do_action('AHEE__EE_PMT_Base___construct__done_initializing_gateway_class', $this, $this->_gateway);
         }
-        if (!isset($this->_has_billing_form)) {
+        if ( ! isset($this->_has_billing_form)) {
             // by default, On Site gateways have a billing form
             if ($this->payment_occurs() == EE_PMT_Base::onsite) {
                 $this->set_has_billing_form(true);
@@ -123,12 +123,12 @@ 
             }
         }
 
-        if (!$this->_pretty_name) {
+        if ( ! $this->_pretty_name) {
             throw new EE_Error(sprintf(__("You must set the pretty name for the Payment Method Type in the constructor (_pretty_name), and please make it internationalized", "event_espresso")));
         }
         //if the child didn't specify a default button, use the credit card one
         if ($this->_default_button_url === NULL) {
-            $this->_default_button_url = EE_PLUGIN_DIR_URL . 'payment_methods' . DS . 'pay-by-credit-card.png';
+            $this->_default_button_url = EE_PLUGIN_DIR_URL.'payment_methods'.DS.'pay-by-credit-card.png';
         }
     }
 
@@ -149,7 +149,7 @@ 
     {
         $reflector = new ReflectionClass(get_class($this));
         $fn = $reflector->getFileName();
-        $this->_file_folder = dirname($fn) . DS;
+        $this->_file_folder = dirname($fn).DS;
     }
 
 
@@ -180,7 +180,7 @@ 
      */
     public function file_folder()
     {
-        if (!$this->_file_folder) {
+        if ( ! $this->_file_folder) {
             $this->_set_file_folder();
         }
         return $this->_file_folder;
@@ -192,7 +192,7 @@ 
      */
     public function file_url()
     {
-        if (!$this->_file_url) {
+        if ( ! $this->_file_url) {
             $this->_set_file_url();
         }
         return $this->_file_url;
@@ -224,7 +224,7 @@ 
      */
     function settings_form()
     {
-        if (!$this->_settings_form) {
+        if ( ! $this->_settings_form) {
             $this->_settings_form = $this->generate_new_settings_form();
             $this->_settings_form->set_payment_method_type($this);
             //if we have already assigned a model object to this pmt, make
@@ -276,7 +276,7 @@ 
     public function billing_form(EE_Transaction $transaction = NULL, $extra_args = array())
     {
         // has billing form already been regenerated ? or overwrite cache?
-        if (!$this->_billing_form instanceof EE_Billing_Info_Form || !$this->_cache_billing_form) {
+        if ( ! $this->_billing_form instanceof EE_Billing_Info_Form || ! $this->_cache_billing_form) {
             $this->_billing_form = $this->generate_new_billing_form($transaction, $extra_args);
         }
         //if we know who the attendee is, and this is a billing form
@@ -371,7 +371,7 @@ 
             $payment = EEM_Payment::instance()->get_one(array($duplicate_properties));
             //if we didn't already have a payment in progress for the same thing,
             //then we actually want to make a new payment
-            if (!$payment instanceof EE_Payment) {
+            if ( ! $payment instanceof EE_Payment) {
                 $payment = EE_Payment::new_instance(
                     array_merge(
                         $duplicate_properties,
@@ -472,7 +472,7 @@ 
     public function handle_ipn($req_data, $transaction)
     {
         $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        if (!$this->_gateway instanceof EE_Offsite_Gateway) {
+        if ( ! $this->_gateway instanceof EE_Offsite_Gateway) {
             throw new EE_Error(sprintf(__("Could not handle IPN because '%s' is not an offsite gateway", "event_espresso"), print_r($this->_gateway, TRUE)));
 
         }
@@ -490,17 +490,17 @@ 
      */
     protected function _save_billing_info_to_attendee($billing_form, $transaction)
     {
-        if (!$transaction || !$transaction instanceof EE_Transaction) {
+        if ( ! $transaction || ! $transaction instanceof EE_Transaction) {
             EE_Error::add_error(__("Cannot save billing info because no transaction was specified", "event_espresso"), __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         $primary_reg = $transaction->primary_registration();
-        if (!$primary_reg) {
+        if ( ! $primary_reg) {
             EE_Error::add_error(__("Cannot save billing info because the transaction has no primary registration", "event_espresso"), __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         $attendee = $primary_reg->attendee();
-        if (!$attendee) {
+        if ( ! $attendee) {
             EE_Error::add_error(__("Cannot save billing info because the transaction's primary registration has no attendee!", "event_espresso"), __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
@@ -600,7 +600,7 @@ 
      */
     public function payment_occurs()
     {
-        if (!$this->_gateway) {
+        if ( ! $this->_gateway) {
             return EE_PMT_Base::offline;
         } elseif ($this->_gateway instanceof EE_Onsite_Gateway) {
             return EE_PMT_Base::onsite;
@@ -621,7 +621,7 @@ 
      */
     public function payment_overview_content(EE_Payment $payment)
     {
-        return EEH_Template::display_template(EE_LIBRARIES . 'payment_methods' . DS . 'templates' . DS . 'payment_details_content.template.php', array('payment_method' => $this->_pm_instance, 'payment' => $payment), true);
+        return EEH_Template::display_template(EE_LIBRARIES.'payment_methods'.DS.'templates'.DS.'payment_details_content.template.php', array('payment_method' => $this->_pm_instance, 'payment' => $payment), true);
     }
 
 
@@ -696,7 +696,7 @@ 
      */
     public function get_help_tab_name()
     {
-        return 'ee_' . strtolower($this->system_name()) . '_help_tab';
+        return 'ee_'.strtolower($this->system_name()).'_help_tab';
     }
 
     /**
@@ -706,7 +706,7 @@ 
      */
     public function cap_name()
     {
-        return 'ee_payment_method_' . strtolower($this->system_name());
+        return 'ee_payment_method_'.strtolower($this->system_name());
     }
 
     /**
@@ -737,7 +737,7 @@ 
      */
     public function introductory_html()
     {
-        return EEH_Template::locate_template($this->file_folder() . 'templates' . DS . strtolower($this->system_name()) . '_intro.template.php', array('pmt_obj' => $this, 'pm_instance' => $this->_pm_instance));
+        return EEH_Template::locate_template($this->file_folder().'templates'.DS.strtolower($this->system_name()).'_intro.template.php', array('pmt_obj' => $this, 'pm_instance' => $this->_pm_instance));
     }