eventespresso / event-espresso-core

core/business/EE_Registration_Processor.class.php

Indentation +8 added lines, -8 removed lines

@@ -215,7 +215,7 @@ 
 			}
 			// don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
 			if ( ! EE_Processor_Base::$IPN ) {
-                // otherwise, send out notifications
+				// otherwise, send out notifications
 				add_filter( 'FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10 );
 			}
 			// DEBUG LOG
@@ -262,7 +262,7 @@ 
 			}
 			// don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
 			if ( ! EE_Processor_Base::$IPN ) {
-                // otherwise, send out notifications
+				// otherwise, send out notifications
 				add_filter( 'FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10 );
 			}
 			// DEBUG LOG
@@ -349,7 +349,7 @@ 
 			}
 			// don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
 			if ( ! EE_Processor_Base::$IPN ) {
-                // otherwise, send out notifications
+				// otherwise, send out notifications
 				add_filter( 'FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10 );
 			}
 			// DEBUG LOG
@@ -390,10 +390,10 @@ 
 			// 	false,
 			// 	'EE_Transaction: ' . $registration->transaction()->ID()
 			// );
-            if ( ! $registration->is_primary_registrant()) {
-                return;
-            }
-            do_action(
+			if ( ! $registration->is_primary_registrant()) {
+				return;
+			}
+			do_action(
 				'AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
 				$registration,
 				$additional_details
@@ -428,7 +428,7 @@ 
 		// set new  REG_Status
 		$this->set_new_reg_status( $registration->ID(), $registration->status_ID() );
 		return $this->reg_status_updated( $registration->ID() )
-		       && $this->new_reg_status( $registration->ID() ) === EEM_Registration::status_id_approved
+			   && $this->new_reg_status( $registration->ID() ) === EEM_Registration::status_id_approved
 			? true
 			: false;
 	}

Spacing +96 added lines, -96 removed lines

@@ -3,8 +3,8 @@ 
 use EventEspresso\core\domain\entities\RegUrlLink;
 use EventEspresso\core\domain\services\registration\CreateRegistrationService;
 
-if ( ! defined( 'EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); }
-EE_Registry::instance()->load_class( 'Processor_Base' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); }
+EE_Registry::instance()->load_class('Processor_Base');
 
 /**
  * Class EE_Registration_Processor
@@ -66,7 +66,7 @@ 
 	 */
 	public static function instance() {
 		// check if class object is instantiated
-		if ( ! self::$_instance instanceof EE_Registration_Processor ) {
+		if ( ! self::$_instance instanceof EE_Registration_Processor) {
 			self::$_instance = new self();
 		}
 		return self::$_instance;
@@ -86,8 +86,8 @@ 
 	 * @param int $REG_ID
 	 * @return string
 	 */
-	public function old_reg_status( $REG_ID ) {
-		return isset( $this->_old_reg_status[ $REG_ID ] ) ? $this->_old_reg_status[ $REG_ID ] : null;
+	public function old_reg_status($REG_ID) {
+		return isset($this->_old_reg_status[$REG_ID]) ? $this->_old_reg_status[$REG_ID] : null;
 	}
 
 
@@ -96,10 +96,10 @@ 
 	 * @param int $REG_ID
 	 * @param string $old_reg_status
 	 */
-	public function set_old_reg_status( $REG_ID, $old_reg_status ) {
+	public function set_old_reg_status($REG_ID, $old_reg_status) {
 		// only set the first time
-		if ( ! isset( $this->_old_reg_status[ $REG_ID ] ) ) {
-			$this->_old_reg_status[ $REG_ID ] = $old_reg_status;
+		if ( ! isset($this->_old_reg_status[$REG_ID])) {
+			$this->_old_reg_status[$REG_ID] = $old_reg_status;
 		}
 	}
 
@@ -109,8 +109,8 @@ 
 	 * @param int $REG_ID
 	 * @return string
 	 */
-	public function new_reg_status( $REG_ID ) {
-		return isset( $this->_new_reg_status[ $REG_ID ] ) ? $this->_new_reg_status[ $REG_ID ] : null;
+	public function new_reg_status($REG_ID) {
+		return isset($this->_new_reg_status[$REG_ID]) ? $this->_new_reg_status[$REG_ID] : null;
 	}
 
 
@@ -119,8 +119,8 @@ 
 	 * @param int $REG_ID
 	 * @param string $new_reg_status
 	 */
-	public function set_new_reg_status( $REG_ID, $new_reg_status ) {
-		$this->_new_reg_status[ $REG_ID ] = $new_reg_status;
+	public function set_new_reg_status($REG_ID, $new_reg_status) {
+		$this->_new_reg_status[$REG_ID] = $new_reg_status;
 	}
 
 
@@ -131,8 +131,8 @@ 
 	 * @param int $REG_ID
 	 * @return bool
 	 */
-	public function reg_status_updated( $REG_ID ) {
-		return $this->new_reg_status( $REG_ID ) !== $this->old_reg_status( $REG_ID ) ? true : false;
+	public function reg_status_updated($REG_ID) {
+		return $this->new_reg_status($REG_ID) !== $this->old_reg_status($REG_ID) ? true : false;
 	}
 
 
@@ -141,13 +141,13 @@ 
 	 * @param \EE_Registration $registration
 	 * @throws \EE_Error
 	 */
-	public function update_registration_status_and_trigger_notifications( \EE_Registration $registration ) {
-		$this->toggle_incomplete_registration_status_to_default( $registration, false );
-		$this->toggle_registration_status_for_default_approved_events( $registration, false );
-		$this->toggle_registration_status_if_no_monies_owing( $registration, false );
+	public function update_registration_status_and_trigger_notifications(\EE_Registration $registration) {
+		$this->toggle_incomplete_registration_status_to_default($registration, false);
+		$this->toggle_registration_status_for_default_approved_events($registration, false);
+		$this->toggle_registration_status_if_no_monies_owing($registration, false);
 		$registration->save();
 		// trigger notifications
-		$this->trigger_registration_update_notifications( $registration );
+		$this->trigger_registration_update_notifications($registration);
 	}
 
 
@@ -162,18 +162,18 @@ 
 	 * @return boolean
 	 * @throws \EE_Error
 	 */
-	public function manually_update_registration_status( EE_Registration $registration, $new_reg_status = '', $save = true ) {
+	public function manually_update_registration_status(EE_Registration $registration, $new_reg_status = '', $save = true) {
 		// set initial REG_Status
-		$this->set_old_reg_status( $registration->ID(), $registration->status_ID() );
+		$this->set_old_reg_status($registration->ID(), $registration->status_ID());
 		// set incoming REG_Status
-		$this->set_new_reg_status( $registration->ID(), $new_reg_status );
+		$this->set_new_reg_status($registration->ID(), $new_reg_status);
 		// toggle reg status but only if it has changed and the user can do so
 		if (
-			$this->reg_status_updated( $registration->ID() ) &&
-			EE_Registry::instance()->CAP->current_user_can( 'ee_edit_registration', 'toggle_registration_status', $registration->ID() )
+			$this->reg_status_updated($registration->ID()) &&
+			EE_Registry::instance()->CAP->current_user_can('ee_edit_registration', 'toggle_registration_status', $registration->ID())
 		) {
 			// change status to new value
-			if ( $registration->set_status( $this->new_reg_status( $registration->ID() ) ) && $save ) {
+			if ($registration->set_status($this->new_reg_status($registration->ID())) && $save) {
 				$registration->save();
 			}
 			return TRUE;
@@ -193,30 +193,30 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	public function toggle_incomplete_registration_status_to_default( EE_Registration $registration, $save = TRUE ) {
+	public function toggle_incomplete_registration_status_to_default(EE_Registration $registration, $save = TRUE) {
 		$existing_reg_status = $registration->status_ID();
 		// set initial REG_Status
-		$this->set_old_reg_status( $registration->ID(), $existing_reg_status );
+		$this->set_old_reg_status($registration->ID(), $existing_reg_status);
 		// is the registration currently incomplete ?
-		if ( $registration->status_ID() === EEM_Registration::status_id_incomplete ) {
+		if ($registration->status_ID() === EEM_Registration::status_id_incomplete) {
 			// grab default reg status for the event, if set
 			$event_default_registration_status = $registration->event()->default_registration_status();
 			// if no default reg status is set for the event, then use the global value
-			$STS_ID = ! empty( $event_default_registration_status )
+			$STS_ID = ! empty($event_default_registration_status)
 				? $event_default_registration_status
 				: EE_Registry::instance()->CFG->registration->default_STS_ID;
 			// if the event default reg status is approved, then downgrade temporarily to payment pending to ensure that payments are triggered
 			$STS_ID = $STS_ID === EEM_Registration::status_id_approved ? EEM_Registration::status_id_pending_payment : $STS_ID;
 			// set incoming REG_Status
-			$this->set_new_reg_status( $registration->ID(), $STS_ID );
-			$registration->set_status( $STS_ID );
-			if ( $save ) {
+			$this->set_new_reg_status($registration->ID(), $STS_ID);
+			$registration->set_status($STS_ID);
+			if ($save) {
 				$registration->save();
 			}
 			// don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
-			if ( ! EE_Processor_Base::$IPN ) {
+			if ( ! EE_Processor_Base::$IPN) {
                 // otherwise, send out notifications
-				add_filter( 'FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10 );
+				add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
 			}
 			// DEBUG LOG
 			//$this->log(
@@ -241,10 +241,10 @@ 
 	 * @return boolean
 	 * @throws \EE_Error
 	 */
-	public function toggle_registration_status_for_default_approved_events( EE_Registration $registration, $save = TRUE ) {
+	public function toggle_registration_status_for_default_approved_events(EE_Registration $registration, $save = TRUE) {
 		$reg_status = $registration->status_ID();
 		// set initial REG_Status
-		$this->set_old_reg_status( $registration->ID(), $reg_status );
+		$this->set_old_reg_status($registration->ID(), $reg_status);
 		// if not already, toggle reg status to approved IF the event default reg status is approved
 		// ( as long as the registration wasn't cancelled or declined at some point )
 		if (
@@ -254,16 +254,16 @@ 
 			$registration->event()->default_registration_status() === EEM_Registration::status_id_approved
 		) {
 			// set incoming REG_Status
-			$this->set_new_reg_status( $registration->ID(), EEM_Registration::status_id_approved );
+			$this->set_new_reg_status($registration->ID(), EEM_Registration::status_id_approved);
 			// toggle status to approved
-			$registration->set_status( EEM_Registration::status_id_approved );
-			if ( $save ) {
+			$registration->set_status(EEM_Registration::status_id_approved);
+			if ($save) {
 				$registration->save();
 			}
 			// don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
-			if ( ! EE_Processor_Base::$IPN ) {
+			if ( ! EE_Processor_Base::$IPN) {
                 // otherwise, send out notifications
-				add_filter( 'FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10 );
+				add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
 			}
 			// DEBUG LOG
 			//$this->log(
@@ -291,19 +291,19 @@ 
 	 * @return bool
 	 * @throws \EE_Error
 	 */
-	public function toggle_registration_status_if_no_monies_owing( EE_Registration $registration, $save = TRUE, $additional_details = array() ) {
+	public function toggle_registration_status_if_no_monies_owing(EE_Registration $registration, $save = TRUE, $additional_details = array()) {
 		// set initial REG_Status
-		$this->set_old_reg_status( $registration->ID(), $registration->status_ID() );
+		$this->set_old_reg_status($registration->ID(), $registration->status_ID());
 		//EEH_Debug_Tools::printr( $additional_details, '$additional_details', __FILE__, __LINE__ );
 		// was a payment just made ?
 		if (
-			isset( $additional_details[ 'payment_updates' ], $additional_details[ 'last_payment' ] ) &&
-			$additional_details[ 'payment_updates' ] &&
-			$additional_details[ 'last_payment' ] instanceof EE_Payment
+			isset($additional_details['payment_updates'], $additional_details['last_payment']) &&
+			$additional_details['payment_updates'] &&
+			$additional_details['last_payment'] instanceof EE_Payment
 		) {
-			$payment = $additional_details[ 'last_payment' ];
+			$payment = $additional_details['last_payment'];
 			$total_paid = 0;
-			foreach ( self::$_amount_paid as $reg => $amount_paid ) {
+			foreach (self::$_amount_paid as $reg => $amount_paid) {
 				$total_paid += $amount_paid;
 			}
 		} else {
@@ -327,30 +327,30 @@ 
 					$registration->transaction()->is_completed() ||
 					$registration->transaction()->is_overpaid() ||
 					$registration->transaction()->is_free() ||
-					apply_filters( 'FHEE__EE_Registration_Processor__toggle_registration_status_if_no_monies_owing', false, $registration )
+					apply_filters('FHEE__EE_Registration_Processor__toggle_registration_status_if_no_monies_owing', false, $registration)
 				) || (
 					$payment instanceof EE_Payment &&
 					$payment->is_approved() &&
 					// this specific registration has not yet been paid for
-					! isset( self::$_amount_paid[ $registration->ID() ] ) &&
+					! isset(self::$_amount_paid[$registration->ID()]) &&
 					// payment amount, less what we have already attributed to other registrations, is greater than this reg's final price
 					$payment->amount() - $total_paid >= $registration->final_price()
 				)
 			)
 		) {
 			// mark as paid
-			self::$_amount_paid[ $registration->ID() ] = $registration->final_price();
+			self::$_amount_paid[$registration->ID()] = $registration->final_price();
 			// track new REG_Status
-			$this->set_new_reg_status( $registration->ID(), EEM_Registration::status_id_approved );
+			$this->set_new_reg_status($registration->ID(), EEM_Registration::status_id_approved);
 			// toggle status to approved
-			$registration->set_status( EEM_Registration::status_id_approved );
-			if ( $save ) {
+			$registration->set_status(EEM_Registration::status_id_approved);
+			if ($save) {
 				$registration->save();
 			}
 			// don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
-			if ( ! EE_Processor_Base::$IPN ) {
+			if ( ! EE_Processor_Base::$IPN) {
                 // otherwise, send out notifications
-				add_filter( 'FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10 );
+				add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
 			}
 			// DEBUG LOG
 			//$this->log(
@@ -376,10 +376,10 @@ 
 	 * @param array 	$additional_details
 	 * @return void
 	 */
-	public function trigger_registration_update_notifications( $registration, $additional_details = array() ) {
+	public function trigger_registration_update_notifications($registration, $additional_details = array()) {
 		try {
-			if ( ! $registration instanceof EE_Registration ) {
-				throw new EE_Error( __( 'An invalid registration was received.', 'event_espresso' ) );
+			if ( ! $registration instanceof EE_Registration) {
+				throw new EE_Error(__('An invalid registration was received.', 'event_espresso'));
 			}
 			// EE_Registry::instance()->load_helper( 'Debug_Tools' );
 			// EEH_Debug_Tools::log(
@@ -398,8 +398,8 @@ 
 				$registration,
 				$additional_details
 			);
-		} catch( Exception $e ) {
-			EE_Error::add_error( $e->getMessage(), $e->getFile(), 'unknown_function_from_exception', $e->getLine() );
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), $e->getFile(), 'unknown_function_from_exception', $e->getLine());
 		}
 	}
 
@@ -413,22 +413,22 @@ 
 	 * @return bool
 	 * @throws \EE_Error
 	 */
-	public function update_registration_after_checkout_or_payment(  EE_Registration $registration, $additional_details = array() ) {
+	public function update_registration_after_checkout_or_payment(EE_Registration $registration, $additional_details = array()) {
 		// set initial REG_Status
-		$this->set_old_reg_status( $registration->ID(), $registration->status_ID() );
+		$this->set_old_reg_status($registration->ID(), $registration->status_ID());
 
 		// if the registration status gets updated, then save the registration
 		if (
-			$this->toggle_registration_status_for_default_approved_events( $registration, false )
-			|| $this->toggle_registration_status_if_no_monies_owing( $registration, false, $additional_details )
+			$this->toggle_registration_status_for_default_approved_events($registration, false)
+			|| $this->toggle_registration_status_if_no_monies_owing($registration, false, $additional_details)
 		) {
 			$registration->save();
 		}
 
 		// set new  REG_Status
-		$this->set_new_reg_status( $registration->ID(), $registration->status_ID() );
-		return $this->reg_status_updated( $registration->ID() )
-		       && $this->new_reg_status( $registration->ID() ) === EEM_Registration::status_id_approved
+		$this->set_new_reg_status($registration->ID(), $registration->status_ID());
+		return $this->reg_status_updated($registration->ID())
+		       && $this->new_reg_status($registration->ID()) === EEM_Registration::status_id_approved
 			? true
 			: false;
 	}
@@ -444,20 +444,20 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	public function update_registration_final_prices( $transaction, $save_regs = true ) {
-		$reg_final_price_per_ticket_line_item = EEH_Line_Item::calculate_reg_final_prices_per_line_item( $transaction->total_line_item() );
-		foreach( $transaction->registrations() as $registration ) {
+	public function update_registration_final_prices($transaction, $save_regs = true) {
+		$reg_final_price_per_ticket_line_item = EEH_Line_Item::calculate_reg_final_prices_per_line_item($transaction->total_line_item());
+		foreach ($transaction->registrations() as $registration) {
 			/** @var EE_Line_Item $line_item */
-			$line_item = EEM_Line_Item::instance()->get_line_item_for_registration( $registration );
-			if( isset( $reg_final_price_per_ticket_line_item[ $line_item->ID() ] ) ) {
-				$registration->set_final_price( $reg_final_price_per_ticket_line_item[ $line_item->ID() ] );
-				if( $save_regs ) {
+			$line_item = EEM_Line_Item::instance()->get_line_item_for_registration($registration);
+			if (isset($reg_final_price_per_ticket_line_item[$line_item->ID()])) {
+				$registration->set_final_price($reg_final_price_per_ticket_line_item[$line_item->ID()]);
+				if ($save_regs) {
 					$registration->save();
 				}
 			}
 		}
 		//and make sure there's no rounding problem
-		$this->fix_reg_final_price_rounding_issue( $transaction );
+		$this->fix_reg_final_price_rounding_issue($transaction);
 	}
 
 
@@ -477,7 +477,7 @@ 
 	 * @return boolean success verifying that there is NO difference after this method is done
 	 * @throws \EE_Error
 	 */
-	public function fix_reg_final_price_rounding_issue( $transaction ) {
+	public function fix_reg_final_price_rounding_issue($transaction) {
 		$reg_final_price_sum = EEM_Registration::instance()->sum(
 			array(
 				array(
@@ -486,9 +486,9 @@ 
 			),
 			'REG_final_price'
 		);
-		$diff =  $transaction->total() - (float) $reg_final_price_sum;
+		$diff = $transaction->total() - (float) $reg_final_price_sum;
 		//ok then, just grab one of the registrations
-		if( $diff !== 0 ) {
+		if ($diff !== 0) {
 			$a_reg = EEM_Registration::instance()->get_one(
 					array(
 						array(
@@ -497,7 +497,7 @@ 
 					));
 			$success = $a_reg instanceof EE_Registration
 				? $a_reg->save(
-					array( 'REG_final_price' => $a_reg->final_price() + $diff )
+					array('REG_final_price' => $a_reg->final_price() + $diff)
 				)
 				: false;
 			return $success ? true : false;
@@ -522,13 +522,13 @@ 
 		$update_reg = true
 	) {
 		// these reg statuses should not be considered in any calculations involving monies owing
-		$closed_reg_statuses = ! empty( $closed_reg_statuses ) ? $closed_reg_statuses
+		$closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses
 			: EEM_Registration::closed_reg_statuses();
-		if ( ! in_array( $registration->status_ID(), $closed_reg_statuses ) ) {
+		if ( ! in_array($registration->status_ID(), $closed_reg_statuses)) {
 			return false;
 		}
 		$registration->set_final_price(0);
-		if ( $update_reg ) {
+		if ($update_reg) {
 			$registration->save();
 		}
 		return true;
@@ -551,23 +551,23 @@ 
 		$update_reg = true
 	) {
 		// these reg statuses should not be considered in any calculations involving monies owing
-		$closed_reg_statuses = ! empty( $closed_reg_statuses ) ? $closed_reg_statuses
+		$closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses
 			: EEM_Registration::closed_reg_statuses();
-		if ( in_array( $registration->status_ID(), $closed_reg_statuses ) ) {
+		if (in_array($registration->status_ID(), $closed_reg_statuses)) {
 			return false;
 		}
 		$ticket = $registration->ticket();
-		if ( ! $ticket instanceof EE_Ticket ) {
+		if ( ! $ticket instanceof EE_Ticket) {
 			throw new EE_Error(
 				sprintf(
-					__( 'The Ticket for Registration %1$d was not found or is invalid.',
-						'event_espresso' ),
+					__('The Ticket for Registration %1$d was not found or is invalid.',
+						'event_espresso'),
 					$registration->ticket_ID()
 				)
 			);
 		}
-		$registration->set_final_price( $ticket->price() );
-		if ( $update_reg ) {
+		$registration->set_final_price($ticket->price());
+		if ($update_reg) {
 			$registration->save();
 		}
 		return true;
@@ -605,7 +605,7 @@ 
 		$total_ticket_count = 1
 	) {
 		EE_Error::doing_it_wrong(
-			__CLASS__ . '::' . __FUNCTION__,
+			__CLASS__.'::'.__FUNCTION__,
 			sprintf(__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
 				'\EventEspresso\core\domain\services\registration\CreateRegistrationService::create()'),
 			'4.9.1',
@@ -648,7 +648,7 @@ 
 	public function generate_reg_url_link($att_nmbr, $item)
 	{
 		EE_Error::doing_it_wrong(
-			__CLASS__ . '::' . __FUNCTION__,
+			__CLASS__.'::'.__FUNCTION__,
 			sprintf(__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
 				'EventEspresso\core\domain\entities\RegUrlLink'),
 			'4.9.1',
@@ -668,11 +668,11 @@ 
 	 * @return string
 	 * @throws \EE_Error
 	 */
-	public function generate_reg_code( EE_Registration $registration ) {
+	public function generate_reg_code(EE_Registration $registration) {
 		EE_Error::doing_it_wrong(
-			__CLASS__ . '::' . __FUNCTION__,
+			__CLASS__.'::'.__FUNCTION__,
 			sprintf(
-				__( 'This method is deprecated. Please use "%s" instead', 'event_espresso' ),
+				__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
 				'EventEspresso\core\domain\entities\RegCode'
 			),
 			'4.9.1',
@@ -681,7 +681,7 @@ 
 		return apply_filters(
 			'FHEE__EE_Registration_Processor___generate_reg_code__new_reg_code',
 			new RegCode(
-				RegUrlLink::fromRegistration( $registration ),
+				RegUrlLink::fromRegistration($registration),
 				$registration->transaction(),
 				$registration->ticket()
 			),

modules/single_page_checkout/reg_steps/finalize_registration/EE_SPCO_Reg_Step_Finalize_Registration.class.php

Indentation +70 added lines, -70 removed lines

@@ -56,10 +56,10 @@ 
 
 
 
-    /**
-     * @return string
-     * @throws \EE_Error
-     */
+	/**
+	 * @return string
+	 * @throws \EE_Error
+	 */
 	public function generate_reg_form() {
 		// create empty form so that things don't break
 		$this->reg_form = new EE_Form_Section_Proper();
@@ -68,26 +68,26 @@ 
 
 
 
-    /**
-     * @return boolean
-     * @throws \RuntimeException
-     * @throws \EE_Error
-     */
+	/**
+	 * @return boolean
+	 * @throws \RuntimeException
+	 * @throws \EE_Error
+	 */
 	public function process_reg_step() {
-        // ensure all data gets refreshed from the db
+		// ensure all data gets refreshed from the db
 		$this->checkout->refresh_all_entities( true );
 		// ensures that all details and statuses for transaction, registration, and payments are updated
 		$txn_update_params = $this->_finalize_transaction();
-        // maybe send messages
-        $this->_set_notification_triggers();
-        // send messages
-        /** @type EE_Registration_Processor $registration_processor */
-        $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-        $registration_processor->trigger_registration_update_notifications(
-            $this->checkout->transaction->primary_registration(),
-            $txn_update_params
-        );
-        // set a hook point
+		// maybe send messages
+		$this->_set_notification_triggers();
+		// send messages
+		/** @type EE_Registration_Processor $registration_processor */
+		$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+		$registration_processor->trigger_registration_update_notifications(
+			$this->checkout->transaction->primary_registration(),
+			$txn_update_params
+		);
+		// set a hook point
 		do_action(
 			'AHEE__EE_SPCO_Reg_Step_Finalize_Registration__process_reg_step__completed',
 			$this->checkout,
@@ -104,7 +104,7 @@ 
 		if (
 			! (
 				$this->checkout->payment_method instanceof EE_Payment_Method
-		        && $this->checkout->payment_method->is_off_site()
+				&& $this->checkout->payment_method->is_off_site()
 			)
 		) {
 			// mark this reg step as completed
@@ -116,14 +116,14 @@ 
 
 
 
-    /**
-     * _finalize_transaction
-     * ensures that all details and statuses for transaction, registration, and payments are updated
-     *
-     * @return array
-     * @throws \RuntimeException
-     * @throws \EE_Error
-     */
+	/**
+	 * _finalize_transaction
+	 * ensures that all details and statuses for transaction, registration, and payments are updated
+	 *
+	 * @return array
+	 * @throws \RuntimeException
+	 * @throws \EE_Error
+	 */
 	protected function _finalize_transaction() {
 		/** @type EE_Transaction_Processor $transaction_processor */
 		$transaction_processor = EE_Registry::instance()->load_class( 'Transaction_Processor' );
@@ -139,17 +139,17 @@ 
 		}
 		// maybe update status, but don't save transaction just yet
 		$this->checkout->transaction->update_status_based_on_total_paid( false );
-        // this will result in the base session properties getting saved to the TXN_Session_data field
+		// this will result in the base session properties getting saved to the TXN_Session_data field
 		$this->checkout->transaction->set_txn_session_data(
 			EE_Registry::instance()->SSN->get_session_data( null, true )
 		);
-        // update the TXN if payment conditions have changed, but do NOT trigger notifications,
-        // because we will do that in process_reg_step() after setting some more triggers
+		// update the TXN if payment conditions have changed, but do NOT trigger notifications,
+		// because we will do that in process_reg_step() after setting some more triggers
 		return $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
 			$this->checkout->transaction,
 			$this->checkout->payment,
 			$this->checkout->reg_cache_where_params,
-            false
+			false
 		);
 	}
 
@@ -167,43 +167,43 @@ 
 	protected function _set_notification_triggers() {
 
 		if ( $this->checkout->payment_method instanceof EE_Payment_Method ) {
-		    // let's start with the assumption that we need to trigger notifications
-            // then toggle this to false for conditions where we know we don't need to
-		    $deliver_notifications = true;
-            if (
-                // if SPCO revisit
-                filter_var($this->checkout->revisit, FILTER_VALIDATE_BOOLEAN)
-                // and TXN or REG statuses have NOT changed due to a payment
-                && ! (
-                    $this->checkout->transaction->txn_status_updated()
-                    || $this->checkout->any_reg_status_updated()
-                )
-            ) {
-                $deliver_notifications = false;
-            }
-            if ($this->checkout->payment_method->is_off_site()) {
-                /** @var EE_Gateway $gateway */
-                $gateway = $this->checkout->payment_method->type_obj()->get_gateway();
-                // and the gateway uses a separate request to process the IPN
-                if (
-                    $gateway instanceof EE_Offsite_Gateway
-                    && $gateway->handle_IPN_in_this_request(\EE_Registry::instance()->REQ->params(), true)
-                ) {
-                    // IPN request will handle triggering notifications
-                    $deliver_notifications = false;
-                    // no really... don't send any notices in this request
-                    remove_all_filters('FHEE__EED_Messages___maybe_registration__deliver_notifications');
-                    add_filter(
-                        'FHEE__EED_Messages___maybe_registration__deliver_notifications',
-                        '__return_false',
-                        15
-                    );
-                }
-            }
-            if ($deliver_notifications) {
-                // send out notifications
-                add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
-            }
+			// let's start with the assumption that we need to trigger notifications
+			// then toggle this to false for conditions where we know we don't need to
+			$deliver_notifications = true;
+			if (
+				// if SPCO revisit
+				filter_var($this->checkout->revisit, FILTER_VALIDATE_BOOLEAN)
+				// and TXN or REG statuses have NOT changed due to a payment
+				&& ! (
+					$this->checkout->transaction->txn_status_updated()
+					|| $this->checkout->any_reg_status_updated()
+				)
+			) {
+				$deliver_notifications = false;
+			}
+			if ($this->checkout->payment_method->is_off_site()) {
+				/** @var EE_Gateway $gateway */
+				$gateway = $this->checkout->payment_method->type_obj()->get_gateway();
+				// and the gateway uses a separate request to process the IPN
+				if (
+					$gateway instanceof EE_Offsite_Gateway
+					&& $gateway->handle_IPN_in_this_request(\EE_Registry::instance()->REQ->params(), true)
+				) {
+					// IPN request will handle triggering notifications
+					$deliver_notifications = false;
+					// no really... don't send any notices in this request
+					remove_all_filters('FHEE__EED_Messages___maybe_registration__deliver_notifications');
+					add_filter(
+						'FHEE__EED_Messages___maybe_registration__deliver_notifications',
+						'__return_false',
+						15
+					);
+				}
+			}
+			if ($deliver_notifications) {
+				// send out notifications
+				add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
+			}
 		}
 	}
 

Spacing +18 added lines, -18 removed lines

@@ -1,5 +1,5 @@ 
-<?php if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 
@@ -21,9 +21,9 @@ 
 	 * @access    public
 	 * @param    EE_Checkout $checkout
 	 */
-	public function __construct( EE_Checkout $checkout ) {
+	public function __construct(EE_Checkout $checkout) {
 		$this->_slug = 'finalize_registration';
-		$this->_name = __( 'Finalize Registration', 'event_espresso' );
+		$this->_name = __('Finalize Registration', 'event_espresso');
 		$this->_submit_button_text = $this->_name;
 		$this->_template = '';
 		$this->checkout = $checkout;
@@ -46,7 +46,7 @@ 
 	 */
 	public function initialize_reg_step() {
 		// there's actually no reg form to process if this is the final step
-		if ( $this->is_current_step() ) {
+		if ($this->is_current_step()) {
 			$this->checkout->step = $_REQUEST['step'] = $this->slug();
 			$this->checkout->action = $_REQUEST['action'] = 'process_reg_step';
 			$this->checkout->generate_reg_form = false;
@@ -75,7 +75,7 @@ 
      */
 	public function process_reg_step() {
         // ensure all data gets refreshed from the db
-		$this->checkout->refresh_all_entities( true );
+		$this->checkout->refresh_all_entities(true);
 		// ensures that all details and statuses for transaction, registration, and payments are updated
 		$txn_update_params = $this->_finalize_transaction();
         // maybe send messages
@@ -94,13 +94,13 @@ 
 			$txn_update_params
 		);
 		// check if transaction has a primary registrant and that it has a related Attendee object
-		if ( ! $this->_validate_primary_registrant() ) {
+		if ( ! $this->_validate_primary_registrant()) {
 			return false;
 		}
 		// you don't have to go home but you can't stay here !
 		$this->checkout->redirect = true;
 		$this->checkout->continue_reg = true;
-		$this->checkout->json_response->set_redirect_url( $this->checkout->redirect_url );
+		$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
 		if (
 			! (
 				$this->checkout->payment_method instanceof EE_Payment_Method
@@ -126,22 +126,22 @@ 
      */
 	protected function _finalize_transaction() {
 		/** @type EE_Transaction_Processor $transaction_processor */
-		$transaction_processor = EE_Registry::instance()->load_class( 'Transaction_Processor' );
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
 		//set revisit flag in txn processor
-		$transaction_processor->set_revisit( $this->checkout->revisit );
+		$transaction_processor->set_revisit($this->checkout->revisit);
 		// at this point we'll consider a TXN to not have been abandoned
 		$this->checkout->transaction->toggle_abandoned_transaction_status();
-		if ( $this->checkout->cart instanceof EE_Cart ) {
+		if ($this->checkout->cart instanceof EE_Cart) {
 			// save TXN data to the cart
 			$this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn(
 				$this->checkout->transaction->ID()
 			);
 		}
 		// maybe update status, but don't save transaction just yet
-		$this->checkout->transaction->update_status_based_on_total_paid( false );
+		$this->checkout->transaction->update_status_based_on_total_paid(false);
         // this will result in the base session properties getting saved to the TXN_Session_data field
 		$this->checkout->transaction->set_txn_session_data(
-			EE_Registry::instance()->SSN->get_session_data( null, true )
+			EE_Registry::instance()->SSN->get_session_data(null, true)
 		);
         // update the TXN if payment conditions have changed, but do NOT trigger notifications,
         // because we will do that in process_reg_step() after setting some more triggers
@@ -166,7 +166,7 @@ 
 	 */
 	protected function _set_notification_triggers() {
 
-		if ( $this->checkout->payment_method instanceof EE_Payment_Method ) {
+		if ($this->checkout->payment_method instanceof EE_Payment_Method) {
 		    // let's start with the assumption that we need to trigger notifications
             // then toggle this to false for conditions where we know we don't need to
 		    $deliver_notifications = true;
@@ -216,9 +216,9 @@ 
 	 * @throws \EE_Error
 	 */
 	protected function _validate_primary_registrant() {
-		if ( ! $this->checkout->transaction_has_primary_registrant() ) {
+		if ( ! $this->checkout->transaction_has_primary_registrant()) {
 			EE_Error::add_error(
-				__( 'A valid Primary Registration for this Transaction could not be found.', 'event_espresso' ),
+				__('A valid Primary Registration for this Transaction could not be found.', 'event_espresso'),
 				__FILE__,
 				__FUNCTION__,
 				__LINE__
@@ -229,7 +229,7 @@ 
 		}
 		// setup URL for redirect
 		$this->checkout->redirect_url = add_query_arg(
-			array( 'e_reg_url_link' => $this->checkout->transaction->primary_registration()->reg_url_link() ),
+			array('e_reg_url_link' => $this->checkout->transaction->primary_registration()->reg_url_link()),
 			$this->checkout->thank_you_page_url
 		);
 		return true;
@@ -242,7 +242,7 @@ 
 	 */
 	public function update_reg_step() {
 		EE_Error::doing_it_wrong(
-			__CLASS__ . '::' . __FILE__,
+			__CLASS__.'::'.__FILE__,
 			__(
 				'Can not call update_reg_step() on the Finalize Registration reg step.',
 				'event_espresso'

core/EE_Addon.core.php

Spacing +83 added lines, -83 removed lines

@@ -1,5 +1,5 @@ 
-<?php if ( !defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 /**
  *
@@ -95,7 +95,7 @@ 
 	 *    class constructor
 	 */
 	public function __construct() {
-		add_action( 'AHEE__EE_System__load_controllers__load_admin_controllers', array( $this, 'admin_init' ) );
+		add_action('AHEE__EE_System__load_controllers__load_admin_controllers', array($this, 'admin_init'));
 	}
 
 
@@ -103,7 +103,7 @@ 
 	/**
 	 * @param mixed $version
 	 */
-	public function set_version( $version = NULL ) {
+	public function set_version($version = NULL) {
 		$this->_version = $version;
 	}
 
@@ -121,7 +121,7 @@ 
 	/**
 	 * @param mixed $min_core_version
 	 */
-	public function set_min_core_version( $min_core_version = NULL ) {
+	public function set_min_core_version($min_core_version = NULL) {
 		$this->_min_core_version = $min_core_version;
 	}
 
@@ -142,7 +142,7 @@ 
 	 * @param string $addon_name
 	 * @return boolean
 	 */
-	public function set_name( $addon_name ) {
+	public function set_name($addon_name) {
 		return $this->_addon_name = $addon_name;
 	}
 
@@ -170,7 +170,7 @@ 
 	/**
 	 * @param string $plugin_basename
 	 */
-	public function set_plugin_basename( $plugin_basename ) {
+	public function set_plugin_basename($plugin_basename) {
 
 		$this->_plugin_basename = $plugin_basename;
 	}
@@ -190,7 +190,7 @@ 
 	/**
 	 * @param string $plugin_slug
 	 */
-	public function set_plugin_slug( $plugin_slug ) {
+	public function set_plugin_slug($plugin_slug) {
 
 		$this->_plugin_slug = $plugin_slug;
 	}
@@ -210,7 +210,7 @@ 
 	/**
 	 * @param string $plugin_action_slug
 	 */
-	public function set_plugin_action_slug( $plugin_action_slug ) {
+	public function set_plugin_action_slug($plugin_action_slug) {
 
 		$this->_plugin_action_slug = $plugin_action_slug;
 	}
@@ -230,9 +230,9 @@ 
 	/**
 	 * @param array $plugins_page_row
 	 */
-	public function set_plugins_page_row( $plugins_page_row = array() ) {
+	public function set_plugins_page_row($plugins_page_row = array()) {
 		// sigh.... check for example content that I stupidly merged to master and remove it if found
-		if ( ! is_array( $plugins_page_row ) && strpos( $plugins_page_row, '<h3>Promotions Addon Upsell Info</h3>' ) !== false ) {
+		if ( ! is_array($plugins_page_row) && strpos($plugins_page_row, '<h3>Promotions Addon Upsell Info</h3>') !== false) {
 			$plugins_page_row = '';
 		}
 		$this->_plugins_page_row = $plugins_page_row;
@@ -250,7 +250,7 @@ 
 		do_action("AHEE__{$classname}__new_install");
 		do_action('AHEE__EE_Addon__new_install', $this);
 		EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-		add_action( 'AHEE__EE_System__perform_activations_upgrades_and_migrations', array( $this, 'initialize_db_if_no_migrations_required' ) );
+		add_action('AHEE__EE_System__perform_activations_upgrades_and_migrations', array($this, 'initialize_db_if_no_migrations_required'));
 	}
 
 
@@ -265,18 +265,18 @@ 
 		do_action("AHEE__{$classname}__reactivation");
 		do_action('AHEE__EE_Addon__reactivation', $this);
 		EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-		add_action( 'AHEE__EE_System__perform_activations_upgrades_and_migrations', array( $this, 'initialize_db_if_no_migrations_required' ) );
+		add_action('AHEE__EE_System__perform_activations_upgrades_and_migrations', array($this, 'initialize_db_if_no_migrations_required'));
 	}
 
 
 
-	public function deactivation(){
+	public function deactivation() {
 		$classname = get_class($this);
 //		echo "Deactivating $classname";die;
 		do_action("AHEE__{$classname}__deactivation");
 		do_action('AHEE__EE_Addon__deactivation', $this);
 		//check if the site no longer needs to be in maintenance mode
-		EE_Register_Addon::deregister( $this->name() );
+		EE_Register_Addon::deregister($this->name());
 		EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
 	}
 
@@ -292,16 +292,16 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function initialize_db_if_no_migrations_required( $verify_schema = true ) {
-		if( $verify_schema === '' ) {
+	public function initialize_db_if_no_migrations_required($verify_schema = true) {
+		if ($verify_schema === '') {
 			//wp core bug imo: if no args are passed to `do_action('some_hook_name')` besides the hook's name
 			//(ie, no 2nd or 3rd arguments), instead of calling the registered callbacks with no arguments, it
 			//calls them with an argument of an empty string (ie ""), which evaluates to false
 			//so we need to treat the empty string as if nothing had been passed, and should instead use the default
 			$verify_schema = true;
 		}
-		if ( EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance ) {
-			if( $verify_schema ) {
+		if (EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
+			if ($verify_schema) {
 				$this->initialize_db();
 			}
 			$this->initialize_default_data();
@@ -319,15 +319,15 @@ 
 			 * other data needs to be verified)
 			 */
 			EEH_Activation::initialize_db_content();
-			update_option( 'ee_flush_rewrite_rules', TRUE );
+			update_option('ee_flush_rewrite_rules', TRUE);
 			//in case there are lots of addons being activated at once, let's force garbage collection
 			//to help avoid memory limit errors
 			//EEH_Debug_Tools::instance()->measure_memory( 'db content initialized for ' . get_class( $this), true );
 			gc_collect_cycles();
-		}else{
+		} else {
 			//ask the data migration manager to init this addon's data
 			//when migrations are finished because we can't do it now
-			EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for( $this->name() );
+			EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for($this->name());
 		}
 	}
 
@@ -341,15 +341,15 @@ 
 	 */
 	public function initialize_db() {
 		//find the migration script that sets the database to be compatible with the code
-		$current_dms_name = EE_Data_Migration_Manager::instance()->get_most_up_to_date_dms( $this->name() );
-		if( $current_dms_name ){
-			$current_data_migration_script = EE_Registry::instance()->load_dms( $current_dms_name );
-			$current_data_migration_script->set_migrating( FALSE );
+		$current_dms_name = EE_Data_Migration_Manager::instance()->get_most_up_to_date_dms($this->name());
+		if ($current_dms_name) {
+			$current_data_migration_script = EE_Registry::instance()->load_dms($current_dms_name);
+			$current_data_migration_script->set_migrating(FALSE);
 			$current_data_migration_script->schema_changes_before_migration();
 			$current_data_migration_script->schema_changes_after_migration();
-			if ( $current_data_migration_script->get_errors() ) {
-				foreach( $current_data_migration_script->get_errors() as $error ) {
-					EE_Error::add_error( $error, __FILE__, __FUNCTION__, __LINE__ );
+			if ($current_data_migration_script->get_errors()) {
+				foreach ($current_data_migration_script->get_errors() as $error) {
+					EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
 				}
 			}
 		}
@@ -381,7 +381,7 @@ 
 		 * default data)
 		 * @param EE_Addon $addon the addon that called this
 		 */
-		do_action( 'AHEE__EE_Addon__initialize_default_data__begin', $this );
+		do_action('AHEE__EE_Addon__initialize_default_data__begin', $this);
 		//override to insert default data. It is safe to use the models here
 		//because the site should not be in maintenance mode
 	}
@@ -401,7 +401,7 @@ 
 		EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
 		//also it's possible there is new default data that needs to be added
 		add_action(
-		    'AHEE__EE_System__perform_activations_upgrades_and_migrations', array( $this, 'initialize_db_if_no_migrations_required' )
+		    'AHEE__EE_System__perform_activations_upgrades_and_migrations', array($this, 'initialize_db_if_no_migrations_required')
         );
 	}
 
@@ -415,7 +415,7 @@ 
 		do_action("AHEE__{$classname}__downgrade");
 		do_action('AHEE__EE_Addon__downgrade', $this);
 		//it's possible there's old default data that needs to be double-checked
-		add_action( 'AHEE__EE_System__perform_activations_upgrades_and_migrations', array( $this, 'initialize_db_if_no_migrations_required' ) );
+		add_action('AHEE__EE_System__perform_activations_upgrades_and_migrations', array($this, 'initialize_db_if_no_migrations_required'));
 	}
 
 
@@ -426,7 +426,7 @@ 
 	 * plugin activation only. In the future, we'll want to do it on plugin updates too
 	 * @return bool
 	 */
-	public function set_db_update_option_name(){
+	public function set_db_update_option_name() {
 		EE_Error::doing_it_wrong(__FUNCTION__, __('EE_Addon::set_db_update_option_name was renamed to EE_Addon::set_activation_indicator_option', 'event_espresso'), '4.3.0.alpha.016');
 		//let's just handle this on the next request, ok? right now we're just not really ready
 		return $this->set_activation_indicator_option();
@@ -454,7 +454,7 @@ 
 	 */
 	public function set_activation_indicator_option() {
 		// let's just handle this on the next request, ok? right now we're just not really ready
-		return update_option( $this->get_activation_indicator_option_name(), TRUE );
+		return update_option($this->get_activation_indicator_option_name(), TRUE);
 	}
 
 
@@ -462,8 +462,8 @@ 
 	 * Gets the name of the wp option which is used to temporarily indicate that this addon was activated
 	 * @return string
 	 */
-	public function get_activation_indicator_option_name(){
-		return 'ee_activation_' . $this->name();
+	public function get_activation_indicator_option_name() {
+		return 'ee_activation_'.$this->name();
 	}
 
 
@@ -473,7 +473,7 @@ 
 	 * Used by EE_System to set the request type of this addon. Should not be used by addon developers
 	 * @param int $req_type
 	 */
-	public function set_req_type( $req_type ) {
+	public function set_req_type($req_type) {
 		$this->_req_type = $req_type;
 	}
 
@@ -484,7 +484,7 @@ 
 	 * of addons
 	 */
 	public function detect_req_type() {
-		if( ! $this->_req_type ){
+		if ( ! $this->_req_type) {
 			$this->detect_activation_or_upgrade();
 		}
 		return $this->_req_type;
@@ -497,36 +497,36 @@ 
 	 * Should only be called once per request
 	 * @return void
 	 */
-	public function detect_activation_or_upgrade(){
+	public function detect_activation_or_upgrade() {
 		$activation_history_for_addon = $this->get_activation_history();
 //		d($activation_history_for_addon);
 		$request_type = EE_System::detect_req_type_given_activation_history($activation_history_for_addon, $this->get_activation_indicator_option_name(), $this->version());
 		$this->set_req_type($request_type);
 		$classname = get_class($this);
-		switch($request_type){
+		switch ($request_type) {
 			case EE_System::req_type_new_activation:
-				do_action( "AHEE__{$classname}__detect_activations_or_upgrades__new_activation" );
-				do_action( 'AHEE__EE_Addon__detect_activations_or_upgrades__new_activation', $this );
+				do_action("AHEE__{$classname}__detect_activations_or_upgrades__new_activation");
+				do_action('AHEE__EE_Addon__detect_activations_or_upgrades__new_activation', $this);
 				$this->new_install();
-				$this->update_list_of_installed_versions( $activation_history_for_addon );
+				$this->update_list_of_installed_versions($activation_history_for_addon);
 				break;
 			case EE_System::req_type_reactivation:
-				do_action( "AHEE__{$classname}__detect_activations_or_upgrades__reactivation" );
-				do_action( 'AHEE__EE_Addon__detect_activations_or_upgrades__reactivation', $this );
+				do_action("AHEE__{$classname}__detect_activations_or_upgrades__reactivation");
+				do_action('AHEE__EE_Addon__detect_activations_or_upgrades__reactivation', $this);
 				$this->reactivation();
-				$this->update_list_of_installed_versions( $activation_history_for_addon );
+				$this->update_list_of_installed_versions($activation_history_for_addon);
 				break;
 			case EE_System::req_type_upgrade:
-				do_action( "AHEE__{$classname}__detect_activations_or_upgrades__upgrade" );
-				do_action( 'AHEE__EE_Addon__detect_activations_or_upgrades__upgrade', $this );
+				do_action("AHEE__{$classname}__detect_activations_or_upgrades__upgrade");
+				do_action('AHEE__EE_Addon__detect_activations_or_upgrades__upgrade', $this);
 				$this->upgrade();
-				$this->update_list_of_installed_versions($activation_history_for_addon );
+				$this->update_list_of_installed_versions($activation_history_for_addon);
 				break;
 			case EE_System::req_type_downgrade:
-				do_action( "AHEE__{$classname}__detect_activations_or_upgrades__downgrade" );
-				do_action( 'AHEE__EE_Addon__detect_activations_or_upgrades__downgrade', $this );
+				do_action("AHEE__{$classname}__detect_activations_or_upgrades__downgrade");
+				do_action('AHEE__EE_Addon__detect_activations_or_upgrades__downgrade', $this);
 				$this->downgrade();
-				$this->update_list_of_installed_versions($activation_history_for_addon );
+				$this->update_list_of_installed_versions($activation_history_for_addon);
 				break;
 			case EE_System::req_type_normal:
 			default:
@@ -534,7 +534,7 @@ 
 				break;
 		}
 
-		do_action( "AHEE__{$classname}__detect_if_activation_or_upgrade__complete" );
+		do_action("AHEE__{$classname}__detect_if_activation_or_upgrade__complete");
 	}
 
 	/**
@@ -543,17 +543,17 @@ 
 	 * @param string $current_version_to_add
 	 * @return boolean success
 	 */
-	public function update_list_of_installed_versions($version_history = NULL,$current_version_to_add = NULL) {
-		if( ! $version_history ) {
+	public function update_list_of_installed_versions($version_history = NULL, $current_version_to_add = NULL) {
+		if ( ! $version_history) {
 			$version_history = $this->get_activation_history();
 		}
-		if( $current_version_to_add === NULL){
+		if ($current_version_to_add === NULL) {
 			$current_version_to_add = $this->version();
 		}
-		$version_history[ $current_version_to_add ][] = date( 'Y-m-d H:i:s',time() );
+		$version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time());
 		// resave
 //		echo "updating list of installed versions:".$this->get_activation_history_option_name();d($version_history);
-		return update_option( $this->get_activation_history_option_name(), $version_history );
+		return update_option($this->get_activation_history_option_name(), $version_history);
 	}
 
 	/**
@@ -561,8 +561,8 @@ 
 	 * of this addon
 	 * @return string
 	 */
-	public function get_activation_history_option_name(){
-		return self::ee_addon_version_history_option_prefix . $this->name();
+	public function get_activation_history_option_name() {
+		return self::ee_addon_version_history_option_prefix.$this->name();
 	}
 
 
@@ -571,7 +571,7 @@ 
 	 * Gets the wp option which stores the activation history for this addon
 	 * @return array
 	 */
-	public function get_activation_history(){
+	public function get_activation_history() {
 		return get_option($this->get_activation_history_option_name(), NULL);
 	}
 
@@ -580,8 +580,8 @@ 
 	/**
 	 * @param string $config_section
 	 */
-	public function set_config_section( $config_section = '' ) {
-		$this->_config_section = ! empty( $config_section ) ? $config_section : 'addons';
+	public function set_config_section($config_section = '') {
+		$this->_config_section = ! empty($config_section) ? $config_section : 'addons';
 	}
 	/**
 	 *	filepath to the main file, which can be used for register_activation_hook, register_deactivation_hook, etc.
@@ -594,14 +594,14 @@ 
 	 * Sets the filepath to the main plugin file
 	 * @param string $filepath
 	 */
-	public function set_main_plugin_file( $filepath ) {
+	public function set_main_plugin_file($filepath) {
 		$this->_main_plugin_file = $filepath;
 	}
 	/**
 	 * gets the filepath to teh main file
 	 * @return string
 	 */
-	public function get_main_plugin_file(){
+	public function get_main_plugin_file() {
 		return $this->_main_plugin_file;
 	}
 
@@ -611,15 +611,15 @@ 
 	 * @return string
 	 */
 	public function get_main_plugin_file_basename() {
-		return plugin_basename( $this->get_main_plugin_file() );
+		return plugin_basename($this->get_main_plugin_file());
 	}
 
 	/**
 	 * Gets the folder name which contains the main plugin file
 	 * @return string
 	 */
-	public function get_main_plugin_file_dirname(){
-		return dirname( $this->get_main_plugin_file() );
+	public function get_main_plugin_file_dirname() {
+		return dirname($this->get_main_plugin_file());
 	}
 
 
@@ -628,11 +628,11 @@ 
      *
      * @return void
 	 */
-	public function admin_init(){
+	public function admin_init() {
 		// is admin and not in M-Mode ?
-		if ( is_admin() && ! EE_Maintenance_Mode::instance()->level() ) {
-			add_filter( 'plugin_action_links', array( $this, 'plugin_action_links' ), 10, 2 );
-			add_filter( 'after_plugin_row_' . $this->_plugin_basename, array( $this, 'after_plugin_row' ), 10, 3 );
+		if (is_admin() && ! EE_Maintenance_Mode::instance()->level()) {
+			add_filter('plugin_action_links', array($this, 'plugin_action_links'), 10, 2);
+			add_filter('after_plugin_row_'.$this->_plugin_basename, array($this, 'after_plugin_row'), 10, 3);
 		}
 	}
 
@@ -647,10 +647,10 @@ 
 	 * @param $file
 	 * @return array
 	 */
-	public function plugin_action_links( $links, $file ) {
-		if ( $file === $this->plugin_basename() && $this->plugin_action_slug() !== '' ) {
+	public function plugin_action_links($links, $file) {
+		if ($file === $this->plugin_basename() && $this->plugin_action_slug() !== '') {
 			// before other links
-			array_unshift( $links, '<a href="admin.php?page=' . $this->plugin_action_slug() . '">' . __( 'Settings' ) . '</a>' );
+			array_unshift($links, '<a href="admin.php?page='.$this->plugin_action_slug().'">'.__('Settings').'</a>');
 		}
 		return $links;
 	}
@@ -668,17 +668,17 @@ 
 	 * @param $status
 	 * @return void
 	 */
-	public function after_plugin_row( $plugin_file, $plugin_data, $status ) {
+	public function after_plugin_row($plugin_file, $plugin_data, $status) {
 
 		$after_plugin_row = '';
-		if ( $plugin_file === $this->plugin_basename() && $this->get_plugins_page_row() !== '' ) {
+		if ($plugin_file === $this->plugin_basename() && $this->get_plugins_page_row() !== '') {
 			$class = $status ? 'active' : 'inactive';
 			$plugins_page_row = $this->get_plugins_page_row();
-			$link_text = isset( $plugins_page_row[ 'link_text' ] ) ? $plugins_page_row[ 'link_text' ] : '';
-			$link_url = isset( $plugins_page_row[ 'link_url' ] ) ? $plugins_page_row[ 'link_url' ] : '';
-			$description = isset( $plugins_page_row[ 'description' ] ) ? $plugins_page_row[ 'description' ] : $plugins_page_row;
-			if ( ! empty( $link_text ) && ! empty( $link_url ) && ! empty( $description )) {
-				$after_plugin_row .= '<tr id="' . sanitize_title( $plugin_file ) . '-ee-addon" class="' . $class . '">';
+			$link_text = isset($plugins_page_row['link_text']) ? $plugins_page_row['link_text'] : '';
+			$link_url = isset($plugins_page_row['link_url']) ? $plugins_page_row['link_url'] : '';
+			$description = isset($plugins_page_row['description']) ? $plugins_page_row['description'] : $plugins_page_row;
+			if ( ! empty($link_text) && ! empty($link_url) && ! empty($description)) {
+				$after_plugin_row .= '<tr id="'.sanitize_title($plugin_file).'-ee-addon" class="'.$class.'">';
 				$after_plugin_row .= '<th class="check-column" scope="row"></th>';
 				$after_plugin_row .= '<td class="ee-addon-upsell-info-title-td plugin-title column-primary">';
 				$after_plugin_row .= '<style>
@@ -720,7 +720,7 @@ 
 </style>';
 				$after_plugin_row .= '
 <p class="ee-addon-upsell-info-dv">
-	<a class="ee-button" href="' . $link_url . '">' . $link_text . ' &nbsp;<span class="dashicons dashicons-arrow-right-alt2" style="margin:0;"></span></a>
+	<a class="ee-button" href="' . $link_url.'">'.$link_text.' &nbsp;<span class="dashicons dashicons-arrow-right-alt2" style="margin:0;"></span></a>
 </p>';
 				$after_plugin_row .= '</td>';
 				$after_plugin_row .= '<td class="ee-addon-upsell-info-desc-td column-description desc">';

Indentation +34 added lines, -34 removed lines

@@ -282,16 +282,16 @@ 
 
 
 
-    /**
-     * Takes care of double-checking that we're not in maintenance mode, and then
-     * initializing this addon's necessary initial data. This is called by default on new activations
-     * and reactivations
-     *
-     * @param boolean $verify_schema whether to verify the database's schema for this addon, or just its data.
-     *                               This is a resource-intensive job so we prefer to only do it when necessary
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Takes care of double-checking that we're not in maintenance mode, and then
+	 * initializing this addon's necessary initial data. This is called by default on new activations
+	 * and reactivations
+	 *
+	 * @param boolean $verify_schema whether to verify the database's schema for this addon, or just its data.
+	 *                               This is a resource-intensive job so we prefer to only do it when necessary
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function initialize_db_if_no_migrations_required( $verify_schema = true ) {
 		if( $verify_schema === '' ) {
 			//wp core bug imo: if no args are passed to `do_action('some_hook_name')` besides the hook's name
@@ -307,11 +307,11 @@ 
 			$this->initialize_default_data();
 			//@todo: this will probably need to be adjusted in 4.4 as the array changed formats I believe
 			EE_Data_Migration_Manager::instance()->update_current_database_state_to(
-			    array(
-			        'slug' => $this->name(),
-                    'version' => $this->version()
-                )
-            );
+				array(
+					'slug' => $this->name(),
+					'version' => $this->version()
+				)
+			);
 			/* make sure core's data is a-ok
 			 * (at the time of writing, we especially want to verify all the caps are present
 			 * because payment method type capabilities are added dynamically, and it's
@@ -355,11 +355,11 @@ 
 		}
 		//if not DMS was found that should be ok. This addon just doesn't require any database changes
 		EE_Data_Migration_Manager::instance()->update_current_database_state_to(
-		    array(
-		        'slug' => $this->name(),
-                'version' => $this->version()
-            )
-        );
+			array(
+				'slug' => $this->name(),
+				'version' => $this->version()
+			)
+		);
 	}
 
 
@@ -401,8 +401,8 @@ 
 		EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
 		//also it's possible there is new default data that needs to be added
 		add_action(
-		    'AHEE__EE_System__perform_activations_upgrades_and_migrations', array( $this, 'initialize_db_if_no_migrations_required' )
-        );
+			'AHEE__EE_System__perform_activations_upgrades_and_migrations', array( $this, 'initialize_db_if_no_migrations_required' )
+		);
 	}
 
 
@@ -624,9 +624,9 @@ 
 
 
 	/**
-     * sets hooks used in the admin
-     *
-     * @return void
+	 * sets hooks used in the admin
+	 *
+	 * @return void
 	 */
 	public function admin_init(){
 		// is admin and not in M-Mode ?
@@ -737,16 +737,16 @@ 
 
 
 
-    /**
-     * a safe space for addons to add additional logic like setting hooks
-     * that will run immediately after addon registration
-     * making this a great place for code that needs to be "omnipresent"
-     *
-     * @since 4.9.26
-     */
+	/**
+	 * a safe space for addons to add additional logic like setting hooks
+	 * that will run immediately after addon registration
+	 * making this a great place for code that needs to be "omnipresent"
+	 *
+	 * @since 4.9.26
+	 */
 	public function after_registration()
-    {
-        // cricket chirp... cricket chirp...
+	{
+		// cricket chirp... cricket chirp...
 	}
 
 

core/entities/models/JsonModelSchema.php

Doc Comments -2 removed lines

@@ -39,7 +39,6 @@ 
 
     /**
      * Return the schema for a given model from a given model.
-     * @param \EEM_Base $model
      * @return array
      */
     public function getModelSchema()
@@ -103,7 +102,6 @@ 
 
     /**
      * Outputs the schema header for a model.
-     * @param \EEM_Base $model
      * @return array
      */
     public function getInitialSchemaStructure()

Spacing +3 added lines, -3 removed lines

@@ -33,7 +33,7 @@ 
      *
      * @param \EEM_Base $model
      */
-    public function __construct(EEM_Base $model){
+    public function __construct(EEM_Base $model) {
         $this->model = $model;
     }
 
@@ -60,7 +60,7 @@ 
     public function getModelSchemaForFields(array $model_fields, array $schema)
     {
         foreach ($model_fields as $field => $model_field) {
-            if (! $model_field instanceof EE_Model_Field_Base) {
+            if ( ! $model_field instanceof EE_Model_Field_Base) {
                 continue;
             }
             $schema['properties'][$field] = $model_field->getSchema();
@@ -91,7 +91,7 @@ 
     public function getModelSchemaForRelations(array $relations_on_model, array $schema)
     {
         foreach ($relations_on_model as $model_name => $relation) {
-            if (! $relation instanceof EE_Model_Relation_Base) {
+            if ( ! $relation instanceof EE_Model_Relation_Base) {
                 continue;
             }
             $model_name_for_schema = EEH_Inflector::pluralize_and_lower($model_name);

Indentation +112 added lines, -112 removed lines

@@ -24,116 +24,116 @@
 class JsonModelSchema
 {
 
-    /**
-     * @var \EEM_Base
-     */
-    protected $model;
-
-    /**
-     * JsonModelSchema constructor.
-     *
-     * @param \EEM_Base $model
-     */
-    public function __construct(EEM_Base $model){
-        $this->model = $model;
-    }
-
-    /**
-     * Return the schema for a given model from a given model.
-     * @param \EEM_Base $model
-     * @return array
-     */
-    public function getModelSchema()
-    {
-        return $this->getModelSchemaForRelations(
-            $this->model->relation_settings(),
-            $this->getModelSchemaForFields(
-                $this->model->field_settings(),
-                $this->getInitialSchemaStructure()
-            )
-        );
-    }
-
-
-    /**
-     * Get the schema for a given set of model fields.
-     * @param \EE_Model_Field_Base[]     $model_fields
-     * @return array
-     */
-    public function getModelSchemaForFields(array $model_fields, array $schema)
-    {
-        foreach ($model_fields as $field => $model_field) {
-            if (! $model_field instanceof EE_Model_Field_Base) {
-                continue;
-            }
-            $schema['properties'][$field] = $model_field->getSchema();
-
-            //if this is a primary key field add the primary key item
-            if ($model_field instanceof EE_Primary_Key_Field_Base) {
-                $schema['properties'][$field]['primary_key'] = true;
-            }
-
-            //if this is a foreign key field add the foreign key item
-            if ($model_field instanceof EE_Foreign_Key_Field_Base) {
-                $schema['properties'][$field]['foreign_key'] = array(
-                    'description' => esc_html__('This is a foreign key the points to the given models.', 'event_espresso'),
-                    'type' => 'array',
-                    'enum' => $model_field->get_model_class_names_pointed_to()
-                );
-            }
-        }
-        return $schema;
-    }
-
-
-    /**
-     * Get the schema for a given set of model relations
-     * @param EE_Model_Relation_Base[] $relations_on_model
-     * @return array
-     */
-    public function getModelSchemaForRelations(array $relations_on_model, array $schema)
-    {
-        foreach ($relations_on_model as $model_name => $relation) {
-            if (! $relation instanceof EE_Model_Relation_Base) {
-                continue;
-            }
-            $model_name_for_schema = $relation instanceof EE_Belongs_To_Relation
-                ? strtolower($model_name)
-                : EEH_Inflector::pluralize_and_lower($model_name);
-            $schema['properties'][$model_name_for_schema] = $relation->getSchema();
-            $schema['properties'][$model_name_for_schema]['relation_model'] = $model_name;
-        }
-        return $schema;
-    }
-
-
-    /**
-     * Outputs the schema header for a model.
-     * @param \EEM_Base $model
-     * @return array
-     */
-    public function getInitialSchemaStructure()
-    {
-        return array(
-            '$schema' => 'http://json-schema.org/draft-04/schema#',
-            'title' => $this->model->get_this_model_name(),
-            'type' => 'object',
-            'properties' => array()
-        );
-    }
-
-
-    /**
-     * Allows one to just use the object as a string to get the json.
-     * eg.
-     *
-     * $json_schema = new JsonModelSchema(EEM_Event::instance());
-     * echo $json_schema; //outputs the schema as a json formatted string.
-     *
-     * @return bool|false|mixed|string
-     */
-    public function __toString()
-    {
-        return wp_json_encode($this->getModelSchema());
-    }
+	/**
+	 * @var \EEM_Base
+	 */
+	protected $model;
+
+	/**
+	 * JsonModelSchema constructor.
+	 *
+	 * @param \EEM_Base $model
+	 */
+	public function __construct(EEM_Base $model){
+		$this->model = $model;
+	}
+
+	/**
+	 * Return the schema for a given model from a given model.
+	 * @param \EEM_Base $model
+	 * @return array
+	 */
+	public function getModelSchema()
+	{
+		return $this->getModelSchemaForRelations(
+			$this->model->relation_settings(),
+			$this->getModelSchemaForFields(
+				$this->model->field_settings(),
+				$this->getInitialSchemaStructure()
+			)
+		);
+	}
+
+
+	/**
+	 * Get the schema for a given set of model fields.
+	 * @param \EE_Model_Field_Base[]     $model_fields
+	 * @return array
+	 */
+	public function getModelSchemaForFields(array $model_fields, array $schema)
+	{
+		foreach ($model_fields as $field => $model_field) {
+			if (! $model_field instanceof EE_Model_Field_Base) {
+				continue;
+			}
+			$schema['properties'][$field] = $model_field->getSchema();
+
+			//if this is a primary key field add the primary key item
+			if ($model_field instanceof EE_Primary_Key_Field_Base) {
+				$schema['properties'][$field]['primary_key'] = true;
+			}
+
+			//if this is a foreign key field add the foreign key item
+			if ($model_field instanceof EE_Foreign_Key_Field_Base) {
+				$schema['properties'][$field]['foreign_key'] = array(
+					'description' => esc_html__('This is a foreign key the points to the given models.', 'event_espresso'),
+					'type' => 'array',
+					'enum' => $model_field->get_model_class_names_pointed_to()
+				);
+			}
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * Get the schema for a given set of model relations
+	 * @param EE_Model_Relation_Base[] $relations_on_model
+	 * @return array
+	 */
+	public function getModelSchemaForRelations(array $relations_on_model, array $schema)
+	{
+		foreach ($relations_on_model as $model_name => $relation) {
+			if (! $relation instanceof EE_Model_Relation_Base) {
+				continue;
+			}
+			$model_name_for_schema = $relation instanceof EE_Belongs_To_Relation
+				? strtolower($model_name)
+				: EEH_Inflector::pluralize_and_lower($model_name);
+			$schema['properties'][$model_name_for_schema] = $relation->getSchema();
+			$schema['properties'][$model_name_for_schema]['relation_model'] = $model_name;
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * Outputs the schema header for a model.
+	 * @param \EEM_Base $model
+	 * @return array
+	 */
+	public function getInitialSchemaStructure()
+	{
+		return array(
+			'$schema' => 'http://json-schema.org/draft-04/schema#',
+			'title' => $this->model->get_this_model_name(),
+			'type' => 'object',
+			'properties' => array()
+		);
+	}
+
+
+	/**
+	 * Allows one to just use the object as a string to get the json.
+	 * eg.
+	 *
+	 * $json_schema = new JsonModelSchema(EEM_Event::instance());
+	 * echo $json_schema; //outputs the schema as a json formatted string.
+	 *
+	 * @return bool|false|mixed|string
+	 */
+	public function __toString()
+	{
+		return wp_json_encode($this->getModelSchema());
+	}
 }

modules/core_rest_api/EED_Core_Rest_Api.module.php

Spacing +17 added lines, -17 removed lines

@@ -157,13 +157,13 @@ 
      */
     protected static function _set_hooks_for_changes()
     {
-        $folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES . 'rest_api' . DS . 'changes'), false);
+        $folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES.'rest_api'.DS.'changes'), false);
         foreach ($folder_contents as $classname_in_namespace => $filepath) {
             //ignore the base parent class
             if ($classname_in_namespace === 'Changes_In_Base') {
                 continue;
             }
-            $full_classname = 'EventEspresso\core\libraries\rest_api\changes\\' . $classname_in_namespace;
+            $full_classname = 'EventEspresso\core\libraries\rest_api\changes\\'.$classname_in_namespace;
             if (class_exists($full_classname)) {
                 $instance_of_class = new $full_classname;
                 if ($instance_of_class instanceof EventEspresso\core\libraries\rest_api\changes\Changes_In_Base) {
@@ -195,11 +195,11 @@ 
                         $model_name = isset($route['schema_callback'][0])
                             ? $route['schema_callback'][0]
                             : '';
-                        $version = isset( $route['schema_callback'][1])
+                        $version = isset($route['schema_callback'][1])
                             ? $route['schema_callback'][1]
                             : '';
-                        if (! empty($model_name) && ! empty($version)) {
-                            $route_args['schema'] = function () use ($model_name, $version) {
+                        if ( ! empty($model_name) && ! empty($version)) {
+                            $route_args['schema'] = function() use ($model_name, $version) {
                                 return EventEspresso\core\libraries\rest_api\controllers\model\Read::handle_schema_request(
                                     $model_name,
                                     $version
@@ -245,7 +245,7 @@ 
     {
         //delete the saved EE REST API routes
         foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden) {
-            delete_option(EED_Core_Rest_Api::saved_routes_option_names . $version);
+            delete_option(EED_Core_Rest_Api::saved_routes_option_names.$version);
         }
     }
 
@@ -264,7 +264,7 @@ 
     {
         $ee_routes = array();
         foreach (self::versions_served() as $version => $hidden_endpoints) {
-            $ee_routes[self::ee_api_namespace . $version] = self::_get_ee_route_data_for_version($version,
+            $ee_routes[self::ee_api_namespace.$version] = self::_get_ee_route_data_for_version($version,
                 $hidden_endpoints);
         }
         return $ee_routes;
@@ -282,7 +282,7 @@ 
      */
     protected static function _get_ee_route_data_for_version($version, $hidden_endpoints = false)
     {
-        $ee_routes = get_option(self::saved_routes_option_names . $version, null);
+        $ee_routes = get_option(self::saved_routes_option_names.$version, null);
         if ( ! $ee_routes || (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE)) {
             $ee_routes = self::_save_ee_route_data_for_version($version, $hidden_endpoints);
         }
@@ -310,7 +310,7 @@ 
                 $instance->_get_rpc_route_data_for_version($version, $hidden_endpoints)
             )
         );
-        $option_name = self::saved_routes_option_names . $version;
+        $option_name = self::saved_routes_option_names.$version;
         if (get_option($option_name)) {
             update_option($option_name, $routes, true);
         } else {
@@ -387,13 +387,13 @@ 
             $model = \EE_Registry::instance()->load_model($model_name);
 
             //if this isn't a valid model then let's skip iterate to the next item in the loop.
-            if (! $model instanceof EEM_Base) {
+            if ( ! $model instanceof EEM_Base) {
                 continue;
             }
 
             //yes we could just register one route for ALL models, but then they wouldn't show up in the index
             $plural_model_route = EEH_Inflector::pluralize_and_lower($model_name);
-            $singular_model_route = $plural_model_route . '/(?P<id>\d+)';
+            $singular_model_route = $plural_model_route.'/(?P<id>\d+)';
             $model_routes[$plural_model_route] = array(
                 array(
                     'callback'        => array(
@@ -404,7 +404,7 @@ 
                     'hidden_endpoint' => $hidden_endpoint,
                     'args'            => $this->_get_read_query_params($model, $version),
                     '_links'          => array(
-                        'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace . $version . $singular_model_route),
+                        'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace.$version.$singular_model_route),
                     ),
                     'schema_callback' => array($model_name, $version)
                 ),
@@ -440,7 +440,7 @@ 
                     $relation_name,
                     $relation_obj
                 );
-                $model_routes[$singular_model_route . '/' . $related_model_name_endpoint_part] = array(
+                $model_routes[$singular_model_route.'/'.$related_model_name_endpoint_part] = array(
                     array(
                         'callback'        => array(
                             'EventEspresso\core\libraries\rest_api\controllers\model\Read',
@@ -476,7 +476,7 @@ 
     {
         $routes = array();
         foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $routes[self::ee_api_namespace . $version] = $this->_get_rpc_route_data_for_version($version,
+            $routes[self::ee_api_namespace.$version] = $this->_get_rpc_route_data_for_version($version,
                 $hidden_endpoint);
         }
         return $routes;
@@ -607,7 +607,7 @@ 
     {
         $config_routes = array();
         foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $config_routes[self::ee_api_namespace . $version] = $this->_get_config_route_data_for_version($version,
+            $config_routes[self::ee_api_namespace.$version] = $this->_get_config_route_data_for_version($version,
                 $hidden_endpoint);
         }
         return $config_routes;
@@ -660,7 +660,7 @@ 
     {
         $meta_routes = array();
         foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $meta_routes[self::ee_api_namespace . $version] = $this->_get_meta_route_data_for_version($version,
+            $meta_routes[self::ee_api_namespace.$version] = $this->_get_meta_route_data_for_version($version,
                 $hidden_endpoint);
         }
         return $meta_routes;
@@ -715,7 +715,7 @@ 
                     if (($route['hidden_endpoint'] && $force_show_ee_namespace === '')
                         || ($force_show_ee_namespace !== '' && $force_show_ee_namespace !== $namespace)
                     ) {
-                        $full_route = '/' . ltrim($namespace, '/') . '/' . ltrim($endpoint, '/');
+                        $full_route = '/'.ltrim($namespace, '/').'/'.ltrim($endpoint, '/');
                         unset($route_data[$full_route]);
                     }
                 }

Indentation +837 added lines, -837 removed lines

@@ -18,844 +18,844 @@
 class EED_Core_Rest_Api extends \EED_Module
 {
 
-    const ee_api_namespace           = 'ee/v';
+	const ee_api_namespace           = 'ee/v';
 
-    const ee_api_namespace_for_regex = 'ee\/v([^/]*)\/';
-
-    const saved_routes_option_names  = 'ee_core_routes';
-
-    /**
-     * string used in _links response bodies to make them globally unique.
-     *
-     * @see http://v2.wp-api.org/extending/linking/
-     */
-    const ee_api_link_namespace = 'https://api.eventespresso.com/';
-
-    /**
-     * @var Calculated_Model_Fields
-     */
-    protected static $_field_calculator = null;
-
-
-
-    /**
-     * @return EED_Core_Rest_Api
-     */
-    public static function instance()
-    {
-        self::$_field_calculator = new Calculated_Model_Fields();
-        return parent::get_instance(__CLASS__);
-    }
-
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-        self::set_hooks_both();
-    }
-
-
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-        self::set_hooks_both();
-    }
-
-
-
-    public static function set_hooks_both()
-    {
-        add_action('rest_api_init', array('EED_Core_Rest_Api', 'register_routes'), 10);
-        add_action('rest_api_init', array('EED_Core_Rest_Api', 'set_hooks_rest_api'), 5);
-        add_filter('rest_route_data', array('EED_Core_Rest_Api', 'hide_old_endpoints'), 10, 2);
-        add_filter('rest_index',
-            array('EventEspresso\core\libraries\rest_api\controllers\model\Meta', 'filter_ee_metadata_into_index'));
-        EED_Core_Rest_Api::invalidate_cached_route_data_on_version_change();
-    }
-
-
-
-    /**
-     * sets up hooks which only need to be included as part of REST API requests;
-     * other requests like to the frontend or admin etc don't need them
-     */
-    public static function set_hooks_rest_api()
-    {
-        //set hooks which account for changes made to the API
-        EED_Core_Rest_Api::_set_hooks_for_changes();
-        EED_Core_Rest_Api::maybe_notify_of_basic_auth_removal();
-    }
-
-
-
-    /**
-     * public wrapper of _set_hooks_for_changes.
-     * Loads all the hooks which make requests to old versions of the API
-     * appear the same as they always did
-     */
-    public static function set_hooks_for_changes()
-    {
-        self::_set_hooks_for_changes();
-    }
-
-
-
-    /**
-     * If the user appears to be using WP API basic auth, tell them (via a persistent
-     * admin notice and an email) that we're going to remove it soon, so they should
-     * replace it with application passwords.
-     */
-    public static function maybe_notify_of_basic_auth_removal()
-    {
-        if (
-        apply_filters(
-            'FHEE__EED_Core_Rest_Api__maybe_notify_of_basic_auth_removal__override',
-            ! isset($_SERVER['PHP_AUTH_USER'])
-            && ! isset($_SERVER['HTTP_AUTHORIZATION'])
-        )
-        ) {
-            //sure it's a WP API request, but they aren't using basic auth, so don't bother them
-            return;
-        }
-        //ok they're using the WP API with Basic Auth
-        $message = sprintf(
-            __('We noticed you\'re using the WP API, which is used by the Event Espresso 4 mobile apps. Because of security and compatibility concerns, we will soon be removing our default authentication mechanism, WP API Basic Auth, from Event Espresso. It is recommended you instead install the %1$sWP Application Passwords plugin%2$s and use it with the EE4 Mobile apps. See %3$sour mobile app documentation%2$s for more information. %4$sIf you have installed the WP API Basic Auth plugin separately, or are not using the Event Espresso 4 mobile apps, you can disregard this message.%4$sThe Event Espresso Team',
-                'event_espresso'),
-            '<a href="https://wordpress.org/plugins/application-passwords/">',
-            '</a>',
-            '<a href="https://eventespresso.com/wiki/ee4-event-apps/#authentication">',
-            '<br/>'
-        );
-        EE_Error::add_persistent_admin_notice('using_basic_auth', $message);
-        if ( ! get_option('ee_notified_admin_on_basic_auth_removal', false)) {
-            add_option('ee_notified_admin_on_basic_auth_removal', true);
-            //piggy back off EE_Error::set_content_type, which sets the content type to HTML
-            add_filter('wp_mail_content_type', array('EE_Error', 'set_content_type'));
-            //and send the message to the site admin too
-            wp_mail(get_option('admin_email'),
-                __('Notice of Removal of WP API Basic Auth From Event Espresso 4', 'event_espresso'), $message);
-            remove_filter('wp_mail_content_type', array('EE_Error', 'set_content_type'));
-        }
-    }
-
-
-
-    /**
-     * Loads all the hooks which make requests to old versions of the API
-     * appear the same as they always did
-     */
-    protected static function _set_hooks_for_changes()
-    {
-        $folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES . 'rest_api' . DS . 'changes'), false);
-        foreach ($folder_contents as $classname_in_namespace => $filepath) {
-            //ignore the base parent class
-            if ($classname_in_namespace === 'Changes_In_Base') {
-                continue;
-            }
-            $full_classname = 'EventEspresso\core\libraries\rest_api\changes\\' . $classname_in_namespace;
-            if (class_exists($full_classname)) {
-                $instance_of_class = new $full_classname;
-                if ($instance_of_class instanceof Changes_In_Base) {
-                    $instance_of_class->set_hooks();
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * Filters the WP routes to add our EE-related ones. This takes a bit of time
-     * so we actually prefer to only do it when an EE plugin is activated or upgraded
-     */
-    public static function register_routes()
-    {
-        foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls) {
-            foreach ($relative_urls as $endpoint => $routes) {
-                foreach ($routes as $route) {
-                    $route_args = array(
-                        array(
-                            'callback' => $route['callback'],
-                            'methods'  => $route['methods'],
-                            'args'     => isset($route['args']) ? $route['args'] : array(),
-                        )
-                    );
-                    if (isset($route['schema_callback'])) {
-                        $model_name = isset($route['schema_callback'][0])
-                            ? $route['schema_callback'][0]
-                            : '';
-                        $version = isset( $route['schema_callback'][1])
-                            ? $route['schema_callback'][1]
-                            : '';
-                        if (! empty($model_name) && ! empty($version)) {
-                            $route_args['schema'] = function () use ($model_name, $version) {
-                                return ModelRead::handle_schema_request(
-                                    $model_name,
-                                    $version
-                                );
-                            };
-                        }
-                    }
-                    register_rest_route(
-                        $namespace,
-                        $endpoint,
-                        $route_args
-                    );
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * Checks if there was a version change or something that merits invalidating the cached
-     * route data. If so, invalidates the cached route data so that it gets refreshed
-     * next time the WP API is used
-     */
-    public static function invalidate_cached_route_data_on_version_change()
-    {
-        if (EE_System::instance()->detect_req_type() != EE_System::req_type_normal) {
-            EED_Core_Rest_Api::invalidate_cached_route_data();
-        }
-        foreach (EE_Registry::instance()->addons as $addon) {
-            if ($addon instanceof EE_Addon && $addon->detect_req_type() != EE_System::req_type_normal) {
-                EED_Core_Rest_Api::invalidate_cached_route_data();
-            }
-        }
-    }
-
-
-
-    /**
-     * Removes the cached route data so it will get refreshed next time the WP API is used
-     */
-    public static function invalidate_cached_route_data()
-    {
-        //delete the saved EE REST API routes
-        foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden) {
-            delete_option(EED_Core_Rest_Api::saved_routes_option_names . $version);
-        }
-    }
-
-
-
-    /**
-     * Gets the EE route data
-     *
-     * @return array top-level key is the namespace, next-level key is the route and its value is array{
-     * @type string|array $callback
-     * @type string       $methods
-     * @type boolean      $hidden_endpoint
-     * }
-     */
-    public static function get_ee_route_data()
-    {
-        $ee_routes = array();
-        foreach (self::versions_served() as $version => $hidden_endpoints) {
-            $ee_routes[self::ee_api_namespace . $version] = self::_get_ee_route_data_for_version($version,
-                $hidden_endpoints);
-        }
-        return $ee_routes;
-    }
-
-
-
-    /**
-     * Gets the EE route data from the wp options if it exists already,
-     * otherwise re-generates it and saves it to the option
-     *
-     * @param string  $version
-     * @param boolean $hidden_endpoints
-     * @return array
-     */
-    protected static function _get_ee_route_data_for_version($version, $hidden_endpoints = false)
-    {
-        $ee_routes = get_option(self::saved_routes_option_names . $version, null);
-        if ( ! $ee_routes || (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE)) {
-            $ee_routes = self::_save_ee_route_data_for_version($version, $hidden_endpoints);
-        }
-        return $ee_routes;
-    }
-
-
-
-    /**
-     * Saves the EE REST API route data to a wp option and returns it
-     *
-     * @param string  $version
-     * @param boolean $hidden_endpoints
-     * @return mixed|null|void
-     */
-    protected static function _save_ee_route_data_for_version($version, $hidden_endpoints = false)
-    {
-        $instance = self::instance();
-        $routes = apply_filters(
-            'EED_Core_Rest_Api__save_ee_route_data_for_version__routes',
-            array_replace_recursive(
-                $instance->_get_config_route_data_for_version($version, $hidden_endpoints),
-                $instance->_get_meta_route_data_for_version($version, $hidden_endpoints),
-                $instance->_get_model_route_data_for_version($version, $hidden_endpoints),
-                $instance->_get_rpc_route_data_for_version($version, $hidden_endpoints)
-            )
-        );
-        $option_name = self::saved_routes_option_names . $version;
-        if (get_option($option_name)) {
-            update_option($option_name, $routes, true);
-        } else {
-            add_option($option_name, $routes, null, 'no');
-        }
-        return $routes;
-    }
-
-
-
-    /**
-     * Calculates all the EE routes and saves it to a wordpress option so we don't
-     * need to calculate it on every request
-     *
-     * @deprecated since version 4.9.1
-     * @return void
-     */
-    public static function save_ee_routes()
-    {
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
-            $instance = self::instance();
-            $routes = apply_filters(
-                'EED_Core_Rest_Api__save_ee_routes__routes',
-                array_replace_recursive(
-                    $instance->_register_config_routes(),
-                    $instance->_register_meta_routes(),
-                    $instance->_register_model_routes(),
-                    $instance->_register_rpc_routes()
-                )
-            );
-            update_option(self::saved_routes_option_names, $routes, true);
-        }
-    }
-
-
-
-    /**
-     * Gets all the route information relating to EE models
-     *
-     * @return array @see get_ee_route_data
-     * @deprecated since version 4.9.1
-     */
-    protected function _register_model_routes()
-    {
-        $model_routes = array();
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $model_routes[EED_Core_Rest_Api::ee_api_namespace
-                          . $version] = $this->_get_config_route_data_for_version($version, $hidden_endpoint);
-        }
-        return $model_routes;
-    }
-
-
-
-    /**
-     * Gets the route data for EE models in the specified version
-     *
-     * @param string  $version
-     * @param boolean $hidden_endpoint
-     * @return array
-     */
-    protected function _get_model_route_data_for_version($version, $hidden_endpoint = false)
-    {
-        $model_version_info = new Model_Version_Info($version);
-        $models_to_register = apply_filters(
-            'FHEE__EED_Core_REST_API___register_model_routes',
-            $model_version_info->models_for_requested_version()
-        );
-        //let's not bother having endpoints for extra metas
-        unset($models_to_register['Extra_Meta']);
-        unset($models_to_register['Extra_Join']);
-        $model_routes = array();
-        foreach ($models_to_register as $model_name => $model_classname) {
-            $model = \EE_Registry::instance()->load_model($model_name);
-
-            //if this isn't a valid model then let's skip iterate to the next item in the loop.
-            if (! $model instanceof EEM_Base) {
-                continue;
-            }
-
-            //yes we could just register one route for ALL models, but then they wouldn't show up in the index
-            $plural_model_route = EEH_Inflector::pluralize_and_lower($model_name);
-            $singular_model_route = $plural_model_route . '/(?P<id>\d+)';
-            $model_routes[$plural_model_route] = array(
-                array(
-                    'callback'        => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Read',
-                        'handle_request_get_all',
-                    ),
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                    'args'            => $this->_get_read_query_params($model, $version),
-                    '_links'          => array(
-                        'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace . $version . $singular_model_route),
-                    ),
-                    'schema_callback' => array($model_name, $version)
-                ),
-                //						array(
-                //							'callback' => array(
-                //								'EventEspresso\core\libraries\rest_api\controllers\model\Write',
-                //								'handle_request_create_one' ),
-                //							'methods' => WP_REST_Server::CREATABLE,
-                //							'hidden_endpoint' => $hidden_endpoint
-                //						)
-            );
-            $model_routes[$singular_model_route] = array(
-                array(
-                    'callback'        => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Read',
-                        'handle_request_get_one',
-                    ),
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                    'args'            => $this->_get_response_selection_query_params($model, $version),
-                ),
-                //						array(
-                //							'callback' => array(
-                //								'EventEspresso\core\libraries\rest_api\controllers\model\Write',
-                //								'handle_request_edit_one' ),
-                //							'methods' => WP_REST_Server::EDITABLE,
-                //							'hidden_endpoint' => $hidden_endpoint
-                //							),
-            );
-            //@todo: also handle  DELETE for a single item
-            foreach ($model_version_info->relation_settings($model) as $relation_name => $relation_obj) {
-                $related_model_name_endpoint_part = ModelRead::get_related_entity_name(
-                    $relation_name,
-                    $relation_obj
-                );
-                $model_routes[$singular_model_route . '/' . $related_model_name_endpoint_part] = array(
-                    array(
-                        'callback'        => array(
-                            'EventEspresso\core\libraries\rest_api\controllers\model\Read',
-                            'handle_request_get_related',
-                        ),
-                        'methods'         => WP_REST_Server::READABLE,
-                        'hidden_endpoint' => $hidden_endpoint,
-                        'args'            => $this->_get_read_query_params($relation_obj->get_other_model(), $version),
-                    ),
-                    //							array(
-                    //								'callback' => array(
-                    //									'EventEspresso\core\libraries\rest_api\controllers\model\Write',
-                    //									'handle_request_create_or_update_related' ),
-                    //								'methods' => WP_REST_Server::EDITABLE,
-                    //								'hidden_endpoint' => $hidden_endpoint
-                    //							)
-                );
-                //@todo: handle delete related and possibly remove relation (not sure hwo to distinguish)
-            }
-        }
-        return $model_routes;
-    }
-
-
-
-    /**
-     * Adds all the RPC-style routes (remote procedure call-like routes, ie
-     * routes that don't conform to the traditional REST CRUD-style).
-     *
-     * @deprecated since 4.9.1
-     */
-    protected function _register_rpc_routes()
-    {
-        $routes = array();
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $routes[self::ee_api_namespace . $version] = $this->_get_rpc_route_data_for_version($version,
-                $hidden_endpoint);
-        }
-        return $routes;
-    }
-
-
-
-    /**
-     * @param string  $version
-     * @param boolean $hidden_endpoint
-     * @return array
-     */
-    protected function _get_rpc_route_data_for_version($version, $hidden_endpoint = false)
-    {
-        $this_versions_routes = array();
-        //checkin endpoint
-        $this_versions_routes['registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)'] = array(
-            array(
-                'callback'        => array(
-                    'EventEspresso\core\libraries\rest_api\controllers\rpc\Checkin',
-                    'handle_request_toggle_checkin',
-                ),
-                'methods'         => WP_REST_Server::CREATABLE,
-                'hidden_endpoint' => $hidden_endpoint,
-                'args'            => array(
-                    'force' => array(
-                        'required'    => false,
-                        'default'     => false,
-                        'description' => __('Whether to force toggle checkin, or to verify the registration status and allowed ticket uses',
-                            'event_espresso'),
-                    ),
-                ),
-            ),
-        );
-        return apply_filters(
-            'FHEE__EED_Core_Rest_Api___register_rpc_routes__this_versions_routes',
-            $this_versions_routes,
-            $version,
-            $hidden_endpoint
-        );
-    }
-
-
-
-    /**
-     * Gets the query params that can be used when request one or many
-     *
-     * @param EEM_Base $model
-     * @param string   $version
-     * @return array
-     */
-    protected function _get_response_selection_query_params(\EEM_Base $model, $version)
-    {
-        return apply_filters(
-            'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
-            array(
-                'include'   => array(
-                    'required' => false,
-                    'default'  => '*',
-                ),
-                'calculate' => array(
-                    'required' => false,
-                    'default'  => '',
-                    'enum'     => self::$_field_calculator->retrieve_calculated_fields_for_model($model),
-                ),
-            ),
-            $model,
-            $version
-        );
-    }
-
-
-
-    /**
-     * Gets info about reading query params that are acceptable
-     *
-     * @param \EEM_Base $model eg 'Event' or 'Venue'
-     * @param  string   $version
-     * @return array    describing the args acceptable when querying this model
-     * @throws \EE_Error
-     */
-    protected function _get_read_query_params(\EEM_Base $model, $version)
-    {
-        $default_orderby = array();
-        foreach ($model->get_combined_primary_key_fields() as $key_field) {
-            $default_orderby[$key_field->get_name()] = 'ASC';
-        }
-        return array_merge(
-            $this->_get_response_selection_query_params($model, $version),
-            array(
-                'where'    => array(
-                    'required' => false,
-                    'default'  => array(),
-                ),
-                'limit'    => array(
-                    'required' => false,
-                    'default'  => EED_Core_Rest_Api::get_default_query_limit(),
-                ),
-                'order_by' => array(
-                    'required' => false,
-                    'default'  => $default_orderby,
-                ),
-                'group_by' => array(
-                    'required' => false,
-                    'default'  => null,
-                ),
-                'having'   => array(
-                    'required' => false,
-                    'default'  => null,
-                ),
-                'caps'     => array(
-                    'required' => false,
-                    'default'  => EEM_Base::caps_read,
-                ),
-            )
-        );
-    }
-
-
-
-    /**
-     * Gets routes for the config
-     *
-     * @return array @see _register_model_routes
-     * @deprecated since version 4.9.1
-     */
-    protected function _register_config_routes()
-    {
-        $config_routes = array();
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $config_routes[self::ee_api_namespace . $version] = $this->_get_config_route_data_for_version($version,
-                $hidden_endpoint);
-        }
-        return $config_routes;
-    }
-
-
-
-    /**
-     * Gets routes for the config for the specified version
-     *
-     * @param string  $version
-     * @param boolean $hidden_endpoint
-     * @return array
-     */
-    protected function _get_config_route_data_for_version($version, $hidden_endpoint)
-    {
-        return array(
-            'config'    => array(
-                array(
-                    'callback'        => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\config\Read',
-                        'handle_request',
-                    ),
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                ),
-            ),
-            'site_info' => array(
-                array(
-                    'callback'        => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\config\Read',
-                        'handle_request_site_info',
-                    ),
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                ),
-            ),
-        );
-    }
-
-
-
-    /**
-     * Gets the meta info routes
-     *
-     * @return array @see _register_model_routes
-     * @deprecated since version 4.9.1
-     */
-    protected function _register_meta_routes()
-    {
-        $meta_routes = array();
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $meta_routes[self::ee_api_namespace . $version] = $this->_get_meta_route_data_for_version($version,
-                $hidden_endpoint);
-        }
-        return $meta_routes;
-    }
-
-
-
-    /**
-     * @param string  $version
-     * @param boolean $hidden_endpoint
-     * @return array
-     */
-    protected function _get_meta_route_data_for_version($version, $hidden_endpoint = false)
-    {
-        return array(
-            'resources' => array(
-                array(
-                    'callback'        => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Meta',
-                        'handle_request_models_meta',
-                    ),
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                ),
-            ),
-        );
-    }
-
-
-
-    /**
-     * Tries to hide old 4.6 endpoints from the
-     *
-     * @param array $route_data
-     * @return array
-     */
-    public static function hide_old_endpoints($route_data)
-    {
-        //allow API clients to override which endpoints get hidden, in case
-        //they want to discover particular endpoints
-        //also, we don't have access to the request so we have to just grab it from the superglobal
-        $force_show_ee_namespace = ltrim(
-            EEH_Array::is_set($_REQUEST, 'force_show_ee_namespace', ''),
-            '/'
-        );
-        foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls) {
-            foreach ($relative_urls as $endpoint => $routes) {
-                foreach ($routes as $route) {
-                    //by default, hide "hidden_endpoint"s, unless the request indicates
-                    //to $force_show_ee_namespace, in which case only show that one
-                    //namespace's endpoints (and hide all others)
-                    if (($route['hidden_endpoint'] && $force_show_ee_namespace === '')
-                        || ($force_show_ee_namespace !== '' && $force_show_ee_namespace !== $namespace)
-                    ) {
-                        $full_route = '/' . ltrim($namespace, '/') . '/' . ltrim($endpoint, '/');
-                        unset($route_data[$full_route]);
-                    }
-                }
-            }
-        }
-        return $route_data;
-    }
-
-
-
-    /**
-     * Returns an array describing which versions of core support serving requests for.
-     * Keys are core versions' major and minor version, and values are the
-     * LOWEST requested version they can serve. Eg, 4.7 can serve requests for 4.6-like
-     * data by just removing a few models and fields from the responses. However, 4.15 might remove
-     * the answers table entirely, in which case it would be very difficult for
-     * it to serve 4.6-style responses.
-     * Versions of core that are missing from this array are unknowns.
-     * previous ver
-     *
-     * @return array
-     */
-    public static function version_compatibilities()
-    {
-        return apply_filters(
-            'FHEE__EED_Core_REST_API__version_compatibilities',
-            array(
-                '4.8.29' => '4.8.29',
-                '4.8.33' => '4.8.29',
-                '4.8.34' => '4.8.29',
-                '4.8.36' => '4.8.29',
-            )
-        );
-    }
-
-
-
-    /**
-     * Gets the latest API version served. Eg if there
-     * are two versions served of the API, 4.8.29 and 4.8.32, and
-     * we are on core version 4.8.34, it will return the string "4.8.32"
-     *
-     * @return string
-     */
-    public static function latest_rest_api_version()
-    {
-        $versions_served = \EED_Core_Rest_Api::versions_served();
-        $versions_served_keys = array_keys($versions_served);
-        return end($versions_served_keys);
-    }
-
-
-
-    /**
-     * Using EED_Core_Rest_Api::version_compatibilities(), determines what version of
-     * EE the API can serve requests for. Eg, if we are on 4.15 of core, and
-     * we can serve requests from 4.12 or later, this will return array( '4.12', '4.13', '4.14', '4.15' ).
-     * We also indicate whether or not this version should be put in the index or not
-     *
-     * @return array keys are API version numbers (just major and minor numbers), and values
-     * are whether or not they should be hidden
-     */
-    public static function versions_served()
-    {
-        $versions_served = array();
-        $possibly_served_versions = EED_Core_Rest_Api::version_compatibilities();
-        $lowest_compatible_version = end($possibly_served_versions);
-        reset($possibly_served_versions);
-        $versions_served_historically = array_keys($possibly_served_versions);
-        $latest_version = end($versions_served_historically);
-        reset($versions_served_historically);
-        //for each version of core we have ever served:
-        foreach ($versions_served_historically as $key_versioned_endpoint) {
-            //if it's not above the current core version, and it's compatible with the current version of core
-            if ($key_versioned_endpoint == $latest_version) {
-                //don't hide the latest version in the index
-                $versions_served[$key_versioned_endpoint] = false;
-            } else if (
-                $key_versioned_endpoint < EED_Core_Rest_Api::core_version()
-                && $key_versioned_endpoint >= $lowest_compatible_version
-            ) {
-                //include, but hide, previous versions which are still supported
-                $versions_served[$key_versioned_endpoint] = true;
-            } elseif (
-            apply_filters(
-                'FHEE__EED_Core_Rest_Api__versions_served__include_incompatible_versions',
-                false,
-                $possibly_served_versions
-            )
-            ) {
-                //if a version is no longer supported, don't include it in index or list of versions served
-                $versions_served[$key_versioned_endpoint] = true;
-            }
-        }
-        return $versions_served;
-    }
-
-
-
-    /**
-     * Gets the major and minor version of EE core's version string
-     *
-     * @return string
-     */
-    public static function core_version()
-    {
-        return apply_filters('FHEE__EED_Core_REST_API__core_version',
-            implode('.', array_slice(explode('.', espresso_version()), 0, 3)));
-    }
-
-
-
-    /**
-     * Gets the default limit that should be used when querying for resources
-     *
-     * @return int
-     */
-    public static function get_default_query_limit()
-    {
-        //we actually don't use a const because we want folks to always use
-        //this method, not the const directly
-        return apply_filters(
-            'FHEE__EED_Core_Rest_Api__get_default_query_limit',
-            50
-        );
-    }
-
-
-
-    /**
-     *    run - initial module setup
-     *
-     * @access    public
-     * @param  WP $WP
-     * @return    void
-     */
-    public function run($WP)
-    {
-    }
+	const ee_api_namespace_for_regex = 'ee\/v([^/]*)\/';
+
+	const saved_routes_option_names  = 'ee_core_routes';
+
+	/**
+	 * string used in _links response bodies to make them globally unique.
+	 *
+	 * @see http://v2.wp-api.org/extending/linking/
+	 */
+	const ee_api_link_namespace = 'https://api.eventespresso.com/';
+
+	/**
+	 * @var Calculated_Model_Fields
+	 */
+	protected static $_field_calculator = null;
+
+
+
+	/**
+	 * @return EED_Core_Rest_Api
+	 */
+	public static function instance()
+	{
+		self::$_field_calculator = new Calculated_Model_Fields();
+		return parent::get_instance(__CLASS__);
+	}
+
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+		self::set_hooks_both();
+	}
+
+
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+		self::set_hooks_both();
+	}
+
+
+
+	public static function set_hooks_both()
+	{
+		add_action('rest_api_init', array('EED_Core_Rest_Api', 'register_routes'), 10);
+		add_action('rest_api_init', array('EED_Core_Rest_Api', 'set_hooks_rest_api'), 5);
+		add_filter('rest_route_data', array('EED_Core_Rest_Api', 'hide_old_endpoints'), 10, 2);
+		add_filter('rest_index',
+			array('EventEspresso\core\libraries\rest_api\controllers\model\Meta', 'filter_ee_metadata_into_index'));
+		EED_Core_Rest_Api::invalidate_cached_route_data_on_version_change();
+	}
+
+
+
+	/**
+	 * sets up hooks which only need to be included as part of REST API requests;
+	 * other requests like to the frontend or admin etc don't need them
+	 */
+	public static function set_hooks_rest_api()
+	{
+		//set hooks which account for changes made to the API
+		EED_Core_Rest_Api::_set_hooks_for_changes();
+		EED_Core_Rest_Api::maybe_notify_of_basic_auth_removal();
+	}
+
+
+
+	/**
+	 * public wrapper of _set_hooks_for_changes.
+	 * Loads all the hooks which make requests to old versions of the API
+	 * appear the same as they always did
+	 */
+	public static function set_hooks_for_changes()
+	{
+		self::_set_hooks_for_changes();
+	}
+
+
+
+	/**
+	 * If the user appears to be using WP API basic auth, tell them (via a persistent
+	 * admin notice and an email) that we're going to remove it soon, so they should
+	 * replace it with application passwords.
+	 */
+	public static function maybe_notify_of_basic_auth_removal()
+	{
+		if (
+		apply_filters(
+			'FHEE__EED_Core_Rest_Api__maybe_notify_of_basic_auth_removal__override',
+			! isset($_SERVER['PHP_AUTH_USER'])
+			&& ! isset($_SERVER['HTTP_AUTHORIZATION'])
+		)
+		) {
+			//sure it's a WP API request, but they aren't using basic auth, so don't bother them
+			return;
+		}
+		//ok they're using the WP API with Basic Auth
+		$message = sprintf(
+			__('We noticed you\'re using the WP API, which is used by the Event Espresso 4 mobile apps. Because of security and compatibility concerns, we will soon be removing our default authentication mechanism, WP API Basic Auth, from Event Espresso. It is recommended you instead install the %1$sWP Application Passwords plugin%2$s and use it with the EE4 Mobile apps. See %3$sour mobile app documentation%2$s for more information. %4$sIf you have installed the WP API Basic Auth plugin separately, or are not using the Event Espresso 4 mobile apps, you can disregard this message.%4$sThe Event Espresso Team',
+				'event_espresso'),
+			'<a href="https://wordpress.org/plugins/application-passwords/">',
+			'</a>',
+			'<a href="https://eventespresso.com/wiki/ee4-event-apps/#authentication">',
+			'<br/>'
+		);
+		EE_Error::add_persistent_admin_notice('using_basic_auth', $message);
+		if ( ! get_option('ee_notified_admin_on_basic_auth_removal', false)) {
+			add_option('ee_notified_admin_on_basic_auth_removal', true);
+			//piggy back off EE_Error::set_content_type, which sets the content type to HTML
+			add_filter('wp_mail_content_type', array('EE_Error', 'set_content_type'));
+			//and send the message to the site admin too
+			wp_mail(get_option('admin_email'),
+				__('Notice of Removal of WP API Basic Auth From Event Espresso 4', 'event_espresso'), $message);
+			remove_filter('wp_mail_content_type', array('EE_Error', 'set_content_type'));
+		}
+	}
+
+
+
+	/**
+	 * Loads all the hooks which make requests to old versions of the API
+	 * appear the same as they always did
+	 */
+	protected static function _set_hooks_for_changes()
+	{
+		$folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES . 'rest_api' . DS . 'changes'), false);
+		foreach ($folder_contents as $classname_in_namespace => $filepath) {
+			//ignore the base parent class
+			if ($classname_in_namespace === 'Changes_In_Base') {
+				continue;
+			}
+			$full_classname = 'EventEspresso\core\libraries\rest_api\changes\\' . $classname_in_namespace;
+			if (class_exists($full_classname)) {
+				$instance_of_class = new $full_classname;
+				if ($instance_of_class instanceof Changes_In_Base) {
+					$instance_of_class->set_hooks();
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * Filters the WP routes to add our EE-related ones. This takes a bit of time
+	 * so we actually prefer to only do it when an EE plugin is activated or upgraded
+	 */
+	public static function register_routes()
+	{
+		foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls) {
+			foreach ($relative_urls as $endpoint => $routes) {
+				foreach ($routes as $route) {
+					$route_args = array(
+						array(
+							'callback' => $route['callback'],
+							'methods'  => $route['methods'],
+							'args'     => isset($route['args']) ? $route['args'] : array(),
+						)
+					);
+					if (isset($route['schema_callback'])) {
+						$model_name = isset($route['schema_callback'][0])
+							? $route['schema_callback'][0]
+							: '';
+						$version = isset( $route['schema_callback'][1])
+							? $route['schema_callback'][1]
+							: '';
+						if (! empty($model_name) && ! empty($version)) {
+							$route_args['schema'] = function () use ($model_name, $version) {
+								return ModelRead::handle_schema_request(
+									$model_name,
+									$version
+								);
+							};
+						}
+					}
+					register_rest_route(
+						$namespace,
+						$endpoint,
+						$route_args
+					);
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * Checks if there was a version change or something that merits invalidating the cached
+	 * route data. If so, invalidates the cached route data so that it gets refreshed
+	 * next time the WP API is used
+	 */
+	public static function invalidate_cached_route_data_on_version_change()
+	{
+		if (EE_System::instance()->detect_req_type() != EE_System::req_type_normal) {
+			EED_Core_Rest_Api::invalidate_cached_route_data();
+		}
+		foreach (EE_Registry::instance()->addons as $addon) {
+			if ($addon instanceof EE_Addon && $addon->detect_req_type() != EE_System::req_type_normal) {
+				EED_Core_Rest_Api::invalidate_cached_route_data();
+			}
+		}
+	}
+
+
+
+	/**
+	 * Removes the cached route data so it will get refreshed next time the WP API is used
+	 */
+	public static function invalidate_cached_route_data()
+	{
+		//delete the saved EE REST API routes
+		foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden) {
+			delete_option(EED_Core_Rest_Api::saved_routes_option_names . $version);
+		}
+	}
+
+
+
+	/**
+	 * Gets the EE route data
+	 *
+	 * @return array top-level key is the namespace, next-level key is the route and its value is array{
+	 * @type string|array $callback
+	 * @type string       $methods
+	 * @type boolean      $hidden_endpoint
+	 * }
+	 */
+	public static function get_ee_route_data()
+	{
+		$ee_routes = array();
+		foreach (self::versions_served() as $version => $hidden_endpoints) {
+			$ee_routes[self::ee_api_namespace . $version] = self::_get_ee_route_data_for_version($version,
+				$hidden_endpoints);
+		}
+		return $ee_routes;
+	}
+
+
+
+	/**
+	 * Gets the EE route data from the wp options if it exists already,
+	 * otherwise re-generates it and saves it to the option
+	 *
+	 * @param string  $version
+	 * @param boolean $hidden_endpoints
+	 * @return array
+	 */
+	protected static function _get_ee_route_data_for_version($version, $hidden_endpoints = false)
+	{
+		$ee_routes = get_option(self::saved_routes_option_names . $version, null);
+		if ( ! $ee_routes || (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE)) {
+			$ee_routes = self::_save_ee_route_data_for_version($version, $hidden_endpoints);
+		}
+		return $ee_routes;
+	}
+
+
+
+	/**
+	 * Saves the EE REST API route data to a wp option and returns it
+	 *
+	 * @param string  $version
+	 * @param boolean $hidden_endpoints
+	 * @return mixed|null|void
+	 */
+	protected static function _save_ee_route_data_for_version($version, $hidden_endpoints = false)
+	{
+		$instance = self::instance();
+		$routes = apply_filters(
+			'EED_Core_Rest_Api__save_ee_route_data_for_version__routes',
+			array_replace_recursive(
+				$instance->_get_config_route_data_for_version($version, $hidden_endpoints),
+				$instance->_get_meta_route_data_for_version($version, $hidden_endpoints),
+				$instance->_get_model_route_data_for_version($version, $hidden_endpoints),
+				$instance->_get_rpc_route_data_for_version($version, $hidden_endpoints)
+			)
+		);
+		$option_name = self::saved_routes_option_names . $version;
+		if (get_option($option_name)) {
+			update_option($option_name, $routes, true);
+		} else {
+			add_option($option_name, $routes, null, 'no');
+		}
+		return $routes;
+	}
+
+
+
+	/**
+	 * Calculates all the EE routes and saves it to a wordpress option so we don't
+	 * need to calculate it on every request
+	 *
+	 * @deprecated since version 4.9.1
+	 * @return void
+	 */
+	public static function save_ee_routes()
+	{
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
+			$instance = self::instance();
+			$routes = apply_filters(
+				'EED_Core_Rest_Api__save_ee_routes__routes',
+				array_replace_recursive(
+					$instance->_register_config_routes(),
+					$instance->_register_meta_routes(),
+					$instance->_register_model_routes(),
+					$instance->_register_rpc_routes()
+				)
+			);
+			update_option(self::saved_routes_option_names, $routes, true);
+		}
+	}
+
+
+
+	/**
+	 * Gets all the route information relating to EE models
+	 *
+	 * @return array @see get_ee_route_data
+	 * @deprecated since version 4.9.1
+	 */
+	protected function _register_model_routes()
+	{
+		$model_routes = array();
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
+			$model_routes[EED_Core_Rest_Api::ee_api_namespace
+						  . $version] = $this->_get_config_route_data_for_version($version, $hidden_endpoint);
+		}
+		return $model_routes;
+	}
+
+
+
+	/**
+	 * Gets the route data for EE models in the specified version
+	 *
+	 * @param string  $version
+	 * @param boolean $hidden_endpoint
+	 * @return array
+	 */
+	protected function _get_model_route_data_for_version($version, $hidden_endpoint = false)
+	{
+		$model_version_info = new Model_Version_Info($version);
+		$models_to_register = apply_filters(
+			'FHEE__EED_Core_REST_API___register_model_routes',
+			$model_version_info->models_for_requested_version()
+		);
+		//let's not bother having endpoints for extra metas
+		unset($models_to_register['Extra_Meta']);
+		unset($models_to_register['Extra_Join']);
+		$model_routes = array();
+		foreach ($models_to_register as $model_name => $model_classname) {
+			$model = \EE_Registry::instance()->load_model($model_name);
+
+			//if this isn't a valid model then let's skip iterate to the next item in the loop.
+			if (! $model instanceof EEM_Base) {
+				continue;
+			}
+
+			//yes we could just register one route for ALL models, but then they wouldn't show up in the index
+			$plural_model_route = EEH_Inflector::pluralize_and_lower($model_name);
+			$singular_model_route = $plural_model_route . '/(?P<id>\d+)';
+			$model_routes[$plural_model_route] = array(
+				array(
+					'callback'        => array(
+						'EventEspresso\core\libraries\rest_api\controllers\model\Read',
+						'handle_request_get_all',
+					),
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+					'args'            => $this->_get_read_query_params($model, $version),
+					'_links'          => array(
+						'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace . $version . $singular_model_route),
+					),
+					'schema_callback' => array($model_name, $version)
+				),
+				//						array(
+				//							'callback' => array(
+				//								'EventEspresso\core\libraries\rest_api\controllers\model\Write',
+				//								'handle_request_create_one' ),
+				//							'methods' => WP_REST_Server::CREATABLE,
+				//							'hidden_endpoint' => $hidden_endpoint
+				//						)
+			);
+			$model_routes[$singular_model_route] = array(
+				array(
+					'callback'        => array(
+						'EventEspresso\core\libraries\rest_api\controllers\model\Read',
+						'handle_request_get_one',
+					),
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+					'args'            => $this->_get_response_selection_query_params($model, $version),
+				),
+				//						array(
+				//							'callback' => array(
+				//								'EventEspresso\core\libraries\rest_api\controllers\model\Write',
+				//								'handle_request_edit_one' ),
+				//							'methods' => WP_REST_Server::EDITABLE,
+				//							'hidden_endpoint' => $hidden_endpoint
+				//							),
+			);
+			//@todo: also handle  DELETE for a single item
+			foreach ($model_version_info->relation_settings($model) as $relation_name => $relation_obj) {
+				$related_model_name_endpoint_part = ModelRead::get_related_entity_name(
+					$relation_name,
+					$relation_obj
+				);
+				$model_routes[$singular_model_route . '/' . $related_model_name_endpoint_part] = array(
+					array(
+						'callback'        => array(
+							'EventEspresso\core\libraries\rest_api\controllers\model\Read',
+							'handle_request_get_related',
+						),
+						'methods'         => WP_REST_Server::READABLE,
+						'hidden_endpoint' => $hidden_endpoint,
+						'args'            => $this->_get_read_query_params($relation_obj->get_other_model(), $version),
+					),
+					//							array(
+					//								'callback' => array(
+					//									'EventEspresso\core\libraries\rest_api\controllers\model\Write',
+					//									'handle_request_create_or_update_related' ),
+					//								'methods' => WP_REST_Server::EDITABLE,
+					//								'hidden_endpoint' => $hidden_endpoint
+					//							)
+				);
+				//@todo: handle delete related and possibly remove relation (not sure hwo to distinguish)
+			}
+		}
+		return $model_routes;
+	}
+
+
+
+	/**
+	 * Adds all the RPC-style routes (remote procedure call-like routes, ie
+	 * routes that don't conform to the traditional REST CRUD-style).
+	 *
+	 * @deprecated since 4.9.1
+	 */
+	protected function _register_rpc_routes()
+	{
+		$routes = array();
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
+			$routes[self::ee_api_namespace . $version] = $this->_get_rpc_route_data_for_version($version,
+				$hidden_endpoint);
+		}
+		return $routes;
+	}
+
+
+
+	/**
+	 * @param string  $version
+	 * @param boolean $hidden_endpoint
+	 * @return array
+	 */
+	protected function _get_rpc_route_data_for_version($version, $hidden_endpoint = false)
+	{
+		$this_versions_routes = array();
+		//checkin endpoint
+		$this_versions_routes['registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)'] = array(
+			array(
+				'callback'        => array(
+					'EventEspresso\core\libraries\rest_api\controllers\rpc\Checkin',
+					'handle_request_toggle_checkin',
+				),
+				'methods'         => WP_REST_Server::CREATABLE,
+				'hidden_endpoint' => $hidden_endpoint,
+				'args'            => array(
+					'force' => array(
+						'required'    => false,
+						'default'     => false,
+						'description' => __('Whether to force toggle checkin, or to verify the registration status and allowed ticket uses',
+							'event_espresso'),
+					),
+				),
+			),
+		);
+		return apply_filters(
+			'FHEE__EED_Core_Rest_Api___register_rpc_routes__this_versions_routes',
+			$this_versions_routes,
+			$version,
+			$hidden_endpoint
+		);
+	}
+
+
+
+	/**
+	 * Gets the query params that can be used when request one or many
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $version
+	 * @return array
+	 */
+	protected function _get_response_selection_query_params(\EEM_Base $model, $version)
+	{
+		return apply_filters(
+			'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
+			array(
+				'include'   => array(
+					'required' => false,
+					'default'  => '*',
+				),
+				'calculate' => array(
+					'required' => false,
+					'default'  => '',
+					'enum'     => self::$_field_calculator->retrieve_calculated_fields_for_model($model),
+				),
+			),
+			$model,
+			$version
+		);
+	}
+
+
+
+	/**
+	 * Gets info about reading query params that are acceptable
+	 *
+	 * @param \EEM_Base $model eg 'Event' or 'Venue'
+	 * @param  string   $version
+	 * @return array    describing the args acceptable when querying this model
+	 * @throws \EE_Error
+	 */
+	protected function _get_read_query_params(\EEM_Base $model, $version)
+	{
+		$default_orderby = array();
+		foreach ($model->get_combined_primary_key_fields() as $key_field) {
+			$default_orderby[$key_field->get_name()] = 'ASC';
+		}
+		return array_merge(
+			$this->_get_response_selection_query_params($model, $version),
+			array(
+				'where'    => array(
+					'required' => false,
+					'default'  => array(),
+				),
+				'limit'    => array(
+					'required' => false,
+					'default'  => EED_Core_Rest_Api::get_default_query_limit(),
+				),
+				'order_by' => array(
+					'required' => false,
+					'default'  => $default_orderby,
+				),
+				'group_by' => array(
+					'required' => false,
+					'default'  => null,
+				),
+				'having'   => array(
+					'required' => false,
+					'default'  => null,
+				),
+				'caps'     => array(
+					'required' => false,
+					'default'  => EEM_Base::caps_read,
+				),
+			)
+		);
+	}
+
+
+
+	/**
+	 * Gets routes for the config
+	 *
+	 * @return array @see _register_model_routes
+	 * @deprecated since version 4.9.1
+	 */
+	protected function _register_config_routes()
+	{
+		$config_routes = array();
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
+			$config_routes[self::ee_api_namespace . $version] = $this->_get_config_route_data_for_version($version,
+				$hidden_endpoint);
+		}
+		return $config_routes;
+	}
+
+
+
+	/**
+	 * Gets routes for the config for the specified version
+	 *
+	 * @param string  $version
+	 * @param boolean $hidden_endpoint
+	 * @return array
+	 */
+	protected function _get_config_route_data_for_version($version, $hidden_endpoint)
+	{
+		return array(
+			'config'    => array(
+				array(
+					'callback'        => array(
+						'EventEspresso\core\libraries\rest_api\controllers\config\Read',
+						'handle_request',
+					),
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+				),
+			),
+			'site_info' => array(
+				array(
+					'callback'        => array(
+						'EventEspresso\core\libraries\rest_api\controllers\config\Read',
+						'handle_request_site_info',
+					),
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+				),
+			),
+		);
+	}
+
+
+
+	/**
+	 * Gets the meta info routes
+	 *
+	 * @return array @see _register_model_routes
+	 * @deprecated since version 4.9.1
+	 */
+	protected function _register_meta_routes()
+	{
+		$meta_routes = array();
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
+			$meta_routes[self::ee_api_namespace . $version] = $this->_get_meta_route_data_for_version($version,
+				$hidden_endpoint);
+		}
+		return $meta_routes;
+	}
+
+
+
+	/**
+	 * @param string  $version
+	 * @param boolean $hidden_endpoint
+	 * @return array
+	 */
+	protected function _get_meta_route_data_for_version($version, $hidden_endpoint = false)
+	{
+		return array(
+			'resources' => array(
+				array(
+					'callback'        => array(
+						'EventEspresso\core\libraries\rest_api\controllers\model\Meta',
+						'handle_request_models_meta',
+					),
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+				),
+			),
+		);
+	}
+
+
+
+	/**
+	 * Tries to hide old 4.6 endpoints from the
+	 *
+	 * @param array $route_data
+	 * @return array
+	 */
+	public static function hide_old_endpoints($route_data)
+	{
+		//allow API clients to override which endpoints get hidden, in case
+		//they want to discover particular endpoints
+		//also, we don't have access to the request so we have to just grab it from the superglobal
+		$force_show_ee_namespace = ltrim(
+			EEH_Array::is_set($_REQUEST, 'force_show_ee_namespace', ''),
+			'/'
+		);
+		foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls) {
+			foreach ($relative_urls as $endpoint => $routes) {
+				foreach ($routes as $route) {
+					//by default, hide "hidden_endpoint"s, unless the request indicates
+					//to $force_show_ee_namespace, in which case only show that one
+					//namespace's endpoints (and hide all others)
+					if (($route['hidden_endpoint'] && $force_show_ee_namespace === '')
+						|| ($force_show_ee_namespace !== '' && $force_show_ee_namespace !== $namespace)
+					) {
+						$full_route = '/' . ltrim($namespace, '/') . '/' . ltrim($endpoint, '/');
+						unset($route_data[$full_route]);
+					}
+				}
+			}
+		}
+		return $route_data;
+	}
+
+
+
+	/**
+	 * Returns an array describing which versions of core support serving requests for.
+	 * Keys are core versions' major and minor version, and values are the
+	 * LOWEST requested version they can serve. Eg, 4.7 can serve requests for 4.6-like
+	 * data by just removing a few models and fields from the responses. However, 4.15 might remove
+	 * the answers table entirely, in which case it would be very difficult for
+	 * it to serve 4.6-style responses.
+	 * Versions of core that are missing from this array are unknowns.
+	 * previous ver
+	 *
+	 * @return array
+	 */
+	public static function version_compatibilities()
+	{
+		return apply_filters(
+			'FHEE__EED_Core_REST_API__version_compatibilities',
+			array(
+				'4.8.29' => '4.8.29',
+				'4.8.33' => '4.8.29',
+				'4.8.34' => '4.8.29',
+				'4.8.36' => '4.8.29',
+			)
+		);
+	}
+
+
+
+	/**
+	 * Gets the latest API version served. Eg if there
+	 * are two versions served of the API, 4.8.29 and 4.8.32, and
+	 * we are on core version 4.8.34, it will return the string "4.8.32"
+	 *
+	 * @return string
+	 */
+	public static function latest_rest_api_version()
+	{
+		$versions_served = \EED_Core_Rest_Api::versions_served();
+		$versions_served_keys = array_keys($versions_served);
+		return end($versions_served_keys);
+	}
+
+
+
+	/**
+	 * Using EED_Core_Rest_Api::version_compatibilities(), determines what version of
+	 * EE the API can serve requests for. Eg, if we are on 4.15 of core, and
+	 * we can serve requests from 4.12 or later, this will return array( '4.12', '4.13', '4.14', '4.15' ).
+	 * We also indicate whether or not this version should be put in the index or not
+	 *
+	 * @return array keys are API version numbers (just major and minor numbers), and values
+	 * are whether or not they should be hidden
+	 */
+	public static function versions_served()
+	{
+		$versions_served = array();
+		$possibly_served_versions = EED_Core_Rest_Api::version_compatibilities();
+		$lowest_compatible_version = end($possibly_served_versions);
+		reset($possibly_served_versions);
+		$versions_served_historically = array_keys($possibly_served_versions);
+		$latest_version = end($versions_served_historically);
+		reset($versions_served_historically);
+		//for each version of core we have ever served:
+		foreach ($versions_served_historically as $key_versioned_endpoint) {
+			//if it's not above the current core version, and it's compatible with the current version of core
+			if ($key_versioned_endpoint == $latest_version) {
+				//don't hide the latest version in the index
+				$versions_served[$key_versioned_endpoint] = false;
+			} else if (
+				$key_versioned_endpoint < EED_Core_Rest_Api::core_version()
+				&& $key_versioned_endpoint >= $lowest_compatible_version
+			) {
+				//include, but hide, previous versions which are still supported
+				$versions_served[$key_versioned_endpoint] = true;
+			} elseif (
+			apply_filters(
+				'FHEE__EED_Core_Rest_Api__versions_served__include_incompatible_versions',
+				false,
+				$possibly_served_versions
+			)
+			) {
+				//if a version is no longer supported, don't include it in index or list of versions served
+				$versions_served[$key_versioned_endpoint] = true;
+			}
+		}
+		return $versions_served;
+	}
+
+
+
+	/**
+	 * Gets the major and minor version of EE core's version string
+	 *
+	 * @return string
+	 */
+	public static function core_version()
+	{
+		return apply_filters('FHEE__EED_Core_REST_API__core_version',
+			implode('.', array_slice(explode('.', espresso_version()), 0, 3)));
+	}
+
+
+
+	/**
+	 * Gets the default limit that should be used when querying for resources
+	 *
+	 * @return int
+	 */
+	public static function get_default_query_limit()
+	{
+		//we actually don't use a const because we want folks to always use
+		//this method, not the const directly
+		return apply_filters(
+			'FHEE__EED_Core_Rest_Api__get_default_query_limit',
+			50
+		);
+	}
+
+
+
+	/**
+	 *    run - initial module setup
+	 *
+	 * @access    public
+	 * @param  WP $WP
+	 * @return    void
+	 */
+	public function run($WP)
+	{
+	}
 
 
 

core/entities/interfaces/HasSchemaInterface.php

Indentation +50 added lines, -50 removed lines

@@ -5,63 +5,63 @@
 
 interface HasSchemaInterface
 {
-    /**
-     * Returns whatever is set as the nicename for the object.
-     *
-     * @return string
-     */
-    public function getSchemaDescription();
+	/**
+	 * Returns whatever is set as the nicename for the object.
+	 *
+	 * @return string
+	 */
+	public function getSchemaDescription();
 
 
-    /**
-     * Returns whatever is set as the $_schema_type property for the object.
-     * Note: this will automatically add 'null' to the schema if the object is_nullable()
-     *
-     * @return string|array
-     */
-    public function getSchemaType();
+	/**
+	 * Returns whatever is set as the $_schema_type property for the object.
+	 * Note: this will automatically add 'null' to the schema if the object is_nullable()
+	 *
+	 * @return string|array
+	 */
+	public function getSchemaType();
 
 
-    /**
-     * This is usually present when the $_schema_type property is 'object'.  Any child classes will need to override
-     * this method and return the properties for the schema.
-     * The reason this is not a property on the class is because there may be filters set on the values for the property
-     * that won't be exposed on construct.  For example enum type schemas may have the enum values filtered.
-     *
-     * @return array
-     */
-    public function getSchemaProperties();
+	/**
+	 * This is usually present when the $_schema_type property is 'object'.  Any child classes will need to override
+	 * this method and return the properties for the schema.
+	 * The reason this is not a property on the class is because there may be filters set on the values for the property
+	 * that won't be exposed on construct.  For example enum type schemas may have the enum values filtered.
+	 *
+	 * @return array
+	 */
+	public function getSchemaProperties();
 
-    /**
-     * If a child class has enum values, they should override this method and provide a simple array
-     * of the enum values.
-     * The reason this is not a property on the class is because there may be filterable enum values that
-     * are set on the instantiated object that could be filtered after construct.
-     *
-     * @return array
-     */
-    public function getSchemaEnum();
+	/**
+	 * If a child class has enum values, they should override this method and provide a simple array
+	 * of the enum values.
+	 * The reason this is not a property on the class is because there may be filterable enum values that
+	 * are set on the instantiated object that could be filtered after construct.
+	 *
+	 * @return array
+	 */
+	public function getSchemaEnum();
 
-    /**
-     * This returns the value of the $_schema_format property on the object.
-     *
-     * @return string
-     */
-    public function getSchemaFormat();
+	/**
+	 * This returns the value of the $_schema_format property on the object.
+	 *
+	 * @return string
+	 */
+	public function getSchemaFormat();
 
-    /**
-     * This returns the value of the $_schema_readonly property on the object.
-     *
-     * @return bool
-     */
-    public function getSchemaReadonly();
+	/**
+	 * This returns the value of the $_schema_readonly property on the object.
+	 *
+	 * @return bool
+	 */
+	public function getSchemaReadonly();
 
 
-    /**
-     * This returns elements used to represent this field in the json schema.
-     *
-     * @link http://json-schema.org/
-     * @return array
-     */
-    public function getSchema();
+	/**
+	 * This returns elements used to represent this field in the json schema.
+	 *
+	 * @link http://json-schema.org/
+	 * @return array
+	 */
+	public function getSchema();
 }
\ No newline at end of file

core/db_models/fields/EE_Text_Field_Base.php

Indentation +30 added lines, -30 removed lines

@@ -7,36 +7,36 @@
 abstract class EE_Text_Field_Base extends EE_Model_Field_Base
 {
 
-    function prepare_for_get($value_of_field_on_model_object)
-    {
-        return is_string($value_of_field_on_model_object) ? stripslashes($value_of_field_on_model_object) : $value_of_field_on_model_object;
-    }
+	function prepare_for_get($value_of_field_on_model_object)
+	{
+		return is_string($value_of_field_on_model_object) ? stripslashes($value_of_field_on_model_object) : $value_of_field_on_model_object;
+	}
 
-    /**
-     * Accepts schema of 'form_input' which formats the string for echoing in form input's value.
-     *
-     * @param string $value_on_field_to_be_outputted
-     * @param string $schema
-     * @return string
-     */
-    function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
-    {
-        if ($schema == 'form_input') {
-            $value_on_field_to_be_outputted = htmlentities($value_on_field_to_be_outputted, ENT_QUOTES, 'UTF-8');
-        }
-        return parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema);
-    }
+	/**
+	 * Accepts schema of 'form_input' which formats the string for echoing in form input's value.
+	 *
+	 * @param string $value_on_field_to_be_outputted
+	 * @param string $schema
+	 * @return string
+	 */
+	function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
+	{
+		if ($schema == 'form_input') {
+			$value_on_field_to_be_outputted = htmlentities($value_on_field_to_be_outputted, ENT_QUOTES, 'UTF-8');
+		}
+		return parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema);
+	}
 
-    /**
-     * In form inputs, we should have called htmlentities and addslashes on form inputs,
-     * so we need to undo that on setting of these fields
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        return stripslashes(html_entity_decode(parent::prepare_for_set($value_inputted_for_field_on_model_object),
-            ENT_QUOTES, 'UTF-8'));
-    }
+	/**
+	 * In form inputs, we should have called htmlentities and addslashes on form inputs,
+	 * so we need to undo that on setting of these fields
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		return stripslashes(html_entity_decode(parent::prepare_for_set($value_inputted_for_field_on_model_object),
+			ENT_QUOTES, 'UTF-8'));
+	}
 }
\ No newline at end of file

core/db_models/fields/EE_Primary_Key_String_Field.php

Indentation +17 added lines, -17 removed lines

@@ -4,22 +4,22 @@
 class EE_Primary_Key_String_Field extends EE_Primary_Key_Field_Base
 {
 
-    public function __construct($table_column, $nicename)
-    {
-        parent::__construct($table_column, $nicename, null);
-    }
+	public function __construct($table_column, $nicename)
+	{
+		parent::__construct($table_column, $nicename, null);
+	}
 
-    /**
-     * removes all tags when setting
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
-            $value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
-        }
-        return wp_strip_all_tags($value_inputted_for_field_on_model_object);
-    }
+	/**
+	 * removes all tags when setting
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
+			$value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
+		}
+		return wp_strip_all_tags($value_inputted_for_field_on_model_object);
+	}
 }
\ No newline at end of file

core/db_models/fields/EE_Foreign_Key_String_Field.php

Indentation +13 added lines, -13 removed lines

@@ -4,17 +4,17 @@
 class EE_Foreign_Key_String_Field extends EE_Foreign_Key_Field_Base
 {
 
-    /**
-     * removes all tags when setting
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
-            $value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
-        }
-        return strtoupper(wp_strip_all_tags($value_inputted_for_field_on_model_object));
-    }
+	/**
+	 * removes all tags when setting
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
+			$value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
+		}
+		return strtoupper(wp_strip_all_tags($value_inputted_for_field_on_model_object));
+	}
 }
\ No newline at end of file