eventespresso / event-espresso-core

core/db_classes/EE_Registration.class.php

Doc Comments +4 added lines, -3 removed lines

@@ -921,7 +921,7 @@ 
 	/**
 	 * Sets deleted
 	 * @param boolean $deleted
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	public function set_deleted($deleted) {
 	    if ( $deleted ) {
@@ -969,6 +969,7 @@ 
 	 *
 	 * @param int | EE_Datetime $DTT_OR_ID The datetime the registration is being checked against
 	 * @param bool   $check_approved   This is used to indicate whether the caller wants can_checkin to also consider registration status as well as datetime access.
+	 * @param integer $DTT_OR_ID
 	 *
 	 * @return bool
 	 */
@@ -1107,7 +1108,7 @@ 
      * Returns the latest datetime related to this registration (via the ticket attached to the registration).
      * "Latest" is defined by the `DTT_EVT_start` column.
      *
-     * @return EE_Datetime|null
+     * @return null|EE_Base_Class
      * @throws \EE_Error
      */
 	public function get_latest_related_datetime() {
@@ -1378,7 +1379,7 @@ 
 	 * This grabs the payment method corresponding to the last payment made for the amount owing on the registration.
 	 * Note: if there are no payments on the registration there will be no payment method returned.
 	 *
-	 * @return EE_Payment_Method|null
+	 * @return null|EE_Base_Class
 	 */
 	public function payment_method() {
 		return EEM_Payment_Method::instance()->get_last_used_for_registration( $this );

Indentation +242 added lines, -242 removed lines

@@ -35,7 +35,7 @@ 
 
 	/**
 	 * extra meta key for tracking reg status os trashed registrations
-     *
+	 *
 	 * @type string
 	 */
 	const PRE_TRASH_REG_STATUS_KEY = 'pre_trash_registration_status';
@@ -43,7 +43,7 @@ 
 
 	/**
 	 * extra meta key for tracking if registration has reserved ticket
-     *
+	 *
 	 * @type string
 	 */
 	const HAS_RESERVED_TICKET_KEY = 'has_reserved_ticket';
@@ -89,15 +89,15 @@ 
 
 
 
-    /**
-     * Overrides parent set() method so that all calls to set( 'REG_code', $REG_code ) OR set( 'STS_ID', $STS_ID ) can be routed to internal methods
-     *
-     * @param string $field_name
-     * @param mixed  $field_value
-     * @param bool   $use_default
-     * @throws \EE_Error
-     * @throws \RuntimeException
-     */
+	/**
+	 * Overrides parent set() method so that all calls to set( 'REG_code', $REG_code ) OR set( 'STS_ID', $STS_ID ) can be routed to internal methods
+	 *
+	 * @param string $field_name
+	 * @param mixed  $field_value
+	 * @param bool   $use_default
+	 * @throws \EE_Error
+	 * @throws \RuntimeException
+	 */
 	public function set( $field_name, $field_value, $use_default = FALSE ) {
 		switch( $field_name ) {
 			case 'REG_code' :
@@ -115,18 +115,18 @@ 
 
 
 
-    /**
-     * Set Status ID
-     * updates the registration status and ALSO...
-     * calls reserve_registration_space() if the reg status changes TO approved from any other reg status
-     * calls release_registration_space() if the reg status changes FROM approved to any other reg status
-     *
-     * @param string  $new_STS_ID
-     * @param boolean $use_default
-     * @return bool
-     * @throws \RuntimeException
-     * @throws \EE_Error
-     */
+	/**
+	 * Set Status ID
+	 * updates the registration status and ALSO...
+	 * calls reserve_registration_space() if the reg status changes TO approved from any other reg status
+	 * calls release_registration_space() if the reg status changes FROM approved to any other reg status
+	 *
+	 * @param string  $new_STS_ID
+	 * @param boolean $use_default
+	 * @return bool
+	 * @throws \RuntimeException
+	 * @throws \EE_Error
+	 */
 	public function set_status( $new_STS_ID = NULL, $use_default = FALSE ) {
 		// get current REG_Status
 		$old_STS_ID = $this->status_ID();
@@ -137,7 +137,7 @@ 
 			&& ! empty( $new_STS_ID ) // as well as the new status
 			&& $this->ID() // ensure registration is in the db
 		) {
-            // TO approved
+			// TO approved
 			if ( $new_STS_ID === EEM_Registration::status_id_approved ) {
 				// reserve a space by incrementing ticket and datetime sold values
 				$this->_reserve_registration_space();
@@ -148,12 +148,12 @@ 
 				$this->_release_registration_space();
 				do_action( 'AHEE__EE_Registration__set_status__from_approved', $this, $old_STS_ID, $new_STS_ID );
 			}
-            // update status
-            parent::set('STS_ID', $new_STS_ID, $use_default);
-            $this->_update_if_canceled_or_declined($new_STS_ID, $old_STS_ID);
-            /** @type EE_Transaction_Payments $transaction_payments */
-            $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-            $transaction_payments->recalculate_transaction_total( $this->transaction(), false );
+			// update status
+			parent::set('STS_ID', $new_STS_ID, $use_default);
+			$this->_update_if_canceled_or_declined($new_STS_ID, $old_STS_ID);
+			/** @type EE_Transaction_Payments $transaction_payments */
+			$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+			$transaction_payments->recalculate_transaction_total( $this->transaction(), false );
 			$this->transaction()->update_status_based_on_total_paid( true );
 			do_action( 'AHEE__EE_Registration__set_status__after_update', $this );
 			return TRUE;
@@ -167,60 +167,60 @@ 
 
 
 
-    /**
-     * update REGs and TXN when cancelled or declined registrations involved
-     *
-     * @param string $new_STS_ID
-     * @param string $old_STS_ID
-     * @throws \EE_Error
-     */
-    private function _update_if_canceled_or_declined($new_STS_ID, $old_STS_ID)
-    {
-        // these reg statuses should not be considered in any calculations involving monies owing
-        $closed_reg_statuses = EEM_Registration::closed_reg_statuses();
-        // true if registration has been cancelled or declined
-        if (
-            in_array($new_STS_ID, $closed_reg_statuses, true)
-            && ! in_array($old_STS_ID, $closed_reg_statuses, true)
-        ) {
-            /** @type EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            /** @type EE_Transaction_Processor $transaction_processor */
-            $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-            // cancelled or declined registration
-            $registration_processor->update_registration_after_being_canceled_or_declined(
-                $this,
-                $closed_reg_statuses
-            );
-            $transaction_processor->update_transaction_after_canceled_or_declined_registration(
-                $this,
-                $closed_reg_statuses,
-                false
-            );
-            do_action('AHEE__EE_Registration__set_status__canceled_or_declined', $this, $old_STS_ID, $new_STS_ID);
-            return;
-        }
-        // true if reinstating cancelled or declined registration
-        if (
-            in_array($old_STS_ID, $closed_reg_statuses, true)
-            && ! in_array($new_STS_ID, $closed_reg_statuses, true)
-        ) {
-            /** @type EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            /** @type EE_Transaction_Processor $transaction_processor */
-            $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-            // reinstating cancelled or declined registration
-            $registration_processor->update_canceled_or_declined_registration_after_being_reinstated(
-                $this,
-                $closed_reg_statuses
-            );
-            $transaction_processor->update_transaction_after_reinstating_canceled_registration(
-                $this,
-                $closed_reg_statuses,
-                false
-            );
-            do_action('AHEE__EE_Registration__set_status__after_reinstated', $this, $old_STS_ID, $new_STS_ID);
-        }
+	/**
+	 * update REGs and TXN when cancelled or declined registrations involved
+	 *
+	 * @param string $new_STS_ID
+	 * @param string $old_STS_ID
+	 * @throws \EE_Error
+	 */
+	private function _update_if_canceled_or_declined($new_STS_ID, $old_STS_ID)
+	{
+		// these reg statuses should not be considered in any calculations involving monies owing
+		$closed_reg_statuses = EEM_Registration::closed_reg_statuses();
+		// true if registration has been cancelled or declined
+		if (
+			in_array($new_STS_ID, $closed_reg_statuses, true)
+			&& ! in_array($old_STS_ID, $closed_reg_statuses, true)
+		) {
+			/** @type EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			/** @type EE_Transaction_Processor $transaction_processor */
+			$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+			// cancelled or declined registration
+			$registration_processor->update_registration_after_being_canceled_or_declined(
+				$this,
+				$closed_reg_statuses
+			);
+			$transaction_processor->update_transaction_after_canceled_or_declined_registration(
+				$this,
+				$closed_reg_statuses,
+				false
+			);
+			do_action('AHEE__EE_Registration__set_status__canceled_or_declined', $this, $old_STS_ID, $new_STS_ID);
+			return;
+		}
+		// true if reinstating cancelled or declined registration
+		if (
+			in_array($old_STS_ID, $closed_reg_statuses, true)
+			&& ! in_array($new_STS_ID, $closed_reg_statuses, true)
+		) {
+			/** @type EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			/** @type EE_Transaction_Processor $transaction_processor */
+			$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+			// reinstating cancelled or declined registration
+			$registration_processor->update_canceled_or_declined_registration_after_being_reinstated(
+				$this,
+				$closed_reg_statuses
+			);
+			$transaction_processor->update_transaction_after_reinstating_canceled_registration(
+				$this,
+				$closed_reg_statuses,
+				false
+			);
+			do_action('AHEE__EE_Registration__set_status__after_reinstated', $this, $old_STS_ID, $new_STS_ID);
+		}
 	}
 
 
@@ -233,16 +233,16 @@ 
 
 
 
-    /**
-     * increments this registration's related ticket sold and corresponding datetime sold values
-     *
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * increments this registration's related ticket sold and corresponding datetime sold values
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	private function _reserve_registration_space() {
-	    // reserved ticket and datetime counts will be decremented as sold counts are incremented
-        // so stop tracking that this reg has a ticket reserved
-	    $this->release_reserved_ticket();
+		// reserved ticket and datetime counts will be decremented as sold counts are incremented
+		// so stop tracking that this reg has a ticket reserved
+		$this->release_reserved_ticket();
 		$ticket = $this->ticket();
 		$ticket->increase_sold();
 		$ticket->save();
@@ -252,13 +252,13 @@ 
 
 
 
-    /**
-     * Gets the ticket this registration is for
-     *
-     * @param boolean $include_archived whether to include archived tickets or not.
-     * @return EE_Ticket|EE_Base_Class
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets the ticket this registration is for
+	 *
+	 * @param boolean $include_archived whether to include archived tickets or not.
+	 * @return EE_Ticket|EE_Base_Class
+	 * @throws \EE_Error
+	 */
 	public function ticket( $include_archived = TRUE ) {
 		$query_params = array();
 		if ( $include_archived ) {
@@ -300,12 +300,12 @@ 
 
 
 
-    /**
-     * decrements (subtracts) this registration's related ticket sold and corresponding datetime sold values
-     *
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * decrements (subtracts) this registration's related ticket sold and corresponding datetime sold values
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	private function _release_registration_space() {
 		$ticket = $this->ticket();
 		$ticket->decrease_sold();
@@ -314,46 +314,46 @@ 
 
 
 
-    /**
-     * tracks this registration's ticket reservation in extra meta
-     * and can increment related ticket reserved and corresponding datetime reserved values
-     *
-     * @param bool $update_ticket if true, will increment ticket and datetime reserved count
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * tracks this registration's ticket reservation in extra meta
+	 * and can increment related ticket reserved and corresponding datetime reserved values
+	 *
+	 * @param bool $update_ticket if true, will increment ticket and datetime reserved count
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function reserve_ticket($update_ticket = false) {
-        if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) === false) {
-            // PLZ NOTE: although checking $update_ticket first would be more efficient,
-            // we NEED to ALWAYS call update_extra_meta(), which is why that is done first
-            if ($this->update_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) && $update_ticket) {
-                $ticket = $this->ticket();
-                $ticket->increase_reserved();
-                $ticket->save();
-            }
-        }
+		if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) === false) {
+			// PLZ NOTE: although checking $update_ticket first would be more efficient,
+			// we NEED to ALWAYS call update_extra_meta(), which is why that is done first
+			if ($this->update_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) && $update_ticket) {
+				$ticket = $this->ticket();
+				$ticket->increase_reserved();
+				$ticket->save();
+			}
+		}
 	}
 
 
 
-    /**
-     * stops tracking this registration's ticket reservation in extra meta
-     * decrements (subtracts) related ticket reserved and corresponding datetime reserved values
-     *
-     * @param bool $update_ticket if true, will decrement ticket and datetime reserved count
-     * @return void
-     * @throws \EE_Error
-     */
-    public function release_reserved_ticket($update_ticket = false) {
-        if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) !== false) {
-            // PLZ NOTE: although checking $update_ticket first would be more efficient,
-            // we NEED to ALWAYS call delete_extra_meta(), which is why that is done first
-            if ($this->delete_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY) && $update_ticket) {
-                $ticket = $this->ticket();
-                $ticket->decrease_reserved();
-                $ticket->save();
-            }
-        }
+	/**
+	 * stops tracking this registration's ticket reservation in extra meta
+	 * decrements (subtracts) related ticket reserved and corresponding datetime reserved values
+	 *
+	 * @param bool $update_ticket if true, will decrement ticket and datetime reserved count
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function release_reserved_ticket($update_ticket = false) {
+		if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) !== false) {
+			// PLZ NOTE: although checking $update_ticket first would be more efficient,
+			// we NEED to ALWAYS call delete_extra_meta(), which is why that is done first
+			if ($this->delete_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY) && $update_ticket) {
+				$ticket = $this->ticket();
+				$ticket->decrease_reserved();
+				$ticket->save();
+			}
+		}
 	}
 
 
@@ -742,9 +742,9 @@ 
 
 
 	/**
-	*		get  Attendee Number
-	* 		@access		public
-	*/
+	 *		get  Attendee Number
+	 * 		@access		public
+	 */
 	public function count() {
 		return $this->get( 'REG_count' );
 	}
@@ -1021,11 +1021,11 @@ 
 	 * @return boolean
 	 */
 	public function set_deleted($deleted) {
-	    if ( $deleted ) {
-	        $this->delete();
-        } else {
-	        $this->restore();
-        }
+		if ( $deleted ) {
+			$this->delete();
+		} else {
+			$this->restore();
+		}
 	}
 
 
@@ -1130,20 +1130,20 @@ 
 
 
 
-    /**
-     * toggle Check-in status for this registration
-     * Check-ins are toggled in the following order:
-     * never checked in -> checked in
-     * checked in -> checked out
-     * checked out -> checked in
-     *
-     * @param  int $DTT_ID  include specific datetime to toggle Check-in for.
-     *                      If not included or null, then it is assumed latest datetime is being toggled.
-     * @param bool $verify  If true then can_checkin() is used to verify whether the person
-     *                      can be checked in or not.  Otherwise this forces change in checkin status.
-     * @return bool|int     the chk_in status toggled to OR false if nothing got changed.
-     * @throws EE_Error
-     */
+	/**
+	 * toggle Check-in status for this registration
+	 * Check-ins are toggled in the following order:
+	 * never checked in -> checked in
+	 * checked in -> checked out
+	 * checked out -> checked in
+	 *
+	 * @param  int $DTT_ID  include specific datetime to toggle Check-in for.
+	 *                      If not included or null, then it is assumed latest datetime is being toggled.
+	 * @param bool $verify  If true then can_checkin() is used to verify whether the person
+	 *                      can be checked in or not.  Otherwise this forces change in checkin status.
+	 * @return bool|int     the chk_in status toggled to OR false if nothing got changed.
+	 * @throws EE_Error
+	 */
 	public function toggle_checkin_status( $DTT_ID = null, $verify = false ) {
 		if ( empty( $DTT_ID ) ) {
 			$datetime = $this->get_latest_related_datetime();
@@ -1200,13 +1200,13 @@ 
 
 
 
-    /**
-     * Returns the latest datetime related to this registration (via the ticket attached to the registration).
-     * "Latest" is defined by the `DTT_EVT_start` column.
-     *
-     * @return EE_Datetime|null
-     * @throws \EE_Error
-     */
+	/**
+	 * Returns the latest datetime related to this registration (via the ticket attached to the registration).
+	 * "Latest" is defined by the `DTT_EVT_start` column.
+	 *
+	 * @return EE_Datetime|null
+	 * @throws \EE_Error
+	 */
 	public function get_latest_related_datetime() {
 		return EEM_Datetime::instance()->get_one(
 			array(
@@ -1220,12 +1220,12 @@ 
 
 
 
-    /**
-     * Returns the earliest datetime related to this registration (via the ticket attached to the registration).
-     * "Earliest" is defined by the `DTT_EVT_start` column.
-     *
-     * @throws \EE_Error
-     */
+	/**
+	 * Returns the earliest datetime related to this registration (via the ticket attached to the registration).
+	 * "Earliest" is defined by the `DTT_EVT_start` column.
+	 *
+	 * @throws \EE_Error
+	 */
 	public function get_earliest_related_datetime() {
 		return EEM_Datetime::instance()->get_one(
 			array(
@@ -1239,18 +1239,18 @@ 
 
 
 
-    /**
-     * This method simply returns the check-in status for this registration and the given datetime.
-     * If neither the datetime nor the checkin values are provided as arguments,
-     * then this will return the LATEST check-in status for the registration across all datetimes it belongs to.
-     *
-     * @param  int $DTT_ID        The ID of the datetime we're checking against
-     *                            (if empty we'll get the primary datetime for
-     *                            this registration (via event) and use it's ID);
-     * @param EE_Checkin $checkin If present, we use the given checkin object rather than the dtt_id.
-     * @return int                Integer representing Check-in status.
-     * @throws \EE_Error
-     */
+	/**
+	 * This method simply returns the check-in status for this registration and the given datetime.
+	 * If neither the datetime nor the checkin values are provided as arguments,
+	 * then this will return the LATEST check-in status for the registration across all datetimes it belongs to.
+	 *
+	 * @param  int $DTT_ID        The ID of the datetime we're checking against
+	 *                            (if empty we'll get the primary datetime for
+	 *                            this registration (via event) and use it's ID);
+	 * @param EE_Checkin $checkin If present, we use the given checkin object rather than the dtt_id.
+	 * @return int                Integer representing Check-in status.
+	 * @throws \EE_Error
+	 */
 	public function check_in_status_for_datetime( $DTT_ID = 0, $checkin = null ) {
 		$checkin_query_params = array(
 			'order_by' => array( 'CHK_timestamp' => 'DESC' )
@@ -1262,8 +1262,8 @@ 
 
 		//get checkin object (if exists)
 		$checkin = $checkin instanceof EE_Checkin
-            ? $checkin
-            : $this->get_first_related( 'Checkin', $checkin_query_params );
+			? $checkin
+			: $this->get_first_related( 'Checkin', $checkin_query_params );
 		if ( $checkin instanceof EE_Checkin ) {
 			if ( $checkin->get( 'CHK_in' ) ) {
 				return EE_Registration::checkin_status_in; //checked in
@@ -1516,46 +1516,46 @@ 
 
 
 
-    /**
-     * Soft Deletes this model object.
-     *
-     * @return boolean | int
-     * @throws \RuntimeException
-     * @throws \EE_Error
-     */
-    public function delete()
-    {
-        if($this->update_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY, $this->status_ID()) === true) {
-            $this->set_status(EEM_Registration::status_id_cancelled);
-        }
-        return parent::delete();
-    }
+	/**
+	 * Soft Deletes this model object.
+	 *
+	 * @return boolean | int
+	 * @throws \RuntimeException
+	 * @throws \EE_Error
+	 */
+	public function delete()
+	{
+		if($this->update_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY, $this->status_ID()) === true) {
+			$this->set_status(EEM_Registration::status_id_cancelled);
+		}
+		return parent::delete();
+	}
 
 
 
-    /**
-     * Restores whatever the previous status was on a registration before it was trashed (if possible)
-     *
-     * @throws \EE_Error
-     * @throws \RuntimeException
-     */
-    public function restore()
-    {
-        $previous_status = $this->get_extra_meta(
-            EE_Registration::PRE_TRASH_REG_STATUS_KEY,
-            true,
-            EEM_Registration::status_id_cancelled
-        );
-        if ($previous_status) {
-            $this->delete_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY);
-            $this->set_status($previous_status);
-        }
-        return parent::restore();
-    }
+	/**
+	 * Restores whatever the previous status was on a registration before it was trashed (if possible)
+	 *
+	 * @throws \EE_Error
+	 * @throws \RuntimeException
+	 */
+	public function restore()
+	{
+		$previous_status = $this->get_extra_meta(
+			EE_Registration::PRE_TRASH_REG_STATUS_KEY,
+			true,
+			EEM_Registration::status_id_cancelled
+		);
+		if ($previous_status) {
+			$this->delete_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY);
+			$this->set_status($previous_status);
+		}
+		return parent::restore();
+	}
 
 
 
-    /*************************** DEPRECATED ***************************/
+	/*************************** DEPRECATED ***************************/
 
 
 
@@ -1605,24 +1605,24 @@ 
 
 
 
-    /**
-     * Gets the primary datetime related to this registration via the related Event to this registration
-     *
-     * @deprecated 4.9.17
-     * @return EE_Datetime
-     */
-    public function get_related_primary_datetime() {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'Use EE_Registration::get_latest_related_datetime() or EE_Registration::get_earliest_related_datetime()',
-                'event_espresso'
-            ),
-            '4.9.17',
-            '5.0.0'
-        );
-        return $this->event()->primary_datetime();
-    }
+	/**
+	 * Gets the primary datetime related to this registration via the related Event to this registration
+	 *
+	 * @deprecated 4.9.17
+	 * @return EE_Datetime
+	 */
+	public function get_related_primary_datetime() {
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'Use EE_Registration::get_latest_related_datetime() or EE_Registration::get_earliest_related_datetime()',
+				'event_espresso'
+			),
+			'4.9.17',
+			'5.0.0'
+		);
+		return $this->event()->primary_datetime();
+	}
 
 
 

Spacing +186 added lines, -186 removed lines

@@ -1,7 +1,7 @@ 
 <?php use EventEspresso\core\exceptions\EntityNotFoundException;
 
-if ( !defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 /**
  * EE_Registration class
@@ -59,9 +59,9 @@ 
 	 *                             		    date_format and the second value is the time format
 	 * @return EE_Registration
 	 */
-	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);
 	}
 
 
@@ -72,8 +72,8 @@ 
 	 *                          		the website will be used.
 	 * @return EE_Registration
 	 */
-	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);
 	}
 
 
@@ -83,8 +83,8 @@ 
 	 *
 	 * @param        int $EVT_ID Event ID
 	 */
-	public function set_event( $EVT_ID = 0 ) {
-		$this->set( 'EVT_ID', $EVT_ID );
+	public function set_event($EVT_ID = 0) {
+		$this->set('EVT_ID', $EVT_ID);
 	}
 
 
@@ -98,18 +98,18 @@ 
      * @throws \EE_Error
      * @throws \RuntimeException
      */
-	public function set( $field_name, $field_value, $use_default = FALSE ) {
-		switch( $field_name ) {
+	public function set($field_name, $field_value, $use_default = FALSE) {
+		switch ($field_name) {
 			case 'REG_code' :
-				if ( ! empty( $field_value ) && $this->reg_code() === null ) {
-					$this->set_reg_code( $field_value, $use_default );
+				if ( ! empty($field_value) && $this->reg_code() === null) {
+					$this->set_reg_code($field_value, $use_default);
 				}
 				break;
 			case 'STS_ID' :
-				$this->set_status( $field_value, $use_default );
+				$this->set_status($field_value, $use_default);
 				break;
 			default :
-				parent::set( $field_name, $field_value, $use_default );
+				parent::set($field_name, $field_value, $use_default);
 		}
 	}
 
@@ -127,40 +127,40 @@ 
      * @throws \RuntimeException
      * @throws \EE_Error
      */
-	public function set_status( $new_STS_ID = NULL, $use_default = FALSE ) {
+	public function set_status($new_STS_ID = NULL, $use_default = FALSE) {
 		// get current REG_Status
 		$old_STS_ID = $this->status_ID();
 		// if status has changed
 		if (
 			$old_STS_ID !== $new_STS_ID // and that status has actually changed
-			&& ! empty( $old_STS_ID ) // and that old status is actually set
-			&& ! empty( $new_STS_ID ) // as well as the new status
+			&& ! empty($old_STS_ID) // and that old status is actually set
+			&& ! empty($new_STS_ID) // as well as the new status
 			&& $this->ID() // ensure registration is in the db
 		) {
             // TO approved
-			if ( $new_STS_ID === EEM_Registration::status_id_approved ) {
+			if ($new_STS_ID === EEM_Registration::status_id_approved) {
 				// reserve a space by incrementing ticket and datetime sold values
 				$this->_reserve_registration_space();
-				do_action( 'AHEE__EE_Registration__set_status__to_approved', $this, $old_STS_ID, $new_STS_ID );
+				do_action('AHEE__EE_Registration__set_status__to_approved', $this, $old_STS_ID, $new_STS_ID);
 			// OR FROM  approved
-			} else if ( $old_STS_ID === EEM_Registration::status_id_approved ) {
+			} else if ($old_STS_ID === EEM_Registration::status_id_approved) {
 				// release a space by decrementing ticket and datetime sold values
 				$this->_release_registration_space();
-				do_action( 'AHEE__EE_Registration__set_status__from_approved', $this, $old_STS_ID, $new_STS_ID );
+				do_action('AHEE__EE_Registration__set_status__from_approved', $this, $old_STS_ID, $new_STS_ID);
 			}
             // update status
             parent::set('STS_ID', $new_STS_ID, $use_default);
             $this->_update_if_canceled_or_declined($new_STS_ID, $old_STS_ID);
             /** @type EE_Transaction_Payments $transaction_payments */
             $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-            $transaction_payments->recalculate_transaction_total( $this->transaction(), false );
-			$this->transaction()->update_status_based_on_total_paid( true );
-			do_action( 'AHEE__EE_Registration__set_status__after_update', $this );
+            $transaction_payments->recalculate_transaction_total($this->transaction(), false);
+			$this->transaction()->update_status_based_on_total_paid(true);
+			do_action('AHEE__EE_Registration__set_status__after_update', $this);
 			return TRUE;
 		} else {
 			//even though the old value matches the new value, it's still good to
 			//allow the parent set method to have a say
-			parent::set( 'STS_ID', $new_STS_ID, $use_default );
+			parent::set('STS_ID', $new_STS_ID, $use_default);
 			return TRUE;
 		}
 	}
@@ -228,7 +228,7 @@ 
 	 *        get Status ID
 	 */
 	public function status_ID() {
-		return $this->get( 'STS_ID' );
+		return $this->get('STS_ID');
 	}
 
 
@@ -259,12 +259,12 @@ 
      * @return EE_Ticket|EE_Base_Class
      * @throws \EE_Error
      */
-	public function ticket( $include_archived = TRUE ) {
+	public function ticket($include_archived = TRUE) {
 		$query_params = array();
-		if ( $include_archived ) {
-			$query_params[ 'default_where_conditions' ] = 'none';
+		if ($include_archived) {
+			$query_params['default_where_conditions'] = 'none';
 		}
-		return $this->get_first_related( 'Ticket', $query_params );
+		return $this->get_first_related('Ticket', $query_params);
 	}
 
 
@@ -292,7 +292,7 @@ 
 	 */
 	public function wp_user() {
 		$event = $this->event();
-		if ( $event instanceof EE_Event ) {
+		if ($event instanceof EE_Event) {
 			return $event->wp_user();
 		}
 		return 0;
@@ -363,8 +363,8 @@ 
 	 *
 	 * @param        int $ATT_ID Attendee ID
 	 */
-	public function set_attendee_id( $ATT_ID = 0 ) {
-		$this->set( 'ATT_ID', $ATT_ID );
+	public function set_attendee_id($ATT_ID = 0) {
+		$this->set('ATT_ID', $ATT_ID);
 	}
 
 
@@ -374,8 +374,8 @@ 
 	 *
 	 * @param        int $TXN_ID Transaction ID
 	 */
-	public function set_transaction_id( $TXN_ID = 0 ) {
-		$this->set( 'TXN_ID', $TXN_ID );
+	public function set_transaction_id($TXN_ID = 0) {
+		$this->set('TXN_ID', $TXN_ID);
 	}
 
 
@@ -385,8 +385,8 @@ 
 	 *
 	 * @param    string $REG_session PHP Session ID
 	 */
-	public function set_session( $REG_session = '' ) {
-		$this->set( 'REG_session', $REG_session );
+	public function set_session($REG_session = '') {
+		$this->set('REG_session', $REG_session);
 	}
 
 
@@ -396,8 +396,8 @@ 
 	 *
 	 * @param    string $REG_url_link Registration URL Link
 	 */
-	public function set_reg_url_link( $REG_url_link = '' ) {
-		$this->set( 'REG_url_link', $REG_url_link );
+	public function set_reg_url_link($REG_url_link = '') {
+		$this->set('REG_url_link', $REG_url_link);
 	}
 
 
@@ -407,8 +407,8 @@ 
 	 *
 	 * @param        int $REG_count Primary Attendee
 	 */
-	public function set_count( $REG_count = 1 ) {
-		$this->set( 'REG_count', $REG_count );
+	public function set_count($REG_count = 1) {
+		$this->set('REG_count', $REG_count);
 	}
 
 
@@ -418,8 +418,8 @@ 
 	 *
 	 * @param        boolean $REG_group_size Group Registration
 	 */
-	public function set_group_size( $REG_group_size = FALSE ) {
-		$this->set( 'REG_group_size', $REG_group_size );
+	public function set_group_size($REG_group_size = FALSE) {
+		$this->set('REG_group_size', $REG_group_size);
 	}
 
 
@@ -495,8 +495,8 @@ 
 	 *
 	 * @param        mixed ( int or string ) $REG_date Registration Date - Unix timestamp or string representation of Date
 	 */
-	public function set_reg_date( $REG_date = FALSE ) {
-		$this->set( 'REG_date', $REG_date );
+	public function set_reg_date($REG_date = FALSE) {
+		$this->set('REG_date', $REG_date);
 	}
 
 
@@ -507,8 +507,8 @@ 
 	 * @access    public
 	 * @param    float $REG_final_price
 	 */
-	public function set_final_price( $REG_final_price = 0.00 ) {
-		$this->set( 'REG_final_price', $REG_final_price );
+	public function set_final_price($REG_final_price = 0.00) {
+		$this->set('REG_final_price', $REG_final_price);
 	}
 
 
@@ -519,8 +519,8 @@ 
 	 * @access    public
 	 * @param    float $REG_paid
 	 */
-	public function set_paid( $REG_paid = 0.00 ) {
-		$this->set( 'REG_paid', $REG_paid );
+	public function set_paid($REG_paid = 0.00) {
+		$this->set('REG_paid', $REG_paid);
 	}
 
 
@@ -530,8 +530,8 @@ 
 	 *
 	 * @param        boolean $REG_att_is_going Attendee Is Going
 	 */
-	public function set_att_is_going( $REG_att_is_going = FALSE ) {
-		$this->set( 'REG_att_is_going', $REG_att_is_going );
+	public function set_att_is_going($REG_att_is_going = FALSE) {
+		$this->set('REG_att_is_going', $REG_att_is_going);
 	}
 
 
@@ -541,7 +541,7 @@ 
 	 * @return EE_Attendee
 	 */
 	public function attendee() {
-		return $this->get_first_related( 'Attendee' );
+		return $this->get_first_related('Attendee');
 	}
 
 
@@ -550,7 +550,7 @@ 
 	 *        get Event ID
 	 */
 	public function event_ID() {
-		return $this->get( 'EVT_ID' );
+		return $this->get('EVT_ID');
 	}
 
 
@@ -560,7 +560,7 @@ 
 	 */
 	public function event_name() {
 		$event = $this->event_obj();
-		if ( $event ) {
+		if ($event) {
 			return $event->name();
 		} else {
 			return NULL;
@@ -574,7 +574,7 @@ 
 	 * @return EE_Event
 	 */
 	public function event_obj() {
-		return $this->get_first_related( 'Event' );
+		return $this->get_first_related('Event');
 	}
 
 
@@ -583,7 +583,7 @@ 
 	 *        get Attendee ID
 	 */
 	public function attendee_ID() {
-		return $this->get( 'ATT_ID' );
+		return $this->get('ATT_ID');
 	}
 
 
@@ -592,7 +592,7 @@ 
 	 *        get PHP Session ID
 	 */
 	public function session_ID() {
-		return $this->get( 'REG_session' );
+		return $this->get('REG_session');
 	}
 
 
@@ -602,7 +602,7 @@ 
 	 * @param string $messenger 'pdf' or 'html'.  Default 'html'.
 	 * @return string
 	 */
-	public function receipt_url( $messenger = 'html' ) {
+	public function receipt_url($messenger = 'html') {
 
 		/**
 		 * The below will be deprecated one version after this.  We check first if there is a custom receipt template already in use on old system.  If there is then we just return the standard url for it.
@@ -610,12 +610,12 @@ 
 		 * @since 4.5.0
 		 */
 		$template_relative_path = 'modules/gateways/Invoice/lib/templates/receipt_body.template.php';
-		$has_custom = EEH_Template::locate_template( $template_relative_path , array(), TRUE, TRUE, TRUE );
+		$has_custom = EEH_Template::locate_template($template_relative_path, array(), TRUE, TRUE, TRUE);
 
-		if ( $has_custom ) {
-			return add_query_arg( array( 'receipt' => 'true' ), $this->invoice_url( 'launch' ) );
+		if ($has_custom) {
+			return add_query_arg(array('receipt' => 'true'), $this->invoice_url('launch'));
 		}
-		return apply_filters( 'FHEE__EE_Registration__receipt_url__receipt_url', '', $this, $messenger, 'receipt' );
+		return apply_filters('FHEE__EE_Registration__receipt_url__receipt_url', '', $this, $messenger, 'receipt');
 	}
 
 
@@ -626,28 +626,28 @@ 
 	 * @param string $messenger 'pdf' or 'html'.  Default 'html'.
 	 * @return string
 	 */
-	public function invoice_url( $messenger = 'html' ) {
+	public function invoice_url($messenger = 'html') {
 		/**
 		 * The below will be deprecated one version after this.  We check first if there is a custom invoice template already in use on old system.  If there is then we just return the standard url for it.
 		 *
 		 * @since 4.5.0
 		 */
 		$template_relative_path = 'modules/gateways/Invoice/lib/templates/invoice_body.template.php';
-		$has_custom = EEH_Template::locate_template( $template_relative_path , array(), TRUE, TRUE, TRUE );
+		$has_custom = EEH_Template::locate_template($template_relative_path, array(), TRUE, TRUE, TRUE);
 
-		if ( $has_custom ) {
-			if ( $messenger == 'html' ) {
-				return $this->invoice_url( 'launch' );
+		if ($has_custom) {
+			if ($messenger == 'html') {
+				return $this->invoice_url('launch');
 			}
 			$route = $messenger == 'download' || $messenger == 'pdf' ? 'download_invoice' : 'launch_invoice';
 
-			$query_args = array( 'ee' => $route, 'id' => $this->reg_url_link() );
-			if ( $messenger == 'html' ) {
+			$query_args = array('ee' => $route, 'id' => $this->reg_url_link());
+			if ($messenger == 'html') {
 				$query_args['html'] = TRUE;
 			}
-			return add_query_arg( $query_args, get_permalink( EE_Registry::instance()->CFG->core->thank_you_page_id ) );
+			return add_query_arg($query_args, get_permalink(EE_Registry::instance()->CFG->core->thank_you_page_id));
 		}
-		return apply_filters( 'FHEE__EE_Registration__invoice_url__invoice_url', '', $this, $messenger, 'invoice' );
+		return apply_filters('FHEE__EE_Registration__invoice_url__invoice_url', '', $this, $messenger, 'invoice');
 	}
 
 
@@ -660,7 +660,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function reg_url_link() {
-		return (string)$this->get( 'REG_url_link' );
+		return (string) $this->get('REG_url_link');
 	}
 
 
@@ -670,8 +670,8 @@ 
 	 * @param string $type 'download','launch', or 'html' (default is 'launch')
 	 * @return void
 	 */
-	public function e_invoice_url( $type = 'launch' ) {
-		echo $this->invoice_url( $type );
+	public function e_invoice_url($type = 'launch') {
+		echo $this->invoice_url($type);
 	}
 
 
@@ -691,7 +691,7 @@ 
 	 * @return string
 	 */
 	public function payment_overview_url() {
-		return add_query_arg( array( 'e_reg_url_link' => $this->reg_url_link(), 'step' => 'payment_options', 'revisit' => TRUE ), EE_Registry::instance()->CFG->core->reg_page_url() );
+		return add_query_arg(array('e_reg_url_link' => $this->reg_url_link(), 'step' => 'payment_options', 'revisit' => TRUE), EE_Registry::instance()->CFG->core->reg_page_url());
 	}
 
 
@@ -702,7 +702,7 @@ 
 	 * @return string
 	 */
 	public function edit_attendee_information_url() {
-		return add_query_arg( array( 'e_reg_url_link' => $this->reg_url_link(), 'step' => 'attendee_information', 'revisit' => TRUE ), EE_Registry::instance()->CFG->core->reg_page_url() );
+		return add_query_arg(array('e_reg_url_link' => $this->reg_url_link(), 'step' => 'attendee_information', 'revisit' => TRUE), EE_Registry::instance()->CFG->core->reg_page_url());
 	}
 
 
@@ -712,7 +712,7 @@ 
 	 * @return string
 	 */
 	public function get_admin_edit_url() {
-		return EEH_URL::add_query_args_and_nonce( array( 'page' => 'espresso_registrations', 'action' => 'view_registration', '_REG_ID' => $this->ID() ), admin_url( 'admin.php' ) );
+		return EEH_URL::add_query_args_and_nonce(array('page' => 'espresso_registrations', 'action' => 'view_registration', '_REG_ID' => $this->ID()), admin_url('admin.php'));
 	}
 
 
@@ -721,7 +721,7 @@ 
 	 *    is_primary_registrant?
 	 */
 	public function is_primary_registrant() {
-		return $this->get( 'REG_count' ) == 1 ? TRUE : FALSE;
+		return $this->get('REG_count') == 1 ? TRUE : FALSE;
 	}
 
 
@@ -730,12 +730,12 @@ 
 	 * This returns the primary registration object for this registration group (which may be this object).
 	 * @return EE_Registration
 	 */
-	public function get_primary_registration()  {
-		if ( $this->is_primary_registrant() )
+	public function get_primary_registration() {
+		if ($this->is_primary_registrant())
 			return $this;
 
 		//k reg_count !== 1 so let's get the EE_Registration object matching this txn_id and reg_count == 1
-		$primary_registrant = EEM_Registration::instance()->get_one( array( array('TXN_ID' => $this->transaction_ID(), 'REG_count' => 1 ) ) );
+		$primary_registrant = EEM_Registration::instance()->get_one(array(array('TXN_ID' => $this->transaction_ID(), 'REG_count' => 1)));
 		return $primary_registrant;
 	}
 
@@ -746,7 +746,7 @@ 
 	* 		@access		public
 	*/
 	public function count() {
-		return $this->get( 'REG_count' );
+		return $this->get('REG_count');
 	}
 
 
@@ -755,7 +755,7 @@ 
 	 *        get Group Size
 	 */
 	public function group_size() {
-		return $this->get( 'REG_group_size' );
+		return $this->get('REG_group_size');
 	}
 
 
@@ -764,7 +764,7 @@ 
 	 *        get Registration Date
 	 */
 	public function date() {
-		return $this->get( 'REG_date' );
+		return $this->get('REG_date');
 	}
 
 
@@ -775,8 +775,8 @@ 
 	 * @param string $time_format
 	 * @return string
 	 */
-	public function pretty_date( $date_format = NULL, $time_format = NULL ) {
-		return $this->get_datetime( 'REG_date', $date_format, $time_format );
+	public function pretty_date($date_format = NULL, $time_format = NULL) {
+		return $this->get_datetime('REG_date', $date_format, $time_format);
 	}
 
 
@@ -788,7 +788,7 @@ 
 	 * @return    float
 	 */
 	public function final_price() {
-		return $this->get( 'REG_final_price' );
+		return $this->get('REG_final_price');
 	}
 
 
@@ -799,7 +799,7 @@ 
 	 * @return string
 	 */
 	public function pretty_final_price() {
-		return $this->get_pretty( 'REG_final_price' );
+		return $this->get_pretty('REG_final_price');
 	}
 
 
@@ -809,7 +809,7 @@ 
 	 * @return 	float
 	 */
 	public function paid() {
-		return $this->get( 'REG_paid' );
+		return $this->get('REG_paid');
 	}
 
 
@@ -819,7 +819,7 @@ 
 	 * @return 	float
 	 */
 	public function pretty_paid() {
-		return $this->get_pretty( 'REG_paid' );
+		return $this->get_pretty('REG_paid');
 	}
 
 
@@ -830,11 +830,11 @@ 
 	 * @param array $requires_payment
 	 * @return bool
 	 */
-	public function owes_monies_and_can_pay( $requires_payment = array()) {
+	public function owes_monies_and_can_pay($requires_payment = array()) {
 		// these reg statuses require payment (if event is not free)
-		$requires_payment = ! empty( $requires_payment ) ? $requires_payment : EEM_Registration::reg_statuses_that_allow_payment();
+		$requires_payment = ! empty($requires_payment) ? $requires_payment : EEM_Registration::reg_statuses_that_allow_payment();
 		if (
-			in_array( $this->status_ID(), $requires_payment ) &&
+			in_array($this->status_ID(), $requires_payment) &&
 			$this->final_price() != 0 &&
 			$this->final_price() != $this->paid()
 		) {
@@ -851,8 +851,8 @@ 
 	 * @param bool $show_icons
 	 * @return void
 	 */
-	public function e_pretty_status( $show_icons = FALSE ) {
-		echo $this->pretty_status( $show_icons );
+	public function e_pretty_status($show_icons = FALSE) {
+		echo $this->pretty_status($show_icons);
 	}
 
 
@@ -863,10 +863,10 @@ 
 	 * @param bool $show_icons
 	 * @return string
 	 */
-	public function pretty_status( $show_icons = FALSE ) {
-		$status = EEM_Status::instance()->localized_status( array( $this->status_ID() => __( 'unknown', 'event_espresso' ) ), FALSE, 'sentence' );
+	public function pretty_status($show_icons = FALSE) {
+		$status = EEM_Status::instance()->localized_status(array($this->status_ID() => __('unknown', 'event_espresso')), FALSE, 'sentence');
 		$icon = '';
-		switch ( $this->status_ID() ) {
+		switch ($this->status_ID()) {
 			case EEM_Registration::status_id_approved:
 				$icon = $show_icons ? '<span class="dashicons dashicons-star-filled ee-icon-size-16 green-text"></span>' : '';
 				break;
@@ -889,7 +889,7 @@ 
 				$icon = $show_icons ? '<span class="dashicons dashicons-clipboard ee-icon-size-16 purple-text"></span>' : '';
 				break;
 		}
-		return $icon . $status[ $this->status_ID() ];
+		return $icon.$status[$this->status_ID()];
 	}
 
 
@@ -898,7 +898,7 @@ 
 	 *        get Attendee Is Going
 	 */
 	public function att_is_going() {
-		return $this->get( 'REG_att_is_going' );
+		return $this->get('REG_att_is_going');
 	}
 
 
@@ -908,8 +908,8 @@ 
 	 * @param array $query_params like EEM_Base::get_all
 	 * @return EE_Answer[]
 	 */
-	public function answers( $query_params = NULL ) {
-		return $this->get_many_related( 'Answer', $query_params );
+	public function answers($query_params = NULL) {
+		return $this->get_many_related('Answer', $query_params);
 	}
 
 
@@ -923,9 +923,9 @@ 
 	 * (because the answer might be an array of answer values, so passing pretty_value=true
 	 * will convert it into some kind of string)
 	 */
-	public function answer_value_to_question( $question, $pretty_value=true ) {
+	public function answer_value_to_question($question, $pretty_value = true) {
 		$question_id = EEM_Question::instance()->ensure_is_ID($question);
-		return EEM_Answer::instance()->get_answer_value_to_question($this,$question_id,$pretty_value);
+		return EEM_Answer::instance()->get_answer_value_to_question($this, $question_id, $pretty_value);
 	}
 
 
@@ -938,13 +938,13 @@ 
 	 */
 	public function question_groups() {
 		$question_groups = array();
-		if ( $this->event() instanceof EE_Event ) {
+		if ($this->event() instanceof EE_Event) {
 			$question_groups = $this->event()->question_groups(
 				array(
 					array(
 						'Event_Question_Group.EQG_primary' => $this->count() == 1 ? true : false
 					),
-					'order_by' => array( 'QSG_order' => 'ASC' )
+					'order_by' => array('QSG_order' => 'ASC')
 				)
 			);
 		}
@@ -961,7 +961,7 @@ 
 	 */
 	public function count_question_groups() {
 		$qg_count = 0;
-		if ( $this->event() instanceof EE_Event ) {
+		if ($this->event() instanceof EE_Event) {
 			$qg_count = $this->event()->count_related(
 				'Question_Group',
 				array(
@@ -982,7 +982,7 @@ 
 	 * @return string
 	 */
 	public function reg_date() {
-		return $this->get_datetime( 'REG_date' );
+		return $this->get_datetime('REG_date');
 	}
 
 
@@ -994,7 +994,7 @@ 
 	 * @return EE_Datetime_Ticket
 	 */
 	public function datetime_ticket() {
-		return $this->get_first_related( 'Datetime_Ticket' );
+		return $this->get_first_related('Datetime_Ticket');
 	}
 
 
@@ -1004,15 +1004,15 @@ 
 	 * @param EE_Datetime_Ticket $datetime_ticket
 	 * @return EE_Datetime_Ticket
 	 */
-	public function set_datetime_ticket( $datetime_ticket ) {
-		return $this->_add_relation_to( $datetime_ticket, 'Datetime_Ticket' );
+	public function set_datetime_ticket($datetime_ticket) {
+		return $this->_add_relation_to($datetime_ticket, 'Datetime_Ticket');
 	}
 	/**
 	 * Gets deleted
 	 * @return boolean
 	 */
 	public function deleted() {
-		return $this->get( 'REG_deleted' );
+		return $this->get('REG_deleted');
 	}
 
 	/**
@@ -1021,7 +1021,7 @@ 
 	 * @return boolean
 	 */
 	public function set_deleted($deleted) {
-	    if ( $deleted ) {
+	    if ($deleted) {
 	        $this->delete();
         } else {
 	        $this->restore();
@@ -1035,7 +1035,7 @@ 
 	 * @return EE_Status
 	 */
 	public function status_obj() {
-		return $this->get_first_related( 'Status' );
+		return $this->get_first_related('Status');
 	}
 
 
@@ -1046,7 +1046,7 @@ 
 	 * @return int
 	 */
 	public function count_checkins() {
-		return $this->get_model()->count_related( $this, 'Checkin' );
+		return $this->get_model()->count_related($this, 'Checkin');
 	}
 
 
@@ -1056,7 +1056,7 @@ 
 	 * @return int
 	 */
 	public function count_checkins_not_checkedout() {
-		return $this->get_model()->count_related( $this, 'Checkin', array( array( 'CHK_in' => 1 ) ) );
+		return $this->get_model()->count_related($this, 'Checkin', array(array('CHK_in' => 1)));
 	}
 
 
@@ -1069,20 +1069,20 @@ 
 	 *
 	 * @return bool
 	 */
-	public function can_checkin( $DTT_OR_ID, $check_approved = TRUE ) {
-		$DTT_ID = EEM_Datetime::instance()->ensure_is_ID( $DTT_OR_ID );
+	public function can_checkin($DTT_OR_ID, $check_approved = TRUE) {
+		$DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
 
 		//first check registration status
-		if (  ( $check_approved && ! $this->is_approved() ) || ! $DTT_ID ) {
+		if (($check_approved && ! $this->is_approved()) || ! $DTT_ID) {
 			return false;
 		}
 		//is there a datetime ticket that matches this dtt_ID?
-		if ( ! ( EEM_Datetime_Ticket::instance()->exists( array( array( 'TKT_ID' => $this->get('TKT_ID' ), 'DTT_ID' => $DTT_ID ) ) ) ) ) {
+		if ( ! (EEM_Datetime_Ticket::instance()->exists(array(array('TKT_ID' => $this->get('TKT_ID'), 'DTT_ID' => $DTT_ID))))) {
 			return false;
 		}
 
 		//final check is against TKT_uses
-		return $this->verify_can_checkin_against_TKT_uses( $DTT_ID );
+		return $this->verify_can_checkin_against_TKT_uses($DTT_ID);
 	}
 
 
@@ -1095,10 +1095,10 @@ 
 	 * @param int | EE_Datetime  $DTT_OR_ID  The datetime the registration is being checked against
 	 * @return bool   true means can checkin.  false means cannot checkin.
 	 */
-	public function verify_can_checkin_against_TKT_uses( $DTT_OR_ID ) {
-		$DTT_ID = EEM_Datetime::instance()->ensure_is_ID( $DTT_OR_ID );
+	public function verify_can_checkin_against_TKT_uses($DTT_OR_ID) {
+		$DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
 
-		if ( ! $DTT_ID ) {
+		if ( ! $DTT_ID) {
 			return false;
 		}
 
@@ -1106,23 +1106,23 @@ 
 
 		// if max uses is not set or equals infinity then return true cause its not a factor for whether user can check-in
 		// or not.
-		if ( ! $max_uses || $max_uses === EE_INF ) {
+		if ( ! $max_uses || $max_uses === EE_INF) {
 			return true;
 		}
 
 		//does this datetime have a checkin record?  If so, then the dtt count has already been verified so we can just
 		//go ahead and toggle.
-		if ( EEM_Checkin::instance()->exists( array( array( 'REG_ID' => $this->ID(), 'DTT_ID' => $DTT_ID ) ) ) ) {
+		if (EEM_Checkin::instance()->exists(array(array('REG_ID' => $this->ID(), 'DTT_ID' => $DTT_ID)))) {
 			return true;
 		}
 
 		//made it here so the last check is whether the number of checkins per unique datetime on this registration
 		//disallows further check-ins.
-		$count_unique_dtt_checkins = EEM_Checkin::instance()->count( array( array( 'REG_ID' => $this->ID(), 'CHK_in' => true ) ), 'DTT_ID', true );
+		$count_unique_dtt_checkins = EEM_Checkin::instance()->count(array(array('REG_ID' => $this->ID(), 'CHK_in' => true)), 'DTT_ID', true);
 		// checkins have already reached their max number of uses
 		// so registrant can NOT checkin
-		if ( $count_unique_dtt_checkins >= $max_uses ) {
-			EE_Error::add_error( __( 'Check-in denied because number of datetime uses for the ticket has been reached or exceeded.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
+		if ($count_unique_dtt_checkins >= $max_uses) {
+			EE_Error::add_error(__('Check-in denied because number of datetime uses for the ticket has been reached or exceeded.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
 		return true;
@@ -1144,15 +1144,15 @@ 
      * @return bool|int     the chk_in status toggled to OR false if nothing got changed.
      * @throws EE_Error
      */
-	public function toggle_checkin_status( $DTT_ID = null, $verify = false ) {
-		if ( empty( $DTT_ID ) ) {
+	public function toggle_checkin_status($DTT_ID = null, $verify = false) {
+		if (empty($DTT_ID)) {
 			$datetime = $this->get_latest_related_datetime();
 			$DTT_ID = $datetime instanceof EE_Datetime ? $datetime->ID() : 0;
 		// verify the registration can checkin for the given DTT_ID
-		} elseif ( ! $this->can_checkin( $DTT_ID, $verify ) ) {
+		} elseif ( ! $this->can_checkin($DTT_ID, $verify)) {
 			EE_Error::add_error(
 					sprintf(
-						__( 'The given registration (ID:%1$d) can not be checked in to the given DTT_ID (%2$d), because the registration does not have access', 'event_espresso'),
+						__('The given registration (ID:%1$d) can not be checked in to the given DTT_ID (%2$d), because the registration does not have access', 'event_espresso'),
 						$this->ID(),
 						$DTT_ID
 					),
@@ -1166,8 +1166,8 @@ 
 			EE_Registration::checkin_status_out => EE_Registration::checkin_status_in
 		);
 		//start by getting the current status so we know what status we'll be changing to.
-		$cur_status = $this->check_in_status_for_datetime( $DTT_ID, NULL );
-		$status_to = $status_paths[ $cur_status ];
+		$cur_status = $this->check_in_status_for_datetime($DTT_ID, NULL);
+		$status_to = $status_paths[$cur_status];
 		// database only records true for checked IN or false for checked OUT
 		// no record ( null ) means checked in NEVER, but we obviously don't save that
 		$new_status = $status_to === EE_Registration::checkin_status_in ? true : false;
@@ -1175,24 +1175,24 @@ 
 		// because we are keeping track of Check-ins over time.
 		// Eventually we'll probably want to show a list table
 		// for the individual Check-ins so that they can be managed.
-		$checkin = EE_Checkin::new_instance( array(
+		$checkin = EE_Checkin::new_instance(array(
 				'REG_ID' => $this->ID(),
 				'DTT_ID' => $DTT_ID,
 				'CHK_in' => $new_status
-		) );
+		));
 		// if the record could not be saved then return false
-		if ( $checkin->save() === 0 ) {
-			if ( WP_DEBUG ) {
+		if ($checkin->save() === 0) {
+			if (WP_DEBUG) {
 				global $wpdb;
 				$error = sprintf(
-					__( 'Registration check in update failed because of the following database error: %1$s%2$s', 'event_espresso' ),
+					__('Registration check in update failed because of the following database error: %1$s%2$s', 'event_espresso'),
 					'<br />',
 					$wpdb->last_error
 				);
 			} else {
-				$error = __( 'Registration check in update failed because of an unknown database error', 'event_espresso' );
+				$error = __('Registration check in update failed because of an unknown database error', 'event_espresso');
 			}
-			EE_Error::add_error( $error, __FILE__, __FUNCTION__, __LINE__ );
+			EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
 		return $status_to;
@@ -1213,7 +1213,7 @@ 
 				array(
 					'Ticket.Registration.REG_ID' => $this->ID()
 				),
-				'order_by' => array( 'DTT_EVT_start' => 'DESC' )
+				'order_by' => array('DTT_EVT_start' => 'DESC')
 			)
 		);
 	}
@@ -1232,7 +1232,7 @@ 
 				array(
 					'Ticket.Registration.REG_ID' => $this->ID()
 				),
-				'order_by' => array( 'DTT_EVT_start' => 'ASC' )
+				'order_by' => array('DTT_EVT_start' => 'ASC')
 			)
 		);
 	}
@@ -1251,21 +1251,21 @@ 
      * @return int                Integer representing Check-in status.
      * @throws \EE_Error
      */
-	public function check_in_status_for_datetime( $DTT_ID = 0, $checkin = null ) {
+	public function check_in_status_for_datetime($DTT_ID = 0, $checkin = null) {
 		$checkin_query_params = array(
-			'order_by' => array( 'CHK_timestamp' => 'DESC' )
+			'order_by' => array('CHK_timestamp' => 'DESC')
 		);
 
-		if ( $DTT_ID > 0 ) {
-			$checkin_query_params[0] = array( 'DTT_ID' => $DTT_ID );
+		if ($DTT_ID > 0) {
+			$checkin_query_params[0] = array('DTT_ID' => $DTT_ID);
 		}
 
 		//get checkin object (if exists)
 		$checkin = $checkin instanceof EE_Checkin
             ? $checkin
-            : $this->get_first_related( 'Checkin', $checkin_query_params );
-		if ( $checkin instanceof EE_Checkin ) {
-			if ( $checkin->get( 'CHK_in' ) ) {
+            : $this->get_first_related('Checkin', $checkin_query_params);
+		if ($checkin instanceof EE_Checkin) {
+			if ($checkin->get('CHK_in')) {
 				return EE_Registration::checkin_status_in; //checked in
 			}
 			return EE_Registration::checkin_status_out; //had checked in but is now checked out.
@@ -1281,28 +1281,28 @@ 
 	 * @param bool $error  This just flags that you want an error message returned. This is put in so that the error message can be customized with the attendee name.
 	 * @return string         internationalized message
 	 */
-	public function get_checkin_msg( $DTT_ID, $error = FALSE ) {
+	public function get_checkin_msg($DTT_ID, $error = FALSE) {
 		//let's get the attendee first so we can include the name of the attendee
-		$attendee = $this->get_first_related( 'Attendee' );
-		if ( $attendee instanceof EE_Attendee ) {
-			if ( $error ) {
-				return sprintf( __( "%s's check-in status was not changed.", "event_espresso" ), $attendee->full_name() );
+		$attendee = $this->get_first_related('Attendee');
+		if ($attendee instanceof EE_Attendee) {
+			if ($error) {
+				return sprintf(__("%s's check-in status was not changed.", "event_espresso"), $attendee->full_name());
 			}
-			$cur_status = $this->check_in_status_for_datetime( $DTT_ID );
+			$cur_status = $this->check_in_status_for_datetime($DTT_ID);
 			//what is the status message going to be?
-			switch ( $cur_status ) {
+			switch ($cur_status) {
 				case EE_Registration::checkin_status_never :
-					return sprintf( __( "%s has been removed from Check-in records", "event_espresso" ), $attendee->full_name() );
+					return sprintf(__("%s has been removed from Check-in records", "event_espresso"), $attendee->full_name());
 					break;
 				case EE_Registration::checkin_status_in :
-					return sprintf( __( '%s has been checked in', 'event_espresso' ), $attendee->full_name() );
+					return sprintf(__('%s has been checked in', 'event_espresso'), $attendee->full_name());
 					break;
 				case EE_Registration::checkin_status_out :
-					return sprintf( __( '%s has been checked out', 'event_espresso' ), $attendee->full_name() );
+					return sprintf(__('%s has been checked out', 'event_espresso'), $attendee->full_name());
 					break;
 			}
 		}
-		return __( "The check-in status could not be determined.", "event_espresso" );
+		return __("The check-in status could not be determined.", "event_espresso");
 	}
 
 
@@ -1326,7 +1326,7 @@ 
 	 *        get Registration Code
 	 */
 	public function reg_code() {
-		return $this->get( 'REG_code' );
+		return $this->get('REG_code');
 	}
 
 
@@ -1335,7 +1335,7 @@ 
 	 *        get Transaction ID
 	 */
 	public function transaction_ID() {
-		return $this->get( 'TXN_ID' );
+		return $this->get('TXN_ID');
 	}
 
 
@@ -1344,7 +1344,7 @@ 
 	 * @return int
 	 */
 	public function ticket_ID() {
-		return $this->get( 'TKT_ID' );
+		return $this->get('TKT_ID');
 	}
 
 
@@ -1356,17 +1356,17 @@ 
 	 * @param    string $REG_code Registration Code
 	 * @param	boolean $use_default
 	 */
-	public function set_reg_code( $REG_code, $use_default = FALSE ) {
-		if ( empty( $REG_code )) {
-			EE_Error::add_error( __( 'REG_code can not be empty.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__ );
+	public function set_reg_code($REG_code, $use_default = FALSE) {
+		if (empty($REG_code)) {
+			EE_Error::add_error(__('REG_code can not be empty.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return;
 		}
-		if ( ! $this->reg_code() ) {
-			parent::set( 'REG_code', $REG_code, $use_default );
+		if ( ! $this->reg_code()) {
+			parent::set('REG_code', $REG_code, $use_default);
 		} else {
 			EE_Error::doing_it_wrong(
-				__CLASS__ . '::' . __FUNCTION__,
-				__( 'Can not change a registration REG_code once it has been set.', 'event_espresso' ),
+				__CLASS__.'::'.__FUNCTION__,
+				__('Can not change a registration REG_code once it has been set.', 'event_espresso'),
 				'4.6.0'
 			);
 		}
@@ -1386,17 +1386,17 @@ 
 	 * @return EE_Registration[]  or empty array if this isn't a group registration.
 	 */
 	public function get_all_other_registrations_in_group() {
-		if ( $this->group_size() < 2 ) {
+		if ($this->group_size() < 2) {
 			return array();
 		}
 
 		$query[0] = array(
 			'TXN_ID' => $this->transaction_ID(),
-			'REG_ID' => array( '!=', $this->ID() ),
+			'REG_ID' => array('!=', $this->ID()),
 			'TKT_ID' => $this->ticket_ID()
 			);
 
-		$registrations = $this->get_model()->get_all( $query );
+		$registrations = $this->get_model()->get_all($query);
 		return $registrations;
 	}
 
@@ -1405,14 +1405,14 @@ 
 	 * @return string
 	 */
 	public function get_admin_details_link() {
-		EE_Registry::instance()->load_helper( 'URL' );
+		EE_Registry::instance()->load_helper('URL');
 		return EEH_URL::add_query_args_and_nonce(
 			array(
 				'page' => 'espresso_registrations',
 				'action' => 'view_registration',
 				'_REG_ID' => $this->ID()
 			),
-			admin_url( 'admin.php' )
+			admin_url('admin.php')
 		);
 	}
 
@@ -1437,12 +1437,12 @@ 
 	 * @return string
 	 */
 	public function get_admin_overview_link() {
-		EE_Registry::instance()->load_helper( 'URL' );
+		EE_Registry::instance()->load_helper('URL');
 		return EEH_URL::add_query_args_and_nonce(
 			array(
 				'page' => 'espresso_registrations'
 			),
-			admin_url( 'admin.php' )
+			admin_url('admin.php')
 		);
 	}
 
@@ -1453,8 +1453,8 @@ 
 	 * @return \EE_Registration[]
 	 * @throws \EE_Error
 	 */
-	public function payments( $query_params = array() ) {
-		return $this->get_many_related( 'Payment', $query_params );
+	public function payments($query_params = array()) {
+		return $this->get_many_related('Payment', $query_params);
 	}
 
 
@@ -1464,8 +1464,8 @@ 
 	 * @return \EE_Registration_Payment[]
 	 * @throws \EE_Error
 	 */
-	public function registration_payments( $query_params = array() ) {
-		return $this->get_many_related( 'Registration_Payment', $query_params );
+	public function registration_payments($query_params = array()) {
+		return $this->get_many_related('Registration_Payment', $query_params);
 	}
 
 
@@ -1478,7 +1478,7 @@ 
 	 * @return EE_Payment_Method|null
 	 */
 	public function payment_method() {
-		return EEM_Payment_Method::instance()->get_last_used_for_registration( $this );
+		return EEM_Payment_Method::instance()->get_last_used_for_registration($this);
 	}
 
 
@@ -1525,7 +1525,7 @@ 
      */
     public function delete()
     {
-        if($this->update_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY, $this->status_ID()) === true) {
+        if ($this->update_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY, $this->status_ID()) === true) {
             $this->set_status(EEM_Registration::status_id_cancelled);
         }
         return parent::delete();

admin_pages/payments/Payments_Admin_Page.core.php

Indentation +999 added lines, -999 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 
@@ -27,838 +27,838 @@ 
 class Payments_Admin_Page extends EE_Admin_Page
 {
 
-    /**
-     * Variables used for when we're re-sorting the logs results, in case
-     * we needed to do two queries and we need to resort
-     *
-     * @var string
-     */
-    private $_sort_logs_again_direction;
-
-
-
-    /**
-     * @Constructor
-     * @access public
-     * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
-     * @return \Payments_Admin_Page
-     */
-    public function __construct($routing = true)
-    {
-        parent::__construct($routing);
-    }
-
-
-
-    protected function _init_page_props()
-    {
-        $this->page_slug = EE_PAYMENTS_PG_SLUG;
-        $this->page_label = __('Payment Methods', 'event_espresso');
-        $this->_admin_base_url = EE_PAYMENTS_ADMIN_URL;
-        $this->_admin_base_path = EE_PAYMENTS_ADMIN;
-    }
-
-
-
-    protected function _ajax_hooks()
-    {
-        //todo: all hooks for ajax goes here.
-    }
-
-
-
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = $this->page_label;
-        $this->_labels = array(
-            'publishbox' => __('Update Settings', 'event_espresso'),
-        );
-    }
-
-
-
-    protected function _set_page_routes()
-    {
-        /**
-         * note that with payment method capabilities, although we've implemented
-         * capability mapping which will be used for accessing payment methods owned by
-         * other users.  This is not fully implemented yet in the payment method ui.
-         * Currently only the "plural" caps are in active use.
-         * When cap mapping is implemented, some routes will need to use the singular form of
-         * capability method and also include the $id of the payment method for the route.
-         **/
-        $this->_page_routes = array(
-            'default'                   => array(
-                'func'       => '_payment_methods_list',
-                'capability' => 'ee_edit_payment_methods',
-            ),
-            'payment_settings'          => array(
-                'func'       => '_payment_settings',
-                'capability' => 'ee_manage_gateways',
-            ),
-            'activate_payment_method'   => array(
-                'func'       => '_activate_payment_method',
-                'noheader'   => true,
-                'capability' => 'ee_edit_payment_methods',
-            ),
-            'deactivate_payment_method' => array(
-                'func'       => '_deactivate_payment_method',
-                'noheader'   => true,
-                'capability' => 'ee_delete_payment_methods',
-            ),
-            'update_payment_method'     => array(
-                'func'               => '_update_payment_method',
-                'noheader'           => true,
-                'headers_sent_route' => 'default',
-                'capability'         => 'ee_edit_payment_methods',
-            ),
-            'update_payment_settings'   => array(
-                'func'       => '_update_payment_settings',
-                'noheader'   => true,
-                'capability' => 'ee_manage_gateways',
-            ),
-            'payment_log'               => array(
-                'func'       => '_payment_log_overview_list_table',
-                'capability' => 'ee_read_payment_methods',
-            ),
-            'payment_log_details'       => array(
-                'func'       => '_payment_log_details',
-                'capability' => 'ee_read_payment_methods',
-            ),
-        );
-    }
-
-
-
-    protected function _set_page_config()
-    {
-        $payment_method_list_config = array(
-            'nav'           => array(
-                'label' => __('Payment Methods', 'event_espresso'),
-                'order' => 10,
-            ),
-            'metaboxes'     => $this->_default_espresso_metaboxes,
-            'help_tabs'     => array_merge(
-                array(
-                    'payment_methods_overview_help_tab' => array(
-                        'title'    => __('Payment Methods Overview', 'event_espresso'),
-                        'filename' => 'payment_methods_overview',
-                    ),
-                ),
-                $this->_add_payment_method_help_tabs()),
-            'help_tour'     => array('Payment_Methods_Selection_Help_Tour'),
-            'require_nonce' => false,
-        );
-        $this->_page_config = array(
-            'default'          => $payment_method_list_config,
-            'payment_settings' => array(
-                'nav'           => array(
-                    'label' => __('Settings', 'event_espresso'),
-                    'order' => 20,
-                ),
-                'help_tabs'     => array(
-                    'payment_methods_settings_help_tab' => array(
-                        'title'    => __('Payment Method Settings', 'event_espresso'),
-                        'filename' => 'payment_methods_settings',
-                    ),
-                ),
-                //'help_tour' => array( 'Payment_Methods_Settings_Help_Tour' ),
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
-                'require_nonce' => false,
-            ),
-            'payment_log'      => array(
-                'nav'           => array(
-                    'label' => __("Logs", 'event_espresso'),
-                    'order' => 30,
-                ),
-                'list_table'    => 'Payment_Log_Admin_List_Table',
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'require_nonce' => false,
-            ),
-        );
-    }
-
-
-
-    /**
-     * @return array
-     */
-    protected function _add_payment_method_help_tabs()
-    {
-        EE_Registry::instance()->load_lib('Payment_Method_Manager');
-        $payment_method_types = EE_Payment_Method_Manager::instance()->payment_method_types();
-        $all_pmt_help_tabs_config = array();
-        foreach ($payment_method_types as $payment_method_type) {
-            if (! EE_Registry::instance()->CAP->current_user_can($payment_method_type->cap_name(),
-                'specific_payment_method_type_access')
-            ) {
-                continue;
-            }
-            foreach ($payment_method_type->help_tabs_config() as $help_tab_name => $config) {
-                $template_args = isset($config['template_args']) ? $config['template_args'] : array();
-                $template_args['admin_page_obj'] = $this;
-                $all_pmt_help_tabs_config[$help_tab_name] = array(
-                    'title'   => $config['title'],
-                    'content' => EEH_Template::display_template(
-                        $payment_method_type->file_folder() . 'help_tabs' . DS . $config['filename'] . '.help_tab.php',
-                        $template_args,
-                        true),
-                );
-            }
-        }
-        return $all_pmt_help_tabs_config;
-    }
-
-
-
-    //none of the below group are currently used for Gateway Settings
-    protected function _add_screen_options()
-    {
-    }
-
-
-
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-
-    public function admin_init()
-    {
-    }
-
-
-
-    public function admin_notices()
-    {
-    }
-
-
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-
-    public function load_scripts_styles()
-    {
-        wp_enqueue_script('ee_admin_js');
-        wp_enqueue_script('ee-text-links');
-        wp_enqueue_script('espresso_payments', EE_PAYMENTS_ASSETS_URL . 'espresso_payments_admin.js',
-            array('espresso-ui-theme', 'ee-datepicker'), EVENT_ESPRESSO_VERSION, true);
-    }
-
-
-
-    public function load_scripts_styles_default()
-    {
-        //styles
-        wp_register_style('espresso_payments', EE_PAYMENTS_ASSETS_URL . 'ee-payments.css', array(),
-            EVENT_ESPRESSO_VERSION);
-        wp_enqueue_style('espresso_payments');
-        wp_enqueue_style('ee-text-links');
-        //scripts
-    }
-
-
-
-    protected function _payment_methods_list()
-    {
-        /**
-         * first let's ensure payment methods have been setup. We do this here because when people activate a
-         * payment method for the first time (as an addon), it may not setup its capabilities or get registered correctly due
-         * to the loading process.  However, people MUST setup the details for the payment method so its safe to do a
-         * recheck here.
-         */
-        EE_Registry::instance()->load_lib('Payment_Method_Manager');
-        EEM_Payment_Method::instance()->verify_button_urls();
-        //setup tabs, one for each payment method type
-        $tabs = array();
-        $payment_methods = array();
-        foreach (EE_Payment_Method_Manager::instance()->payment_method_types() as $pmt_obj) {
-            // we don't want to show admin-only PMTs for now
-            if ($pmt_obj instanceof EE_PMT_Admin_Only) {
-                continue;
-            }
-            //check access
-            if (! EE_Registry::instance()->CAP->current_user_can($pmt_obj->cap_name(),
-                'specific_payment_method_type_access')
-            ) {
-                continue;
-            }
-            //check for any active pms of that type
-            $payment_method = EEM_Payment_Method::instance()->get_one_of_type($pmt_obj->system_name());
-            if (! $payment_method instanceof EE_Payment_Method) {
-                $payment_method = EE_Payment_Method::new_instance(
-                    array(
-                        'PMD_slug'       => sanitize_key($pmt_obj->system_name()),
-                        'PMD_type'       => $pmt_obj->system_name(),
-                        'PMD_name'       => $pmt_obj->pretty_name(),
-                        'PMD_admin_name' => $pmt_obj->pretty_name(),
-                    )
-                );
-            }
-            $payment_methods[$payment_method->slug()] = $payment_method;
-        }
-        $payment_methods = apply_filters('FHEE__Payments_Admin_Page___payment_methods_list__payment_methods',
-            $payment_methods);
-        foreach ($payment_methods as $payment_method) {
-            if ($payment_method instanceof EE_Payment_Method) {
-                add_meta_box(
-                //html id
-                    'espresso_' . $payment_method->slug() . '_payment_settings',
-                    //title
-                    sprintf(__('%s Settings', 'event_espresso'), $payment_method->admin_name()),
-                    //callback
-                    array($this, 'payment_method_settings_meta_box'),
-                    //post type
-                    null,
-                    //context
-                    'normal',
-                    //priority
-                    'default',
-                    //callback args
-                    array('payment_method' => $payment_method)
-                );
-                //setup for tabbed content
-                $tabs[$payment_method->slug()] = array(
-                    'label' => $payment_method->admin_name(),
-                    'class' => $payment_method->active() ? 'gateway-active' : '',
-                    'href'  => 'espresso_' . $payment_method->slug() . '_payment_settings',
-                    'title' => __('Modify this Payment Method', 'event_espresso'),
-                    'slug'  => $payment_method->slug(),
-                );
-            }
-        }
-        $this->_template_args['admin_page_header'] = EEH_Tabbed_Content::tab_text_links($tabs, 'payment_method_links',
-            '|', $this->_get_active_payment_method_slug());
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-
-    /**
-     *   _get_active_payment_method_slug
-     *
-     * @return string
-     */
-    protected function _get_active_payment_method_slug()
-    {
-        $payment_method_slug = false;
-        //decide which payment method tab to open first, as dictated by the request's 'payment_method'
-        if (isset($this->_req_data['payment_method'])) {
-            // if they provided the current payment method, use it
-            $payment_method_slug = sanitize_key($this->_req_data['payment_method']);
-        }
-        $payment_method = EEM_Payment_Method::instance()->get_one(array(array('PMD_slug' => $payment_method_slug)));
-        // if that didn't work or wasn't provided, find another way to select the current pm
-        if (! $this->_verify_payment_method($payment_method)) {
-            // like, looking for an active one
-            $payment_method = EEM_Payment_Method::instance()->get_one_active('CART');
-            // test that one as well
-            if ($this->_verify_payment_method($payment_method)) {
-                $payment_method_slug = $payment_method->slug();
-            } else {
-                $payment_method_slug = 'paypal_standard';
-            }
-        }
-        return $payment_method_slug;
-    }
-
-
-
-    /**
-     *    payment_method_settings_meta_box
-     *    returns TRUE if the passed payment method is properly constructed and the logged in user has the correct
-     *    capabilities to access it
-     *
-     * @param \EE_Payment_Method $payment_method
-     * @return boolean
-     */
-    protected function _verify_payment_method($payment_method)
-    {
-        if (
-            $payment_method instanceof EE_Payment_Method && $payment_method->type_obj() instanceof EE_PMT_Base
-            && EE_Registry::instance()->CAP->current_user_can($payment_method->type_obj()->cap_name(),
-                'specific_payment_method_type_access')
-        ) {
-            return true;
-        }
-        return false;
-    }
-
-
-
-    /**
-     *    payment_method_settings_meta_box
-     *
-     * @param NULL  $post_obj_which_is_null is an object containing the current post (as a $post object)
-     * @param array $metabox                is an array with metabox id, title, callback, and args elements. the value
-     *                                      at 'args' has key 'payment_method', as set within _payment_methods_list
-     * @return string
-     * @throws EE_Error
-     */
-    public function payment_method_settings_meta_box($post_obj_which_is_null, $metabox)
-    {
-        $payment_method = isset($metabox['args'], $metabox['args']['payment_method'])
-            ? $metabox['args']['payment_method'] : null;
-        if (! $payment_method instanceof EE_Payment_Method) {
-            throw new EE_Error(sprintf(__('Payment method metabox setup incorrectly. No Payment method object was supplied',
-                'event_espresso')));
-        }
-        $payment_method_scopes = $payment_method->active();
-        // if the payment method really exists show its form, otherwise the activation template
-        if ($payment_method->ID() && ! empty($payment_method_scopes)) {
-            $form = $this->_generate_payment_method_settings_form($payment_method);
-            if ($form->form_data_present_in($this->_req_data)) {
-                $form->receive_form_submission($this->_req_data);
-            }
-            echo $form->form_open() . $form->get_html_and_js() . $form->form_close();
-        } else {
-            echo $this->_activate_payment_method_button($payment_method)->get_html_and_js();
-        }
-    }
-
-
-
-    /**
-     * Gets the form for all the settings related to this payment method type
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_Proper
-     */
-    protected function _generate_payment_method_settings_form(EE_Payment_Method $payment_method)
-    {
-        if (! $payment_method instanceof EE_Payment_Method) {
-            return new EE_Form_Section_Proper();
-        }
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => $payment_method->slug() . '_settings_form',
-                'html_id'         => $payment_method->slug() . '_settings_form',
-                'action'          => EE_Admin_Page::add_query_args_and_nonce(
-                    array(
-                        'action'         => 'update_payment_method',
-                        'payment_method' => $payment_method->slug(),
-                    ),
-                    EE_PAYMENTS_ADMIN_URL
-                ),
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => apply_filters(
-                    'FHEE__Payments_Admin_Page___generate_payment_method_settings_form__form_subsections',
-                    array(
-                        'pci_dss_compliance'      => $this->_pci_dss_compliance($payment_method),
-                        'currency_support'        => $this->_currency_support($payment_method),
-                        'payment_method_settings' => $this->_payment_method_settings($payment_method),
-                        'update'                  => $this->_update_payment_method_button($payment_method),
-                        'deactivate'              => $this->_deactivate_payment_method_button($payment_method),
-                        'fine_print'              => $this->_fine_print(),
-                    ),
-                    $payment_method
-                ),
-            )
-        );
-    }
-
-
-
-    /**
-     * _pci_dss_compliance
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_Proper
-     */
-    protected function _pci_dss_compliance(EE_Payment_Method $payment_method)
-    {
-        if ($payment_method->type_obj()->requires_https()) {
-            return new EE_Form_Section_HTML(
-                EEH_HTML::tr(
-                    EEH_HTML::th(
-                        EEH_HTML::label(
-                            EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
-                        )
-                    ) .
-                    EEH_HTML::td(
-                        EEH_HTML::strong(__('You are responsible for your own website security and Payment Card Industry Data Security Standards (PCI DSS) compliance.',
-                            'event_espresso'))
-                        .
-                        EEH_HTML::br()
-                        .
-                        __('Learn more about ', 'event_espresso')
-                        . EEH_HTML::link('https://www.pcisecuritystandards.org/merchants/index.php',
-                            __('PCI DSS compliance', 'event_espresso'))
-                    )
-                )
-            );
-        } else {
-            return new EE_Form_Section_HTML('');
-        }
-    }
-
-
-
-    /**
-     * _currency_support
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_Proper
-     */
-    protected function _currency_support(EE_Payment_Method $payment_method)
-    {
-        if (! $payment_method->usable_for_currency(EE_Config::instance()->currency->code)) {
-            return new EE_Form_Section_HTML(
-                EEH_HTML::tr(
-                    EEH_HTML::th(
-                        EEH_HTML::label(
-                            EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
-                        )
-                    ) .
-                    EEH_HTML::td(
-                        EEH_HTML::strong(
-                            sprintf(
-                                __('This payment method does not support the currency set on your site (%1$s). Please activate a different payment method or change your site\'s country and associated currency.',
-                                    'event_espresso'),
-                                EE_Config::instance()->currency->code
-                            )
-                        )
-                    )
-                )
-            );
-        } else {
-            return new EE_Form_Section_HTML('');
-        }
-    }
-
-
-
-    /**
-     * _update_payment_method_button
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_HTML
-     */
-    protected function _payment_method_settings(EE_Payment_Method $payment_method)
-    {
-        //modify the form so we only have/show fields that will be implemented for this version
-        return $this->_simplify_form($payment_method->type_obj()->settings_form(), $payment_method->name());
-    }
-
-
-
-    /**
-     * Simplifies the form to merely reproduce 4.1's gateway settings functionality
-     *
-     * @param EE_Form_Section_Proper $form_section
-     * @param string                 $payment_method_name
-     * @return \EE_Payment_Method_Form
-     * @throws \EE_Error
-     */
-    protected function _simplify_form($form_section, $payment_method_name = '')
-    {
-        if ($form_section instanceof EE_Payment_Method_Form) {
-            $form_section->exclude(
-                array(
-                    'PMD_type', //dont want them changing the type
-                    'PMD_slug', //or the slug (probably never)
-                    'PMD_wp_user', //or the user's ID
-                    'Currency' //or the currency, until the rest of EE supports simultaneous currencies
-                )
-            );
-            return $form_section;
-        } else {
-            throw new EE_Error(sprintf(__('The EE_Payment_Method_Form for the "%1$s" payment method is missing or invalid.',
-                'event_espresso'), $payment_method_name));
-        }
-    }
-
-
-
-    /**
-     * _update_payment_method_button
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_HTML
-     */
-    protected function _update_payment_method_button(EE_Payment_Method $payment_method)
-    {
-        $update_button = new EE_Submit_Input(
-            array(
-                'name'       => 'submit',
-                'html_id'    => 'save_' . $payment_method->slug() . '_settings',
-                'default'    => sprintf(__('Update %s Payment Settings', 'event_espresso'),
-                    $payment_method->admin_name()),
-                'html_label' => EEH_HTML::nbsp(),
-            )
-        );
-        return new EE_Form_Section_HTML(
-            EEH_HTML::no_row(EEH_HTML::br(2)) .
-            EEH_HTML::tr(
-                EEH_HTML::th(__('Update Settings', 'event_espresso')) .
-                EEH_HTML::td(
-                    $update_button->get_html_for_input()
-                )
-            )
-        );
-    }
-
-
-
-    /**
-     * _deactivate_payment_method_button
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_Proper
-     */
-    protected function _deactivate_payment_method_button(EE_Payment_Method $payment_method)
-    {
-        $link_text_and_title = sprintf(__('Deactivate %1$s Payments?', 'event_espresso'),
-            $payment_method->admin_name());
-        return new EE_Form_Section_HTML(
-            EEH_HTML::tr(
-                EEH_HTML::th(__('Deactivate Payment Method', 'event_espresso')) .
-                EEH_HTML::td(
-                    EEH_HTML::link(
-                        EE_Admin_Page::add_query_args_and_nonce(
-                            array(
-                                'action'         => 'deactivate_payment_method',
-                                'payment_method' => $payment_method->slug(),
-                            ),
-                            EE_PAYMENTS_ADMIN_URL
-                        ),
-                        $link_text_and_title,
-                        $link_text_and_title,
-                        'deactivate_' . $payment_method->slug(),
-                        'espresso-button button-secondary'
-                    )
-                )
-            )
-        );
-    }
-
-
-
-    /**
-     * _activate_payment_method_button
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_Proper
-     */
-    protected function _activate_payment_method_button(EE_Payment_Method $payment_method)
-    {
-        $link_text_and_title = sprintf(__('Activate %1$s Payment Method?', 'event_espresso'),
-            $payment_method->admin_name());
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => 'activate_' . $payment_method->slug() . '_settings_form',
-                'html_id'         => 'activate_' . $payment_method->slug() . '_settings_form',
-                'action'          => '#',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => apply_filters(
-                    'FHEE__Payments_Admin_Page___activate_payment_method_button__form_subsections',
-                    array(
-                        new EE_Form_Section_HTML(
-                            EEH_HTML::tr(
-                                EEH_HTML::td($payment_method->type_obj()->introductory_html(),
-                                    '',
-                                    '',
-                                    '',
-                                    'colspan="2"'
-                                )
-                            ) .
-                            EEH_HTML::tr(
-                                EEH_HTML::th(
-                                    EEH_HTML::label(__('Click to Activate ', 'event_espresso'))
-                                ) .
-                                EEH_HTML::td(
-                                    EEH_HTML::link(
-                                        EE_Admin_Page::add_query_args_and_nonce(
-                                            array(
-                                                'action'              => 'activate_payment_method',
-                                                'payment_method_type' => $payment_method->type(),
-                                            ),
-                                            EE_PAYMENTS_ADMIN_URL
-                                        ),
-                                        $link_text_and_title,
-                                        $link_text_and_title,
-                                        'activate_' . $payment_method->slug(),
-                                        'espresso-button-green button-primary'
-                                    )
-                                )
-                            )
-                        ),
-                    ),
-                    $payment_method
-                ),
-            )
-        );
-    }
-
-
-
-    /**
-     * _fine_print
-     *
-     * @access protected
-     * @return \EE_Form_Section_HTML
-     */
-    protected function _fine_print()
-    {
-        return new EE_Form_Section_HTML(
-            EEH_HTML::tr(
-                EEH_HTML::th() .
-                EEH_HTML::td(
-                    EEH_HTML::p(__('All fields marked with a * are required fields', 'event_espresso'), '', 'grey-text')
-                )
-            )
-        );
-    }
-
-
-
-    /**
-     * Activates a payment method of that type. Mostly assuming there is only 1 of that type (or none so far)
-     *
-     * @global WP_User $current_user
-     */
-    protected function _activate_payment_method()
-    {
-        if (isset($this->_req_data['payment_method_type'])) {
-            $payment_method_type = sanitize_text_field($this->_req_data['payment_method_type']);
-            //see if one exists
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            $payment_method = EE_Payment_Method_Manager::instance()
-                                                       ->activate_a_payment_method_of_type($payment_method_type);
-            $this->_redirect_after_action(1, 'Payment Method', 'activated',
-                array('action' => 'default', 'payment_method' => $payment_method->slug()));
-        } else {
-            $this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default'));
-        }
-    }
-
-
-
-    /**
-     * Deactivates the payment method with the specified slug, and redirects.
-     */
-    protected function _deactivate_payment_method()
-    {
-        if (isset($this->_req_data['payment_method'])) {
-            $payment_method_slug = sanitize_key($this->_req_data['payment_method']);
-            //deactivate it
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            $count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method($payment_method_slug);
-            $this->_redirect_after_action($count_updated, 'Payment Method', 'deactivated',
-                array('action' => 'default', 'payment_method' => $payment_method_slug));
-        } else {
-            $this->_redirect_after_action(false, 'Payment Method', 'deactivated', array('action' => 'default'));
-        }
-    }
-
-
-
-    /**
-     * Processes the payment method form that was submitted. This is slightly trickier than usual form
-     * processing because we first need to identify WHICH form was processed and which payment method
-     * it corresponds to. Once we have done that, we see if the form is valid. If it is, the
-     * form's data is saved and we redirect to the default payment methods page, setting the updated payment method
-     * as the currently-selected one. If it DOESN'T validate, we render the page with the form's errors (in the
-     * subsequently called 'headers_sent_func' which is _payment_methods_list)
-     *
-     * @return void
-     */
-    protected function _update_payment_method()
-    {
-        if ($_SERVER['REQUEST_METHOD'] == 'POST') {
-            //ok let's find which gateway form to use based on the form input
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            /** @var $correct_pmt_form_to_use EE_Payment_Method_Form */
-            $correct_pmt_form_to_use = null;
-            $payment_method = null;
-            foreach (EEM_Payment_Method::instance()->get_all() as $payment_method) {
-                //get the form and simplify it, like what we do when we display it
-                $pmt_form = $this->_generate_payment_method_settings_form($payment_method);
-                if ($pmt_form->form_data_present_in($this->_req_data)) {
-                    $correct_pmt_form_to_use = $pmt_form;
-                    break;
-                }
-            }
-            //if we couldn't find the correct payment method type...
-            if (! $correct_pmt_form_to_use) {
-                EE_Error::add_error(__("We could not find which payment method type your form submission related to. Please contact support",
-                    'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
-                $this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default'));
-            }
-            $correct_pmt_form_to_use->receive_form_submission($this->_req_data);
-            if ($correct_pmt_form_to_use->is_valid()) {
-                $payment_settings_subform = $correct_pmt_form_to_use->get_subsection('payment_method_settings');
-                if (! $payment_settings_subform instanceof EE_Payment_Method_Form) {
-                    throw new EE_Error(
-                        sprintf(
-                            __('The payment method could not be saved because the form sections were misnamed. We expected to find %1$s, but did not.',
-                                'event_espresso'),
-                            'payment_method_settings'
-                        )
-                    );
-                }
-                $payment_settings_subform->save();
-                /** @var $pm EE_Payment_Method */
-                $this->_redirect_after_action(true, 'Payment Method', 'updated',
-                    array('action' => 'default', 'payment_method' => $payment_method->slug()));
-            } else {
-                EE_Error::add_error(
-                    sprintf(
-                        __('Payment method of type %s was not saved because there were validation errors. They have been marked in the form',
-                            'event_espresso'),
-                        $payment_method instanceof EE_PMT_Base ? $payment_method->pretty_name()
-                            : __('"(unknown)"', 'event_espresso')
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-        return;
-    }
-
-
-
-    protected function _payment_settings()
-    {
-        $this->_template_args['values'] = $this->_yes_no_values;
-        $this->_template_args['show_pending_payment_options'] = isset(EE_Registry::instance()->CFG->registration->show_pending_payment_options)
-            ? absint(EE_Registry::instance()->CFG->registration->show_pending_payment_options) : false;
-        $this->_set_add_edit_form_tags('update_payment_settings');
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(EE_PAYMENTS_TEMPLATE_PATH
-                                                                                     . 'payment_settings.template.php',
-            $this->_template_args, true);
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-
-    /**
-     *        _update_payment_settings
-     *
-     * @access protected
-     * @return array
-     */
-    protected function _update_payment_settings()
-    {
-        EE_Registry::instance()->CFG->registration->show_pending_payment_options = isset($this->_req_data['show_pending_payment_options'])
-            ? $this->_req_data['show_pending_payment_options'] : false;
-        EE_Registry::instance()->CFG = apply_filters('FHEE__Payments_Admin_Page___update_payment_settings__CFG',
-            EE_Registry::instance()->CFG);
+	/**
+	 * Variables used for when we're re-sorting the logs results, in case
+	 * we needed to do two queries and we need to resort
+	 *
+	 * @var string
+	 */
+	private $_sort_logs_again_direction;
+
+
+
+	/**
+	 * @Constructor
+	 * @access public
+	 * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
+	 * @return \Payments_Admin_Page
+	 */
+	public function __construct($routing = true)
+	{
+		parent::__construct($routing);
+	}
+
+
+
+	protected function _init_page_props()
+	{
+		$this->page_slug = EE_PAYMENTS_PG_SLUG;
+		$this->page_label = __('Payment Methods', 'event_espresso');
+		$this->_admin_base_url = EE_PAYMENTS_ADMIN_URL;
+		$this->_admin_base_path = EE_PAYMENTS_ADMIN;
+	}
+
+
+
+	protected function _ajax_hooks()
+	{
+		//todo: all hooks for ajax goes here.
+	}
+
+
+
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = $this->page_label;
+		$this->_labels = array(
+			'publishbox' => __('Update Settings', 'event_espresso'),
+		);
+	}
+
+
+
+	protected function _set_page_routes()
+	{
+		/**
+		 * note that with payment method capabilities, although we've implemented
+		 * capability mapping which will be used for accessing payment methods owned by
+		 * other users.  This is not fully implemented yet in the payment method ui.
+		 * Currently only the "plural" caps are in active use.
+		 * When cap mapping is implemented, some routes will need to use the singular form of
+		 * capability method and also include the $id of the payment method for the route.
+		 **/
+		$this->_page_routes = array(
+			'default'                   => array(
+				'func'       => '_payment_methods_list',
+				'capability' => 'ee_edit_payment_methods',
+			),
+			'payment_settings'          => array(
+				'func'       => '_payment_settings',
+				'capability' => 'ee_manage_gateways',
+			),
+			'activate_payment_method'   => array(
+				'func'       => '_activate_payment_method',
+				'noheader'   => true,
+				'capability' => 'ee_edit_payment_methods',
+			),
+			'deactivate_payment_method' => array(
+				'func'       => '_deactivate_payment_method',
+				'noheader'   => true,
+				'capability' => 'ee_delete_payment_methods',
+			),
+			'update_payment_method'     => array(
+				'func'               => '_update_payment_method',
+				'noheader'           => true,
+				'headers_sent_route' => 'default',
+				'capability'         => 'ee_edit_payment_methods',
+			),
+			'update_payment_settings'   => array(
+				'func'       => '_update_payment_settings',
+				'noheader'   => true,
+				'capability' => 'ee_manage_gateways',
+			),
+			'payment_log'               => array(
+				'func'       => '_payment_log_overview_list_table',
+				'capability' => 'ee_read_payment_methods',
+			),
+			'payment_log_details'       => array(
+				'func'       => '_payment_log_details',
+				'capability' => 'ee_read_payment_methods',
+			),
+		);
+	}
+
+
+
+	protected function _set_page_config()
+	{
+		$payment_method_list_config = array(
+			'nav'           => array(
+				'label' => __('Payment Methods', 'event_espresso'),
+				'order' => 10,
+			),
+			'metaboxes'     => $this->_default_espresso_metaboxes,
+			'help_tabs'     => array_merge(
+				array(
+					'payment_methods_overview_help_tab' => array(
+						'title'    => __('Payment Methods Overview', 'event_espresso'),
+						'filename' => 'payment_methods_overview',
+					),
+				),
+				$this->_add_payment_method_help_tabs()),
+			'help_tour'     => array('Payment_Methods_Selection_Help_Tour'),
+			'require_nonce' => false,
+		);
+		$this->_page_config = array(
+			'default'          => $payment_method_list_config,
+			'payment_settings' => array(
+				'nav'           => array(
+					'label' => __('Settings', 'event_espresso'),
+					'order' => 20,
+				),
+				'help_tabs'     => array(
+					'payment_methods_settings_help_tab' => array(
+						'title'    => __('Payment Method Settings', 'event_espresso'),
+						'filename' => 'payment_methods_settings',
+					),
+				),
+				//'help_tour' => array( 'Payment_Methods_Settings_Help_Tour' ),
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
+				'require_nonce' => false,
+			),
+			'payment_log'      => array(
+				'nav'           => array(
+					'label' => __("Logs", 'event_espresso'),
+					'order' => 30,
+				),
+				'list_table'    => 'Payment_Log_Admin_List_Table',
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'require_nonce' => false,
+			),
+		);
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	protected function _add_payment_method_help_tabs()
+	{
+		EE_Registry::instance()->load_lib('Payment_Method_Manager');
+		$payment_method_types = EE_Payment_Method_Manager::instance()->payment_method_types();
+		$all_pmt_help_tabs_config = array();
+		foreach ($payment_method_types as $payment_method_type) {
+			if (! EE_Registry::instance()->CAP->current_user_can($payment_method_type->cap_name(),
+				'specific_payment_method_type_access')
+			) {
+				continue;
+			}
+			foreach ($payment_method_type->help_tabs_config() as $help_tab_name => $config) {
+				$template_args = isset($config['template_args']) ? $config['template_args'] : array();
+				$template_args['admin_page_obj'] = $this;
+				$all_pmt_help_tabs_config[$help_tab_name] = array(
+					'title'   => $config['title'],
+					'content' => EEH_Template::display_template(
+						$payment_method_type->file_folder() . 'help_tabs' . DS . $config['filename'] . '.help_tab.php',
+						$template_args,
+						true),
+				);
+			}
+		}
+		return $all_pmt_help_tabs_config;
+	}
+
+
+
+	//none of the below group are currently used for Gateway Settings
+	protected function _add_screen_options()
+	{
+	}
+
+
+
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+
+	public function admin_init()
+	{
+	}
+
+
+
+	public function admin_notices()
+	{
+	}
+
+
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+
+	public function load_scripts_styles()
+	{
+		wp_enqueue_script('ee_admin_js');
+		wp_enqueue_script('ee-text-links');
+		wp_enqueue_script('espresso_payments', EE_PAYMENTS_ASSETS_URL . 'espresso_payments_admin.js',
+			array('espresso-ui-theme', 'ee-datepicker'), EVENT_ESPRESSO_VERSION, true);
+	}
+
+
+
+	public function load_scripts_styles_default()
+	{
+		//styles
+		wp_register_style('espresso_payments', EE_PAYMENTS_ASSETS_URL . 'ee-payments.css', array(),
+			EVENT_ESPRESSO_VERSION);
+		wp_enqueue_style('espresso_payments');
+		wp_enqueue_style('ee-text-links');
+		//scripts
+	}
+
+
+
+	protected function _payment_methods_list()
+	{
+		/**
+		 * first let's ensure payment methods have been setup. We do this here because when people activate a
+		 * payment method for the first time (as an addon), it may not setup its capabilities or get registered correctly due
+		 * to the loading process.  However, people MUST setup the details for the payment method so its safe to do a
+		 * recheck here.
+		 */
+		EE_Registry::instance()->load_lib('Payment_Method_Manager');
+		EEM_Payment_Method::instance()->verify_button_urls();
+		//setup tabs, one for each payment method type
+		$tabs = array();
+		$payment_methods = array();
+		foreach (EE_Payment_Method_Manager::instance()->payment_method_types() as $pmt_obj) {
+			// we don't want to show admin-only PMTs for now
+			if ($pmt_obj instanceof EE_PMT_Admin_Only) {
+				continue;
+			}
+			//check access
+			if (! EE_Registry::instance()->CAP->current_user_can($pmt_obj->cap_name(),
+				'specific_payment_method_type_access')
+			) {
+				continue;
+			}
+			//check for any active pms of that type
+			$payment_method = EEM_Payment_Method::instance()->get_one_of_type($pmt_obj->system_name());
+			if (! $payment_method instanceof EE_Payment_Method) {
+				$payment_method = EE_Payment_Method::new_instance(
+					array(
+						'PMD_slug'       => sanitize_key($pmt_obj->system_name()),
+						'PMD_type'       => $pmt_obj->system_name(),
+						'PMD_name'       => $pmt_obj->pretty_name(),
+						'PMD_admin_name' => $pmt_obj->pretty_name(),
+					)
+				);
+			}
+			$payment_methods[$payment_method->slug()] = $payment_method;
+		}
+		$payment_methods = apply_filters('FHEE__Payments_Admin_Page___payment_methods_list__payment_methods',
+			$payment_methods);
+		foreach ($payment_methods as $payment_method) {
+			if ($payment_method instanceof EE_Payment_Method) {
+				add_meta_box(
+				//html id
+					'espresso_' . $payment_method->slug() . '_payment_settings',
+					//title
+					sprintf(__('%s Settings', 'event_espresso'), $payment_method->admin_name()),
+					//callback
+					array($this, 'payment_method_settings_meta_box'),
+					//post type
+					null,
+					//context
+					'normal',
+					//priority
+					'default',
+					//callback args
+					array('payment_method' => $payment_method)
+				);
+				//setup for tabbed content
+				$tabs[$payment_method->slug()] = array(
+					'label' => $payment_method->admin_name(),
+					'class' => $payment_method->active() ? 'gateway-active' : '',
+					'href'  => 'espresso_' . $payment_method->slug() . '_payment_settings',
+					'title' => __('Modify this Payment Method', 'event_espresso'),
+					'slug'  => $payment_method->slug(),
+				);
+			}
+		}
+		$this->_template_args['admin_page_header'] = EEH_Tabbed_Content::tab_text_links($tabs, 'payment_method_links',
+			'|', $this->_get_active_payment_method_slug());
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+
+	/**
+	 *   _get_active_payment_method_slug
+	 *
+	 * @return string
+	 */
+	protected function _get_active_payment_method_slug()
+	{
+		$payment_method_slug = false;
+		//decide which payment method tab to open first, as dictated by the request's 'payment_method'
+		if (isset($this->_req_data['payment_method'])) {
+			// if they provided the current payment method, use it
+			$payment_method_slug = sanitize_key($this->_req_data['payment_method']);
+		}
+		$payment_method = EEM_Payment_Method::instance()->get_one(array(array('PMD_slug' => $payment_method_slug)));
+		// if that didn't work or wasn't provided, find another way to select the current pm
+		if (! $this->_verify_payment_method($payment_method)) {
+			// like, looking for an active one
+			$payment_method = EEM_Payment_Method::instance()->get_one_active('CART');
+			// test that one as well
+			if ($this->_verify_payment_method($payment_method)) {
+				$payment_method_slug = $payment_method->slug();
+			} else {
+				$payment_method_slug = 'paypal_standard';
+			}
+		}
+		return $payment_method_slug;
+	}
+
+
+
+	/**
+	 *    payment_method_settings_meta_box
+	 *    returns TRUE if the passed payment method is properly constructed and the logged in user has the correct
+	 *    capabilities to access it
+	 *
+	 * @param \EE_Payment_Method $payment_method
+	 * @return boolean
+	 */
+	protected function _verify_payment_method($payment_method)
+	{
+		if (
+			$payment_method instanceof EE_Payment_Method && $payment_method->type_obj() instanceof EE_PMT_Base
+			&& EE_Registry::instance()->CAP->current_user_can($payment_method->type_obj()->cap_name(),
+				'specific_payment_method_type_access')
+		) {
+			return true;
+		}
+		return false;
+	}
+
+
+
+	/**
+	 *    payment_method_settings_meta_box
+	 *
+	 * @param NULL  $post_obj_which_is_null is an object containing the current post (as a $post object)
+	 * @param array $metabox                is an array with metabox id, title, callback, and args elements. the value
+	 *                                      at 'args' has key 'payment_method', as set within _payment_methods_list
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function payment_method_settings_meta_box($post_obj_which_is_null, $metabox)
+	{
+		$payment_method = isset($metabox['args'], $metabox['args']['payment_method'])
+			? $metabox['args']['payment_method'] : null;
+		if (! $payment_method instanceof EE_Payment_Method) {
+			throw new EE_Error(sprintf(__('Payment method metabox setup incorrectly. No Payment method object was supplied',
+				'event_espresso')));
+		}
+		$payment_method_scopes = $payment_method->active();
+		// if the payment method really exists show its form, otherwise the activation template
+		if ($payment_method->ID() && ! empty($payment_method_scopes)) {
+			$form = $this->_generate_payment_method_settings_form($payment_method);
+			if ($form->form_data_present_in($this->_req_data)) {
+				$form->receive_form_submission($this->_req_data);
+			}
+			echo $form->form_open() . $form->get_html_and_js() . $form->form_close();
+		} else {
+			echo $this->_activate_payment_method_button($payment_method)->get_html_and_js();
+		}
+	}
+
+
+
+	/**
+	 * Gets the form for all the settings related to this payment method type
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return \EE_Form_Section_Proper
+	 */
+	protected function _generate_payment_method_settings_form(EE_Payment_Method $payment_method)
+	{
+		if (! $payment_method instanceof EE_Payment_Method) {
+			return new EE_Form_Section_Proper();
+		}
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => $payment_method->slug() . '_settings_form',
+				'html_id'         => $payment_method->slug() . '_settings_form',
+				'action'          => EE_Admin_Page::add_query_args_and_nonce(
+					array(
+						'action'         => 'update_payment_method',
+						'payment_method' => $payment_method->slug(),
+					),
+					EE_PAYMENTS_ADMIN_URL
+				),
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => apply_filters(
+					'FHEE__Payments_Admin_Page___generate_payment_method_settings_form__form_subsections',
+					array(
+						'pci_dss_compliance'      => $this->_pci_dss_compliance($payment_method),
+						'currency_support'        => $this->_currency_support($payment_method),
+						'payment_method_settings' => $this->_payment_method_settings($payment_method),
+						'update'                  => $this->_update_payment_method_button($payment_method),
+						'deactivate'              => $this->_deactivate_payment_method_button($payment_method),
+						'fine_print'              => $this->_fine_print(),
+					),
+					$payment_method
+				),
+			)
+		);
+	}
+
+
+
+	/**
+	 * _pci_dss_compliance
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return \EE_Form_Section_Proper
+	 */
+	protected function _pci_dss_compliance(EE_Payment_Method $payment_method)
+	{
+		if ($payment_method->type_obj()->requires_https()) {
+			return new EE_Form_Section_HTML(
+				EEH_HTML::tr(
+					EEH_HTML::th(
+						EEH_HTML::label(
+							EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
+						)
+					) .
+					EEH_HTML::td(
+						EEH_HTML::strong(__('You are responsible for your own website security and Payment Card Industry Data Security Standards (PCI DSS) compliance.',
+							'event_espresso'))
+						.
+						EEH_HTML::br()
+						.
+						__('Learn more about ', 'event_espresso')
+						. EEH_HTML::link('https://www.pcisecuritystandards.org/merchants/index.php',
+							__('PCI DSS compliance', 'event_espresso'))
+					)
+				)
+			);
+		} else {
+			return new EE_Form_Section_HTML('');
+		}
+	}
+
+
+
+	/**
+	 * _currency_support
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return \EE_Form_Section_Proper
+	 */
+	protected function _currency_support(EE_Payment_Method $payment_method)
+	{
+		if (! $payment_method->usable_for_currency(EE_Config::instance()->currency->code)) {
+			return new EE_Form_Section_HTML(
+				EEH_HTML::tr(
+					EEH_HTML::th(
+						EEH_HTML::label(
+							EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
+						)
+					) .
+					EEH_HTML::td(
+						EEH_HTML::strong(
+							sprintf(
+								__('This payment method does not support the currency set on your site (%1$s). Please activate a different payment method or change your site\'s country and associated currency.',
+									'event_espresso'),
+								EE_Config::instance()->currency->code
+							)
+						)
+					)
+				)
+			);
+		} else {
+			return new EE_Form_Section_HTML('');
+		}
+	}
+
+
+
+	/**
+	 * _update_payment_method_button
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return \EE_Form_Section_HTML
+	 */
+	protected function _payment_method_settings(EE_Payment_Method $payment_method)
+	{
+		//modify the form so we only have/show fields that will be implemented for this version
+		return $this->_simplify_form($payment_method->type_obj()->settings_form(), $payment_method->name());
+	}
+
+
+
+	/**
+	 * Simplifies the form to merely reproduce 4.1's gateway settings functionality
+	 *
+	 * @param EE_Form_Section_Proper $form_section
+	 * @param string                 $payment_method_name
+	 * @return \EE_Payment_Method_Form
+	 * @throws \EE_Error
+	 */
+	protected function _simplify_form($form_section, $payment_method_name = '')
+	{
+		if ($form_section instanceof EE_Payment_Method_Form) {
+			$form_section->exclude(
+				array(
+					'PMD_type', //dont want them changing the type
+					'PMD_slug', //or the slug (probably never)
+					'PMD_wp_user', //or the user's ID
+					'Currency' //or the currency, until the rest of EE supports simultaneous currencies
+				)
+			);
+			return $form_section;
+		} else {
+			throw new EE_Error(sprintf(__('The EE_Payment_Method_Form for the "%1$s" payment method is missing or invalid.',
+				'event_espresso'), $payment_method_name));
+		}
+	}
+
+
+
+	/**
+	 * _update_payment_method_button
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return \EE_Form_Section_HTML
+	 */
+	protected function _update_payment_method_button(EE_Payment_Method $payment_method)
+	{
+		$update_button = new EE_Submit_Input(
+			array(
+				'name'       => 'submit',
+				'html_id'    => 'save_' . $payment_method->slug() . '_settings',
+				'default'    => sprintf(__('Update %s Payment Settings', 'event_espresso'),
+					$payment_method->admin_name()),
+				'html_label' => EEH_HTML::nbsp(),
+			)
+		);
+		return new EE_Form_Section_HTML(
+			EEH_HTML::no_row(EEH_HTML::br(2)) .
+			EEH_HTML::tr(
+				EEH_HTML::th(__('Update Settings', 'event_espresso')) .
+				EEH_HTML::td(
+					$update_button->get_html_for_input()
+				)
+			)
+		);
+	}
+
+
+
+	/**
+	 * _deactivate_payment_method_button
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return \EE_Form_Section_Proper
+	 */
+	protected function _deactivate_payment_method_button(EE_Payment_Method $payment_method)
+	{
+		$link_text_and_title = sprintf(__('Deactivate %1$s Payments?', 'event_espresso'),
+			$payment_method->admin_name());
+		return new EE_Form_Section_HTML(
+			EEH_HTML::tr(
+				EEH_HTML::th(__('Deactivate Payment Method', 'event_espresso')) .
+				EEH_HTML::td(
+					EEH_HTML::link(
+						EE_Admin_Page::add_query_args_and_nonce(
+							array(
+								'action'         => 'deactivate_payment_method',
+								'payment_method' => $payment_method->slug(),
+							),
+							EE_PAYMENTS_ADMIN_URL
+						),
+						$link_text_and_title,
+						$link_text_and_title,
+						'deactivate_' . $payment_method->slug(),
+						'espresso-button button-secondary'
+					)
+				)
+			)
+		);
+	}
+
+
+
+	/**
+	 * _activate_payment_method_button
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return \EE_Form_Section_Proper
+	 */
+	protected function _activate_payment_method_button(EE_Payment_Method $payment_method)
+	{
+		$link_text_and_title = sprintf(__('Activate %1$s Payment Method?', 'event_espresso'),
+			$payment_method->admin_name());
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => 'activate_' . $payment_method->slug() . '_settings_form',
+				'html_id'         => 'activate_' . $payment_method->slug() . '_settings_form',
+				'action'          => '#',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => apply_filters(
+					'FHEE__Payments_Admin_Page___activate_payment_method_button__form_subsections',
+					array(
+						new EE_Form_Section_HTML(
+							EEH_HTML::tr(
+								EEH_HTML::td($payment_method->type_obj()->introductory_html(),
+									'',
+									'',
+									'',
+									'colspan="2"'
+								)
+							) .
+							EEH_HTML::tr(
+								EEH_HTML::th(
+									EEH_HTML::label(__('Click to Activate ', 'event_espresso'))
+								) .
+								EEH_HTML::td(
+									EEH_HTML::link(
+										EE_Admin_Page::add_query_args_and_nonce(
+											array(
+												'action'              => 'activate_payment_method',
+												'payment_method_type' => $payment_method->type(),
+											),
+											EE_PAYMENTS_ADMIN_URL
+										),
+										$link_text_and_title,
+										$link_text_and_title,
+										'activate_' . $payment_method->slug(),
+										'espresso-button-green button-primary'
+									)
+								)
+							)
+						),
+					),
+					$payment_method
+				),
+			)
+		);
+	}
+
+
+
+	/**
+	 * _fine_print
+	 *
+	 * @access protected
+	 * @return \EE_Form_Section_HTML
+	 */
+	protected function _fine_print()
+	{
+		return new EE_Form_Section_HTML(
+			EEH_HTML::tr(
+				EEH_HTML::th() .
+				EEH_HTML::td(
+					EEH_HTML::p(__('All fields marked with a * are required fields', 'event_espresso'), '', 'grey-text')
+				)
+			)
+		);
+	}
+
+
+
+	/**
+	 * Activates a payment method of that type. Mostly assuming there is only 1 of that type (or none so far)
+	 *
+	 * @global WP_User $current_user
+	 */
+	protected function _activate_payment_method()
+	{
+		if (isset($this->_req_data['payment_method_type'])) {
+			$payment_method_type = sanitize_text_field($this->_req_data['payment_method_type']);
+			//see if one exists
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			$payment_method = EE_Payment_Method_Manager::instance()
+													   ->activate_a_payment_method_of_type($payment_method_type);
+			$this->_redirect_after_action(1, 'Payment Method', 'activated',
+				array('action' => 'default', 'payment_method' => $payment_method->slug()));
+		} else {
+			$this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default'));
+		}
+	}
+
+
+
+	/**
+	 * Deactivates the payment method with the specified slug, and redirects.
+	 */
+	protected function _deactivate_payment_method()
+	{
+		if (isset($this->_req_data['payment_method'])) {
+			$payment_method_slug = sanitize_key($this->_req_data['payment_method']);
+			//deactivate it
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			$count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method($payment_method_slug);
+			$this->_redirect_after_action($count_updated, 'Payment Method', 'deactivated',
+				array('action' => 'default', 'payment_method' => $payment_method_slug));
+		} else {
+			$this->_redirect_after_action(false, 'Payment Method', 'deactivated', array('action' => 'default'));
+		}
+	}
+
+
+
+	/**
+	 * Processes the payment method form that was submitted. This is slightly trickier than usual form
+	 * processing because we first need to identify WHICH form was processed and which payment method
+	 * it corresponds to. Once we have done that, we see if the form is valid. If it is, the
+	 * form's data is saved and we redirect to the default payment methods page, setting the updated payment method
+	 * as the currently-selected one. If it DOESN'T validate, we render the page with the form's errors (in the
+	 * subsequently called 'headers_sent_func' which is _payment_methods_list)
+	 *
+	 * @return void
+	 */
+	protected function _update_payment_method()
+	{
+		if ($_SERVER['REQUEST_METHOD'] == 'POST') {
+			//ok let's find which gateway form to use based on the form input
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			/** @var $correct_pmt_form_to_use EE_Payment_Method_Form */
+			$correct_pmt_form_to_use = null;
+			$payment_method = null;
+			foreach (EEM_Payment_Method::instance()->get_all() as $payment_method) {
+				//get the form and simplify it, like what we do when we display it
+				$pmt_form = $this->_generate_payment_method_settings_form($payment_method);
+				if ($pmt_form->form_data_present_in($this->_req_data)) {
+					$correct_pmt_form_to_use = $pmt_form;
+					break;
+				}
+			}
+			//if we couldn't find the correct payment method type...
+			if (! $correct_pmt_form_to_use) {
+				EE_Error::add_error(__("We could not find which payment method type your form submission related to. Please contact support",
+					'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
+				$this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default'));
+			}
+			$correct_pmt_form_to_use->receive_form_submission($this->_req_data);
+			if ($correct_pmt_form_to_use->is_valid()) {
+				$payment_settings_subform = $correct_pmt_form_to_use->get_subsection('payment_method_settings');
+				if (! $payment_settings_subform instanceof EE_Payment_Method_Form) {
+					throw new EE_Error(
+						sprintf(
+							__('The payment method could not be saved because the form sections were misnamed. We expected to find %1$s, but did not.',
+								'event_espresso'),
+							'payment_method_settings'
+						)
+					);
+				}
+				$payment_settings_subform->save();
+				/** @var $pm EE_Payment_Method */
+				$this->_redirect_after_action(true, 'Payment Method', 'updated',
+					array('action' => 'default', 'payment_method' => $payment_method->slug()));
+			} else {
+				EE_Error::add_error(
+					sprintf(
+						__('Payment method of type %s was not saved because there were validation errors. They have been marked in the form',
+							'event_espresso'),
+						$payment_method instanceof EE_PMT_Base ? $payment_method->pretty_name()
+							: __('"(unknown)"', 'event_espresso')
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+		return;
+	}
+
+
+
+	protected function _payment_settings()
+	{
+		$this->_template_args['values'] = $this->_yes_no_values;
+		$this->_template_args['show_pending_payment_options'] = isset(EE_Registry::instance()->CFG->registration->show_pending_payment_options)
+			? absint(EE_Registry::instance()->CFG->registration->show_pending_payment_options) : false;
+		$this->_set_add_edit_form_tags('update_payment_settings');
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(EE_PAYMENTS_TEMPLATE_PATH
+																					 . 'payment_settings.template.php',
+			$this->_template_args, true);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+
+	/**
+	 *        _update_payment_settings
+	 *
+	 * @access protected
+	 * @return array
+	 */
+	protected function _update_payment_settings()
+	{
+		EE_Registry::instance()->CFG->registration->show_pending_payment_options = isset($this->_req_data['show_pending_payment_options'])
+			? $this->_req_data['show_pending_payment_options'] : false;
+		EE_Registry::instance()->CFG = apply_filters('FHEE__Payments_Admin_Page___update_payment_settings__CFG',
+			EE_Registry::instance()->CFG);
 //		 $superform = new EE_Form_Section_Proper(
 //		 	array(
 //		 		'subsections' => array(
@@ -876,176 +876,176 @@ 
 //		 	);
 //		 	$this->_redirect_after_action( 0, 'settings', 'updated', array( 'action' => 'payment_settings' ) );
 //		 }
-        $what = __('Payment Settings', 'event_espresso');
-        $success = $this->_update_espresso_configuration($what, EE_Registry::instance()->CFG, __FILE__, __FUNCTION__,
-            __LINE__);
-        $this->_redirect_after_action($success, $what, __('updated', 'event_espresso'),
-            array('action' => 'payment_settings'));
-    }
+		$what = __('Payment Settings', 'event_espresso');
+		$success = $this->_update_espresso_configuration($what, EE_Registry::instance()->CFG, __FILE__, __FUNCTION__,
+			__LINE__);
+		$this->_redirect_after_action($success, $what, __('updated', 'event_espresso'),
+			array('action' => 'payment_settings'));
+	}
 
 
 
-    protected function _payment_log_overview_list_table()
-    {
+	protected function _payment_log_overview_list_table()
+	{
 //		$this->_search_btn_label = __('Payment Log', 'event_espresso');
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-
-    protected function _set_list_table_views_payment_log()
-    {
-        $this->_views = array(
-            'all' => array(
-                'slug'  => 'all',
-                'label' => __('View All Logs', 'event_espresso'),
-                'count' => 0,
-            ),
-        );
-    }
-
-
-
-    /**
-     * @param int  $per_page
-     * @param int  $current_page
-     * @param bool $count
-     * @return array
-     */
-    public function get_payment_logs($per_page = 50, $current_page = 0, $count = false)
-    {
-        EE_Registry::instance()->load_model('Change_Log');
-        //we may need to do multiple queries (joining differently), so we actually wan tan array of query params
-        $query_params = array(array('LOG_type' => EEM_Change_Log::type_gateway));
-        //check if they've selected a specific payment method
-        if (isset($this->_req_data['_payment_method']) && $this->_req_data['_payment_method'] !== 'all') {
-            $query_params[0]['OR*pm_or_pay_pm'] = array(
-                'Payment.Payment_Method.PMD_ID' => $this->_req_data['_payment_method'],
-                'Payment_Method.PMD_ID'         => $this->_req_data['_payment_method'],
-            );
-        }
-        //take into account search
-        if (isset($this->_req_data['s']) && $this->_req_data['s']) {
-            $similarity_string = array('LIKE', '%' . str_replace("", "%", $this->_req_data['s']) . '%');
-            $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_fname'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_lname'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_email'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment.Payment_Method.PMD_name'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment.Payment_Method.PMD_admin_name'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment.Payment_Method.PMD_type'] = $similarity_string;
-            $query_params[0]['OR*s']['LOG_message'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment_Method.PMD_name'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment_Method.PMD_admin_name'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment_Method.PMD_type'] = $similarity_string;
-            $query_params[0]['OR*s']['LOG_message'] = $similarity_string;
-        }
-        if (isset($this->_req_data['payment-filter-start-date'])
-            && isset($this->_req_data['payment-filter-end-date'])
-        ) {
-            //add date
-            $start_date = wp_strip_all_tags($this->_req_data['payment-filter-start-date']);
-            $end_date = wp_strip_all_tags($this->_req_data['payment-filter-end-date']);
-            //make sure our timestamps start and end right at the boundaries for each day
-            $start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
-            $end_date = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
-            //convert to timestamps
-            $start_date = strtotime($start_date);
-            $end_date = strtotime($end_date);
-            //makes sure start date is the lowest value and vice versa
-            $start_date = min($start_date, $end_date);
-            $end_date = max($start_date, $end_date);
-            //convert for query
-            $start_date = EEM_Change_Log::instance()
-                                        ->convert_datetime_for_query('LOG_time', date('Y-m-d H:i:s', $start_date),
-                                            'Y-m-d H:i:s');
-            $end_date = EEM_Change_Log::instance()
-                                      ->convert_datetime_for_query('LOG_time', date('Y-m-d H:i:s', $end_date),
-                                          'Y-m-d H:i:s');
-            $query_params[0]['LOG_time'] = array('BETWEEN', array($start_date, $end_date));
-        }
-        if ($count) {
-            return EEM_Change_Log::instance()->count($query_params);
-        }
-        if (isset($this->_req_data['order'])) {
-            $sort = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order']
-                : 'DESC';
-            $query_params['order_by'] = array('LOG_time' => $sort);
-        } else {
-            $query_params['order_by'] = array('LOG_time' => 'DESC');
-        }
-        $offset = ($current_page - 1) * $per_page;
-        if (! isset($this->_req_data['download_results'])) {
-            $query_params['limit'] = array($offset, $per_page);
-        }
-        //now they've requested to instead just download the file instead of viewing it.
-        if (isset($this->_req_data['download_results'])) {
-            $wpdb_results = EEM_Change_Log::instance()->get_all_efficiently($query_params);
-            header('Content-Disposition: attachment');
-            header("Content-Disposition: attachment; filename=ee_payment_logs_for_" . sanitize_key(site_url()));
-            echo "<h1>Payment Logs for " . site_url() . "</h1>";
-            echo "<h3>Query:</h3>";
-            var_dump($query_params);
-            echo "<h3>Results:</h3>";
-            var_dump($wpdb_results);
-            die;
-        }
-        $results = EEM_Change_Log::instance()->get_all($query_params);
-        return $results;
-    }
-
-
-
-    /**
-     * Used by usort to RE-sort log query results, because we lose the ordering
-     * because we're possibly combining the results from two queries
-     *
-     * @param EE_Change_Log $logA
-     * @param EE_Change_Log $logB
-     * @return int
-     */
-    protected function _sort_logs_again($logA, $logB)
-    {
-        $timeA = $logA->get_raw('LOG_time');
-        $timeB = $logB->get_raw('LOG_time');
-        if ($timeA == $timeB) {
-            return 0;
-        }
-        $comparison = $timeA < $timeB ? -1 : 1;
-        if (strtoupper($this->_sort_logs_again_direction) == 'DESC') {
-            return $comparison * -1;
-        } else {
-            return $comparison;
-        }
-    }
-
-
-
-    protected function _payment_log_details()
-    {
-        EE_Registry::instance()->load_model('Change_Log');
-        /** @var $payment_log EE_Change_Log */
-        $payment_log = EEM_Change_Log::instance()->get_one_by_ID($this->_req_data['ID']);
-        $payment_method = null;
-        $transaction = null;
-        if ($payment_log instanceof EE_Change_Log) {
-            if ($payment_log->object() instanceof EE_Payment) {
-                $payment_method = $payment_log->object()->payment_method();
-                $transaction = $payment_log->object()->transaction();
-            } elseif ($payment_log->object() instanceof EE_Payment_Method) {
-                $payment_method = $payment_log->object();
-            }
-        }
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EE_PAYMENTS_TEMPLATE_PATH . 'payment_log_details.template.php',
-            array(
-                'payment_log'    => $payment_log,
-                'payment_method' => $payment_method,
-                'transaction'    => $transaction,
-            ),
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+
+	protected function _set_list_table_views_payment_log()
+	{
+		$this->_views = array(
+			'all' => array(
+				'slug'  => 'all',
+				'label' => __('View All Logs', 'event_espresso'),
+				'count' => 0,
+			),
+		);
+	}
+
+
+
+	/**
+	 * @param int  $per_page
+	 * @param int  $current_page
+	 * @param bool $count
+	 * @return array
+	 */
+	public function get_payment_logs($per_page = 50, $current_page = 0, $count = false)
+	{
+		EE_Registry::instance()->load_model('Change_Log');
+		//we may need to do multiple queries (joining differently), so we actually wan tan array of query params
+		$query_params = array(array('LOG_type' => EEM_Change_Log::type_gateway));
+		//check if they've selected a specific payment method
+		if (isset($this->_req_data['_payment_method']) && $this->_req_data['_payment_method'] !== 'all') {
+			$query_params[0]['OR*pm_or_pay_pm'] = array(
+				'Payment.Payment_Method.PMD_ID' => $this->_req_data['_payment_method'],
+				'Payment_Method.PMD_ID'         => $this->_req_data['_payment_method'],
+			);
+		}
+		//take into account search
+		if (isset($this->_req_data['s']) && $this->_req_data['s']) {
+			$similarity_string = array('LIKE', '%' . str_replace("", "%", $this->_req_data['s']) . '%');
+			$query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_fname'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_lname'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_email'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment.Payment_Method.PMD_name'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment.Payment_Method.PMD_admin_name'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment.Payment_Method.PMD_type'] = $similarity_string;
+			$query_params[0]['OR*s']['LOG_message'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment_Method.PMD_name'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment_Method.PMD_admin_name'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment_Method.PMD_type'] = $similarity_string;
+			$query_params[0]['OR*s']['LOG_message'] = $similarity_string;
+		}
+		if (isset($this->_req_data['payment-filter-start-date'])
+			&& isset($this->_req_data['payment-filter-end-date'])
+		) {
+			//add date
+			$start_date = wp_strip_all_tags($this->_req_data['payment-filter-start-date']);
+			$end_date = wp_strip_all_tags($this->_req_data['payment-filter-end-date']);
+			//make sure our timestamps start and end right at the boundaries for each day
+			$start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
+			$end_date = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
+			//convert to timestamps
+			$start_date = strtotime($start_date);
+			$end_date = strtotime($end_date);
+			//makes sure start date is the lowest value and vice versa
+			$start_date = min($start_date, $end_date);
+			$end_date = max($start_date, $end_date);
+			//convert for query
+			$start_date = EEM_Change_Log::instance()
+										->convert_datetime_for_query('LOG_time', date('Y-m-d H:i:s', $start_date),
+											'Y-m-d H:i:s');
+			$end_date = EEM_Change_Log::instance()
+									  ->convert_datetime_for_query('LOG_time', date('Y-m-d H:i:s', $end_date),
+										  'Y-m-d H:i:s');
+			$query_params[0]['LOG_time'] = array('BETWEEN', array($start_date, $end_date));
+		}
+		if ($count) {
+			return EEM_Change_Log::instance()->count($query_params);
+		}
+		if (isset($this->_req_data['order'])) {
+			$sort = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order']
+				: 'DESC';
+			$query_params['order_by'] = array('LOG_time' => $sort);
+		} else {
+			$query_params['order_by'] = array('LOG_time' => 'DESC');
+		}
+		$offset = ($current_page - 1) * $per_page;
+		if (! isset($this->_req_data['download_results'])) {
+			$query_params['limit'] = array($offset, $per_page);
+		}
+		//now they've requested to instead just download the file instead of viewing it.
+		if (isset($this->_req_data['download_results'])) {
+			$wpdb_results = EEM_Change_Log::instance()->get_all_efficiently($query_params);
+			header('Content-Disposition: attachment');
+			header("Content-Disposition: attachment; filename=ee_payment_logs_for_" . sanitize_key(site_url()));
+			echo "<h1>Payment Logs for " . site_url() . "</h1>";
+			echo "<h3>Query:</h3>";
+			var_dump($query_params);
+			echo "<h3>Results:</h3>";
+			var_dump($wpdb_results);
+			die;
+		}
+		$results = EEM_Change_Log::instance()->get_all($query_params);
+		return $results;
+	}
+
+
+
+	/**
+	 * Used by usort to RE-sort log query results, because we lose the ordering
+	 * because we're possibly combining the results from two queries
+	 *
+	 * @param EE_Change_Log $logA
+	 * @param EE_Change_Log $logB
+	 * @return int
+	 */
+	protected function _sort_logs_again($logA, $logB)
+	{
+		$timeA = $logA->get_raw('LOG_time');
+		$timeB = $logB->get_raw('LOG_time');
+		if ($timeA == $timeB) {
+			return 0;
+		}
+		$comparison = $timeA < $timeB ? -1 : 1;
+		if (strtoupper($this->_sort_logs_again_direction) == 'DESC') {
+			return $comparison * -1;
+		} else {
+			return $comparison;
+		}
+	}
+
+
+
+	protected function _payment_log_details()
+	{
+		EE_Registry::instance()->load_model('Change_Log');
+		/** @var $payment_log EE_Change_Log */
+		$payment_log = EEM_Change_Log::instance()->get_one_by_ID($this->_req_data['ID']);
+		$payment_method = null;
+		$transaction = null;
+		if ($payment_log instanceof EE_Change_Log) {
+			if ($payment_log->object() instanceof EE_Payment) {
+				$payment_method = $payment_log->object()->payment_method();
+				$transaction = $payment_log->object()->transaction();
+			} elseif ($payment_log->object() instanceof EE_Payment_Method) {
+				$payment_method = $payment_log->object();
+			}
+		}
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			EE_PAYMENTS_TEMPLATE_PATH . 'payment_log_details.template.php',
+			array(
+				'payment_log'    => $payment_log,
+				'payment_method' => $payment_method,
+				'transaction'    => $transaction,
+			),
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
 
 
 } //end Payments_Admin_Page class

Spacing +38 added lines, -38 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('NO direct script access allowed');
 }
 
@@ -189,7 +189,7 @@ 
         $payment_method_types = EE_Payment_Method_Manager::instance()->payment_method_types();
         $all_pmt_help_tabs_config = array();
         foreach ($payment_method_types as $payment_method_type) {
-            if (! EE_Registry::instance()->CAP->current_user_can($payment_method_type->cap_name(),
+            if ( ! EE_Registry::instance()->CAP->current_user_can($payment_method_type->cap_name(),
                 'specific_payment_method_type_access')
             ) {
                 continue;
@@ -200,7 +200,7 @@ 
                 $all_pmt_help_tabs_config[$help_tab_name] = array(
                     'title'   => $config['title'],
                     'content' => EEH_Template::display_template(
-                        $payment_method_type->file_folder() . 'help_tabs' . DS . $config['filename'] . '.help_tab.php',
+                        $payment_method_type->file_folder().'help_tabs'.DS.$config['filename'].'.help_tab.php',
                         $template_args,
                         true),
                 );
@@ -246,7 +246,7 @@ 
     {
         wp_enqueue_script('ee_admin_js');
         wp_enqueue_script('ee-text-links');
-        wp_enqueue_script('espresso_payments', EE_PAYMENTS_ASSETS_URL . 'espresso_payments_admin.js',
+        wp_enqueue_script('espresso_payments', EE_PAYMENTS_ASSETS_URL.'espresso_payments_admin.js',
             array('espresso-ui-theme', 'ee-datepicker'), EVENT_ESPRESSO_VERSION, true);
     }
 
@@ -255,7 +255,7 @@ 
     public function load_scripts_styles_default()
     {
         //styles
-        wp_register_style('espresso_payments', EE_PAYMENTS_ASSETS_URL . 'ee-payments.css', array(),
+        wp_register_style('espresso_payments', EE_PAYMENTS_ASSETS_URL.'ee-payments.css', array(),
             EVENT_ESPRESSO_VERSION);
         wp_enqueue_style('espresso_payments');
         wp_enqueue_style('ee-text-links');
@@ -283,14 +283,14 @@ 
                 continue;
             }
             //check access
-            if (! EE_Registry::instance()->CAP->current_user_can($pmt_obj->cap_name(),
+            if ( ! EE_Registry::instance()->CAP->current_user_can($pmt_obj->cap_name(),
                 'specific_payment_method_type_access')
             ) {
                 continue;
             }
             //check for any active pms of that type
             $payment_method = EEM_Payment_Method::instance()->get_one_of_type($pmt_obj->system_name());
-            if (! $payment_method instanceof EE_Payment_Method) {
+            if ( ! $payment_method instanceof EE_Payment_Method) {
                 $payment_method = EE_Payment_Method::new_instance(
                     array(
                         'PMD_slug'       => sanitize_key($pmt_obj->system_name()),
@@ -308,7 +308,7 @@ 
             if ($payment_method instanceof EE_Payment_Method) {
                 add_meta_box(
                 //html id
-                    'espresso_' . $payment_method->slug() . '_payment_settings',
+                    'espresso_'.$payment_method->slug().'_payment_settings',
                     //title
                     sprintf(__('%s Settings', 'event_espresso'), $payment_method->admin_name()),
                     //callback
@@ -326,7 +326,7 @@ 
                 $tabs[$payment_method->slug()] = array(
                     'label' => $payment_method->admin_name(),
                     'class' => $payment_method->active() ? 'gateway-active' : '',
-                    'href'  => 'espresso_' . $payment_method->slug() . '_payment_settings',
+                    'href'  => 'espresso_'.$payment_method->slug().'_payment_settings',
                     'title' => __('Modify this Payment Method', 'event_espresso'),
                     'slug'  => $payment_method->slug(),
                 );
@@ -354,7 +354,7 @@ 
         }
         $payment_method = EEM_Payment_Method::instance()->get_one(array(array('PMD_slug' => $payment_method_slug)));
         // if that didn't work or wasn't provided, find another way to select the current pm
-        if (! $this->_verify_payment_method($payment_method)) {
+        if ( ! $this->_verify_payment_method($payment_method)) {
             // like, looking for an active one
             $payment_method = EEM_Payment_Method::instance()->get_one_active('CART');
             // test that one as well
@@ -404,7 +404,7 @@ 
     {
         $payment_method = isset($metabox['args'], $metabox['args']['payment_method'])
             ? $metabox['args']['payment_method'] : null;
-        if (! $payment_method instanceof EE_Payment_Method) {
+        if ( ! $payment_method instanceof EE_Payment_Method) {
             throw new EE_Error(sprintf(__('Payment method metabox setup incorrectly. No Payment method object was supplied',
                 'event_espresso')));
         }
@@ -415,7 +415,7 @@ 
             if ($form->form_data_present_in($this->_req_data)) {
                 $form->receive_form_submission($this->_req_data);
             }
-            echo $form->form_open() . $form->get_html_and_js() . $form->form_close();
+            echo $form->form_open().$form->get_html_and_js().$form->form_close();
         } else {
             echo $this->_activate_payment_method_button($payment_method)->get_html_and_js();
         }
@@ -432,13 +432,13 @@ 
      */
     protected function _generate_payment_method_settings_form(EE_Payment_Method $payment_method)
     {
-        if (! $payment_method instanceof EE_Payment_Method) {
+        if ( ! $payment_method instanceof EE_Payment_Method) {
             return new EE_Form_Section_Proper();
         }
         return new EE_Form_Section_Proper(
             array(
-                'name'            => $payment_method->slug() . '_settings_form',
-                'html_id'         => $payment_method->slug() . '_settings_form',
+                'name'            => $payment_method->slug().'_settings_form',
+                'html_id'         => $payment_method->slug().'_settings_form',
                 'action'          => EE_Admin_Page::add_query_args_and_nonce(
                     array(
                         'action'         => 'update_payment_method',
@@ -481,7 +481,7 @@ 
                         EEH_HTML::label(
                             EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
                         )
-                    ) .
+                    ).
                     EEH_HTML::td(
                         EEH_HTML::strong(__('You are responsible for your own website security and Payment Card Industry Data Security Standards (PCI DSS) compliance.',
                             'event_espresso'))
@@ -510,14 +510,14 @@ 
      */
     protected function _currency_support(EE_Payment_Method $payment_method)
     {
-        if (! $payment_method->usable_for_currency(EE_Config::instance()->currency->code)) {
+        if ( ! $payment_method->usable_for_currency(EE_Config::instance()->currency->code)) {
             return new EE_Form_Section_HTML(
                 EEH_HTML::tr(
                     EEH_HTML::th(
                         EEH_HTML::label(
                             EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
                         )
-                    ) .
+                    ).
                     EEH_HTML::td(
                         EEH_HTML::strong(
                             sprintf(
@@ -591,16 +591,16 @@ 
         $update_button = new EE_Submit_Input(
             array(
                 'name'       => 'submit',
-                'html_id'    => 'save_' . $payment_method->slug() . '_settings',
+                'html_id'    => 'save_'.$payment_method->slug().'_settings',
                 'default'    => sprintf(__('Update %s Payment Settings', 'event_espresso'),
                     $payment_method->admin_name()),
                 'html_label' => EEH_HTML::nbsp(),
             )
         );
         return new EE_Form_Section_HTML(
-            EEH_HTML::no_row(EEH_HTML::br(2)) .
+            EEH_HTML::no_row(EEH_HTML::br(2)).
             EEH_HTML::tr(
-                EEH_HTML::th(__('Update Settings', 'event_espresso')) .
+                EEH_HTML::th(__('Update Settings', 'event_espresso')).
                 EEH_HTML::td(
                     $update_button->get_html_for_input()
                 )
@@ -623,7 +623,7 @@ 
             $payment_method->admin_name());
         return new EE_Form_Section_HTML(
             EEH_HTML::tr(
-                EEH_HTML::th(__('Deactivate Payment Method', 'event_espresso')) .
+                EEH_HTML::th(__('Deactivate Payment Method', 'event_espresso')).
                 EEH_HTML::td(
                     EEH_HTML::link(
                         EE_Admin_Page::add_query_args_and_nonce(
@@ -635,7 +635,7 @@ 
                         ),
                         $link_text_and_title,
                         $link_text_and_title,
-                        'deactivate_' . $payment_method->slug(),
+                        'deactivate_'.$payment_method->slug(),
                         'espresso-button button-secondary'
                     )
                 )
@@ -658,8 +658,8 @@ 
             $payment_method->admin_name());
         return new EE_Form_Section_Proper(
             array(
-                'name'            => 'activate_' . $payment_method->slug() . '_settings_form',
-                'html_id'         => 'activate_' . $payment_method->slug() . '_settings_form',
+                'name'            => 'activate_'.$payment_method->slug().'_settings_form',
+                'html_id'         => 'activate_'.$payment_method->slug().'_settings_form',
                 'action'          => '#',
                 'layout_strategy' => new EE_Admin_Two_Column_Layout(),
                 'subsections'     => apply_filters(
@@ -673,11 +673,11 @@ 
                                     '',
                                     'colspan="2"'
                                 )
-                            ) .
+                            ).
                             EEH_HTML::tr(
                                 EEH_HTML::th(
                                     EEH_HTML::label(__('Click to Activate ', 'event_espresso'))
-                                ) .
+                                ).
                                 EEH_HTML::td(
                                     EEH_HTML::link(
                                         EE_Admin_Page::add_query_args_and_nonce(
@@ -689,7 +689,7 @@ 
                                         ),
                                         $link_text_and_title,
                                         $link_text_and_title,
-                                        'activate_' . $payment_method->slug(),
+                                        'activate_'.$payment_method->slug(),
                                         'espresso-button-green button-primary'
                                     )
                                 )
@@ -714,7 +714,7 @@ 
     {
         return new EE_Form_Section_HTML(
             EEH_HTML::tr(
-                EEH_HTML::th() .
+                EEH_HTML::th().
                 EEH_HTML::td(
                     EEH_HTML::p(__('All fields marked with a * are required fields', 'event_espresso'), '', 'grey-text')
                 )
@@ -792,7 +792,7 @@ 
                 }
             }
             //if we couldn't find the correct payment method type...
-            if (! $correct_pmt_form_to_use) {
+            if ( ! $correct_pmt_form_to_use) {
                 EE_Error::add_error(__("We could not find which payment method type your form submission related to. Please contact support",
                     'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
                 $this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default'));
@@ -800,7 +800,7 @@ 
             $correct_pmt_form_to_use->receive_form_submission($this->_req_data);
             if ($correct_pmt_form_to_use->is_valid()) {
                 $payment_settings_subform = $correct_pmt_form_to_use->get_subsection('payment_method_settings');
-                if (! $payment_settings_subform instanceof EE_Payment_Method_Form) {
+                if ( ! $payment_settings_subform instanceof EE_Payment_Method_Form) {
                     throw new EE_Error(
                         sprintf(
                             __('The payment method could not be saved because the form sections were misnamed. We expected to find %1$s, but did not.',
@@ -926,7 +926,7 @@ 
         }
         //take into account search
         if (isset($this->_req_data['s']) && $this->_req_data['s']) {
-            $similarity_string = array('LIKE', '%' . str_replace("", "%", $this->_req_data['s']) . '%');
+            $similarity_string = array('LIKE', '%'.str_replace("", "%", $this->_req_data['s']).'%');
             $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_fname'] = $similarity_string;
             $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_lname'] = $similarity_string;
             $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_email'] = $similarity_string;
@@ -946,8 +946,8 @@ 
             $start_date = wp_strip_all_tags($this->_req_data['payment-filter-start-date']);
             $end_date = wp_strip_all_tags($this->_req_data['payment-filter-end-date']);
             //make sure our timestamps start and end right at the boundaries for each day
-            $start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
-            $end_date = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
+            $start_date = date('Y-m-d', strtotime($start_date)).' 00:00:00';
+            $end_date = date('Y-m-d', strtotime($end_date)).' 23:59:59';
             //convert to timestamps
             $start_date = strtotime($start_date);
             $end_date = strtotime($end_date);
@@ -974,15 +974,15 @@ 
             $query_params['order_by'] = array('LOG_time' => 'DESC');
         }
         $offset = ($current_page - 1) * $per_page;
-        if (! isset($this->_req_data['download_results'])) {
+        if ( ! isset($this->_req_data['download_results'])) {
             $query_params['limit'] = array($offset, $per_page);
         }
         //now they've requested to instead just download the file instead of viewing it.
         if (isset($this->_req_data['download_results'])) {
             $wpdb_results = EEM_Change_Log::instance()->get_all_efficiently($query_params);
             header('Content-Disposition: attachment');
-            header("Content-Disposition: attachment; filename=ee_payment_logs_for_" . sanitize_key(site_url()));
-            echo "<h1>Payment Logs for " . site_url() . "</h1>";
+            header("Content-Disposition: attachment; filename=ee_payment_logs_for_".sanitize_key(site_url()));
+            echo "<h1>Payment Logs for ".site_url()."</h1>";
             echo "<h3>Query:</h3>";
             var_dump($query_params);
             echo "<h3>Results:</h3>";
@@ -1036,7 +1036,7 @@ 
             }
         }
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EE_PAYMENTS_TEMPLATE_PATH . 'payment_log_details.template.php',
+            EE_PAYMENTS_TEMPLATE_PATH.'payment_log_details.template.php',
             array(
                 'payment_log'    => $payment_log,
                 'payment_method' => $payment_method,

core/libraries/form_sections/base/EE_Model_Form_Section.form.php

Indentation +433 added lines, -433 removed lines

@@ -14,439 +14,439 @@
 class EE_Model_Form_Section extends EE_Form_Section_Proper
 {
 
-    /**
-     * @var EEM_Base
-     */
-    protected $_model = null;
-
-    /**
-     * @var EE_Base_Class
-     */
-    protected $_model_object = null;
-
-
-
-    /**
-     * @param array        $options_array   keys: {
-     * @type EEM_Base      $model
-     * @type EE_Base_Class $model_object
-     * @type array         $subsection_args array keys should be subsection names (that either do or will exist), and
-     *       values are the arrays as you would pass them to that subsection
-     *                                      }
-     * @throws EE_Error
-     */
-    public function __construct($options_array = array())
-    {
-        if (isset($options_array['model']) && $options_array['model'] instanceof EEM_Base) {
-            $this->_model = $options_array['model'];
-        }
-        if (! $this->_model || ! $this->_model instanceof EEM_Base) {
-            throw new EE_Error(sprintf(__("Model Form Sections must first specify the _model property to be a subclass of EEM_Base",
-                "event_espresso")));
-        }
-        if (isset($options_array['subsection_args'])) {
-            $subsection_args = $options_array['subsection_args'];
-        } else {
-            $subsection_args = array();
-        }
-        //gather fields and relations to convert to inputs
-        //but if they're just going to exclude a field anyways, don't bother converting it to an input
-        $exclude = $this->_subsections;
-        if (isset($options_array['exclude'])) {
-            $exclude = array_merge($exclude, array_flip($options_array['exclude']));
-        }
-        $model_fields = array_diff_key($this->_model->field_settings(), $exclude);
-        $model_relations = array_diff_key($this->_model->relation_settings(), $exclude);
-        //convert fields and relations to inputs
-        $this->_subsections = array_merge(
-            $this->_convert_model_fields_to_inputs($model_fields),
-            $this->_convert_model_relations_to_inputs($model_relations, $subsection_args),
-            $this->_subsections
-        );
-        parent::__construct($options_array);
-        if (isset($options_array['model_object']) && $options_array['model_object'] instanceof EE_Base_Class) {
-            $this->populate_model_obj($options_array['model_object']);
-        }
-    }
-
-
-
-    /**
-     * For now, just makes inputs for only HABTM relations
-     *
-     * @param EE_Model_Relation_Base[] $relations
-     * @param array                    $subsection_args keys should be existing or soon-to-be-existing input names, and
-     *                                                  their values are {
-     * @type array {
-     * @type EE_Base_Class[]           $model_objects   if the subsection is an EE_Select_Multi_Model_Input
-     *                                                  }
-     *                                                  }
-     * @return array
-     */
-    protected function _convert_model_relations_to_inputs($relations, $subsection_args = array())
-    {
-        $inputs = array();
-        foreach ($relations as $relation_name => $relation_obj) {
-            $input_constructor_args = array(
-                array_merge(
-                    array(
-                        'required'        => $relation_obj instanceof EE_Belongs_To_Relation,
-                        'html_label_text' => $relation_obj instanceof EE_Belongs_To_Relation
-                            ? $relation_obj->get_other_model()->item_name(1)
-                            : $relation_obj->get_other_model()
-                                           ->item_name(2),
-                    ),
-                    $subsection_args
-                ),
-            );
-            $input = null;
-            switch (get_class($relation_obj)) {
-                case 'EE_HABTM_Relation':
-                    if (isset($subsection_args[$relation_name])
-                        && isset($subsection_args[$relation_name]['model_objects'])
-                    ) {
-                        $model_objects = $subsection_args[$relation_name]['model_objects'];
-                    } else {
-                        $model_objects = $relation_obj->get_other_model()->get_all();
-                    }
-                    $input = new EE_Select_Multi_Model_Input($model_objects, $input_constructor_args);
-                    break;
-                default:
-            }
-            if ($input) {
-                $inputs[$relation_name] = $input;
-            }
-        }
-        return $inputs;
-    }
-
-
-
-    /**
-     * Changes model fields into form section inputs
-     *
-     * @param EE_Model_Field_Base[] $model_fields keys are the model's name
-     * @throws EE_Error
-     * @return EE_Form_Input_Base[]
-     */
-    protected function _convert_model_fields_to_inputs($model_fields = array())
-    {
-        $inputs = array();
-        foreach ($model_fields as $field_name => $model_field) {
-            if ($model_field instanceof EE_Model_Field_Base) {
-                $input_constructor_args = array(
-                    array(
-                        'required'        => ! $model_field->is_nullable()
-                                             && $model_field->get_default_value()
-                                                === null,
-                        'html_label_text' => $model_field->get_nicename(),
-                        'default'         => $model_field->get_default_value(),
-                    ),
-                );
-                switch (get_class($model_field)) {
-                    case 'EE_All_Caps_Text_Field':
-                    case 'EE_Any_Foreign_Model_Name_Field':
-                        $input_class = 'EE_Text_Input';
-                        break;
-                    case 'EE_Boolean_Field':
-                        $input_class = 'EE_Yes_No_Input';
-                        break;
-                    case 'EE_Datetime_Field':
-                        throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"), get_class($model_field)));
-                        break;
-                    case 'EE_Email_Field':
-                        $input_class = 'EE_Email_Input';
-                        break;
-                    case 'EE_Enum_Integer_Field':
-                        throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"), get_class($model_field)));
-                        break;
-                    case 'EE_Enum_Text_Field':
-                        throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"), get_class($model_field)));
-                        break;
-                    case 'EE_Float_Field':
-                        $input_class = 'EE_Float_Input';
-                        break;
-                    case 'EE_Foreign_Key_Int_Field':
-                    case 'EE_Foreign_Key_String_Field':
-                    case 'EE_WP_User_Field':
-                        $models_pointed_to = $model_field instanceof EE_Field_With_Model_Name
-                            ? $model_field->get_model_class_names_pointed_to() : array();
-                        if (true || is_array($models_pointed_to) && count($models_pointed_to) > 1) {
-                            $input_class = 'EE_Text_Input';
-                        } else {
-                            //so its just one model
-                            $model_name = is_array($models_pointed_to) ? reset($models_pointed_to) : $models_pointed_to;
-                            $model = EE_Registry::instance()->load_model($model_name);
-                            $model_names = $model->get_all_names(array('limit' => 10));
-                            if ($model_field->is_nullable()) {
-                                array_unshift($model_names, __("Please Select", 'event_espresso'));
-                            }
-                            $input_constructor_args[1] = $input_constructor_args[0];
-                            $input_constructor_args[0] = $model_names;
-                            $input_class = 'EE_Select_Input';
-                        }
-                        break;
-                    case 'EE_Full_HTML_Field':
-                        $input_class = 'EE_Text_Area_Input';
-                        $input_constructor_args[0]['validation_strategies'] = array(new EE_Full_HTML_Validation_Strategy());
-                        break;
-                    case 'EE_Infinite_Integer':
-                        throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"), get_class($model_field)));
-                        break;
-                    case 'EE_Integer_Field':
-                        $input_class = 'EE_Text_Input';
-                        break;
-                    case 'EE_Maybe_Serialized_Text_Field':
-                        $input_class = 'EE_Text_Area_Input';
-                        break;
-                    case 'EE_Money_Field':
-                        throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"), get_class($model_field)));
-                        break;
-                    case 'EE_Post_Content_Field':
-                        $input_class = 'EE_Text_Area_Input';
-                        $input_constructor_args[0]['validation_strategies'] = array(new EE_Full_HTML_Validation_Strategy());
-                        break;
-                    case 'EE_Plain_Text_Field':
-                        $input_class = 'EE_Text_Input';
-                        break;
-                    case 'EE_Primary_Key_Int_Field':
-                        $input_class = 'EE_Hidden_Input';
-                        $input_constructor_args['normalization_strategy'] = new EE_Int_Normalization();
-                        break;
-                    case 'EE_Primary_Key_String_Field':
-                        $input_class = 'EE_Hidden_Input';
-                        break;
-                    case 'EE_Serialized_Text_Field':
-                        $input_class = 'EE_Text_Area_Input';
-                        break;
-                    case 'EE_Simple_HTML_Field':
-                        $input_class = 'EE_Text_Area_Input';
-                        $input_constructor_args[0]['validation_strategies'] = array(new EE_Simple_HTML_Validation_Strategy());
-                        break;
-                    case 'EE_Slug_Field':
-                        $input_class = 'EE_Text_Input';
-                        break;
-                    case 'EE_Trashed_Flag_Field':
-                        $input_class = 'EE_Yes_No_Input';
-                        break;
-                    case 'EE_WP_Post_Status_Field':
-                        throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"), get_class($model_field)));
-                        break;
-                    case 'EE_WP_Post_Type_Field':
-                        throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"), get_class($model_field)));
-                        break;
-                    default:
-                        throw new EE_Error(sprintf(__("Model field of type '%s' does not convert to any known Form Input. Please add a case to EE_Model_Form_section's _convert_model_fields_to_inputs switch statement",
-                            "event_espresso"), get_class($model_field)));
-                }
-                $reflection = new ReflectionClass($input_class);
-                $input = $reflection->newInstanceArgs($input_constructor_args);
-                $inputs[$field_name] = $input;
-            }
-        }
-        return $inputs;
-    }
-
-
-
-    /**
-     * Mostly the same as populate_defaults , except takes a model object as input, not an array,
-     * and also sets the form's _model_object
-     *
-     * @param EE_Base_Class $model_obj
-     * @return void
-     */
-    public function populate_model_obj($model_obj)
-    {
-        $model_obj = $this->_model->ensure_is_obj($model_obj);
-        $this->_model_object = $model_obj;
-        $defaults = $model_obj->model_field_array();
-        foreach ($this->_model->relation_settings() as $relation_name => $relation_obj) {
-            $subsection = $this->get_subsection($relation_name, false);
-            if ($subsection instanceof EE_Form_Input_Base) {
-                if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                    //then we only expect there to be one
-                    $related_item = $this->_model_object->get_first_related($relation_name);
-                    $defaults[$relation_name] = $related_item->ID();
-                } else {
-                    $related_items = $this->_model_object->get_many_related($relation_name);
-                    $ids = array();
-                    foreach ($related_items as $related_item) {
-                        $ids[] = $related_item->ID();
-                    }
-                    $defaults[$relation_name] = $ids;
-                }
-            }
-        }
-        $defaults = apply_filters(
-            'FHEE__EE_Model_Form_Section__populate_model_obj',
-            $defaults,
-            $this
-        );
-        $this->populate_defaults($defaults);
-    }
-
-
-
-    /**
-     * Gets all the input values that correspond to model fields. Keys are the input/field names,
-     * values are their normalized values
-     *
-     * @return array
-     */
-    public function inputs_values_corresponding_to_model_fields()
-    {
-        return array_intersect_key($this->input_values(), $this->_model->field_settings());
-    }
-
-
-
-    /**
-     * After we've normalized the data as normal, set the corresponding model object
-     * on the form.
-     *
-     * @param array $req_data should usually be $_REQUEST (the default).
-     * @return void
-     */
-    public function _normalize($req_data)
-    {
-        parent::_normalize($req_data);
-        //create or set the model object, if it isn't already
-        if (! $this->_model_object) {
-            //check to see if the form indicates a PK, in which case we want to only retrieve it and update it
-            $pk_name = $this->_model->primary_key_name();
-            $model_obj = $this->_model->get_one_by_ID($this->get_input_value($pk_name));
-            if ($model_obj) {
-                $this->_model_object = $model_obj;
-            } else {
-                $this->_model_object = EE_Registry::instance()->load_class($this->_model->get_this_model_name());
-            }
-        }
-    }
-
-
-
-    /**
-     * After this form has been initialized and is verified to be valid,
-     * either creates a model object from its data and saves it, or updates
-     * the model object its data represents
-     *
-     * @throws EE_Error
-     * @return int, 1 on a successful update, the ID of
-     *                    the new entry on insert; 0 on failure
-     */
-    public function save()
-    {
-        if (! $this->_model_object) {
-            throw new EE_Error(sprintf(__("Cannot save the model form's model object (model is '%s') because there is no model object set. You must either set it, or call receive_form_submission where it is set automatically",
-                "event_espresso"), get_class($this->_model)));
-        }
-        //ok so the model object is set. Just set it with the submitted form data
-        foreach ($this->inputs_values_corresponding_to_model_fields() as $field_name => $field_value) {
-            //only set the non-primary key
-            if ($field_name != $this->_model->primary_key_name()) {
-                $this->_model_object->set($field_name, $field_value);
-            }
-        }
-        $success = $this->_model_object->save();
-        foreach ($this->_model->relation_settings() as $relation_name => $relation_obj) {
-            if (isset($this->_subsections[$relation_name])) {
-                $success = $this->_save_related_info($relation_name);
-            }
-        }
-        do_action('AHEE__EE_Model_Form_Section__save__done', $this, $success);
-        return $success;
-    }
-
-
-
-    /**
-     * Automatically finds the related model info from the form, if present, and
-     * save the relations indicated
-     *
-     * @type string $relation_name
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function _save_related_info($relation_name)
-    {
-        $relation_obj = $this->_model->related_settings_for($relation_name);
-        if ($relation_obj instanceof EE_Belongs_To_Relation) {
-            //there is just a foreign key on this model pointing to that one
-            $this->_model_object->_add_relation_to($this->get_input_value($relation_name), $relation_name);
-        } elseif ($relation_obj instanceof EE_Has_Many_Relation) {
-            //then we want to consider all of its currently-related things.
-            //if they're in this list, keep them
-            //if they're not in this list, remove them
-            //and lastly add all the new items
-            throw new EE_Error(sprintf(__('Automatic saving of related info across a "has many" relation is not yet supported',
-                "event_espresso")));
-        } elseif ($relation_obj instanceof EE_HABTM_Relation) {
-            //delete everything NOT in this list
-            $normalized_input_value = $this->get_input_value($relation_name);
-            if ($normalized_input_value && is_array($normalized_input_value)) {
-                $where_query_params = array(
-                    $relation_obj->get_other_model()->primary_key_name() => array('NOT_IN', $normalized_input_value),
-                );
-            } else {
-                $where_query_params = array();
-            }
-            $this->_model_object->_remove_relations($relation_name, $where_query_params);
-            foreach ($normalized_input_value as $id) {
-                $this->_model_object->_add_relation_to($id, $relation_name);
-            }
-        }
-        return true;
-    }
-
-
-
-    /**
-     * Gets the model of this model form
-     *
-     * @return EEM_Base
-     */
-    public function get_model()
-    {
-        return $this->_model;
-    }
-
-
-
-    /**
-     * Gets the model object for this model form, which was either set
-     * upon construction (using the $options_array arg 'model_object'), by using
-     * set_model_object($model_obj), or implicitly
-     * when receive_form_submission($req_data) was called.
-     *
-     * @return EE_Base_Class
-     */
-    public function get_model_object()
-    {
-        return $this->_model_object;
-    }
-
-
-
-    /**
-     * gets teh default name of this form section if none is specified
-     *
-     * @return string
-     */
-    protected function _set_default_name_if_empty()
-    {
-        if (! $this->_name) {
-            $default_name = str_replace("EEM_", "", get_class($this->_model)) . "_Model_Form";
-            $this->_name = $default_name;
-        }
-    }
+	/**
+	 * @var EEM_Base
+	 */
+	protected $_model = null;
+
+	/**
+	 * @var EE_Base_Class
+	 */
+	protected $_model_object = null;
+
+
+
+	/**
+	 * @param array        $options_array   keys: {
+	 * @type EEM_Base      $model
+	 * @type EE_Base_Class $model_object
+	 * @type array         $subsection_args array keys should be subsection names (that either do or will exist), and
+	 *       values are the arrays as you would pass them to that subsection
+	 *                                      }
+	 * @throws EE_Error
+	 */
+	public function __construct($options_array = array())
+	{
+		if (isset($options_array['model']) && $options_array['model'] instanceof EEM_Base) {
+			$this->_model = $options_array['model'];
+		}
+		if (! $this->_model || ! $this->_model instanceof EEM_Base) {
+			throw new EE_Error(sprintf(__("Model Form Sections must first specify the _model property to be a subclass of EEM_Base",
+				"event_espresso")));
+		}
+		if (isset($options_array['subsection_args'])) {
+			$subsection_args = $options_array['subsection_args'];
+		} else {
+			$subsection_args = array();
+		}
+		//gather fields and relations to convert to inputs
+		//but if they're just going to exclude a field anyways, don't bother converting it to an input
+		$exclude = $this->_subsections;
+		if (isset($options_array['exclude'])) {
+			$exclude = array_merge($exclude, array_flip($options_array['exclude']));
+		}
+		$model_fields = array_diff_key($this->_model->field_settings(), $exclude);
+		$model_relations = array_diff_key($this->_model->relation_settings(), $exclude);
+		//convert fields and relations to inputs
+		$this->_subsections = array_merge(
+			$this->_convert_model_fields_to_inputs($model_fields),
+			$this->_convert_model_relations_to_inputs($model_relations, $subsection_args),
+			$this->_subsections
+		);
+		parent::__construct($options_array);
+		if (isset($options_array['model_object']) && $options_array['model_object'] instanceof EE_Base_Class) {
+			$this->populate_model_obj($options_array['model_object']);
+		}
+	}
+
+
+
+	/**
+	 * For now, just makes inputs for only HABTM relations
+	 *
+	 * @param EE_Model_Relation_Base[] $relations
+	 * @param array                    $subsection_args keys should be existing or soon-to-be-existing input names, and
+	 *                                                  their values are {
+	 * @type array {
+	 * @type EE_Base_Class[]           $model_objects   if the subsection is an EE_Select_Multi_Model_Input
+	 *                                                  }
+	 *                                                  }
+	 * @return array
+	 */
+	protected function _convert_model_relations_to_inputs($relations, $subsection_args = array())
+	{
+		$inputs = array();
+		foreach ($relations as $relation_name => $relation_obj) {
+			$input_constructor_args = array(
+				array_merge(
+					array(
+						'required'        => $relation_obj instanceof EE_Belongs_To_Relation,
+						'html_label_text' => $relation_obj instanceof EE_Belongs_To_Relation
+							? $relation_obj->get_other_model()->item_name(1)
+							: $relation_obj->get_other_model()
+										   ->item_name(2),
+					),
+					$subsection_args
+				),
+			);
+			$input = null;
+			switch (get_class($relation_obj)) {
+				case 'EE_HABTM_Relation':
+					if (isset($subsection_args[$relation_name])
+						&& isset($subsection_args[$relation_name]['model_objects'])
+					) {
+						$model_objects = $subsection_args[$relation_name]['model_objects'];
+					} else {
+						$model_objects = $relation_obj->get_other_model()->get_all();
+					}
+					$input = new EE_Select_Multi_Model_Input($model_objects, $input_constructor_args);
+					break;
+				default:
+			}
+			if ($input) {
+				$inputs[$relation_name] = $input;
+			}
+		}
+		return $inputs;
+	}
+
+
+
+	/**
+	 * Changes model fields into form section inputs
+	 *
+	 * @param EE_Model_Field_Base[] $model_fields keys are the model's name
+	 * @throws EE_Error
+	 * @return EE_Form_Input_Base[]
+	 */
+	protected function _convert_model_fields_to_inputs($model_fields = array())
+	{
+		$inputs = array();
+		foreach ($model_fields as $field_name => $model_field) {
+			if ($model_field instanceof EE_Model_Field_Base) {
+				$input_constructor_args = array(
+					array(
+						'required'        => ! $model_field->is_nullable()
+											 && $model_field->get_default_value()
+												=== null,
+						'html_label_text' => $model_field->get_nicename(),
+						'default'         => $model_field->get_default_value(),
+					),
+				);
+				switch (get_class($model_field)) {
+					case 'EE_All_Caps_Text_Field':
+					case 'EE_Any_Foreign_Model_Name_Field':
+						$input_class = 'EE_Text_Input';
+						break;
+					case 'EE_Boolean_Field':
+						$input_class = 'EE_Yes_No_Input';
+						break;
+					case 'EE_Datetime_Field':
+						throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"), get_class($model_field)));
+						break;
+					case 'EE_Email_Field':
+						$input_class = 'EE_Email_Input';
+						break;
+					case 'EE_Enum_Integer_Field':
+						throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"), get_class($model_field)));
+						break;
+					case 'EE_Enum_Text_Field':
+						throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"), get_class($model_field)));
+						break;
+					case 'EE_Float_Field':
+						$input_class = 'EE_Float_Input';
+						break;
+					case 'EE_Foreign_Key_Int_Field':
+					case 'EE_Foreign_Key_String_Field':
+					case 'EE_WP_User_Field':
+						$models_pointed_to = $model_field instanceof EE_Field_With_Model_Name
+							? $model_field->get_model_class_names_pointed_to() : array();
+						if (true || is_array($models_pointed_to) && count($models_pointed_to) > 1) {
+							$input_class = 'EE_Text_Input';
+						} else {
+							//so its just one model
+							$model_name = is_array($models_pointed_to) ? reset($models_pointed_to) : $models_pointed_to;
+							$model = EE_Registry::instance()->load_model($model_name);
+							$model_names = $model->get_all_names(array('limit' => 10));
+							if ($model_field->is_nullable()) {
+								array_unshift($model_names, __("Please Select", 'event_espresso'));
+							}
+							$input_constructor_args[1] = $input_constructor_args[0];
+							$input_constructor_args[0] = $model_names;
+							$input_class = 'EE_Select_Input';
+						}
+						break;
+					case 'EE_Full_HTML_Field':
+						$input_class = 'EE_Text_Area_Input';
+						$input_constructor_args[0]['validation_strategies'] = array(new EE_Full_HTML_Validation_Strategy());
+						break;
+					case 'EE_Infinite_Integer':
+						throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"), get_class($model_field)));
+						break;
+					case 'EE_Integer_Field':
+						$input_class = 'EE_Text_Input';
+						break;
+					case 'EE_Maybe_Serialized_Text_Field':
+						$input_class = 'EE_Text_Area_Input';
+						break;
+					case 'EE_Money_Field':
+						throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"), get_class($model_field)));
+						break;
+					case 'EE_Post_Content_Field':
+						$input_class = 'EE_Text_Area_Input';
+						$input_constructor_args[0]['validation_strategies'] = array(new EE_Full_HTML_Validation_Strategy());
+						break;
+					case 'EE_Plain_Text_Field':
+						$input_class = 'EE_Text_Input';
+						break;
+					case 'EE_Primary_Key_Int_Field':
+						$input_class = 'EE_Hidden_Input';
+						$input_constructor_args['normalization_strategy'] = new EE_Int_Normalization();
+						break;
+					case 'EE_Primary_Key_String_Field':
+						$input_class = 'EE_Hidden_Input';
+						break;
+					case 'EE_Serialized_Text_Field':
+						$input_class = 'EE_Text_Area_Input';
+						break;
+					case 'EE_Simple_HTML_Field':
+						$input_class = 'EE_Text_Area_Input';
+						$input_constructor_args[0]['validation_strategies'] = array(new EE_Simple_HTML_Validation_Strategy());
+						break;
+					case 'EE_Slug_Field':
+						$input_class = 'EE_Text_Input';
+						break;
+					case 'EE_Trashed_Flag_Field':
+						$input_class = 'EE_Yes_No_Input';
+						break;
+					case 'EE_WP_Post_Status_Field':
+						throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"), get_class($model_field)));
+						break;
+					case 'EE_WP_Post_Type_Field':
+						throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"), get_class($model_field)));
+						break;
+					default:
+						throw new EE_Error(sprintf(__("Model field of type '%s' does not convert to any known Form Input. Please add a case to EE_Model_Form_section's _convert_model_fields_to_inputs switch statement",
+							"event_espresso"), get_class($model_field)));
+				}
+				$reflection = new ReflectionClass($input_class);
+				$input = $reflection->newInstanceArgs($input_constructor_args);
+				$inputs[$field_name] = $input;
+			}
+		}
+		return $inputs;
+	}
+
+
+
+	/**
+	 * Mostly the same as populate_defaults , except takes a model object as input, not an array,
+	 * and also sets the form's _model_object
+	 *
+	 * @param EE_Base_Class $model_obj
+	 * @return void
+	 */
+	public function populate_model_obj($model_obj)
+	{
+		$model_obj = $this->_model->ensure_is_obj($model_obj);
+		$this->_model_object = $model_obj;
+		$defaults = $model_obj->model_field_array();
+		foreach ($this->_model->relation_settings() as $relation_name => $relation_obj) {
+			$subsection = $this->get_subsection($relation_name, false);
+			if ($subsection instanceof EE_Form_Input_Base) {
+				if ($relation_obj instanceof EE_Belongs_To_Relation) {
+					//then we only expect there to be one
+					$related_item = $this->_model_object->get_first_related($relation_name);
+					$defaults[$relation_name] = $related_item->ID();
+				} else {
+					$related_items = $this->_model_object->get_many_related($relation_name);
+					$ids = array();
+					foreach ($related_items as $related_item) {
+						$ids[] = $related_item->ID();
+					}
+					$defaults[$relation_name] = $ids;
+				}
+			}
+		}
+		$defaults = apply_filters(
+			'FHEE__EE_Model_Form_Section__populate_model_obj',
+			$defaults,
+			$this
+		);
+		$this->populate_defaults($defaults);
+	}
+
+
+
+	/**
+	 * Gets all the input values that correspond to model fields. Keys are the input/field names,
+	 * values are their normalized values
+	 *
+	 * @return array
+	 */
+	public function inputs_values_corresponding_to_model_fields()
+	{
+		return array_intersect_key($this->input_values(), $this->_model->field_settings());
+	}
+
+
+
+	/**
+	 * After we've normalized the data as normal, set the corresponding model object
+	 * on the form.
+	 *
+	 * @param array $req_data should usually be $_REQUEST (the default).
+	 * @return void
+	 */
+	public function _normalize($req_data)
+	{
+		parent::_normalize($req_data);
+		//create or set the model object, if it isn't already
+		if (! $this->_model_object) {
+			//check to see if the form indicates a PK, in which case we want to only retrieve it and update it
+			$pk_name = $this->_model->primary_key_name();
+			$model_obj = $this->_model->get_one_by_ID($this->get_input_value($pk_name));
+			if ($model_obj) {
+				$this->_model_object = $model_obj;
+			} else {
+				$this->_model_object = EE_Registry::instance()->load_class($this->_model->get_this_model_name());
+			}
+		}
+	}
+
+
+
+	/**
+	 * After this form has been initialized and is verified to be valid,
+	 * either creates a model object from its data and saves it, or updates
+	 * the model object its data represents
+	 *
+	 * @throws EE_Error
+	 * @return int, 1 on a successful update, the ID of
+	 *                    the new entry on insert; 0 on failure
+	 */
+	public function save()
+	{
+		if (! $this->_model_object) {
+			throw new EE_Error(sprintf(__("Cannot save the model form's model object (model is '%s') because there is no model object set. You must either set it, or call receive_form_submission where it is set automatically",
+				"event_espresso"), get_class($this->_model)));
+		}
+		//ok so the model object is set. Just set it with the submitted form data
+		foreach ($this->inputs_values_corresponding_to_model_fields() as $field_name => $field_value) {
+			//only set the non-primary key
+			if ($field_name != $this->_model->primary_key_name()) {
+				$this->_model_object->set($field_name, $field_value);
+			}
+		}
+		$success = $this->_model_object->save();
+		foreach ($this->_model->relation_settings() as $relation_name => $relation_obj) {
+			if (isset($this->_subsections[$relation_name])) {
+				$success = $this->_save_related_info($relation_name);
+			}
+		}
+		do_action('AHEE__EE_Model_Form_Section__save__done', $this, $success);
+		return $success;
+	}
+
+
+
+	/**
+	 * Automatically finds the related model info from the form, if present, and
+	 * save the relations indicated
+	 *
+	 * @type string $relation_name
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function _save_related_info($relation_name)
+	{
+		$relation_obj = $this->_model->related_settings_for($relation_name);
+		if ($relation_obj instanceof EE_Belongs_To_Relation) {
+			//there is just a foreign key on this model pointing to that one
+			$this->_model_object->_add_relation_to($this->get_input_value($relation_name), $relation_name);
+		} elseif ($relation_obj instanceof EE_Has_Many_Relation) {
+			//then we want to consider all of its currently-related things.
+			//if they're in this list, keep them
+			//if they're not in this list, remove them
+			//and lastly add all the new items
+			throw new EE_Error(sprintf(__('Automatic saving of related info across a "has many" relation is not yet supported',
+				"event_espresso")));
+		} elseif ($relation_obj instanceof EE_HABTM_Relation) {
+			//delete everything NOT in this list
+			$normalized_input_value = $this->get_input_value($relation_name);
+			if ($normalized_input_value && is_array($normalized_input_value)) {
+				$where_query_params = array(
+					$relation_obj->get_other_model()->primary_key_name() => array('NOT_IN', $normalized_input_value),
+				);
+			} else {
+				$where_query_params = array();
+			}
+			$this->_model_object->_remove_relations($relation_name, $where_query_params);
+			foreach ($normalized_input_value as $id) {
+				$this->_model_object->_add_relation_to($id, $relation_name);
+			}
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * Gets the model of this model form
+	 *
+	 * @return EEM_Base
+	 */
+	public function get_model()
+	{
+		return $this->_model;
+	}
+
+
+
+	/**
+	 * Gets the model object for this model form, which was either set
+	 * upon construction (using the $options_array arg 'model_object'), by using
+	 * set_model_object($model_obj), or implicitly
+	 * when receive_form_submission($req_data) was called.
+	 *
+	 * @return EE_Base_Class
+	 */
+	public function get_model_object()
+	{
+		return $this->_model_object;
+	}
+
+
+
+	/**
+	 * gets teh default name of this form section if none is specified
+	 *
+	 * @return string
+	 */
+	protected function _set_default_name_if_empty()
+	{
+		if (! $this->_name) {
+			$default_name = str_replace("EEM_", "", get_class($this->_model)) . "_Model_Form";
+			$this->_name = $default_name;
+		}
+	}
 
 
 

modules/events_archive/EED_Events_Archive.module.php

Doc Comments +2 added lines, -2 removed lines

@@ -249,7 +249,7 @@ 
 
     /**
      * @access public
-     * @return string
+     * @return boolean
      */
 	public static function is_iframe() {
         return \EED_Events_Archive::$iframe;
@@ -722,7 +722,7 @@ 
 	 *    display_description
 	 *
 	 * @access    public
-	 * @param $value
+	 * @param integer $value
 	 * @return    bool
 	 */
 	public static function display_description( $value ) {

Indentation +27 added lines, -27 removed lines

@@ -37,19 +37,19 @@ 
 	 */
 	protected static $using_get_the_excerpt = false;
 
-    /**
-     * Used to flag when the event list is being called from an external iframe.
-     *
-     * @var bool $iframe
-     */
-    protected static $iframe = false;
-
-    /**
+	/**
+	 * Used to flag when the event list is being called from an external iframe.
+	 *
+	 * @var bool $iframe
+	 */
+	protected static $iframe = false;
+
+	/**
 	 * @var \EventEspresso\core\libraries\iframe_display\EventListIframeEmbedButton $_iframe_embed_button
 	 */
 	private static $_iframe_embed_button;
 
-    /**
+	/**
 	 * @type EE_Template_Part_Manager $template_parts
 	 */
 	protected $template_parts;
@@ -233,36 +233,36 @@ 
 
 
 
-    /**
-     * @access    public
-     * @return    void
-     * @throws \EE_Error
-     * @throws \DomainException
-     */
+	/**
+	 * @access    public
+	 * @return    void
+	 * @throws \EE_Error
+	 * @throws \DomainException
+	 */
 	public function event_list_iframe() {
-        \EED_Events_Archive::$iframe = true;
+		\EED_Events_Archive::$iframe = true;
 		$event_list_iframe = new EventsArchiveIframe( $this );
 		$event_list_iframe->display();
 	}
 
 
 
-    /**
-     * @access public
-     * @return string
-     */
+	/**
+	 * @access public
+	 * @return string
+	 */
 	public static function is_iframe() {
-        return \EED_Events_Archive::$iframe;
+		return \EED_Events_Archive::$iframe;
 	}
 
 
 
-    /**
-     * @access public
-     * @return string
-     */
+	/**
+	 * @access public
+	 * @return string
+	 */
 	public static function link_target() {
-        return \EED_Events_Archive::$iframe ? ' target="_blank"' : '';
+		return \EED_Events_Archive::$iframe ? ' target="_blank"' : '';
 	}
 
 
@@ -600,7 +600,7 @@ 
 	 *  @return 	void
 	 */
 	public function load_event_list_assets() {
-        do_action( 'AHEE__EED_Events_Archive__before_load_assets' );
+		do_action( 'AHEE__EED_Events_Archive__before_load_assets' );
 		add_filter( 'FHEE_load_EE_Session', '__return_true' );
 		add_filter( 'FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true' );
 		add_action('wp_enqueue_scripts', array( $this, 'wp_enqueue_scripts' ), 10 );

Spacing +178 added lines, -178 removed lines

@@ -3,7 +3,7 @@ 
 use EventEspresso\core\libraries\iframe_display\EventListIframeEmbedButton;
 use EventEspresso\modules\events_archive\EventsArchiveIframe;
 
-if ( ! defined( 'EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
+if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
 /**
  * Event Espresso
  *
@@ -60,7 +60,7 @@ 
 	 * @return EED_Events_Archive
 	 */
 	public static function instance() {
-		return parent::get_instance( __CLASS__ );
+		return parent::get_instance(__CLASS__);
 	}
 
 
@@ -72,10 +72,10 @@ 
 	 *  @return 	void
 	 */
 	public static function set_hooks() {
-		EE_Config::register_route( EE_Registry::instance()->CFG->core->event_cpt_slug, 'Events_Archive', 'run' );
-		EE_Config::register_route( 'event_list', 'Events_Archive', 'event_list' );
-		EE_Config::register_route( 'iframe', 'Events_Archive', 'event_list_iframe', 'event_list' );
-		add_action( 'wp_loaded', array( 'EED_Events_Archive', 'set_definitions' ), 2 );
+		EE_Config::register_route(EE_Registry::instance()->CFG->core->event_cpt_slug, 'Events_Archive', 'run');
+		EE_Config::register_route('event_list', 'Events_Archive', 'event_list');
+		EE_Config::register_route('iframe', 'Events_Archive', 'event_list_iframe', 'event_list');
+		add_action('wp_loaded', array('EED_Events_Archive', 'set_definitions'), 2);
 	}
 
 	/**
@@ -85,12 +85,12 @@ 
 	 *  @return 	void
 	 */
 	public static function set_hooks_admin() {
-		add_action( 'wp_loaded', array( 'EED_Events_Archive', 'set_definitions' ), 2 );
+		add_action('wp_loaded', array('EED_Events_Archive', 'set_definitions'), 2);
 		// hook into the end of the \EE_Admin_Page::_load_page_dependencies()
 		// to load assets for "espresso_events" page on the "default" route (action)
 		add_action(
 			'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__default',
-			array( 'EED_Events_Archive', 'event_list_iframe_embed_button' ),
+			array('EED_Events_Archive', 'event_list_iframe_embed_button'),
 			10
 		);
 	}
@@ -105,8 +105,8 @@ 
 	 *  @return 	void
 	 */
 	public static function set_definitions() {
-		define( 'EVENTS_ARCHIVE_ASSETS_URL', plugin_dir_url( __FILE__ ) . 'assets' . DS );
-		define( 'EVENTS_ARCHIVE_TEMPLATES_PATH', str_replace( '\\', DS, plugin_dir_path( __FILE__ )) . 'templates' . DS );
+		define('EVENTS_ARCHIVE_ASSETS_URL', plugin_dir_url(__FILE__).'assets'.DS);
+		define('EVENTS_ARCHIVE_TEMPLATES_PATH', str_replace('\\', DS, plugin_dir_path(__FILE__)).'templates'.DS);
 	}
 
 
@@ -114,10 +114,10 @@ 
 	/**
 	 * set up EE_Events_Archive_Config
 	 */
-	protected function set_config(){
-		$this->set_config_section( 'template_settings' );
-		$this->set_config_class( 'EE_Events_Archive_Config' );
-		$this->set_config_name( 'EED_Events_Archive' );
+	protected function set_config() {
+		$this->set_config_section('template_settings');
+		$this->set_config_class('EE_Events_Archive_Config');
+		$this->set_config_name('EED_Events_Archive');
 	}
 
 
@@ -126,7 +126,7 @@ 
 	 * @return EventListIframeEmbedButton
 	 */
 	public static function get_iframe_embed_button() {
-		if ( ! self::$_iframe_embed_button instanceof EventListIframeEmbedButton ) {
+		if ( ! self::$_iframe_embed_button instanceof EventListIframeEmbedButton) {
 			self::$_iframe_embed_button = new EventListIframeEmbedButton();
 		}
 		return self::$_iframe_embed_button;
@@ -152,35 +152,35 @@ 
 	 * @param \EE_Events_Archive_Config $config
 	 * @return \EE_Template_Part_Manager
 	 */
-	public function initialize_template_parts( EE_Events_Archive_Config $config = null ) {
+	public function initialize_template_parts(EE_Events_Archive_Config $config = null) {
 		$config = $config instanceof EE_Events_Archive_Config ? $config : $this->config();
 		EEH_Autoloader::instance()->register_template_part_autoloaders();
 		$template_parts = new EE_Template_Part_Manager();
 		$template_parts->add_template_part(
 			'tickets',
-			__( 'Ticket Selector', 'event_espresso' ),
+			__('Ticket Selector', 'event_espresso'),
 			'content-espresso_events-tickets.php',
 			$config->display_order_tickets
 		);
 		$template_parts->add_template_part(
 			'datetimes',
-			__( 'Dates and Times', 'event_espresso' ),
+			__('Dates and Times', 'event_espresso'),
 			'content-espresso_events-datetimes.php',
 			$config->display_order_datetimes
 		);
 		$template_parts->add_template_part(
 			'event',
-			__( 'Event Description', 'event_espresso' ),
+			__('Event Description', 'event_espresso'),
 			'content-espresso_events-details.php',
 			$config->display_order_event
 		);
 		$template_parts->add_template_part(
 			'venue',
-			__( 'Venue Information', 'event_espresso' ),
+			__('Venue Information', 'event_espresso'),
 			'content-espresso_events-venues.php',
 			$config->display_order_venue
 		);
-		do_action( 'AHEE__EED_Event_Archive__initialize_template_parts', $template_parts );
+		do_action('AHEE__EED_Event_Archive__initialize_template_parts', $template_parts);
 		return $template_parts;
 	}
 
@@ -193,8 +193,8 @@ 
 	 * @param WP $WP
 	 * @return    void
 	 */
-	public function run( $WP ) {
-		do_action( 'AHEE__EED_Events_Archive__before_run' );
+	public function run($WP) {
+		do_action('AHEE__EED_Events_Archive__before_run');
 		// ensure valid EE_Events_Archive_Config() object exists
 		$this->set_config();
 		/** @type EE_Events_Archive_Config $config */
@@ -206,14 +206,14 @@ 
 		EEH_Event_Query::add_query_filters();
 		// set params that will get used by the filters
 		EEH_Event_Query::set_query_params(
-			'', 	// month
-			'', 	// category
-			$config->display_expired_events, 	// show_expired
-			'start_date', 	// orderby
+			'', // month
+			'', // category
+			$config->display_expired_events, // show_expired
+			'start_date', // orderby
 			'ASC' 	// sort
 		);
 		// check what template is loaded
-		add_filter( 'template_include',  array( $this, 'template_include' ), 999, 1 );
+		add_filter('template_include', array($this, 'template_include'), 999, 1);
 	}
 
 
@@ -241,7 +241,7 @@ 
      */
 	public function event_list_iframe() {
         \EED_Events_Archive::$iframe = true;
-		$event_list_iframe = new EventsArchiveIframe( $this );
+		$event_list_iframe = new EventsArchiveIframe($this);
 		$event_list_iframe->display();
 	}
 
@@ -279,32 +279,32 @@ 
 	 * @param string $template
 	 * @return    string
 	 */
-	public function template_include( $template = '' ) {
+	public function template_include($template = '') {
 		// don't add content filter for dedicated EE child themes or private posts
-		if ( ! EEH_Template::is_espresso_theme() ) {
+		if ( ! EEH_Template::is_espresso_theme()) {
 			/** @type EE_Events_Archive_Config $config */
 			$config = $this->config();
 			// add status banner ?
-			if ( $config->display_status_banner ) {
-				add_filter( 'the_title', array( 'EED_Events_Archive', 'the_title' ), 100, 2 );
+			if ($config->display_status_banner) {
+				add_filter('the_title', array('EED_Events_Archive', 'the_title'), 100, 2);
 			}
 			// if NOT a custom template
 			if (
-				EE_Registry::instance()->load_core( 'Front_Controller', array(), false, true )->get_selected_template() != 'archive-espresso_events.php'
-				|| apply_filters( 'FHEE__EED_Event_Archive__template_include__allow_custom_selected_template', FALSE )
+				EE_Registry::instance()->load_core('Front_Controller', array(), false, true)->get_selected_template() != 'archive-espresso_events.php'
+				|| apply_filters('FHEE__EED_Event_Archive__template_include__allow_custom_selected_template', FALSE)
 			) {
 				// don't display entry meta because the existing theme will take care of that
-				add_filter( 'FHEE__EED_Events_Archive__template_include__events_list_active', '__return_true' );
+				add_filter('FHEE__EED_Events_Archive__template_include__events_list_active', '__return_true');
 			// load functions.php file for the theme (loaded by WP if using child theme)
 				EEH_Template::load_espresso_theme_functions();
 				// because we don't know if the theme is using the_excerpt()
-				add_filter( 'the_excerpt', array( 'EED_Events_Archive', 'event_details' ), 100, 1 );
+				add_filter('the_excerpt', array('EED_Events_Archive', 'event_details'), 100, 1);
 				// or the_content
-				add_filter( 'the_content', array( 'EED_Events_Archive', 'event_details' ), 100, 1 );
+				add_filter('the_content', array('EED_Events_Archive', 'event_details'), 100, 1);
 				// and just in case they are running get_the_excerpt() which DESTROYS things
-				add_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1, 1 );
+				add_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1, 1);
 				// don't display entry meta because the existing theme will take care of that
-				add_filter( 'FHEE__content_espresso_events_details_template__display_entry_meta', '__return_false' );
+				add_filter('FHEE__content_espresso_events_details_template__display_entry_meta', '__return_false');
 			}
 		}
 		return $template;
@@ -319,17 +319,17 @@ 
 	 * 	@param		string 	$excerpt
 	 * 	@return 		string
 	 */
-	public static function get_the_excerpt( $excerpt = '' ) {
-		if ( post_password_required() ) {
+	public static function get_the_excerpt($excerpt = '') {
+		if (post_password_required()) {
 			return $excerpt;
 		}
-		if ( apply_filters( 'FHEE__EED_Events_Archive__get_the_excerpt__theme_uses_get_the_excerpt', false ) ) {
-			remove_filter( 'the_excerpt', array( 'EED_Events_Archive', 'event_details' ), 100 );
-			remove_filter( 'the_content', array( 'EED_Events_Archive', 'event_details' ), 100 );
-			$excerpt = EED_Events_Archive::event_details( $excerpt );
+		if (apply_filters('FHEE__EED_Events_Archive__get_the_excerpt__theme_uses_get_the_excerpt', false)) {
+			remove_filter('the_excerpt', array('EED_Events_Archive', 'event_details'), 100);
+			remove_filter('the_content', array('EED_Events_Archive', 'event_details'), 100);
+			$excerpt = EED_Events_Archive::event_details($excerpt);
 		} else {
 			EED_Events_Archive::$using_get_the_excerpt = true;
-			add_filter( 'wp_trim_excerpt', array( 'EED_Events_Archive', 'end_get_the_excerpt' ), 999, 1 );
+			add_filter('wp_trim_excerpt', array('EED_Events_Archive', 'end_get_the_excerpt'), 999, 1);
 		}
 		return $excerpt;
 	}
@@ -343,7 +343,7 @@ 
 	 * @param  string $text
 	 * @return string
 	 */
-	public static function end_get_the_excerpt( $text = '' ) {
+	public static function end_get_the_excerpt($text = '') {
 		EED_Events_Archive::$using_get_the_excerpt = false;
 		return $text;
 	}
@@ -358,10 +358,10 @@ 
 	 * @param 		string 		$id
 	 * @return 		string
 	 */
-	public static function the_title( $title = '', $id = '' ) {
+	public static function the_title($title = '', $id = '') {
 	global $post;
-	if ( $post instanceof WP_Post ) {
-		return in_the_loop() && $post->ID == $id ? espresso_event_status_banner( $post->ID  ) . $title :  $title;
+	if ($post instanceof WP_Post) {
+		return in_the_loop() && $post->ID == $id ? espresso_event_status_banner($post->ID).$title : $title;
 	}
 	return $title;
 }
@@ -375,7 +375,7 @@ 
 	 * 	@param		string 	$content
 	 * 	@return 		string
 	 */
-	public static function event_details( $content ) {
+	public static function event_details($content) {
 		global $post;
 		static $current_post_ID = 0;
 		if (
@@ -384,8 +384,8 @@ 
 			&& ! EED_Events_Archive::$using_get_the_excerpt
 			&& ! post_password_required()
 			&& (
-				apply_filters( 'FHEE__EES_Espresso_Events__process_shortcode__true', false )
-				|| ! apply_filters( 'FHEE__content_espresso_events__template_loaded', false )
+				apply_filters('FHEE__EES_Espresso_Events__process_shortcode__true', false)
+				|| ! apply_filters('FHEE__content_espresso_events__template_loaded', false)
 			)
 		) {
 			// Set current post ID to prevent showing content twice, but only if headers have definitely been sent.
@@ -394,8 +394,8 @@ 
 			// We want to allow those plugins to still do their thing and have access to our content, but depending on
 			// how your event content is being displayed (shortcode, CPT route, etc), this filter can get applied twice,
 			// so the following allows this filter to be applied multiple times, but only once for real
-			$current_post_ID = did_action( 'loop_start' ) ? $post->ID : 0;
-			if ( EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->use_sortable_display_order ) {
+			$current_post_ID = did_action('loop_start') ? $post->ID : 0;
+			if (EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->use_sortable_display_order) {
 				$content = \EED_Events_Archive::use_sortable_display_order();
 			} else {
 				$content = \EED_Events_Archive::use_filterable_display_order();
@@ -414,20 +414,20 @@ 
 	 */
 	protected static function use_sortable_display_order() {
 		// no further password checks required atm
-		add_filter( 'FHEE__EED_Events_Archive__event_details__no_post_password_required', '__return_true' );
+		add_filter('FHEE__EED_Events_Archive__event_details__no_post_password_required', '__return_true');
 		// we need to first remove this callback from being applied to the_content() or the_excerpt() (otherwise it will recurse and blow up the interweb)
-		remove_filter( 'the_excerpt', array( 'EED_Events_Archive', 'event_details' ), 100 );
-		remove_filter( 'the_content', array( 'EED_Events_Archive', 'event_details' ), 100 );
-		remove_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1 );
+		remove_filter('the_excerpt', array('EED_Events_Archive', 'event_details'), 100);
+		remove_filter('the_content', array('EED_Events_Archive', 'event_details'), 100);
+		remove_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1);
 		// now add additional content depending on whether event is using the_excerpt() or the_content()
 		EED_Events_Archive::instance()->template_parts = EED_Events_Archive::instance()->initialize_template_parts();
-		$content = EEH_Template::locate_template( 'content-espresso_events-details.php' );
-		$content = EED_Events_Archive::instance()->template_parts->apply_template_part_filters( $content );
+		$content = EEH_Template::locate_template('content-espresso_events-details.php');
+		$content = EED_Events_Archive::instance()->template_parts->apply_template_part_filters($content);
 		// re-add our main filters (or else the next event won't have them)
-		add_filter( 'the_excerpt', array( 'EED_Events_Archive', 'event_details' ), 100, 1 );
-		add_filter( 'the_content', array( 'EED_Events_Archive', 'event_details' ), 100, 1 );
-		add_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1, 1 );
-		remove_filter( 'FHEE__EED_Events_Archive__event_details__no_post_password_required', '__return_true' );
+		add_filter('the_excerpt', array('EED_Events_Archive', 'event_details'), 100, 1);
+		add_filter('the_content', array('EED_Events_Archive', 'event_details'), 100, 1);
+		add_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1, 1);
+		remove_filter('FHEE__EED_Events_Archive__event_details__no_post_password_required', '__return_true');
 		return $content;
 	}
 
@@ -442,22 +442,22 @@ 
 	protected static function use_filterable_display_order() {
 		// we need to first remove this callback from being applied to the_content()
 		// (otherwise it will recurse and blow up the interweb)
-		remove_filter( 'the_excerpt', array( 'EED_Events_Archive', 'event_details' ), 100 );
-		remove_filter( 'the_content', array( 'EED_Events_Archive', 'event_details' ), 100 );
-		remove_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1 );
+		remove_filter('the_excerpt', array('EED_Events_Archive', 'event_details'), 100);
+		remove_filter('the_content', array('EED_Events_Archive', 'event_details'), 100);
+		remove_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1);
 		//now add additional content depending on whether event is using the_excerpt() or the_content()
 		EED_Events_Archive::_add_additional_excerpt_filters();
 		EED_Events_Archive::_add_additional_content_filters();
-		do_action( 'AHEE__EED_Events_Archive__use_filterable_display_order__after_add_filters' );
+		do_action('AHEE__EED_Events_Archive__use_filterable_display_order__after_add_filters');
 		// now load our template
-		$content = EEH_Template::locate_template( 'content-espresso_events-details.php' );
+		$content = EEH_Template::locate_template('content-espresso_events-details.php');
 		// re-add our main filters (or else the next event won't have them)
-		add_filter( 'the_excerpt', array( 'EED_Events_Archive', 'event_details' ), 100, 1 );
-		add_filter( 'the_content', array( 'EED_Events_Archive', 'event_details' ), 100, 1 );
-		add_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1, 1 );
+		add_filter('the_excerpt', array('EED_Events_Archive', 'event_details'), 100, 1);
+		add_filter('the_content', array('EED_Events_Archive', 'event_details'), 100, 1);
+		add_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1, 1);
 		// but remove the other filters so that they don't get applied to the next post
 		EED_Events_Archive::_remove_additional_events_archive_filters();
-		do_action( 'AHEE__EED_Events_Archive__use_filterable_display_order__after_remove_filters' );
+		do_action('AHEE__EED_Events_Archive__use_filterable_display_order__after_remove_filters');
 		// we're not returning the $content directly because the template we are loading uses the_content (or the_excerpt)
 		//return ! empty( $template ) ? $template : $content;
 		return $content;
@@ -472,11 +472,11 @@ 
 	 * 	@param		string 	$content
 	 *  	@return 		string
 	 */
-	public static function event_datetimes( $content ) {
-		if ( post_password_required() ) {
+	public static function event_datetimes($content) {
+		if (post_password_required()) {
 			return $content;
 		}
-		return EEH_Template::locate_template( 'content-espresso_events-datetimes.php' ) . $content;
+		return EEH_Template::locate_template('content-espresso_events-datetimes.php').$content;
 	}
 
 	/**
@@ -486,11 +486,11 @@ 
 	 * 	@param		string 	$content
 	 *  	@return 		string
 	 */
-	public static function event_tickets( $content ) {
-		if ( post_password_required() ) {
+	public static function event_tickets($content) {
+		if (post_password_required()) {
 			return $content;
 		}
-		return EEH_Template::locate_template( 'content-espresso_events-tickets.php' ) . $content;
+		return EEH_Template::locate_template('content-espresso_events-tickets.php').$content;
 	}
 
 
@@ -502,8 +502,8 @@ 
 	 * @param    string $content
 	 * @return    string
 	 */
-	public static function event_venue( $content ) {
-		return EED_Events_Archive::event_venues( $content );
+	public static function event_venue($content) {
+		return EED_Events_Archive::event_venues($content);
 	}
 
 	/**
@@ -513,11 +513,11 @@ 
 	 * 	@param		string 	$content
 	 *  	@return 		string
 	 */
-	public static function event_venues( $content ) {
-		if ( post_password_required() ) {
+	public static function event_venues($content) {
+		if (post_password_required()) {
 			return $content;
 		}
-		return $content . EEH_Template::locate_template( 'content-espresso_events-venues.php' );
+		return $content.EEH_Template::locate_template('content-espresso_events-venues.php');
 	}
 
 
@@ -529,9 +529,9 @@ 
 	 * @return        void
 	 */
 	private static function _add_additional_excerpt_filters() {
-		add_filter( 'the_excerpt', array( 'EED_Events_Archive', 'event_datetimes' ), 110, 1 );
-		add_filter( 'the_excerpt', array( 'EED_Events_Archive', 'event_tickets' ), 120, 1 );
-		add_filter( 'the_excerpt', array( 'EED_Events_Archive', 'event_venues' ), 130, 1 );
+		add_filter('the_excerpt', array('EED_Events_Archive', 'event_datetimes'), 110, 1);
+		add_filter('the_excerpt', array('EED_Events_Archive', 'event_tickets'), 120, 1);
+		add_filter('the_excerpt', array('EED_Events_Archive', 'event_venues'), 130, 1);
 	}
 
 
@@ -543,9 +543,9 @@ 
 	 * @return        void
 	 */
 	private static function _add_additional_content_filters() {
-		add_filter( 'the_content', array( 'EED_Events_Archive', 'event_datetimes' ), 110, 1 );
-		add_filter( 'the_content', array( 'EED_Events_Archive', 'event_tickets' ), 120, 1 );
-		add_filter( 'the_content', array( 'EED_Events_Archive', 'event_venues' ), 130, 1 );
+		add_filter('the_content', array('EED_Events_Archive', 'event_datetimes'), 110, 1);
+		add_filter('the_content', array('EED_Events_Archive', 'event_tickets'), 120, 1);
+		add_filter('the_content', array('EED_Events_Archive', 'event_venues'), 130, 1);
 	}
 
 
@@ -557,12 +557,12 @@ 
 	 * @return        void
 	 */
 	private static function _remove_additional_events_archive_filters() {
-		remove_filter( 'the_excerpt', array( 'EED_Events_Archive', 'event_datetimes' ), 110 );
-		remove_filter( 'the_excerpt', array( 'EED_Events_Archive', 'event_tickets' ), 120 );
-		remove_filter( 'the_excerpt', array( 'EED_Events_Archive', 'event_venues' ), 130 );
-		remove_filter( 'the_content', array( 'EED_Events_Archive', 'event_datetimes' ), 110 );
-		remove_filter( 'the_content', array( 'EED_Events_Archive', 'event_tickets' ), 120 );
-		remove_filter( 'the_content', array( 'EED_Events_Archive', 'event_venues' ), 130 );
+		remove_filter('the_excerpt', array('EED_Events_Archive', 'event_datetimes'), 110);
+		remove_filter('the_excerpt', array('EED_Events_Archive', 'event_tickets'), 120);
+		remove_filter('the_excerpt', array('EED_Events_Archive', 'event_venues'), 130);
+		remove_filter('the_content', array('EED_Events_Archive', 'event_datetimes'), 110);
+		remove_filter('the_content', array('EED_Events_Archive', 'event_tickets'), 120);
+		remove_filter('the_content', array('EED_Events_Archive', 'event_venues'), 130);
 	}
 
 
@@ -575,17 +575,17 @@ 
 	 */
 	public static function remove_all_events_archive_filters() {
 		//remove_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1 );
-		remove_filter( 'the_title', array( 'EED_Events_Archive', 'the_title' ), 100 );
-		remove_filter( 'the_excerpt', array( 'EED_Events_Archive', 'event_details' ), 100 );
-		remove_filter( 'the_excerpt', array( 'EED_Events_Archive', 'event_datetimes' ), 110 );
-		remove_filter( 'the_excerpt', array( 'EED_Events_Archive', 'event_tickets' ), 120 );
-		remove_filter( 'the_excerpt', array( 'EED_Events_Archive', 'event_venues' ), 130 );
-		remove_filter( 'the_content', array( 'EED_Events_Archive', 'event_details' ), 100 );
-		remove_filter( 'the_content', array( 'EED_Events_Archive', 'event_datetimes' ), 110 );
-		remove_filter( 'the_content', array( 'EED_Events_Archive', 'event_tickets' ), 120 );
-		remove_filter( 'the_content', array( 'EED_Events_Archive', 'event_venues' ), 130 );
+		remove_filter('the_title', array('EED_Events_Archive', 'the_title'), 100);
+		remove_filter('the_excerpt', array('EED_Events_Archive', 'event_details'), 100);
+		remove_filter('the_excerpt', array('EED_Events_Archive', 'event_datetimes'), 110);
+		remove_filter('the_excerpt', array('EED_Events_Archive', 'event_tickets'), 120);
+		remove_filter('the_excerpt', array('EED_Events_Archive', 'event_venues'), 130);
+		remove_filter('the_content', array('EED_Events_Archive', 'event_details'), 100);
+		remove_filter('the_content', array('EED_Events_Archive', 'event_datetimes'), 110);
+		remove_filter('the_content', array('EED_Events_Archive', 'event_tickets'), 120);
+		remove_filter('the_content', array('EED_Events_Archive', 'event_venues'), 130);
 		// don't display entry meta because the existing theme will take care of that
-		remove_filter( 'FHEE__content_espresso_events_details_template__display_entry_meta', '__return_false' );
+		remove_filter('FHEE__content_espresso_events_details_template__display_entry_meta', '__return_false');
 	}
 
 
@@ -600,12 +600,12 @@ 
 	 *  @return 	void
 	 */
 	public function load_event_list_assets() {
-        do_action( 'AHEE__EED_Events_Archive__before_load_assets' );
-		add_filter( 'FHEE_load_EE_Session', '__return_true' );
-		add_filter( 'FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true' );
-		add_action('wp_enqueue_scripts', array( $this, 'wp_enqueue_scripts' ), 10 );
-		if ( EE_Registry::instance()->CFG->map_settings->use_google_maps ) {
-			add_action('wp_enqueue_scripts', array( 'EEH_Maps', 'espresso_google_map_js' ), 11 );
+        do_action('AHEE__EED_Events_Archive__before_load_assets');
+		add_filter('FHEE_load_EE_Session', '__return_true');
+		add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
+		add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 10);
+		if (EE_Registry::instance()->CFG->map_settings->use_google_maps) {
+			add_action('wp_enqueue_scripts', array('EEH_Maps', 'espresso_google_map_js'), 11);
 		}
 	}
 
@@ -622,13 +622,13 @@ 
 	 */
 	public function wp_enqueue_scripts() {
 		// get some style
-		if ( apply_filters( 'FHEE_enable_default_espresso_css', FALSE ) ) {
+		if (apply_filters('FHEE_enable_default_espresso_css', FALSE)) {
 			// first check uploads folder
-			if ( EEH_File::is_readable( get_stylesheet_directory() . $this->theme . DS . 'style.css' )) {
-				wp_register_style( $this->theme, get_stylesheet_directory_uri() . $this->theme . DS . 'style.css', array( 'dashicons', 'espresso_default' ));
+			if (EEH_File::is_readable(get_stylesheet_directory().$this->theme.DS.'style.css')) {
+				wp_register_style($this->theme, get_stylesheet_directory_uri().$this->theme.DS.'style.css', array('dashicons', 'espresso_default'));
 			} else {
 		}
-		wp_enqueue_style( $this->theme );
+		wp_enqueue_style($this->theme);
 
 	}
 }
@@ -646,8 +646,8 @@ 
 	 */
 	public static function template_settings_form() {
 	$template_settings = EE_Registry::instance()->CFG->template_settings;
-	$template_settings->EED_Events_Archive = isset( $template_settings->EED_Events_Archive ) ? $template_settings->EED_Events_Archive : new EE_Events_Archive_Config();
-	$template_settings->EED_Events_Archive = apply_filters( 'FHEE__EED_Events_Archive__template_settings_form__event_list_config', $template_settings->EED_Events_Archive );
+	$template_settings->EED_Events_Archive = isset($template_settings->EED_Events_Archive) ? $template_settings->EED_Events_Archive : new EE_Events_Archive_Config();
+	$template_settings->EED_Events_Archive = apply_filters('FHEE__EED_Events_Archive__template_settings_form__event_list_config', $template_settings->EED_Events_Archive);
 	$events_archive_settings = array(
 		'display_status_banner' => 0,
 		'display_description' => 1,
@@ -656,8 +656,8 @@ 
 		'display_venue' => 0,
 		'display_expired_events' => 0
 	);
-	$events_archive_settings = array_merge( $events_archive_settings, (array)$template_settings->EED_Events_Archive );
-	EEH_Template::display_template( EVENTS_ARCHIVE_TEMPLATES_PATH . 'admin-event-list-settings.template.php', $events_archive_settings );
+	$events_archive_settings = array_merge($events_archive_settings, (array) $template_settings->EED_Events_Archive);
+	EEH_Template::display_template(EVENTS_ARCHIVE_TEMPLATES_PATH.'admin-event-list-settings.template.php', $events_archive_settings);
 }
 
 
@@ -673,16 +673,16 @@ 
 	 *  @param 	EE_Request_Handler $REQ
 	 *  @return 	EE_Template_Config
 	 */
-	public static function update_template_settings( $CFG, $REQ ) {
+	public static function update_template_settings($CFG, $REQ) {
 		$CFG->EED_Events_Archive = new EE_Events_Archive_Config();
 		// unless we are resetting the config...
-		if ( ! isset( $REQ['EED_Events_Archive_reset_event_list_settings'] ) || absint( $REQ['EED_Events_Archive_reset_event_list_settings'] ) !== 1 ) {
-			$CFG->EED_Events_Archive->display_status_banner = isset( $REQ['EED_Events_Archive_display_status_banner'] ) ? absint( $REQ['EED_Events_Archive_display_status_banner'] ) : 0;
-			$CFG->EED_Events_Archive->display_description = isset( $REQ['EED_Events_Archive_display_description'] ) ? absint( $REQ['EED_Events_Archive_display_description'] ) : 1;
-			$CFG->EED_Events_Archive->display_ticket_selector = isset( $REQ['EED_Events_Archive_display_ticket_selector'] ) ? absint( $REQ['EED_Events_Archive_display_ticket_selector'] ) : 0;
-			$CFG->EED_Events_Archive->display_datetimes = isset( $REQ['EED_Events_Archive_display_datetimes'] ) ? absint( $REQ['EED_Events_Archive_display_datetimes'] ) : 1;
-			$CFG->EED_Events_Archive->display_venue = isset( $REQ['EED_Events_Archive_display_venue'] ) ? absint( $REQ['EED_Events_Archive_display_venue'] ) : 0;
-			$CFG->EED_Events_Archive->display_expired_events = isset( $REQ['EED_Events_Archive_display_expired_events'] ) ? absint( $REQ['EED_Events_Archive_display_expired_events'] ) : 0;			}
+		if ( ! isset($REQ['EED_Events_Archive_reset_event_list_settings']) || absint($REQ['EED_Events_Archive_reset_event_list_settings']) !== 1) {
+			$CFG->EED_Events_Archive->display_status_banner = isset($REQ['EED_Events_Archive_display_status_banner']) ? absint($REQ['EED_Events_Archive_display_status_banner']) : 0;
+			$CFG->EED_Events_Archive->display_description = isset($REQ['EED_Events_Archive_display_description']) ? absint($REQ['EED_Events_Archive_display_description']) : 1;
+			$CFG->EED_Events_Archive->display_ticket_selector = isset($REQ['EED_Events_Archive_display_ticket_selector']) ? absint($REQ['EED_Events_Archive_display_ticket_selector']) : 0;
+			$CFG->EED_Events_Archive->display_datetimes = isset($REQ['EED_Events_Archive_display_datetimes']) ? absint($REQ['EED_Events_Archive_display_datetimes']) : 1;
+			$CFG->EED_Events_Archive->display_venue = isset($REQ['EED_Events_Archive_display_venue']) ? absint($REQ['EED_Events_Archive_display_venue']) : 0;
+			$CFG->EED_Events_Archive->display_expired_events = isset($REQ['EED_Events_Archive_display_expired_events']) ? absint($REQ['EED_Events_Archive_display_expired_events']) : 0; }
 		return $CFG;
 	}
 
@@ -695,10 +695,10 @@ 
 	 * @param string $extra_class
 	 * @return    string
 	 */
-	public static function event_list_css( $extra_class = '' ) {
-		$event_list_css = ! empty( $extra_class ) ? array( $extra_class ) : array();
+	public static function event_list_css($extra_class = '') {
+		$event_list_css = ! empty($extra_class) ? array($extra_class) : array();
 		$event_list_css[] = 'espresso-event-list-event';
-		return implode( ' ', $event_list_css );
+		return implode(' ', $event_list_css);
 	}
 
 
@@ -725,9 +725,9 @@ 
 	 * @param $value
 	 * @return    bool
 	 */
-	public static function display_description( $value ) {
+	public static function display_description($value) {
 		$config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
-		$display_description= isset( $config->display_description ) ? $config->display_description : 1;
+		$display_description = isset($config->display_description) ? $config->display_description : 1;
 		return $display_description === $value ? TRUE : FALSE;
 	}
 
@@ -740,7 +740,7 @@ 
 	 */
 	public static function display_ticket_selector() {
 		$config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
-		return isset( $config->display_ticket_selector ) && $config->display_ticket_selector ? TRUE : FALSE;
+		return isset($config->display_ticket_selector) && $config->display_ticket_selector ? TRUE : FALSE;
 	}
 
 
@@ -753,7 +753,7 @@ 
 	 */
 	public static function display_venue() {
 		$config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
-		return isset( $config->display_venue ) && $config->display_venue && EEH_Venue_View::venue_name() ? TRUE : FALSE;
+		return isset($config->display_venue) && $config->display_venue && EEH_Venue_View::venue_name() ? TRUE : FALSE;
 	}
 
 
@@ -765,7 +765,7 @@ 
 	 */
 	public static function display_datetimes() {
 		$config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
-		return isset( $config->display_datetimes ) && $config->display_datetimes ? TRUE : FALSE;
+		return isset($config->display_datetimes) && $config->display_datetimes ? TRUE : FALSE;
 }
 
 
@@ -780,7 +780,7 @@ 
 	 *  @return 	string
 	 */
 	public static function event_list_title() {
-		return apply_filters( 'FHEE__archive_espresso_events_template__upcoming_events_h1', __( 'Upcoming Events', 'event_espresso' ));
+		return apply_filters('FHEE__archive_espresso_events_template__upcoming_events_h1', __('Upcoming Events', 'event_espresso'));
 	}
 
 
@@ -789,11 +789,11 @@ 
 	/**
 	 * 	@since 4.4.0
 	 */
-	public static function _doing_it_wrong_notice( $function = '' ) {
+	public static function _doing_it_wrong_notice($function = '') {
 		EE_Error::doing_it_wrong(
 			__FUNCTION__,
 			sprintf(
-				__( 'EED_Events_Archive::%1$s was moved to EEH_Event_Query::%1$s:%2$sPlease update your existing code because the method it calls will be removed in version %3$s', 'event_espresso' ),
+				__('EED_Events_Archive::%1$s was moved to EEH_Event_Query::%1$s:%2$sPlease update your existing code because the method it calls will be removed in version %3$s', 'event_espresso'),
 				$function,
 				'<br />',
 				'4.6.0'
@@ -815,89 +815,89 @@ 
 	 * 	@deprecated
 	 * 	@since 4.4.0
 	 */
-	public function posts_fields( $SQL, WP_Query $wp_query ) {
-		EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ );
-		return EEH_Event_Query::posts_fields( $SQL, $wp_query );
+	public function posts_fields($SQL, WP_Query $wp_query) {
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_fields($SQL, $wp_query);
 	}
 	/**
 	 * 	@deprecated
 	 * 	@since 4.4.0
 	 */
-	public static function posts_fields_sql_for_orderby( $orderby_params = array() ) {
-		EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ );
-		return EEH_Event_Query::posts_fields_sql_for_orderby( $orderby_params );
+	public static function posts_fields_sql_for_orderby($orderby_params = array()) {
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_fields_sql_for_orderby($orderby_params);
 	}
 	/**
 	 * 	@deprecated
 	 * 	@since 4.4.0
 	 */
-	public function posts_join( $SQL, WP_Query $wp_query ) {
-		EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ );
-		return EEH_Event_Query::posts_join( $SQL, $wp_query );
+	public function posts_join($SQL, WP_Query $wp_query) {
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_join($SQL, $wp_query);
 	}
 	/**
 	 * 	@deprecated
 	 * 	@since 4.4.0
 	 */
-	public static function posts_join_sql_for_terms( $join_terms = NULL ) {
-		EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ );
-		return EEH_Event_Query::posts_join_sql_for_terms( $join_terms );
+	public static function posts_join_sql_for_terms($join_terms = NULL) {
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_join_sql_for_terms($join_terms);
 	}
 	/**
 	 * 	@deprecated
 	 * 	@since 4.4.0
 	 */
-	public static function posts_join_for_orderby( $orderby_params = array() ) {
-		EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ );
-		return EEH_Event_Query::posts_join_for_orderby( $orderby_params );
+	public static function posts_join_for_orderby($orderby_params = array()) {
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_join_for_orderby($orderby_params);
 	}
 	/**
 	 * 	@deprecated
 	 * 	@since 4.4.0
 	 */
-	public function posts_where( $SQL, WP_Query $wp_query ) {
-		EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ );
-		return EEH_Event_Query::posts_where( $SQL, $wp_query );
+	public function posts_where($SQL, WP_Query $wp_query) {
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_where($SQL, $wp_query);
 	}
 	/**
 	 * 	@deprecated
 	 * 	@since 4.4.0
 	 */
-	public static function posts_where_sql_for_show_expired( $show_expired = FALSE ) {
-		EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ );
-		return EEH_Event_Query::posts_where_sql_for_show_expired( $show_expired );
+	public static function posts_where_sql_for_show_expired($show_expired = FALSE) {
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_where_sql_for_show_expired($show_expired);
 	}
 	/**
 	 * 	@deprecated
 	 * 	@since 4.4.0
 	 */
-	public static function posts_where_sql_for_event_category_slug( $event_category_slug = NULL ) {
-		EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ );
-		return EEH_Event_Query::posts_where_sql_for_event_category_slug( $event_category_slug );
+	public static function posts_where_sql_for_event_category_slug($event_category_slug = NULL) {
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_where_sql_for_event_category_slug($event_category_slug);
 	}
 	/**
 	 * 	@deprecated
 	 * 	@since 4.4.0
 	 */
-	public static function posts_where_sql_for_event_list_month( $month = NULL ) {
-		EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ );
-		return EEH_Event_Query::posts_where_sql_for_event_list_month( $month );
+	public static function posts_where_sql_for_event_list_month($month = NULL) {
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_where_sql_for_event_list_month($month);
 	}
 	/**
 	 * 	@deprecated
 	 * 	@since 4.4.0
 	 */
-	public function posts_orderby( $SQL, WP_Query $wp_query ) {
-		EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ );
-		return EEH_Event_Query::posts_orderby( $SQL, $wp_query );
+	public function posts_orderby($SQL, WP_Query $wp_query) {
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_orderby($SQL, $wp_query);
 	}
 	/**
 	 * 	@deprecated
 	 * 	@since 4.4.0
 	 */
-	public static function posts_orderby_sql( $orderby_params = array(), $sort = 'ASC' ) {
-		EED_Events_Archive::_doing_it_wrong_notice( __FUNCTION__ );
-		return EEH_Event_Query::posts_orderby_sql( $orderby_params, $sort );
+	public static function posts_orderby_sql($orderby_params = array(), $sort = 'ASC') {
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_orderby_sql($orderby_params, $sort);
 	}
 
 
@@ -928,8 +928,8 @@ 
  * @param string $extra_class
  * @return string
  */
-function espresso_event_list_css( $extra_class = '' ) {
-	return EED_Events_Archive::event_list_css( $extra_class );
+function espresso_event_list_css($extra_class = '') {
+	return EED_Events_Archive::event_list_css($extra_class);
 }
 
 /**
@@ -943,14 +943,14 @@ 
  * @return bool
  */
 function espresso_display_full_description_in_event_list() {
-	return EED_Events_Archive::display_description( 2 );
+	return EED_Events_Archive::display_description(2);
 }
 
 /**
  * @return bool
  */
 function espresso_display_excerpt_in_event_list() {
-	return EED_Events_Archive::display_description( 1 );
+	return EED_Events_Archive::display_description(1);
 }
 
 /**

modules/ticket_selector/DisplayTicketSelector.php

Indentation +670 added lines, -670 removed lines

@@ -2,7 +2,7 @@ 
 namespace EventEspresso\modules\ticket_selector;
 
 if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-    exit( 'No direct script access allowed' );
+	exit( 'No direct script access allowed' );
 }
 
 
@@ -19,678 +19,678 @@ 
 class DisplayTicketSelector
 {
 
-    /**
-     * event that ticket selector is being generated for
-     *
-     * @access protected
-     * @var \EE_Event $event
-     */
-    protected $event;
-
-    /**
-     * Used to flag when the ticket selector is being called from an external iframe.
-     *
-     * @var bool $iframe
-     */
-    protected $iframe = false;
-
-    /**
-     * max attendees that can register for event at one time
-     *
-     * @var int $max_attendees
-     */
-    private $max_attendees = EE_INF;
-
-    /**
-     *@var string $date_format
-     */
-    private $date_format = '';
-
-    /**
-     *@var string $time_format
-     */
-    private $time_format = '';
-
-
-
-    /**
-     * DisplayTicketSelector constructor.
-     */
-    public function __construct()
-    {
-        $this->date_format = apply_filters(
-            'FHEE__EED_Ticket_Selector__display_ticket_selector__date_format',
-            get_option('date_format')
-        );
-        $this->time_format = apply_filters(
-            'FHEE__EED_Ticket_Selector__display_ticket_selector__time_format',
-            get_option('time_format')
-        );
-    }
-
-
-
-    /**
-     * @param boolean $iframe
-     */
-    public function setIframe( $iframe = true )
-    {
-        $this->iframe = filter_var( $iframe, FILTER_VALIDATE_BOOLEAN );
-    }
-
-
-
-    /**
-     * finds and sets the \EE_Event object for use throughout class
-     *
-     * @param    mixed $event
-     * @return    bool
-     */
-    protected function setEvent( $event = null )
-    {
-        if ( $event === null ) {
-            global $post;
-            $event = $post;
-        }
-        if ( $event instanceof \EE_Event ) {
-            $this->event = $event;
-        } else if ( $event instanceof \WP_Post ) {
-            if ( isset( $event->EE_Event ) && $event->EE_Event instanceof \EE_Event ) {
-                $this->event = $event->EE_Event;
-            } else if ( $event->post_type === 'espresso_events' ) {
-                $event->EE_Event = \EEM_Event::instance()->instantiate_class_from_post_object( $event );
-                $this->event = $event->EE_Event;
-            }
-        } else {
-            $user_msg = __( 'No Event object or an invalid Event object was supplied.', 'event_espresso' );
-            $dev_msg = $user_msg . __(
-                    'In order to generate a ticket selector, please ensure you are passing either an EE_Event object or a WP_Post object of the post type "espresso_event" to the EE_Ticket_Selector class constructor.',
-                    'event_espresso'
-                );
-            \EE_Error::add_error( $user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__ );
-            return false;
-        }
-        return true;
-    }
-
-
-
-    /**
-     * @return int
-     */
-    public function getMaxAttendees()
-    {
-        return $this->max_attendees;
-    }
-
-
-
-    /**
-     * @param int $max_attendees
-     */
-    public function setMaxAttendees($max_attendees)
-    {
-        $this->max_attendees = absint(
-            apply_filters(
-                'FHEE__EE_Ticket_Selector__display_ticket_selector__max_tickets',
-                $max_attendees
-            )
-        );
-    }
-
-
-
-    /**
-     * creates buttons for selecting number of attendees for an event
-     *
-     * @param \WP_Post|int $event
-     * @param bool         $view_details
-     * @return string
-     * @throws \EE_Error
-     */
-    public function display( $event = null, $view_details = false )
-    {
-        // reset filter for displaying submit button
-        remove_filter( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true' );
-        // poke and prod incoming event till it tells us what it is
-        if ( ! $this->setEvent( $event ) ) {
-            return false;
-        }
-        // begin gathering template arguments by getting event status
-        $template_args = array( 'event_status' => $this->event->get_active_status() );
-        if ( $this->activeEventAndShowTicketSelector($event, $template_args['event_status'], $view_details) ) {
-            return ! is_single() ? $this->displayViewDetailsButton() : '';
-        }
-        // filter the maximum qty that can appear in the Ticket Selector qty dropdowns
-        $this->setMaxAttendees($this->event->additional_limit());
-        if ($this->getMaxAttendees() < 1) {
-            return $this->ticketSalesClosedMessage();
-        }
-        // is the event expired ?
-        $template_args['event_is_expired'] = $this->event->is_expired();
-        if ( $template_args[ 'event_is_expired' ] ) {
-            return $this->expiredEventMessage();
-        }
-        // get all tickets for this event ordered by the datetime
-        $tickets = $this->getTickets();
-        if (count($tickets) < 1) {
-            return $this->noTicketAvailableMessage();
-        }
-        if (\EED_Events_Archive::is_iframe()){
-            $this->setIframe();
-        }
-        // redirecting to another site for registration ??
-        $external_url = (string) $this->event->external_url();
-        // if redirecting to another site for registration, then we don't load the TS
-        $ticket_selector = $external_url
-            ? $this->externalEventRegistration()
-            : $this->loadTicketSelector($tickets,$template_args);
-        // now set up the form (but not for the admin)
-        $ticket_selector = ! is_admin()
-            ? $this->formOpen($this->event->ID(), $external_url) . $ticket_selector
-            : $ticket_selector;
-        // submit button and form close tag
-        $ticket_selector .= ! is_admin() ? $this->displaySubmitButton($external_url) : '';
-        return $ticket_selector;
-    }
-
-
-
-    /**
-     * displayTicketSelector
-     * examines the event properties and determines whether a Ticket Selector should be displayed
-     *
-     * @param \WP_Post|int $event
-     * @param string       $_event_active_status
-     * @param bool         $view_details
-     * @return bool
-     * @throws \EE_Error
-     */
-    protected function activeEventAndShowTicketSelector($event, $_event_active_status, $view_details)
-    {
-        $event_post = $this->event instanceof \EE_Event ? $this->event->ID() : $event;
-        return ! is_admin()
-               && (
-                   ! $this->event->display_ticket_selector()
-                   || $view_details
-                   || post_password_required($event_post)
-                   || (
-                       $_event_active_status !== \EE_Datetime::active
-                       && $_event_active_status !== \EE_Datetime::upcoming
-                       && $_event_active_status !== \EE_Datetime::sold_out
-                       && ! (
-                           $_event_active_status === \EE_Datetime::inactive
-                           && is_user_logged_in()
-                       )
-                   )
-               );
-    }
-
-
-
-    /**
-     * noTicketAvailableMessage
-     * notice displayed if event is expired
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    protected function expiredEventMessage()
-    {
-        return '<div class="ee-event-expired-notice"><span class="important-notice">' . esc_html__(
-            'We\'re sorry, but all tickets sales have ended because the event is expired.',
-            'event_espresso'
-        ) . '</span></div>';
-    }
-
-
-
-    /**
-     * noTicketAvailableMessage
-     * notice displayed if event has no more tickets available
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    protected function noTicketAvailableMessage()
-    {
-        $no_ticket_available_msg = esc_html__( 'We\'re sorry, but all ticket sales have ended.', 'event_espresso' );
-        if (current_user_can('edit_post', $this->event->ID())) {
-            $no_ticket_available_msg .= sprintf(
-                esc_html__(
-                    '%1$sNote to Event Admin:%2$sNo tickets were found for this event. This effectively turns off ticket sales. Please ensure that at least one ticket is available for if you want people to be able to register.%3$s(click to edit this event)%4$s',
-                    'event_espresso'
-                ),
-                '<div class="ee-attention" style="text-align: left;"><b>',
-                '</b><br />',
-                '<span class="edit-link"><a class="post-edit-link" href="'.get_edit_post_link($this->event->ID()).'">',
-                '</a></span></div>'
-            );
-        }
-        return '
+	/**
+	 * event that ticket selector is being generated for
+	 *
+	 * @access protected
+	 * @var \EE_Event $event
+	 */
+	protected $event;
+
+	/**
+	 * Used to flag when the ticket selector is being called from an external iframe.
+	 *
+	 * @var bool $iframe
+	 */
+	protected $iframe = false;
+
+	/**
+	 * max attendees that can register for event at one time
+	 *
+	 * @var int $max_attendees
+	 */
+	private $max_attendees = EE_INF;
+
+	/**
+	 *@var string $date_format
+	 */
+	private $date_format = '';
+
+	/**
+	 *@var string $time_format
+	 */
+	private $time_format = '';
+
+
+
+	/**
+	 * DisplayTicketSelector constructor.
+	 */
+	public function __construct()
+	{
+		$this->date_format = apply_filters(
+			'FHEE__EED_Ticket_Selector__display_ticket_selector__date_format',
+			get_option('date_format')
+		);
+		$this->time_format = apply_filters(
+			'FHEE__EED_Ticket_Selector__display_ticket_selector__time_format',
+			get_option('time_format')
+		);
+	}
+
+
+
+	/**
+	 * @param boolean $iframe
+	 */
+	public function setIframe( $iframe = true )
+	{
+		$this->iframe = filter_var( $iframe, FILTER_VALIDATE_BOOLEAN );
+	}
+
+
+
+	/**
+	 * finds and sets the \EE_Event object for use throughout class
+	 *
+	 * @param    mixed $event
+	 * @return    bool
+	 */
+	protected function setEvent( $event = null )
+	{
+		if ( $event === null ) {
+			global $post;
+			$event = $post;
+		}
+		if ( $event instanceof \EE_Event ) {
+			$this->event = $event;
+		} else if ( $event instanceof \WP_Post ) {
+			if ( isset( $event->EE_Event ) && $event->EE_Event instanceof \EE_Event ) {
+				$this->event = $event->EE_Event;
+			} else if ( $event->post_type === 'espresso_events' ) {
+				$event->EE_Event = \EEM_Event::instance()->instantiate_class_from_post_object( $event );
+				$this->event = $event->EE_Event;
+			}
+		} else {
+			$user_msg = __( 'No Event object or an invalid Event object was supplied.', 'event_espresso' );
+			$dev_msg = $user_msg . __(
+					'In order to generate a ticket selector, please ensure you are passing either an EE_Event object or a WP_Post object of the post type "espresso_event" to the EE_Ticket_Selector class constructor.',
+					'event_espresso'
+				);
+			\EE_Error::add_error( $user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__ );
+			return false;
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * @return int
+	 */
+	public function getMaxAttendees()
+	{
+		return $this->max_attendees;
+	}
+
+
+
+	/**
+	 * @param int $max_attendees
+	 */
+	public function setMaxAttendees($max_attendees)
+	{
+		$this->max_attendees = absint(
+			apply_filters(
+				'FHEE__EE_Ticket_Selector__display_ticket_selector__max_tickets',
+				$max_attendees
+			)
+		);
+	}
+
+
+
+	/**
+	 * creates buttons for selecting number of attendees for an event
+	 *
+	 * @param \WP_Post|int $event
+	 * @param bool         $view_details
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function display( $event = null, $view_details = false )
+	{
+		// reset filter for displaying submit button
+		remove_filter( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true' );
+		// poke and prod incoming event till it tells us what it is
+		if ( ! $this->setEvent( $event ) ) {
+			return false;
+		}
+		// begin gathering template arguments by getting event status
+		$template_args = array( 'event_status' => $this->event->get_active_status() );
+		if ( $this->activeEventAndShowTicketSelector($event, $template_args['event_status'], $view_details) ) {
+			return ! is_single() ? $this->displayViewDetailsButton() : '';
+		}
+		// filter the maximum qty that can appear in the Ticket Selector qty dropdowns
+		$this->setMaxAttendees($this->event->additional_limit());
+		if ($this->getMaxAttendees() < 1) {
+			return $this->ticketSalesClosedMessage();
+		}
+		// is the event expired ?
+		$template_args['event_is_expired'] = $this->event->is_expired();
+		if ( $template_args[ 'event_is_expired' ] ) {
+			return $this->expiredEventMessage();
+		}
+		// get all tickets for this event ordered by the datetime
+		$tickets = $this->getTickets();
+		if (count($tickets) < 1) {
+			return $this->noTicketAvailableMessage();
+		}
+		if (\EED_Events_Archive::is_iframe()){
+			$this->setIframe();
+		}
+		// redirecting to another site for registration ??
+		$external_url = (string) $this->event->external_url();
+		// if redirecting to another site for registration, then we don't load the TS
+		$ticket_selector = $external_url
+			? $this->externalEventRegistration()
+			: $this->loadTicketSelector($tickets,$template_args);
+		// now set up the form (but not for the admin)
+		$ticket_selector = ! is_admin()
+			? $this->formOpen($this->event->ID(), $external_url) . $ticket_selector
+			: $ticket_selector;
+		// submit button and form close tag
+		$ticket_selector .= ! is_admin() ? $this->displaySubmitButton($external_url) : '';
+		return $ticket_selector;
+	}
+
+
+
+	/**
+	 * displayTicketSelector
+	 * examines the event properties and determines whether a Ticket Selector should be displayed
+	 *
+	 * @param \WP_Post|int $event
+	 * @param string       $_event_active_status
+	 * @param bool         $view_details
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	protected function activeEventAndShowTicketSelector($event, $_event_active_status, $view_details)
+	{
+		$event_post = $this->event instanceof \EE_Event ? $this->event->ID() : $event;
+		return ! is_admin()
+			   && (
+				   ! $this->event->display_ticket_selector()
+				   || $view_details
+				   || post_password_required($event_post)
+				   || (
+					   $_event_active_status !== \EE_Datetime::active
+					   && $_event_active_status !== \EE_Datetime::upcoming
+					   && $_event_active_status !== \EE_Datetime::sold_out
+					   && ! (
+						   $_event_active_status === \EE_Datetime::inactive
+						   && is_user_logged_in()
+					   )
+				   )
+			   );
+	}
+
+
+
+	/**
+	 * noTicketAvailableMessage
+	 * notice displayed if event is expired
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	protected function expiredEventMessage()
+	{
+		return '<div class="ee-event-expired-notice"><span class="important-notice">' . esc_html__(
+			'We\'re sorry, but all tickets sales have ended because the event is expired.',
+			'event_espresso'
+		) . '</span></div>';
+	}
+
+
+
+	/**
+	 * noTicketAvailableMessage
+	 * notice displayed if event has no more tickets available
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	protected function noTicketAvailableMessage()
+	{
+		$no_ticket_available_msg = esc_html__( 'We\'re sorry, but all ticket sales have ended.', 'event_espresso' );
+		if (current_user_can('edit_post', $this->event->ID())) {
+			$no_ticket_available_msg .= sprintf(
+				esc_html__(
+					'%1$sNote to Event Admin:%2$sNo tickets were found for this event. This effectively turns off ticket sales. Please ensure that at least one ticket is available for if you want people to be able to register.%3$s(click to edit this event)%4$s',
+					'event_espresso'
+				),
+				'<div class="ee-attention" style="text-align: left;"><b>',
+				'</b><br />',
+				'<span class="edit-link"><a class="post-edit-link" href="'.get_edit_post_link($this->event->ID()).'">',
+				'</a></span></div>'
+			);
+		}
+		return '
             <div class="ee-event-expired-notice">
                 <span class="important-notice">' . $no_ticket_available_msg . '</span>
             </div>';
-    }
-
-
-
-    /**
-     * ticketSalesClosed
-     * notice displayed if event ticket sales are turned off
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    protected function ticketSalesClosedMessage()
-    {
-        $sales_closed_msg = esc_html__(
-            'We\'re sorry, but ticket sales have been closed at this time. Please check back again later.',
-            'event_espresso'
-        );
-        if (current_user_can('edit_post', $this->event->ID())) {
-            $sales_closed_msg .= sprintf(
-                esc_html__(
-                    '%sNote to Event Admin:%sThe "Maximum number of tickets allowed per order for this event" in the Event Registration Options has been set to "0". This effectively turns off ticket sales. %s(click to edit this event)%s',
-                    'event_espresso'
-                ),
-                '<div class="ee-attention" style="text-align: left;"><b>',
-                '</b><br />',
-                '<span class="edit-link"><a class="post-edit-link" href="'.get_edit_post_link($this->event->ID()).'">',
-                '</a></span></div>'
-            );
-        }
-        return '<p><span class="important-notice">' . $sales_closed_msg . '</span></p>';
-    }
-
-
-
-    /**
-     * getTickets
-     *
-     * @return \EE_Base_Class[]|\EE_Ticket[]
-     * @throws \EE_Error
-     */
-    protected function getTickets()
-    {
-        $ticket_query_args = array(
-            array('Datetime.EVT_ID' => $this->event->ID()),
-            'order_by' => array(
-                'TKT_order'              => 'ASC',
-                'TKT_required'           => 'DESC',
-                'TKT_start_date'         => 'ASC',
-                'TKT_end_date'           => 'ASC',
-                'Datetime.DTT_EVT_start' => 'DESC',
-            ),
-        );
-        if ( ! \EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector->show_expired_tickets) {
-            //use the correct applicable time query depending on what version of core is being run.
-            $current_time = method_exists('EEM_Datetime', 'current_time_for_query')
-                ? time()
-                : current_time('timestamp');
-            $ticket_query_args[0]['TKT_end_date'] = array('>', $current_time);
-        }
-        return \EEM_Ticket::instance()->get_all($ticket_query_args);
-    }
-
-
-
-    /**
-     * loadTicketSelector
-     * begins to assemble template arguments
-     * and decides whether to load a "simple" ticket selector, or the standard
-     *
-     * @param \EE_Ticket[] $tickets
-     * @param array $template_args
-     * @return string
-     * @throws \EE_Error
-     */
-    protected function loadTicketSelector(array $tickets, array $template_args)
-    {
-        $template_args['event'] = $this->event;
-        $template_args['EVT_ID'] = $this->event->ID();
-        $template_args['event_is_expired'] = $this->event->is_expired();
-        $template_args['max_atndz'] = $this->getMaxAttendees();
-        $template_args['date_format'] = $this->date_format;
-        $template_args['time_format'] = $this->time_format;
-        /**
-         * Filters the anchor ID used when redirecting to the Ticket Selector if no quantity selected
-         *
-         * @since 4.9.13
-         * @param     string  '#tkt-slctr-tbl-' . $EVT_ID The html ID to anchor to
-         * @param int $EVT_ID The Event ID
-         */
-        $template_args['anchor_id'] = apply_filters(
-            'FHEE__EE_Ticket_Selector__redirect_anchor_id',
-            '#tkt-slctr-tbl-' . $this->event->ID(),
-            $this->event->ID()
-        );
-        $template_args['tickets'] = $tickets;
-        $template_args['ticket_count'] = count($tickets);
-        $ticket_selector = $this->simpleTicketSelector( $tickets, $template_args);
-        return $ticket_selector instanceof TicketSelectorSimple
-            ? $ticket_selector
-            : new TicketSelectorStandard(
-                $this->event,
-                $tickets,
-                $this->getMaxAttendees(),
-                $template_args,
-                $this->date_format,
-                $this->time_format
-            );
-    }
-
-
-
-    /**
-     * simpleTicketSelector
-     * there's one ticket, and max attendees is set to one,
-     * so if the event is free, then this is a "simple" ticket selector
-     * a.k.a. "Dude Where's my Ticket Selector?"
-     *
-     * @param \EE_Ticket[] $tickets
-     * @param array  $template_args
-     * @return string
-     * @throws \EE_Error
-     */
-    protected function simpleTicketSelector($tickets, array $template_args)
-    {
-        // if there is only ONE ticket with a max qty of ONE
-        if (count($tickets) > 1 || $this->getMaxAttendees() !== 1) {
-            return '';
-        }
-        /** @var \EE_Ticket $ticket */
-        $ticket = reset($tickets);
-        // if the ticket is free... then not much need for the ticket selector
-        if (
-            apply_filters(
-                'FHEE__ticket_selector_chart_template__hide_ticket_selector',
-                $ticket->is_free(),
-                $this->event->ID()
-            )
-        ) {
-            return new TicketSelectorSimple(
-                $this->event,
-                $ticket,
-                $this->getMaxAttendees(),
-                $template_args
-            );
-        }
-        return '';
-    }
-
-
-
-    /**
-     * externalEventRegistration
-     *
-     * @return string
-     */
-    public function externalEventRegistration()
-    {
-        // if not we still need to trigger the display of the submit button
-        add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
-        //display notice to admin that registration is external
-        return is_admin()
-            ? esc_html__(
-                'Registration is at an external URL for this event.',
-                'event_espresso'
-            )
-            : '';
-    }
-
-
-
-    /**
-     * formOpen
-     *
-     * @param        int    $ID
-     * @param        string $external_url
-     * @return        string
-     */
-    public function formOpen( $ID = 0, $external_url = '' )
-    {
-        // if redirecting, we don't need any anything else
-        if ( $external_url ) {
-            $html = '<form method="GET" action="' . \EEH_URL::refactor_url($external_url) . '"';
-            // open link in new window ?
-            $html .= apply_filters(
-                'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__formOpen__external_url_target_blank',
-                \EED_Events_Archive::is_iframe()
-            )
-                ? ' target="_blank"'
-                : '';
-            $html .= '>';
-            $query_args = \EEH_URL::get_query_string( $external_url );
-            foreach ( (array)$query_args as $query_arg => $value ) {
-                $html .= '<input type="hidden" name="' . $query_arg . '" value="' . $value . '">';
-            }
-            return $html;
-        }
-        // if there is no submit button, then don't start building a form
-        // because the "View Details" button will build its own form
-        if ( ! apply_filters( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false ) ) {
-            return '';
-        }
-        $checkout_url = \EEH_Event_View::event_link_url( $ID );
-        if ( ! $checkout_url ) {
-            \EE_Error::add_error(
-                esc_html__( 'The URL for the Event Details page could not be retrieved.', 'event_espresso' ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        // set no cache headers and constants
-        \EE_System::do_not_cache();
-        $extra_params = $this->iframe ? ' target="_blank"' : '';
-        $html = '<form method="POST" action="' . $checkout_url . '"' . $extra_params . '>';
-        $html .= wp_nonce_field( 'process_ticket_selections', 'process_ticket_selections_nonce_' . $ID, true, false );
-        $html .= '<input type="hidden" name="ee" value="process_ticket_selections">';
-        $html = apply_filters( 'FHEE__EE_Ticket_Selector__ticket_selector_form_open__html', $html, $this->event );
-        return $html;
-    }
-
-
-
-    /**
-     * displaySubmitButton
-     *
-     * @param  string $external_url
-     * @return string
-     * @throws \EE_Error
-     */
-    public function displaySubmitButton($external_url = '')
-    {
-        $html = '';
-        if ( ! is_admin()) {
-            // standard TS displayed with submit button, ie: "Register Now"
-            if (apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
-                $html .= $this->displayRegisterNowButton();
-                $html .= empty($external_url)
-                    ? $this->ticketSelectorEndDiv()
-                    : $this->clearTicketSelector();
-                $html .= '<br/>' . $this->formClose();
-            } else if ($this->getMaxAttendees() === 1) {
-                // its a "Dude Where's my Ticket Selector?" (DWMTS) type event (ie: $_max_atndz === 1)
-                if ($this->event->is_sold_out()) {
-                    // then instead of a View Details or Submit button, just display a "Sold Out" message
-                    $html .= apply_filters(
-                        'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__sold_out_msg',
-                        sprintf(
-                            __(
-                                '%1$s"%2$s" is currently sold out.%4$sPlease check back again later, as spots may become available.%3$s',
-                                'event_espresso'
-                            ),
-                            '<p class="no-ticket-selector-msg clear-float">',
-                            $this->event->name(),
-                            '</p>',
-                            '<br />'
-                        ),
-                        $this->event
-                    );
-                    if (
-                    apply_filters(
-                        'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
-                        false,
-                        $this->event
-                    )
-                    ) {
-                        $html .= $this->displayRegisterNowButton();
-                    }
-                    // sold out DWMTS event, no TS, no submit or view details button, but has additional content
-                    $html .= $this->ticketSelectorEndDiv();
-                } else if (
-                    apply_filters('FHEE__EE_Ticket_Selector__hide_ticket_selector', false)
-                    && ! is_single()
-                ) {
-                    // this is a "Dude Where's my Ticket Selector?" (DWMTS) type event,
-                    // but no tickets are available, so display event's "View Details" button.
-                    // it is being viewed via somewhere other than a single post
-                    $html .= $this->displayViewDetailsButton(true);
-                }
-            } else if (is_archive()) {
-                // event list, no tickets available so display event's "View Details" button
-                $html .= $this->ticketSelectorEndDiv();
-                $html .= $this->displayViewDetailsButton();
-            } else {
-                if (
-                apply_filters(
-                    'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
-                    false,
-                    $this->event
-                )
-                ) {
-                    $html .= $this->displayRegisterNowButton();
-                }
-                // no submit or view details button, and no additional content
-                $html .= $this->ticketSelectorEndDiv();
-            }
-            if ( ! $this->iframe && ! is_archive()) {
-                $html .= \EEH_Template::powered_by_event_espresso('', '', array('utm_content' => 'ticket_selector'));
-            }
-        }
-        return $html;
-    }
-
-
-
-    /**
-     * @return string
-     * @throws \EE_Error
-     */
-    public function displayRegisterNowButton()
-    {
-        $btn_text = apply_filters(
-            'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__btn_text',
-            __('Register Now', 'event_espresso'),
-            $this->event
-        );
-        $external_url = $this->event->external_url();
-        $html = \EEH_HTML::div(
-            '', 'ticket-selector-submit-' . $this->event->ID() . '-btn-wrap', 'ticket-selector-submit-btn-wrap'
-        );
-        $html .= '<input id="ticket-selector-submit-' . $this->event->ID() . '-btn"';
-        $html .= ' class="ticket-selector-submit-btn ';
-        $html .= empty($external_url) ? 'ticket-selector-submit-ajax"' : '"';
-        $html .= ' type="submit" value="' . $btn_text . '" />';
-        $html .= \EEH_HTML::divx();
-        $html .= apply_filters(
-            'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
-            '',
-            $this->event
-        );
-        return $html;
-    }
-
-
-    /**
-     * displayViewDetailsButton
-     *
-     * @param bool $DWMTS indicates a "Dude Where's my Ticket Selector?" (DWMTS) type event
-     *                    (ie: $_max_atndz === 1) where there are no available tickets,
-     *                    either because they are sold out, expired, or not yet on sale.
-     *                    In this case, we need to close the form BEFORE adding any closing divs
-     * @return string
-     * @throws \EE_Error
-     */
-    public function displayViewDetailsButton( $DWMTS = false )
-    {
-        if ( ! $this->event->get_permalink() ) {
-            \EE_Error::add_error(
-                esc_html__( 'The URL for the Event Details page could not be retrieved.', 'event_espresso' ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-        $view_details_btn = '<form method="POST" action="';
-        $view_details_btn .= apply_filters(
-            'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_url',
-            $this->event->get_permalink(),
-            $this->event
-        );
-        $view_details_btn .= '"';
-        // open link in new window ?
-        $view_details_btn .= apply_filters(
-            'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__displayViewDetailsButton__url_target_blank',
-            \EED_Events_Archive::is_iframe()
-        )
-            ? ' target="_blank"'
-            : '';
-        $view_details_btn .='>';
-        $btn_text = apply_filters(
-            'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_text',
-            esc_html__('View Details', 'event_espresso'),
-            $this->event
-        );
-        $view_details_btn .= '<input id="ticket-selector-submit-'
-                             . $this->event->ID()
-                             . '-btn" class="ticket-selector-submit-btn view-details-btn" type="submit" value="'
-                             . $btn_text
-                             . '" />';
-        $view_details_btn .= apply_filters( 'FHEE__EE_Ticket_Selector__after_view_details_btn', '', $this->event );
-        if ($DWMTS) {
-            $view_details_btn .= $this->formClose();
-            $view_details_btn .= $this->ticketSelectorEndDiv();
-            $view_details_btn .= '<br/>';
-        } else {
-            $view_details_btn .= $this->clearTicketSelector();
-            $view_details_btn .= '<br/>';
-            $view_details_btn .= $this->formClose();
-        }
-        return $view_details_btn;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function ticketSelectorEndDiv()
-    {
-        return '<div class="clear"></div></div>';
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function clearTicketSelector()
-    {
-        // standard TS displayed, appears after a "Register Now" or "view Details" button
-        return '<div class="clear"></div>';
-    }
-
-
-
-    /**
-     * @access        public
-     * @return        string
-     */
-    public function formClose()
-    {
-        return '</form>';
-    }
+	}
+
+
+
+	/**
+	 * ticketSalesClosed
+	 * notice displayed if event ticket sales are turned off
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	protected function ticketSalesClosedMessage()
+	{
+		$sales_closed_msg = esc_html__(
+			'We\'re sorry, but ticket sales have been closed at this time. Please check back again later.',
+			'event_espresso'
+		);
+		if (current_user_can('edit_post', $this->event->ID())) {
+			$sales_closed_msg .= sprintf(
+				esc_html__(
+					'%sNote to Event Admin:%sThe "Maximum number of tickets allowed per order for this event" in the Event Registration Options has been set to "0". This effectively turns off ticket sales. %s(click to edit this event)%s',
+					'event_espresso'
+				),
+				'<div class="ee-attention" style="text-align: left;"><b>',
+				'</b><br />',
+				'<span class="edit-link"><a class="post-edit-link" href="'.get_edit_post_link($this->event->ID()).'">',
+				'</a></span></div>'
+			);
+		}
+		return '<p><span class="important-notice">' . $sales_closed_msg . '</span></p>';
+	}
+
+
+
+	/**
+	 * getTickets
+	 *
+	 * @return \EE_Base_Class[]|\EE_Ticket[]
+	 * @throws \EE_Error
+	 */
+	protected function getTickets()
+	{
+		$ticket_query_args = array(
+			array('Datetime.EVT_ID' => $this->event->ID()),
+			'order_by' => array(
+				'TKT_order'              => 'ASC',
+				'TKT_required'           => 'DESC',
+				'TKT_start_date'         => 'ASC',
+				'TKT_end_date'           => 'ASC',
+				'Datetime.DTT_EVT_start' => 'DESC',
+			),
+		);
+		if ( ! \EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector->show_expired_tickets) {
+			//use the correct applicable time query depending on what version of core is being run.
+			$current_time = method_exists('EEM_Datetime', 'current_time_for_query')
+				? time()
+				: current_time('timestamp');
+			$ticket_query_args[0]['TKT_end_date'] = array('>', $current_time);
+		}
+		return \EEM_Ticket::instance()->get_all($ticket_query_args);
+	}
+
+
+
+	/**
+	 * loadTicketSelector
+	 * begins to assemble template arguments
+	 * and decides whether to load a "simple" ticket selector, or the standard
+	 *
+	 * @param \EE_Ticket[] $tickets
+	 * @param array $template_args
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	protected function loadTicketSelector(array $tickets, array $template_args)
+	{
+		$template_args['event'] = $this->event;
+		$template_args['EVT_ID'] = $this->event->ID();
+		$template_args['event_is_expired'] = $this->event->is_expired();
+		$template_args['max_atndz'] = $this->getMaxAttendees();
+		$template_args['date_format'] = $this->date_format;
+		$template_args['time_format'] = $this->time_format;
+		/**
+		 * Filters the anchor ID used when redirecting to the Ticket Selector if no quantity selected
+		 *
+		 * @since 4.9.13
+		 * @param     string  '#tkt-slctr-tbl-' . $EVT_ID The html ID to anchor to
+		 * @param int $EVT_ID The Event ID
+		 */
+		$template_args['anchor_id'] = apply_filters(
+			'FHEE__EE_Ticket_Selector__redirect_anchor_id',
+			'#tkt-slctr-tbl-' . $this->event->ID(),
+			$this->event->ID()
+		);
+		$template_args['tickets'] = $tickets;
+		$template_args['ticket_count'] = count($tickets);
+		$ticket_selector = $this->simpleTicketSelector( $tickets, $template_args);
+		return $ticket_selector instanceof TicketSelectorSimple
+			? $ticket_selector
+			: new TicketSelectorStandard(
+				$this->event,
+				$tickets,
+				$this->getMaxAttendees(),
+				$template_args,
+				$this->date_format,
+				$this->time_format
+			);
+	}
+
+
+
+	/**
+	 * simpleTicketSelector
+	 * there's one ticket, and max attendees is set to one,
+	 * so if the event is free, then this is a "simple" ticket selector
+	 * a.k.a. "Dude Where's my Ticket Selector?"
+	 *
+	 * @param \EE_Ticket[] $tickets
+	 * @param array  $template_args
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	protected function simpleTicketSelector($tickets, array $template_args)
+	{
+		// if there is only ONE ticket with a max qty of ONE
+		if (count($tickets) > 1 || $this->getMaxAttendees() !== 1) {
+			return '';
+		}
+		/** @var \EE_Ticket $ticket */
+		$ticket = reset($tickets);
+		// if the ticket is free... then not much need for the ticket selector
+		if (
+			apply_filters(
+				'FHEE__ticket_selector_chart_template__hide_ticket_selector',
+				$ticket->is_free(),
+				$this->event->ID()
+			)
+		) {
+			return new TicketSelectorSimple(
+				$this->event,
+				$ticket,
+				$this->getMaxAttendees(),
+				$template_args
+			);
+		}
+		return '';
+	}
+
+
+
+	/**
+	 * externalEventRegistration
+	 *
+	 * @return string
+	 */
+	public function externalEventRegistration()
+	{
+		// if not we still need to trigger the display of the submit button
+		add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
+		//display notice to admin that registration is external
+		return is_admin()
+			? esc_html__(
+				'Registration is at an external URL for this event.',
+				'event_espresso'
+			)
+			: '';
+	}
+
+
+
+	/**
+	 * formOpen
+	 *
+	 * @param        int    $ID
+	 * @param        string $external_url
+	 * @return        string
+	 */
+	public function formOpen( $ID = 0, $external_url = '' )
+	{
+		// if redirecting, we don't need any anything else
+		if ( $external_url ) {
+			$html = '<form method="GET" action="' . \EEH_URL::refactor_url($external_url) . '"';
+			// open link in new window ?
+			$html .= apply_filters(
+				'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__formOpen__external_url_target_blank',
+				\EED_Events_Archive::is_iframe()
+			)
+				? ' target="_blank"'
+				: '';
+			$html .= '>';
+			$query_args = \EEH_URL::get_query_string( $external_url );
+			foreach ( (array)$query_args as $query_arg => $value ) {
+				$html .= '<input type="hidden" name="' . $query_arg . '" value="' . $value . '">';
+			}
+			return $html;
+		}
+		// if there is no submit button, then don't start building a form
+		// because the "View Details" button will build its own form
+		if ( ! apply_filters( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false ) ) {
+			return '';
+		}
+		$checkout_url = \EEH_Event_View::event_link_url( $ID );
+		if ( ! $checkout_url ) {
+			\EE_Error::add_error(
+				esc_html__( 'The URL for the Event Details page could not be retrieved.', 'event_espresso' ),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		// set no cache headers and constants
+		\EE_System::do_not_cache();
+		$extra_params = $this->iframe ? ' target="_blank"' : '';
+		$html = '<form method="POST" action="' . $checkout_url . '"' . $extra_params . '>';
+		$html .= wp_nonce_field( 'process_ticket_selections', 'process_ticket_selections_nonce_' . $ID, true, false );
+		$html .= '<input type="hidden" name="ee" value="process_ticket_selections">';
+		$html = apply_filters( 'FHEE__EE_Ticket_Selector__ticket_selector_form_open__html', $html, $this->event );
+		return $html;
+	}
+
+
+
+	/**
+	 * displaySubmitButton
+	 *
+	 * @param  string $external_url
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function displaySubmitButton($external_url = '')
+	{
+		$html = '';
+		if ( ! is_admin()) {
+			// standard TS displayed with submit button, ie: "Register Now"
+			if (apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
+				$html .= $this->displayRegisterNowButton();
+				$html .= empty($external_url)
+					? $this->ticketSelectorEndDiv()
+					: $this->clearTicketSelector();
+				$html .= '<br/>' . $this->formClose();
+			} else if ($this->getMaxAttendees() === 1) {
+				// its a "Dude Where's my Ticket Selector?" (DWMTS) type event (ie: $_max_atndz === 1)
+				if ($this->event->is_sold_out()) {
+					// then instead of a View Details or Submit button, just display a "Sold Out" message
+					$html .= apply_filters(
+						'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__sold_out_msg',
+						sprintf(
+							__(
+								'%1$s"%2$s" is currently sold out.%4$sPlease check back again later, as spots may become available.%3$s',
+								'event_espresso'
+							),
+							'<p class="no-ticket-selector-msg clear-float">',
+							$this->event->name(),
+							'</p>',
+							'<br />'
+						),
+						$this->event
+					);
+					if (
+					apply_filters(
+						'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
+						false,
+						$this->event
+					)
+					) {
+						$html .= $this->displayRegisterNowButton();
+					}
+					// sold out DWMTS event, no TS, no submit or view details button, but has additional content
+					$html .= $this->ticketSelectorEndDiv();
+				} else if (
+					apply_filters('FHEE__EE_Ticket_Selector__hide_ticket_selector', false)
+					&& ! is_single()
+				) {
+					// this is a "Dude Where's my Ticket Selector?" (DWMTS) type event,
+					// but no tickets are available, so display event's "View Details" button.
+					// it is being viewed via somewhere other than a single post
+					$html .= $this->displayViewDetailsButton(true);
+				}
+			} else if (is_archive()) {
+				// event list, no tickets available so display event's "View Details" button
+				$html .= $this->ticketSelectorEndDiv();
+				$html .= $this->displayViewDetailsButton();
+			} else {
+				if (
+				apply_filters(
+					'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
+					false,
+					$this->event
+				)
+				) {
+					$html .= $this->displayRegisterNowButton();
+				}
+				// no submit or view details button, and no additional content
+				$html .= $this->ticketSelectorEndDiv();
+			}
+			if ( ! $this->iframe && ! is_archive()) {
+				$html .= \EEH_Template::powered_by_event_espresso('', '', array('utm_content' => 'ticket_selector'));
+			}
+		}
+		return $html;
+	}
+
+
+
+	/**
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function displayRegisterNowButton()
+	{
+		$btn_text = apply_filters(
+			'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__btn_text',
+			__('Register Now', 'event_espresso'),
+			$this->event
+		);
+		$external_url = $this->event->external_url();
+		$html = \EEH_HTML::div(
+			'', 'ticket-selector-submit-' . $this->event->ID() . '-btn-wrap', 'ticket-selector-submit-btn-wrap'
+		);
+		$html .= '<input id="ticket-selector-submit-' . $this->event->ID() . '-btn"';
+		$html .= ' class="ticket-selector-submit-btn ';
+		$html .= empty($external_url) ? 'ticket-selector-submit-ajax"' : '"';
+		$html .= ' type="submit" value="' . $btn_text . '" />';
+		$html .= \EEH_HTML::divx();
+		$html .= apply_filters(
+			'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
+			'',
+			$this->event
+		);
+		return $html;
+	}
+
+
+	/**
+	 * displayViewDetailsButton
+	 *
+	 * @param bool $DWMTS indicates a "Dude Where's my Ticket Selector?" (DWMTS) type event
+	 *                    (ie: $_max_atndz === 1) where there are no available tickets,
+	 *                    either because they are sold out, expired, or not yet on sale.
+	 *                    In this case, we need to close the form BEFORE adding any closing divs
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function displayViewDetailsButton( $DWMTS = false )
+	{
+		if ( ! $this->event->get_permalink() ) {
+			\EE_Error::add_error(
+				esc_html__( 'The URL for the Event Details page could not be retrieved.', 'event_espresso' ),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+		$view_details_btn = '<form method="POST" action="';
+		$view_details_btn .= apply_filters(
+			'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_url',
+			$this->event->get_permalink(),
+			$this->event
+		);
+		$view_details_btn .= '"';
+		// open link in new window ?
+		$view_details_btn .= apply_filters(
+			'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__displayViewDetailsButton__url_target_blank',
+			\EED_Events_Archive::is_iframe()
+		)
+			? ' target="_blank"'
+			: '';
+		$view_details_btn .='>';
+		$btn_text = apply_filters(
+			'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_text',
+			esc_html__('View Details', 'event_espresso'),
+			$this->event
+		);
+		$view_details_btn .= '<input id="ticket-selector-submit-'
+							 . $this->event->ID()
+							 . '-btn" class="ticket-selector-submit-btn view-details-btn" type="submit" value="'
+							 . $btn_text
+							 . '" />';
+		$view_details_btn .= apply_filters( 'FHEE__EE_Ticket_Selector__after_view_details_btn', '', $this->event );
+		if ($DWMTS) {
+			$view_details_btn .= $this->formClose();
+			$view_details_btn .= $this->ticketSelectorEndDiv();
+			$view_details_btn .= '<br/>';
+		} else {
+			$view_details_btn .= $this->clearTicketSelector();
+			$view_details_btn .= '<br/>';
+			$view_details_btn .= $this->formClose();
+		}
+		return $view_details_btn;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function ticketSelectorEndDiv()
+	{
+		return '<div class="clear"></div></div>';
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function clearTicketSelector()
+	{
+		// standard TS displayed, appears after a "Register Now" or "view Details" button
+		return '<div class="clear"></div>';
+	}
+
+
+
+	/**
+	 * @access        public
+	 * @return        string
+	 */
+	public function formClose()
+	{
+		return '</form>';
+	}
 
 
 

Spacing +52 added lines, -52 removed lines

@@ -1,8 +1,8 @@ 
 <?php
 namespace EventEspresso\modules\ticket_selector;
 
-if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-    exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+    exit('No direct script access allowed');
 }
 
 
@@ -73,9 +73,9 @@ 
     /**
      * @param boolean $iframe
      */
-    public function setIframe( $iframe = true )
+    public function setIframe($iframe = true)
     {
-        $this->iframe = filter_var( $iframe, FILTER_VALIDATE_BOOLEAN );
+        $this->iframe = filter_var($iframe, FILTER_VALIDATE_BOOLEAN);
     }
 
 
@@ -86,28 +86,28 @@ 
      * @param    mixed $event
      * @return    bool
      */
-    protected function setEvent( $event = null )
+    protected function setEvent($event = null)
     {
-        if ( $event === null ) {
+        if ($event === null) {
             global $post;
             $event = $post;
         }
-        if ( $event instanceof \EE_Event ) {
+        if ($event instanceof \EE_Event) {
             $this->event = $event;
-        } else if ( $event instanceof \WP_Post ) {
-            if ( isset( $event->EE_Event ) && $event->EE_Event instanceof \EE_Event ) {
+        } else if ($event instanceof \WP_Post) {
+            if (isset($event->EE_Event) && $event->EE_Event instanceof \EE_Event) {
                 $this->event = $event->EE_Event;
-            } else if ( $event->post_type === 'espresso_events' ) {
-                $event->EE_Event = \EEM_Event::instance()->instantiate_class_from_post_object( $event );
+            } else if ($event->post_type === 'espresso_events') {
+                $event->EE_Event = \EEM_Event::instance()->instantiate_class_from_post_object($event);
                 $this->event = $event->EE_Event;
             }
         } else {
-            $user_msg = __( 'No Event object or an invalid Event object was supplied.', 'event_espresso' );
-            $dev_msg = $user_msg . __(
+            $user_msg = __('No Event object or an invalid Event object was supplied.', 'event_espresso');
+            $dev_msg = $user_msg.__(
                     'In order to generate a ticket selector, please ensure you are passing either an EE_Event object or a WP_Post object of the post type "espresso_event" to the EE_Ticket_Selector class constructor.',
                     'event_espresso'
                 );
-            \EE_Error::add_error( $user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__ );
+            \EE_Error::add_error($user_msg.'||'.$dev_msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         return true;
@@ -148,17 +148,17 @@ 
      * @return string
      * @throws \EE_Error
      */
-    public function display( $event = null, $view_details = false )
+    public function display($event = null, $view_details = false)
     {
         // reset filter for displaying submit button
-        remove_filter( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true' );
+        remove_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
         // poke and prod incoming event till it tells us what it is
-        if ( ! $this->setEvent( $event ) ) {
+        if ( ! $this->setEvent($event)) {
             return false;
         }
         // begin gathering template arguments by getting event status
-        $template_args = array( 'event_status' => $this->event->get_active_status() );
-        if ( $this->activeEventAndShowTicketSelector($event, $template_args['event_status'], $view_details) ) {
+        $template_args = array('event_status' => $this->event->get_active_status());
+        if ($this->activeEventAndShowTicketSelector($event, $template_args['event_status'], $view_details)) {
             return ! is_single() ? $this->displayViewDetailsButton() : '';
         }
         // filter the maximum qty that can appear in the Ticket Selector qty dropdowns
@@ -168,7 +168,7 @@ 
         }
         // is the event expired ?
         $template_args['event_is_expired'] = $this->event->is_expired();
-        if ( $template_args[ 'event_is_expired' ] ) {
+        if ($template_args['event_is_expired']) {
             return $this->expiredEventMessage();
         }
         // get all tickets for this event ordered by the datetime
@@ -176,7 +176,7 @@ 
         if (count($tickets) < 1) {
             return $this->noTicketAvailableMessage();
         }
-        if (\EED_Events_Archive::is_iframe()){
+        if (\EED_Events_Archive::is_iframe()) {
             $this->setIframe();
         }
         // redirecting to another site for registration ??
@@ -184,10 +184,10 @@ 
         // if redirecting to another site for registration, then we don't load the TS
         $ticket_selector = $external_url
             ? $this->externalEventRegistration()
-            : $this->loadTicketSelector($tickets,$template_args);
+            : $this->loadTicketSelector($tickets, $template_args);
         // now set up the form (but not for the admin)
         $ticket_selector = ! is_admin()
-            ? $this->formOpen($this->event->ID(), $external_url) . $ticket_selector
+            ? $this->formOpen($this->event->ID(), $external_url).$ticket_selector
             : $ticket_selector;
         // submit button and form close tag
         $ticket_selector .= ! is_admin() ? $this->displaySubmitButton($external_url) : '';
@@ -237,10 +237,10 @@ 
      */
     protected function expiredEventMessage()
     {
-        return '<div class="ee-event-expired-notice"><span class="important-notice">' . esc_html__(
+        return '<div class="ee-event-expired-notice"><span class="important-notice">'.esc_html__(
             'We\'re sorry, but all tickets sales have ended because the event is expired.',
             'event_espresso'
-        ) . '</span></div>';
+        ).'</span></div>';
     }
 
 
@@ -254,7 +254,7 @@ 
      */
     protected function noTicketAvailableMessage()
     {
-        $no_ticket_available_msg = esc_html__( 'We\'re sorry, but all ticket sales have ended.', 'event_espresso' );
+        $no_ticket_available_msg = esc_html__('We\'re sorry, but all ticket sales have ended.', 'event_espresso');
         if (current_user_can('edit_post', $this->event->ID())) {
             $no_ticket_available_msg .= sprintf(
                 esc_html__(
@@ -269,7 +269,7 @@ 
         }
         return '
             <div class="ee-event-expired-notice">
-                <span class="important-notice">' . $no_ticket_available_msg . '</span>
+                <span class="important-notice">' . $no_ticket_available_msg.'</span>
             </div>';
     }
 
@@ -300,7 +300,7 @@ 
                 '</a></span></div>'
             );
         }
-        return '<p><span class="important-notice">' . $sales_closed_msg . '</span></p>';
+        return '<p><span class="important-notice">'.$sales_closed_msg.'</span></p>';
     }
 
 
@@ -362,12 +362,12 @@ 
          */
         $template_args['anchor_id'] = apply_filters(
             'FHEE__EE_Ticket_Selector__redirect_anchor_id',
-            '#tkt-slctr-tbl-' . $this->event->ID(),
+            '#tkt-slctr-tbl-'.$this->event->ID(),
             $this->event->ID()
         );
         $template_args['tickets'] = $tickets;
         $template_args['ticket_count'] = count($tickets);
-        $ticket_selector = $this->simpleTicketSelector( $tickets, $template_args);
+        $ticket_selector = $this->simpleTicketSelector($tickets, $template_args);
         return $ticket_selector instanceof TicketSelectorSimple
             ? $ticket_selector
             : new TicketSelectorStandard(
@@ -448,11 +448,11 @@ 
      * @param        string $external_url
      * @return        string
      */
-    public function formOpen( $ID = 0, $external_url = '' )
+    public function formOpen($ID = 0, $external_url = '')
     {
         // if redirecting, we don't need any anything else
-        if ( $external_url ) {
-            $html = '<form method="GET" action="' . \EEH_URL::refactor_url($external_url) . '"';
+        if ($external_url) {
+            $html = '<form method="GET" action="'.\EEH_URL::refactor_url($external_url).'"';
             // open link in new window ?
             $html .= apply_filters(
                 'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__formOpen__external_url_target_blank',
@@ -461,21 +461,21 @@ 
                 ? ' target="_blank"'
                 : '';
             $html .= '>';
-            $query_args = \EEH_URL::get_query_string( $external_url );
-            foreach ( (array)$query_args as $query_arg => $value ) {
-                $html .= '<input type="hidden" name="' . $query_arg . '" value="' . $value . '">';
+            $query_args = \EEH_URL::get_query_string($external_url);
+            foreach ((array) $query_args as $query_arg => $value) {
+                $html .= '<input type="hidden" name="'.$query_arg.'" value="'.$value.'">';
             }
             return $html;
         }
         // if there is no submit button, then don't start building a form
         // because the "View Details" button will build its own form
-        if ( ! apply_filters( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false ) ) {
+        if ( ! apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
             return '';
         }
-        $checkout_url = \EEH_Event_View::event_link_url( $ID );
-        if ( ! $checkout_url ) {
+        $checkout_url = \EEH_Event_View::event_link_url($ID);
+        if ( ! $checkout_url) {
             \EE_Error::add_error(
-                esc_html__( 'The URL for the Event Details page could not be retrieved.', 'event_espresso' ),
+                esc_html__('The URL for the Event Details page could not be retrieved.', 'event_espresso'),
                 __FILE__,
                 __FUNCTION__,
                 __LINE__
@@ -484,10 +484,10 @@ 
         // set no cache headers and constants
         \EE_System::do_not_cache();
         $extra_params = $this->iframe ? ' target="_blank"' : '';
-        $html = '<form method="POST" action="' . $checkout_url . '"' . $extra_params . '>';
-        $html .= wp_nonce_field( 'process_ticket_selections', 'process_ticket_selections_nonce_' . $ID, true, false );
+        $html = '<form method="POST" action="'.$checkout_url.'"'.$extra_params.'>';
+        $html .= wp_nonce_field('process_ticket_selections', 'process_ticket_selections_nonce_'.$ID, true, false);
         $html .= '<input type="hidden" name="ee" value="process_ticket_selections">';
-        $html = apply_filters( 'FHEE__EE_Ticket_Selector__ticket_selector_form_open__html', $html, $this->event );
+        $html = apply_filters('FHEE__EE_Ticket_Selector__ticket_selector_form_open__html', $html, $this->event);
         return $html;
     }
 
@@ -510,7 +510,7 @@ 
                 $html .= empty($external_url)
                     ? $this->ticketSelectorEndDiv()
                     : $this->clearTicketSelector();
-                $html .= '<br/>' . $this->formClose();
+                $html .= '<br/>'.$this->formClose();
             } else if ($this->getMaxAttendees() === 1) {
                 // its a "Dude Where's my Ticket Selector?" (DWMTS) type event (ie: $_max_atndz === 1)
                 if ($this->event->is_sold_out()) {
@@ -588,12 +588,12 @@ 
         );
         $external_url = $this->event->external_url();
         $html = \EEH_HTML::div(
-            '', 'ticket-selector-submit-' . $this->event->ID() . '-btn-wrap', 'ticket-selector-submit-btn-wrap'
+            '', 'ticket-selector-submit-'.$this->event->ID().'-btn-wrap', 'ticket-selector-submit-btn-wrap'
         );
-        $html .= '<input id="ticket-selector-submit-' . $this->event->ID() . '-btn"';
+        $html .= '<input id="ticket-selector-submit-'.$this->event->ID().'-btn"';
         $html .= ' class="ticket-selector-submit-btn ';
         $html .= empty($external_url) ? 'ticket-selector-submit-ajax"' : '"';
-        $html .= ' type="submit" value="' . $btn_text . '" />';
+        $html .= ' type="submit" value="'.$btn_text.'" />';
         $html .= \EEH_HTML::divx();
         $html .= apply_filters(
             'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
@@ -614,11 +614,11 @@ 
      * @return string
      * @throws \EE_Error
      */
-    public function displayViewDetailsButton( $DWMTS = false )
+    public function displayViewDetailsButton($DWMTS = false)
     {
-        if ( ! $this->event->get_permalink() ) {
+        if ( ! $this->event->get_permalink()) {
             \EE_Error::add_error(
-                esc_html__( 'The URL for the Event Details page could not be retrieved.', 'event_espresso' ),
+                esc_html__('The URL for the Event Details page could not be retrieved.', 'event_espresso'),
                 __FILE__, __FUNCTION__, __LINE__
             );
         }
@@ -636,7 +636,7 @@ 
         )
             ? ' target="_blank"'
             : '';
-        $view_details_btn .='>';
+        $view_details_btn .= '>';
         $btn_text = apply_filters(
             'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_text',
             esc_html__('View Details', 'event_espresso'),
@@ -647,7 +647,7 @@ 
                              . '-btn" class="ticket-selector-submit-btn view-details-btn" type="submit" value="'
                              . $btn_text
                              . '" />';
-        $view_details_btn .= apply_filters( 'FHEE__EE_Ticket_Selector__after_view_details_btn', '', $this->event );
+        $view_details_btn .= apply_filters('FHEE__EE_Ticket_Selector__after_view_details_btn', '', $this->event);
         if ($DWMTS) {
             $view_details_btn .= $this->formClose();
             $view_details_btn .= $this->ticketSelectorEndDiv();

modules/ticket_selector/templates/standard_ticket_selector.template.php

Spacing +14 added lines, -14 removed lines

@@ -21,7 +21,7 @@ 
 ?>
 <div id="tkt-slctr-tbl-wrap-dv-<?php echo $EVT_ID; ?>" class="tkt-slctr-tbl-wrap-dv">
 
-	<?php do_action( 'AHEE__ticket_selector_chart__template__before_ticket_selector', $event ); ?>
+	<?php do_action('AHEE__ticket_selector_chart__template__before_ticket_selector', $event); ?>
 	<?php echo $datetime_selector; ?>
 
 	<table id="tkt-slctr-tbl-<?php echo $EVT_ID; ?>" class="tkt-slctr-tbl">
@@ -36,7 +36,7 @@ 
                     );
                     ?>
 				</th>
-				<?php if ( apply_filters( 'FHEE__ticket_selector_chart_template__display_ticket_price_details', TRUE ) ) { ?>
+				<?php if (apply_filters('FHEE__ticket_selector_chart_template__display_ticket_price_details', TRUE)) { ?>
 				<th scope="col" class="ee-ticket-selector-ticket-price-th cntr">
 					<?php
 						/**
@@ -49,7 +49,7 @@ 
 						 */
 						echo apply_filters(
                             'FHEE__ticket_selector_chart_template__table_header_price',
-                            esc_html__( 'Price', 'event_espresso' ),
+                            esc_html__('Price', 'event_espresso'),
                             $EVT_ID
                         );
 					?>
@@ -67,7 +67,7 @@ 
 						*/
 						echo apply_filters(
                             'FHEE__ticket_selector_chart_template__table_header_qty',
-                            esc_html__( 'Qty', 'event_espresso' ),
+                            esc_html__('Qty', 'event_espresso'),
                             $EVT_ID
                         );
 					?>
@@ -75,17 +75,17 @@ 
 			</tr>
 		</thead>
 		<tbody>
-			<?php echo $ticket_row_html;?>
+			<?php echo $ticket_row_html; ?>
 		</tbody>
 	</table>
 	<?php
-	if ( $taxable_tickets && apply_filters( 'FHEE__ticket_selector_chart_template__display_ticket_price_details', true ) ) {
-		if ( $prices_displayed_including_taxes ) {
-			$ticket_price_includes_taxes = esc_html__( '* price includes taxes', 'event_espresso' );
+	if ($taxable_tickets && apply_filters('FHEE__ticket_selector_chart_template__display_ticket_price_details', true)) {
+		if ($prices_displayed_including_taxes) {
+			$ticket_price_includes_taxes = esc_html__('* price includes taxes', 'event_espresso');
 		} else {
-			$ticket_price_includes_taxes = esc_html__( '* price does not include taxes', 'event_espresso' );
+			$ticket_price_includes_taxes = esc_html__('* price does not include taxes', 'event_espresso');
 		}
-		echo '<p class="small-text lt-grey-text" style="text-align:right; margin: -1em 0 1em;">' . $ticket_price_includes_taxes . '</p>';
+		echo '<p class="small-text lt-grey-text" style="text-align:right; margin: -1em 0 1em;">'.$ticket_price_includes_taxes.'</p>';
 	}
 	?>
 
@@ -93,13 +93,13 @@ 
 
 
 <?php
-if ( $max_atndz > 0 ) {
+if ($max_atndz > 0) {
 	echo apply_filters(
 		'FHEE__ticket_selector_chart_template__maximum_tickets_purchased_footnote',
         esc_html('')
 	);
 }
-if ( ! apply_filters( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false ) ) {
-	add_filter( 'FHEE__EE_Ticket_Selector__no_ticket_selector_submit', '__return_true' );
+if ( ! apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
+	add_filter('FHEE__EE_Ticket_Selector__no_ticket_selector_submit', '__return_true');
 }
-do_action( 'AHEE__ticket_selector_chart__template__after_ticket_selector', $EVT_ID, $event );
\ No newline at end of file
+do_action('AHEE__ticket_selector_chart__template__after_ticket_selector', $EVT_ID, $event);
\ No newline at end of file

modules/ticket_selector/TicketSelector.php

Indentation +109 added lines, -109 removed lines

@@ -16,115 +16,115 @@
 abstract class TicketSelector
 {
 
-    /**
-     * @var \EE_Event $event
-     */
-    protected $event;
-
-    /**
-     * @var \EE_Ticket[] $tickets
-     */
-    protected $tickets;
-
-    /**
-     * @var int max_attendees
-     */
-    protected $max_attendees;
-
-    /**
-     * @var array $template_args
-     */
-    protected $template_args;
-
-
-
-    /**
-     * TicketSelectorSimple constructor.
-     *
-     * @param \EE_Event    $event
-     * @param \EE_Ticket[] $tickets
-     * @param int          $max_attendees
-     * @param array        $template_args
-     * @throws \EE_Error
-     */
-    public function __construct(\EE_Event $event, array $tickets, $max_attendees, array $template_args)
-    {
-        $this->event         = $event;
-        $this->tickets       = $tickets;
-        $this->max_attendees = $max_attendees;
-        $this->template_args = $template_args;
-        $this->template_args['hidden_inputs'] = $this->getHiddenInputs();
-        $this->addTemplateArgs();
-    }
-
-
-
-    /**
-     * sets any and all template args that are required for this Ticket Selector
-     *
-     * @return void
-     */
-    abstract protected function addTemplateArgs();
-
-
-
-    /**
-     * loadTicketSelectorTemplate
-     *
-     * @return string
-     */
-    protected function loadTicketSelectorTemplate()
-    {
-        try {
-            return \EEH_Template::locate_template(
-                apply_filters(
-                    'FHEE__EE_Ticket_Selector__display_ticket_selector__template_path',
-                    $this->template_args['template_path'],
-                    $this->event
-                ),
-                $this->template_args
-            );
-        } catch (\Exception $e) {
-            \EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-        }
-        return '';
-    }
-
-
-
-    /**
-     * The __toString method allows a class to decide how it will react when it is converted to a string.
-     *
-     * @return string
-     * @link http://php.net/manual/en/language.oop5.magic.php#language.oop5.magic.tostring
-     */
-    public function __toString()
-    {
-        return $this->loadTicketSelectorTemplate();
-    }
-
-
-
-
-    /**
-     * getHiddenInputs
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    public function getHiddenInputs()
-    {
-        // $rows = count($this->tickets);
-        $html = '<input type="hidden" name="noheader" value="true"/>';
-        $html .= '<input type="hidden" name="tkt-slctr-return-url-' . $this->event->ID() . '"';
-        $html .= ' value="' . \EEH_URL::current_url() . $this->template_args['anchor_id'] . '"/>';
-        $html .= '<input type="hidden" name="tkt-slctr-rows-' . $this->event->ID();
-        $html .= '" value="' . count($this->tickets) . '"/>';
-        $html .= '<input type="hidden" name="tkt-slctr-max-atndz-' . $this->event->ID();
-        $html .= '" value="' . $this->template_args['max_atndz'] . '"/>';
-        $html .= '<input type="hidden" name="tkt-slctr-event-id" value="' . $this->event->ID() . '"/>';
-        return $html;
-    }
+	/**
+	 * @var \EE_Event $event
+	 */
+	protected $event;
+
+	/**
+	 * @var \EE_Ticket[] $tickets
+	 */
+	protected $tickets;
+
+	/**
+	 * @var int max_attendees
+	 */
+	protected $max_attendees;
+
+	/**
+	 * @var array $template_args
+	 */
+	protected $template_args;
+
+
+
+	/**
+	 * TicketSelectorSimple constructor.
+	 *
+	 * @param \EE_Event    $event
+	 * @param \EE_Ticket[] $tickets
+	 * @param int          $max_attendees
+	 * @param array        $template_args
+	 * @throws \EE_Error
+	 */
+	public function __construct(\EE_Event $event, array $tickets, $max_attendees, array $template_args)
+	{
+		$this->event         = $event;
+		$this->tickets       = $tickets;
+		$this->max_attendees = $max_attendees;
+		$this->template_args = $template_args;
+		$this->template_args['hidden_inputs'] = $this->getHiddenInputs();
+		$this->addTemplateArgs();
+	}
+
+
+
+	/**
+	 * sets any and all template args that are required for this Ticket Selector
+	 *
+	 * @return void
+	 */
+	abstract protected function addTemplateArgs();
+
+
+
+	/**
+	 * loadTicketSelectorTemplate
+	 *
+	 * @return string
+	 */
+	protected function loadTicketSelectorTemplate()
+	{
+		try {
+			return \EEH_Template::locate_template(
+				apply_filters(
+					'FHEE__EE_Ticket_Selector__display_ticket_selector__template_path',
+					$this->template_args['template_path'],
+					$this->event
+				),
+				$this->template_args
+			);
+		} catch (\Exception $e) {
+			\EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+		}
+		return '';
+	}
+
+
+
+	/**
+	 * The __toString method allows a class to decide how it will react when it is converted to a string.
+	 *
+	 * @return string
+	 * @link http://php.net/manual/en/language.oop5.magic.php#language.oop5.magic.tostring
+	 */
+	public function __toString()
+	{
+		return $this->loadTicketSelectorTemplate();
+	}
+
+
+
+
+	/**
+	 * getHiddenInputs
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function getHiddenInputs()
+	{
+		// $rows = count($this->tickets);
+		$html = '<input type="hidden" name="noheader" value="true"/>';
+		$html .= '<input type="hidden" name="tkt-slctr-return-url-' . $this->event->ID() . '"';
+		$html .= ' value="' . \EEH_URL::current_url() . $this->template_args['anchor_id'] . '"/>';
+		$html .= '<input type="hidden" name="tkt-slctr-rows-' . $this->event->ID();
+		$html .= '" value="' . count($this->tickets) . '"/>';
+		$html .= '<input type="hidden" name="tkt-slctr-max-atndz-' . $this->event->ID();
+		$html .= '" value="' . $this->template_args['max_atndz'] . '"/>';
+		$html .= '<input type="hidden" name="tkt-slctr-event-id" value="' . $this->event->ID() . '"/>';
+		return $html;
+	}
 
 }
 // End of file TicketSelector.php

Spacing +7 added lines, -7 removed lines

@@ -116,13 +116,13 @@
     {
         // $rows = count($this->tickets);
         $html = '<input type="hidden" name="noheader" value="true"/>';
-        $html .= '<input type="hidden" name="tkt-slctr-return-url-' . $this->event->ID() . '"';
-        $html .= ' value="' . \EEH_URL::current_url() . $this->template_args['anchor_id'] . '"/>';
-        $html .= '<input type="hidden" name="tkt-slctr-rows-' . $this->event->ID();
-        $html .= '" value="' . count($this->tickets) . '"/>';
-        $html .= '<input type="hidden" name="tkt-slctr-max-atndz-' . $this->event->ID();
-        $html .= '" value="' . $this->template_args['max_atndz'] . '"/>';
-        $html .= '<input type="hidden" name="tkt-slctr-event-id" value="' . $this->event->ID() . '"/>';
+        $html .= '<input type="hidden" name="tkt-slctr-return-url-'.$this->event->ID().'"';
+        $html .= ' value="'.\EEH_URL::current_url().$this->template_args['anchor_id'].'"/>';
+        $html .= '<input type="hidden" name="tkt-slctr-rows-'.$this->event->ID();
+        $html .= '" value="'.count($this->tickets).'"/>';
+        $html .= '<input type="hidden" name="tkt-slctr-max-atndz-'.$this->event->ID();
+        $html .= '" value="'.$this->template_args['max_atndz'].'"/>';
+        $html .= '<input type="hidden" name="tkt-slctr-event-id" value="'.$this->event->ID().'"/>';
         return $html;
     }
 

core/services/formatters/AsciiOnly.php

Doc Comments +1 added lines, -1 removed lines

@@ -36,7 +36,7 @@
 
     /**
      * Taken from https://gist.github.com/jaywilliams/119517
-     * @param $string
+     * @param string $string
      * @return string
      */
     protected function convertAscii($string)

Unused Use Statements -2 removed lines

@@ -1,8 +1,6 @@
 <?php
 namespace EventEspresso\core\services\formatters;
 
-use EventEspresso\core\exceptions\InvalidDataTypeException;
-
 defined('EVENT_ESPRESSO_VERSION') || exit;
 
 

Indentation +51 added lines, -51 removed lines

@@ -18,60 +18,60 @@
 class AsciiOnly extends FormatterBase
 {
 
-    /**
-     * Removes all non Ascii characters from string
-     *
-     * @param string|int|float $input anything easily cast into a string
-     * @return string
-     */
-    public function format($input)
-    {
-        //in case an int or float etc was passed in
-        $input = (string)$input;
-        $input = $this->convertAscii($input);
-        return $input;
-    }
+	/**
+	 * Removes all non Ascii characters from string
+	 *
+	 * @param string|int|float $input anything easily cast into a string
+	 * @return string
+	 */
+	public function format($input)
+	{
+		//in case an int or float etc was passed in
+		$input = (string)$input;
+		$input = $this->convertAscii($input);
+		return $input;
+	}
 
 
 
-    /**
-     * Taken from https://gist.github.com/jaywilliams/119517
-     * @param $string
-     * @return string
-     */
-    protected function convertAscii($string)
-    {
-        // Replace Single Curly Quotes
-        $search[]  = chr(226).chr(128).chr(152);
-        $replace[] = "'";
-        $search[]  = chr(226).chr(128).chr(153);
-        $replace[] = "'";
-        // Replace Smart Double Curly Quotes
-        $search[]  = chr(226).chr(128).chr(156);
-        $replace[] = '"';
-        $search[]  = chr(226).chr(128).chr(157);
-        $replace[] = '"';
-        // Replace En Dash
-        $search[]  = chr(226).chr(128).chr(147);
-        $replace[] = '--';
-        // Replace Em Dash
-        $search[]  = chr(226).chr(128).chr(148);
-        $replace[] = '---';
-        // Replace Bullet
-        $search[]  = chr(226).chr(128).chr(162);
-        $replace[] = '*';
-        // Replace Middle Dot
-        $search[]  = chr(194).chr(183);
-        $replace[] = '*';
-        // Replace Ellipsis with three consecutive dots
-        $search[]  = chr(226).chr(128).chr(166);
-        $replace[] = '...';
-        // Apply Replacements
-        $string = str_replace($search, $replace, $string);
-        // Remove any non-ASCII Characters
-        $string = preg_replace("/[^\x01-\x7F]/","", $string);
-        return $string;
-    }
+	/**
+	 * Taken from https://gist.github.com/jaywilliams/119517
+	 * @param $string
+	 * @return string
+	 */
+	protected function convertAscii($string)
+	{
+		// Replace Single Curly Quotes
+		$search[]  = chr(226).chr(128).chr(152);
+		$replace[] = "'";
+		$search[]  = chr(226).chr(128).chr(153);
+		$replace[] = "'";
+		// Replace Smart Double Curly Quotes
+		$search[]  = chr(226).chr(128).chr(156);
+		$replace[] = '"';
+		$search[]  = chr(226).chr(128).chr(157);
+		$replace[] = '"';
+		// Replace En Dash
+		$search[]  = chr(226).chr(128).chr(147);
+		$replace[] = '--';
+		// Replace Em Dash
+		$search[]  = chr(226).chr(128).chr(148);
+		$replace[] = '---';
+		// Replace Bullet
+		$search[]  = chr(226).chr(128).chr(162);
+		$replace[] = '*';
+		// Replace Middle Dot
+		$search[]  = chr(194).chr(183);
+		$replace[] = '*';
+		// Replace Ellipsis with three consecutive dots
+		$search[]  = chr(226).chr(128).chr(166);
+		$replace[] = '...';
+		// Apply Replacements
+		$string = str_replace($search, $replace, $string);
+		// Remove any non-ASCII Characters
+		$string = preg_replace("/[^\x01-\x7F]/","", $string);
+		return $string;
+	}
 }
 // End of file EmojiRemoval.php
 // Location: core\services\formatters/EmojiRemoval.php
\ No newline at end of file

Spacing +2 added lines, -2 removed lines

@@ -27,7 +27,7 @@ 
     public function format($input)
     {
         //in case an int or float etc was passed in
-        $input = (string)$input;
+        $input = (string) $input;
         $input = $this->convertAscii($input);
         return $input;
     }
@@ -69,7 +69,7 @@ 
         // Apply Replacements
         $string = str_replace($search, $replace, $string);
         // Remove any non-ASCII Characters
-        $string = preg_replace("/[^\x01-\x7F]/","", $string);
+        $string = preg_replace("/[^\x01-\x7F]/", "", $string);
         return $string;
     }
 }

core/services/formatters/LeaveAlone.php

Indentation +21 added lines, -21 removed lines

@@ -18,28 +18,28 @@
 class LeaveAlone extends FormatterBase
 {
 
-    /**
-     * Removes the emojis from the inputted string
-     *
-     * @param string|int|float $input anything easily cast into a string
-     * @return string
-     * @throws InvalidDataTypeException if $input is not a string
-     */
-    public function format($input)
-    {
-        return $input;
-    }
+	/**
+	 * Removes the emojis from the inputted string
+	 *
+	 * @param string|int|float $input anything easily cast into a string
+	 * @return string
+	 * @throws InvalidDataTypeException if $input is not a string
+	 */
+	public function format($input)
+	{
+		return $input;
+	}
 
-    /**
-     * Just returns the inputted $input array
-     *
-     * @param array $input
-     * @return array
-     */
-    public function formatArray($input)
-    {
-        return $input;
-    }
+	/**
+	 * Just returns the inputted $input array
+	 *
+	 * @param array $input
+	 * @return array
+	 */
+	public function formatArray($input)
+	{
+		return $input;
+	}
 }
 // End of file LeaveAlonel.php
 // Location: core\services\formatters/LeaveAlonel.php
\ No newline at end of file